White Papers
52 REST API Guide OpenManage Essentials | Revision A02
Description
A short description of the task.
ControlType
An enumerated value indicating the type of LED control (Start LED, Stop LED)
Devices
The list of selected device identifiers. If only one device is affected, the list will
contain one element. The device identifier is the identifier associated with the
device.
Schedule
The schedule for the task. This will be in cron format. If it is a run now task,
-
UserName
The username required to run the task.
Password
The password required to run the task.
A sample XML that would comprise the payload when initiating a POST operation to create a LED control task
is as follows:
<RESTLEDControlTask>
<Id>0</Id>
<Name>Blink LED</Name>
<Description>Start blinking LED of 1,2,3</Description>
<Schedule>-1</Schedule>
<ControlType>1</ControlType>
<Devices>
<int>1</int>
<int>2</int>
<int>3</int>
</Devices>
<UserName>username</UserName>
<Password>password</Password>
</RESTLEDControlTask>
The attributes associated with the LED control type enumeration are defined in the following table.
Enum Value
Description
0
Stop blinking LED
1
Start blinking LED
2.12.3 Task Start Time consideration
If the schedule field is set as part of the payload, then particular attention needs to be paid to the repeating time
field of the schedule. For example, if the schedule is specified as 46 22 */1 * * *, it would translate as follows:
46 : minute
22 : hour