Jump to

• Request
• Response

Update a blackout by blackout ID

patch

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/{blackoutId}

Updates a blackout by blackout ID.

Request

Path Parameters

• blackoutId(required): string
  Blackout ID.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Payload to edit an existing blackout.

Show Source

• description: string
  Blackout related comments.

  Example: A regular maintenance scheduled blackouts for oemrep database.
• excludeTargets: array excludeTargets
  List of indirect blackout members which should be excluded from blackout.
• excludeTypes: array excludeTypes
  List of indirect blackout member type names which should be excluded from blackout.
• isAllowJobs: boolean
  Default Value: false

  Indicate of jobs on targets are still allowed to be executed.
• isFullBlackoutOnHost: boolean
  Default Value: false

  Indicate that all targets on host are under blackout.
• reasonId: number
  Reason ID for the blackout.
• targets: array targets
  List of targets to be blacked out.
• type: string
  Default Value: PATCHING

  Allowed Values: [ "PATCHING", "NOTIFICATION", "NOTIFICATION_MAINTENANCE" ]

  Type of the blackout.

{
    "x-em-sdk-level":"emSDK",
    "description":"Payload to edit an existing blackout.",
    "properties":{
        "type":{
            "$ref":"#/components/schemas/BlackoutType"
        },
        "description":{
            "type":"string",
            "description":"Blackout related comments.",
            "example":"A regular maintenance scheduled blackouts for oemrep database."
        },
        "targets":{
            "type":"array",
            "description":"List of targets to be blacked out.",
            "items":{
                "$ref":"#/components/schemas/BlackoutTarget"
            }
        },
        "reasonId":{
            "type":"number",
            "description":"Reason ID for the blackout."
        },
        "isAllowJobs":{
            "type":"boolean",
            "description":"Indicate of jobs on targets are still allowed to be executed.",
            "default":false
        },
        "isFullBlackoutOnHost":{
            "type":"boolean",
            "description":"Indicate that all targets on host are under blackout.",
            "default":false
        },
        "excludeTypes":{
            "type":"array",
            "description":"List of indirect blackout member type names which should be excluded from blackout.",
            "items":{
                "type":"string"
            }
        },
        "excludeTargets":{
            "type":"array",
            "description":"List of indirect blackout members which should be excluded from blackout.",
            "items":{
                "$ref":"#/components/schemas/TargetIdentifier"
            }
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/Schedule"
        }
    ]
}

Match All

Payload to edit an existing blackout.

Show Source

• object Schedule
  Defining time schedule

{
    "x-em-sdk-level":"emSDK",
    "description":"Payload to edit an existing blackout.",
    "properties":{
        "type":{
            "$ref":"#/components/schemas/BlackoutType"
        },
        "description":{
            "type":"string",
            "description":"Blackout related comments.",
            "example":"A regular maintenance scheduled blackouts for oemrep database."
        },
        "targets":{
            "type":"array",
            "description":"List of targets to be blacked out.",
            "items":{
                "$ref":"#/components/schemas/BlackoutTarget"
            }
        },
        "reasonId":{
            "type":"number",
            "description":"Reason ID for the blackout."
        },
        "isAllowJobs":{
            "type":"boolean",
            "description":"Indicate of jobs on targets are still allowed to be executed.",
            "default":false
        },
        "isFullBlackoutOnHost":{
            "type":"boolean",
            "description":"Indicate that all targets on host are under blackout.",
            "default":false
        },
        "excludeTypes":{
            "type":"array",
            "description":"List of indirect blackout member type names which should be excluded from blackout.",
            "items":{
                "type":"string"
            }
        },
        "excludeTargets":{
            "type":"array",
            "description":"List of indirect blackout members which should be excluded from blackout.",
            "items":{
                "$ref":"#/components/schemas/TargetIdentifier"
            }
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/Schedule"
        }
    ]
}

Nested Schema : excludeTargets

Type: array

List of indirect blackout members which should be excluded from blackout.

Show Source

• Array of: object TargetIdentifier
  Identifies a target either by name and typeName or by id.

