|
ManageEngine® Applications Manager Creating Downtime Scheduler Tasks | ||
This API allows the user to create downtime schedules in Applications Manager. The schedules can be created with any of the following recurrence types:
You can schedule a maintenance task for for monitor groups as well as individual monitors. To configure a schedule for a monitor group, just provide the tasktype as group and resourceid as the monitor group id.
Sample Request:
http://[Host]:[Port]/AppManager/xml/CreateMaintenanceTask?apikey=[APIKEY]&taskMethod=daily&taskStartTime=[STARTTIME]& taskEndTime=[ENDTIME]&taskStatus=disable&taskEffectFrom=[DATE]&taskName=[NAME]&taskType=monitor&resourceid=[RESOURCEID]
Request Parameters
The parameters involved in this API request are described below. Also, refer the list of common Request Parameters involved in executing the CreateMaintenanceTask API requests.
| Field | Description |
| taskMethod | Denotes the recurring frequency of the maintenance schedule, 'daily' indicates the schedule runs every day. |
| taskStartTime | The time when the maintenance task starts running |
| taskEndTime | The time when the maintenance task stops running |
| taskEffectFrom | The date and time from which the maintenance task becomes active |
| offset | The difference in the number of hours with respect to GMT. If the offset value provided is invalid, Applications Manager uses the user's system time as the offset value. |
| taskType | The type of task to be created. Possible values are monitor (for an individual monitor) and group (for a monitor group) . You can configure a schedule for a monitor group by providing the tasktype as group. |
| resourceid | The resource id of the monitor or monitor group for which the schedule has to be created |
Example:
http://app-windows:9090/AppManager/xml/CreateMaintenanceTask?apikey=bdd4d0643c6f591e123b7ba6fb69d9dd&taskMethod=daily
&taskStartTime=20:00&taskEndTime=21:00&taskStatus=disable&taskEffectFrom=2010-05-24%2016:48&taskName=dr1
&taskType=monitor&resourceid=10000055
Output for the above example:
| <AppManager-response uri="/AppManager/xml/CreateMaintenanceTask"> <result> <response response-code="4000"> <message>Maintenance Task successfully created.</message> </response> </result> </AppManager-response> |
Sample Request:
http://[Host]:[Port]/AppManager/xml/CreateMaintenanceTask?apikey=[APIKEY]&taskType=[TASKTYPE]&resourceid=[RESOURCEID]
&totalNumber=[TOTALNUMBER]&taskMethod=[TASKMETHOD]&taskDescription=[TASKDESCRIPTION]&taskStatus=[TASKSTATUS]
&taskEffectFrom=[DATETIME]&startDay1=[STARTDAY1]&startTime1=[STARTTIME1]&endDay1=[ENDDAY1]&endTime1=[ENDTIME1]
&taskName=[TASKNAME]
Request Parameters
The parameters involved in the API request are described below:
| Field | Description |
| totalNumber | The number of schedules to be created. You can create a maximum of 7 weekly schedules |
| taskMethod | Denotes the recurring frequency of the maintenance schedule, 'weekly' indicates the schedule runs every week. |
| taskDescription | The description of what the maintenance schedule does, optional value. |
| taskEffectFrom | The date and time from which the maintenance task becomes active |
| startDay[n] | The day on which the maintenance task starts running. The allowed values for n are 1,2,3,4,5,6 and 7 |
| startTime[n] | The time when the maintenance task starts running. The allowed values for n are 1,2,3,4,5,6 and 7 |
| endDay[n] | The day on which the maintenance task stops running. The allowed values for n are 1,2,3,4,5,6 and 7 |
| offset | The difference in the number of hours with respect to GMT. If the offset value provided is invalid, Applications Manager uses the user's system time as the offset value. |
| endTime[n] | The time at which the maintenance task stops running. The allowed values for n are 1,2,3,4,5,6 and 7 |
| taskType | The type of task to be created. Possible values are monitor (for an individual monitor) and group (for a monitor group) . You can configure a schedule for a monitor group by providing the tasktype as group. |
| resourceid | The resource id of the monitor or monitor group for which the schedule has to be created |
Example:
http://app-windows:9090/AppManager/xml/CreateMaintenanceTask?apikey=983a7d7ed56c5753f4977df5883e2b2d&taskType=monitor
&resourceid=10000028&totalNumber=1&taskMethod=weekly&taskDescription=&taskStatus=disable&taskEffectFrom=2010-06-01%2011:25
&startDay1=tuesday&startTime1=10:00&endDay1=friday&endTime1=12:00&taskName=week
You can create up to 7 weekly schedules at one go.
Sample Request:
http://[Host]:[Port]/AppManager/xml/CreateMaintenanceTask?apikey=[APIKEY]&taskMethod=[TASKMETHOD]&customTaskStartTime=[CUSTOMTASKSTARTTIME]
&customTaskEndTime=[CUSTOMTASKENDTIME]&taskStatus=[TASKSTATUS]&taskName=[TASKNAME]&taskType=[TASKTYPE]
&taskDescription=[TASKDESCRIPTION]&resourceid=[RESOURCEID]
Request Parameters
The parameters involved in this API request are described below. Also, refer the list of common Request Parameters involved in executing the API requests.
| Field | Description |
| API Key | The key generated from "Generate API Key" option in the Admin tab. |
| taskMethod | Denotes the recurring frequency of the maintenance schedule, 'weekly' indicates the schedule runs every week. |
| customTaskStartTime | The date and time when the schedule starts running |
| customTaskEndTime | The date and time when the schedule stops running |
| taskDescription | The description of what the maintenance schedule does. This parameter is optional. |
| offset | The difference in the number of hours with respect to GMT. If the offset value provided is invalid, Applications Manager uses the user's system time as the offset value. |
| taskType | The type of task to be created. Possible values are monitor (for an individual monitor) and group (for a monitor group) . You can configure a schedule for a monitor group by providing the tasktype as group. |
| resourceid | The resource id of the monitor or monitor group for which the schedule has to be created |
Example:
http://app-windows:9090/AppManager/xml/CreateMaintenanceTask?apikey=095cb3835ff015b01a3b3a6c4ab2c38a&taskMethod=once
&customTaskStartTime=2010-06-03%2012:46&customTaskEndTime=2010-06-05%2012:46&taskStatus=disable&taskName=once
&taskType=monitor&taskDescription=&resourceid=10000322
MaintenanceTask API |
DeleteMaintenanceTask API |