Use this method to modify a scheduled job (task).
Authentication with user name and password is required.
PUT https://{management_server_IP}/tasks/schedules/{job_id}
where {job_id} is the ID of the scheduled job. To obtain the scheduled job IDs, use GET /tasks/schedules.
None
Attributes | Required / Optional | Type | Description | ||
---|---|---|---|---|---|
action | Required | String | The action to take. This can be one of the following
values:
|
{
"action ": "PLAY"
}
Attributes | Required / Optional | Type | Description | ||
---|---|---|---|---|---|
action | Optional | String | The action to take. This can be one of the following values.
|
||
componentUUIDs | Optional | Array of strings | List of UUIDs of the devices or resource groups that are the
target for the action. To obtain the device and resource group IDs, use GET /chassis, GET /nodes, GET /storage, GET /switches, and GET /resourceGroups. |
||
execDate | Required when schedule type is changed to ONE_TIME | String | (ONE_TIME schedule types only) Timestamp when the scheduled job is to run next. | ||
matchEverything | Optional | Boolean | Indicates whether the action is to be run against all managed
devices. This can be one of the following values.
|
||
name | Optional | String | Name of the scheduled job | ||
rule | Required when schedule type is changed to RECURRING | Object | (RECURRING schedule types only) Information about the scheduling rules. | ||
dayOfWeek | Required when rule type is changed to weekly or monthly, or yearly | String | Day of each week when the job is to run. This can be one of
the following values.
|
||
days | Required when rule type is changed to daily | Array of strings | Days when the job is to run. This can be one or more of the
following values.
|
||
endDate | Required when noEnd is changed to false | String | Date and time when the job stops running | ||
monthOfYear | Required when rule type is changed to yearly | String | Month of each year when the job is to run. This can be one
of the following values.
|
||
noEnd | Optional | Boolean | Specifies whether the schedule has no end date. This can be
one of the following values.
|
||
recurEvery | Optional when rule type is changed to weekly, monthly, or yearly | Integer | Interval for running the job (for example, specify 2 for every
two weeks). The default is 1. |
||
startDate | Optional | String | Date and time when the job starts running | ||
timeZone | Optional | String | Time zone for the schedule, for example, GMT-0. | ||
type | Optional | String | The type of recurring schedule. This can be one of the following
values.
|
||
weekOfMonth | Required when rule type is monthly or yearly | Integer | Week of each month when the job is to run. This can be one
of the following values
|
||
eventFilter | Required when schedule type is changed to EVENT_TRIGGERED | Object | (EVENT_TRIGGERED schedule types only) Information about the events that trigger the job to run | ||
eventID | Optional | String | A list of IDs, separated by a comma, for events that trigger the job to run. | ||
eventService | Optional | Array of strings | The service type. This can be one or both of the following
values.
|
||
eventClass | Optional | Array of objects | Information about the event class - severity mapping. | ||
name | Optional | String | The name of the event class. This can be one of the following
values.
|
||
severities | Optional | Array of strings | List of severities that trigger the job to run. This can be
one or more of the following values:
|
||
scope | Required when schedule type is changed to EVENT_TRIGGERED | Object | (EVENT_TRIGGERED schedule types only) A date interval on which the event triggered scheduler will be active. | ||
startDate | Optional | String | Date and time when the schedule starts, in the GMT-0 time zone. | ||
endDate | Required if noEnd is changed to true | String | Date and time when the schedule ends, in the GMT-0 time zone. | ||
noEnd | Optional | Boolean | Specifies whether the schedule has no end date. This can be
one of the following values.
|
||
triggerAction | Required | Object | Information about the action to run on the target devices. | ||
id | Required | String | ID of the action to run. To obtain the action IDs, use GET /tasks/schedules/actions. |
||
type | Required | String | Type of schedule. This can be one of the following
values.
|
{
"componentIDs": ["784A050844A0E5119A9E008CFAE82560"],
"matchEverything": false,
"name": "Daily schedule",
"rule": {
"days": ["monday","wednesday"],
"endDate": "2017-10-27 18:39:00"
"startDate": "2017-10-18 18:39:00",
"timeZone": "Europe/Bucharest",
"type": "daily"
},
"triggerAction": {
"id": "ServiceDataCollect",
},
"type": "RECURRING"
}
Code | Description | Comments |
---|---|---|
200 | OK | The request completed successfully. |
400 | Bad Request | A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body. |
404 | Not found | A specified resource cannot be found. A descriptive error message is returned in the response body. |
500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
None