{
    "type":"array",
    "description":"List of indirect blackout members which should be excluded from blackout.",
    "items":{
        "$ref":"#/components/schemas/TargetIdentifier"
    }
}

Nested Schema : excludeTypes

Type: array

List of indirect blackout member type names which should be excluded from blackout.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of indirect blackout member type names which should be excluded from blackout.",
    "items":{
        "type":"string"
    }
}

Nested Schema : targets

Type: array

List of targets to be blacked out.

Show Source

• Array of: object BlackoutTarget
  Representation of a target contained in a blackout.

{
    "type":"array",
    "description":"List of targets to be blacked out.",
    "items":{
        "$ref":"#/components/schemas/BlackoutTarget"
    }
}

Nested Schema : Schedule

Type: object

Defining time schedule

Show Source

• isTargetZoneUsed: boolean
  To indicate the time should be interpreted in target's timezone or not. If Timezone is specified in time and useTargetZone is true, it will be reported as an ERROR condition

  Example: true
• recurring: string
  Frequency at which the operation must be executed repeatedly

  Example: Weekly
• scheduleType: string
  Currently we support ical specification default is ICAL, in future it can be extended to other types e.g CRON.
• startGracePeriodInMinutes: number
  Time in minutes after which the job will be marked as skipped if not started. Null or Negative value means no grace period.

  Example: 60
• timeToEnd: string
  end time for the job in the format YYYY-MM-DDTHH24:Mi:SSZTimezone Timezone specification is optional and will be defaulted to UTC.

  Example: 2021-03-02 22:00:13
• timeToStart: string
  start time for the job in the format YYYY-MM-DDTHH24:Mi:SSZTimezone Timezone specification is optional and will be defaulted to UTC.

  Example: 2021-03-01 21:23:03

{
    "description":"Defining time schedule",
    "type":"object",
    "properties":{
        "timeToStart":{
            "type":"string",
            "description":"start time for the job in the format YYYY-MM-DDTHH24:Mi:SSZTimezone Timezone specification is optional and will be defaulted to UTC.",
            "example":"2021-03-01 21:23:03"
        },
        "timeToEnd":{
            "type":"string",
            "description":"end time for the job in the format YYYY-MM-DDTHH24:Mi:SSZTimezone Timezone specification is optional and will be defaulted to UTC.",
            "example":"2021-03-02 22:00:13"
        },
        "isTargetZoneUsed":{
            "type":"boolean",
            "description":"To indicate the time should be interpreted in target's timezone or not. If Timezone is specified in time and useTargetZone is true, it will be reported as an ERROR condition",
            "example":true
        },
        "scheduleType":{
            "type":"string",
            "description":"Currently we support ical specification default is ICAL, in future it can be extended to other types e.g CRON."
        },
        "recurring":{
            "type":"string",
            "description":"Frequency at which the operation must be executed repeatedly",
            "example":"Weekly"
        },
        "startGracePeriodInMinutes":{
            "type":"number",
            "description":"Time in minutes after which the job will be marked as skipped if not started. Null or Negative value means no grace period.",
            "example":60
        }
    }
}

Nested Schema : TargetIdentifier

Type: object

Identifies a target either by name and typeName or by id.

Show Source

• id: string
  Target ID
• name: string
  Target Name
• typeName: string
  Target Type Name

{
    "type":"object",
    "description":"Identifies a target either by name and typeName or by id.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Target ID"
        },
        "name":{
            "type":"string",
            "description":"Target Name"
        },
        "typeName":{
            "type":"string",
            "description":"Target Type Name"
        }
    }
}

Nested Schema : BlackoutTarget

Type: object

Representation of a target contained in a blackout.

Show Source

• id: string
  Target ID.
• isIncludeMembers: boolean
  Default Value: true

  Indicates if members of the target should be included in the blackout.
• name: string
  Target Name
• typeName: string
  Target Type Name

{
    "x-em-sdk-level":"emSDK",
    "description":"Representation of a target contained in a blackout.",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Target Name"
        },
        "typeName":{
            "type":"string",
            "description":"Target Type Name"
        },
        "id":{
            "type":"string",
            "description":"Target ID."
        },
        "isIncludeMembers":{
            "type":"boolean",
            "description":"Indicates if members of the target should be included in the blackout.",
            "default":true
        }
    }
}

Examples

Select an example Modify attributes of a blackout

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Blackout

Type: object

This is a blackout description.

Show Source

• agent: string
  Name of the agent starting the blackout.

  Example: hostName:1838
• creationTimeToEnd: string
  The timeToEnd given at blackout creation time.
• creationTimeToStart: string
  The timeToStart given at blackout creation time.
• description: string
  Blackout related comments.

  Example: A regular maintenance scheduled blackouts for oemrep database
• excludeTargets: array excludeTargets
  List of indirect blackout members which should be excluded from blackout.
• excludeTypes: array excludeTypes
  List of indirect blackout member type names which should be excluded from blackout.
• id(required): string
  Blackout ID

  Example: D91786E288D35455C3ADA1B329B49BB5
• isAllowJobs: boolean
  Default Value: false

  Indicates if job executions on targets are allowed during blackout.
• isFullBlackoutOnHost: boolean
  Default Value: false

  Indicates if all targets on hosts in the blackout are blacked out too.
• links(required): object links
  Blackout related links.
• name(required): string
  Blackout Name

  Example: my_blackout
• owner(required): string
  Owner of the blackout

  Example: scott
• reason: string
  Blackout reason

  Example: Host patching
• status(required): string
  Allowed Values: [ "SCHEDULED", "START_PROCESSING", "START_PARTIAL", "START_FAILED", "STARTED", "STOP_PENDING", "STOP_FAILED", "STOP_PARTIAL", "EDIT_FAILED", "EDIT_PARTIAL", "EDIT_PENDING", "STOPPED", "ENDED", "END_PARTIAL" ]

  Blackout status.
• type(required): string
  Default Value: PATCHING

  Allowed Values: [ "PATCHING", "NOTIFICATION", "NOTIFICATION_MAINTENANCE" ]

  Type of the blackout.

{
    "x-em-sdk-level":"emSDK",
    "description":"This is a blackout description.",
    "type":"object",
    "required":[
        "id",
        "name",
        "type",
        "status",
        "owner",
        "links"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Blackout ID",
            "example":"D91786E288D35455C3ADA1B329B49BB5"
        },
        "name":{
            "type":"string",
            "description":"Blackout Name",
            "example":"my_blackout"
        },
        "type":{
            "$ref":"#/components/schemas/BlackoutType"
        },
        "owner":{
            "type":"string",
            "description":"Owner of the blackout",
            "example":"scott"
        },
        "reason":{
            "type":"string",
            "description":"Blackout reason",
            "example":"Host patching"
        },
        "description":{
            "type":"string",
            "description":"Blackout related comments.",
            "example":"A regular maintenance scheduled blackouts for oemrep database"
        },
        "agent":{
            "type":"string",
            "description":"Name of the agent starting the blackout.",
            "example":"hostName:1838"
        },
        "status":{
            "$ref":"#/components/schemas/BlackoutStatus"
        },
        "isAllowJobs":{
            "type":"boolean",
            "description":"Indicates if job executions on targets are allowed during blackout.",
            "default":false
        },
        "isFullBlackoutOnHost":{
            "type":"boolean",
            "description":"Indicates if all targets on hosts in the blackout are blacked out too.",
            "default":false
        },
        "excludeTypes":{
            "type":"array",
            "description":"List of indirect blackout member type names which should be excluded from blackout.",
            "items":{
                "type":"string"
            }
        },
        "excludeTargets":{
            "type":"array",
            "description":"List of indirect blackout members which should be excluded from blackout.",
            "items":{
                "$ref":"#/components/schemas/TargetIdentifier"
            }
        },
        "creationTimeToStart":{
            "type":"string",
            "description":"The timeToStart given at blackout creation time."
        },
        "creationTimeToEnd":{
            "type":"string",
            "description":"The timeToEnd given at blackout creation time."
        },
        "links":{
            "type":"object",
            "description":"Blackout related links.",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the blackout."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts/D91786E288D35455C3ADA1B329B49BB5"
                            }
                        }
                    ]
                },
                "targets":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the targets under blackout."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts/D91786E288DFSE2323ADA1B329B49BB5/targets"
                            }
                        }
                    ]
                }
            }
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/Schedule"
        }
    ]
}

Match All

This is a blackout description.

Show Source

• object Schedule
  Defining time schedule

{
    "x-em-sdk-level":"emSDK",
    "description":"This is a blackout description.",
    "type":"object",
    "required":[
        "id",
        "name",
        "type",
        "status",
        "owner",
        "links"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Blackout ID",
            "example":"D91786E288D35455C3ADA1B329B49BB5"
        },
        "name":{
            "type":"string",
            "description":"Blackout Name",
            "example":"my_blackout"
        },
        "type":{
            "$ref":"#/components/schemas/BlackoutType"
        },
        "owner":{
            "type":"string",
            "description":"Owner of the blackout",
            "example":"scott"
        },
        "reason":{
            "type":"string",
            "description":"Blackout reason",
            "example":"Host patching"
        },
        "description":{
            "type":"string",
            "description":"Blackout related comments.",
            "example":"A regular maintenance scheduled blackouts for oemrep database"
        },
        "agent":{
            "type":"string",
            "description":"Name of the agent starting the blackout.",
            "example":"hostName:1838"
        },
        "status":{
            "$ref":"#/components/schemas/BlackoutStatus"
        },
        "isAllowJobs":{
            "type":"boolean",
            "description":"Indicates if job executions on targets are allowed during blackout.",
            "default":false
        },
        "isFullBlackoutOnHost":{
            "type":"boolean",
            "description":"Indicates if all targets on hosts in the blackout are blacked out too.",
            "default":false
        },
        "excludeTypes":{
            "type":"array",
            "description":"List of indirect blackout member type names which should be excluded from blackout.",
            "items":{
                "type":"string"
            }
        },
        "excludeTargets":{
            "type":"array",
            "description":"List of indirect blackout members which should be excluded from blackout.",
            "items":{
                "$ref":"#/components/schemas/TargetIdentifier"
            }
        },
        "creationTimeToStart":{
            "type":"string",
            "description":"The timeToStart given at blackout creation time."
        },
        "creationTimeToEnd":{
            "type":"string",
            "description":"The timeToEnd given at blackout creation time."
        },
        "links":{
            "type":"object",
            "description":"Blackout related links.",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the blackout."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts/D91786E288D35455C3ADA1B329B49BB5"
                            }
                        }
                    ]
                },
                "targets":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the targets under blackout."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts/D91786E288DFSE2323ADA1B329B49BB5/targets"
                            }
                        }
                    ]
                }
            }
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/Schedule"
        }
    ]
}

Nested Schema : excludeTargets

Type: array

List of indirect blackout members which should be excluded from blackout.

Show Source

• Array of: object TargetIdentifier
  Identifies a target either by name and typeName or by id.

{
    "type":"array",
    "description":"List of indirect blackout members which should be excluded from blackout.",
    "items":{
        "$ref":"#/components/schemas/TargetIdentifier"
    }
}

Nested Schema : excludeTypes

Type: array

List of indirect blackout member type names which should be excluded from blackout.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of indirect blackout member type names which should be excluded from blackout.",
    "items":{
        "type":"string"
    }
}

Nested Schema : links

Type: object

Blackout related links.

Show Source

• self: self
• targets: targets

{
    "type":"object",
    "description":"Blackout related links.",
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the blackout."
                },
                {
                    "example":{
                        "href":"/em/api/blackouts/D91786E288D35455C3ADA1B329B49BB5"
                    }
                }
            ]
        },
        "targets":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the targets under blackout."
                },
                {
                    "example":{
                        "href":"/em/api/blackouts/D91786E288DFSE2323ADA1B329B49BB5/targets"
                    }
                }
            ]
        }
    }
}

Nested Schema : Schedule

Type: object

Defining time schedule

Show Source

• isTargetZoneUsed: boolean
  To indicate the time should be interpreted in target's timezone or not. If Timezone is specified in time and useTargetZone is true, it will be reported as an ERROR condition

  Example: true
• recurring: string
  Frequency at which the operation must be executed repeatedly

  Example: Weekly
• scheduleType: string
  Currently we support ical specification default is ICAL, in future it can be extended to other types e.g CRON.
• startGracePeriodInMinutes: number
  Time in minutes after which the job will be marked as skipped if not started. Null or Negative value means no grace period.

  Example: 60
• timeToEnd: string
  end time for the job in the format YYYY-MM-DDTHH24:Mi:SSZTimezone Timezone specification is optional and will be defaulted to UTC.

  Example: 2021-03-02 22:00:13
• timeToStart: string
  start time for the job in the format YYYY-MM-DDTHH24:Mi:SSZTimezone Timezone specification is optional and will be defaulted to UTC.

  Example: 2021-03-01 21:23:03

{
    "description":"Defining time schedule",
    "type":"object",
    "properties":{
        "timeToStart":{
            "type":"string",
            "description":"start time for the job in the format YYYY-MM-DDTHH24:Mi:SSZTimezone Timezone specification is optional and will be defaulted to UTC.",
            "example":"2021-03-01 21:23:03"
        },
        "timeToEnd":{
            "type":"string",
            "description":"end time for the job in the format YYYY-MM-DDTHH24:Mi:SSZTimezone Timezone specification is optional and will be defaulted to UTC.",
            "example":"2021-03-02 22:00:13"
        },
        "isTargetZoneUsed":{
            "type":"boolean",
            "description":"To indicate the time should be interpreted in target's timezone or not. If Timezone is specified in time and useTargetZone is true, it will be reported as an ERROR condition",
            "example":true
        },
        "scheduleType":{
            "type":"string",
            "description":"Currently we support ical specification default is ICAL, in future it can be extended to other types e.g CRON."
        },
        "recurring":{
            "type":"string",
            "description":"Frequency at which the operation must be executed repeatedly",
            "example":"Weekly"
        },
        "startGracePeriodInMinutes":{
            "type":"number",
            "description":"Time in minutes after which the job will be marked as skipped if not started. Null or Negative value means no grace period.",
            "example":60
        }
    }
}

Nested Schema : TargetIdentifier

Type: object

Identifies a target either by name and typeName or by id.

Show Source

• id: string
  Target ID
• name: string
  Target Name
• typeName: string
  Target Type Name

{
    "type":"object",
    "description":"Identifies a target either by name and typeName or by id.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Target ID"
        },
        "name":{
            "type":"string",
            "description":"Target Name"
        },
        "typeName":{
            "type":"string",
            "description":"Target Type Name"
        }
    }
}

Nested Schema : self

Match All

Link to the blackout.

Show Source

• object Link
  It represents a Link
• Link to the blackout.
• Example: { "href":"/em/api/blackouts/D91786E288D35455C3ADA1B329B49BB5" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the blackout."
        },
        {
            "example":{
                "href":"/em/api/blackouts/D91786E288D35455C3ADA1B329B49BB5"
            }
        }
    ]
}

Nested Schema : targets

Match All

Link to the targets under blackout.

Show Source

• object Link
  It represents a Link
• Link to the targets under blackout.
• Example: { "href":"/em/api/blackouts/D91786E288DFSE2323ADA1B329B49BB5/targets" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the targets under blackout."
        },
        {
            "example":{
                "href":"/em/api/blackouts/D91786E288DFSE2323ADA1B329B49BB5/targets"
            }
        }
    ]
}

Nested Schema : Link

Type: object

It represents a Link

Show Source

• href: string
  URL for the link

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for the link"
        }
    },
    "description":"It represents a Link"
}

Examples

Select an example Result - Modify attributes of a blackout

401 Response

client is not authenticated

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

404 Response

resource not found or not authorized

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

500 Response

internal error serving the request

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

503 Response

indicates that a required service is not available.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Back to Top