API Guide
Table Of Contents
- OpenManage Enterprise Power Manager RESTful API Guide version 2.0
- Contents
- About this document
- Overview
- Key integration concepts
- Settings
- Monitored Devices
- Monitored Groups
- Power Policy
- api/PowerService/PowerBounds
- /api/PowerService/Policies
- /api/PowerService/Policies(
) - /api/PowerService/Policies(
)/PolicyDetails - /api/PowerService/MonitoredDevices(
)/Policies - /api/PowerService/MonitoredGroups(
)/Policies - /api/PowerService/Actions/PowerService.CreatePolicy
- /api/PowerService/Actions/PowerService. EditPolicy
- /api/PowerService/Actions/PowerService.EnablePolicies
- /api/PowerService/Actions/PowerService.DisablePolicies
- /api/PowerService/Actions/PowerService.DeletePolicies
- Emergency Power Reduction
- Unmonitored devices
- api/PowerService/UserDefinedEntities/Actions/UserDefinedEntities.Create
- api/PowerService/UserDefinedEntities/Actions/UserDefinedEntities.Update
- api/PowerService/UserDefinedEntities/Actions/UserDefinedEntities.Delete
- api/PowerService/UserDefinedEntities/Devices
- api/PowerService/UserDefinedEntities/Devices(
)
- Physical Groups
- api/GroupService/Actions/GroupService.CreateGroup
- api/GroupService/Actions/GroupService.UpdateGroup
- api/GroupService/Actions/GroupService.DeleteGroup
- /api/PowerService/PhysicalGroups/GroupDetails
- /api/PowerService/PhysicalGroups/GroupDetails(
) - api/PowerService/PhysicalGroups/GroupDetails
/AllLeafgroups - api/PowerService/Actions/PowerService.UpdateDeviceDetails
- /api/PowerService/DeviceDetails
- api/PowerService/PhysicalGroups/CapableDevices
- api/PowerService/PhysicalGroups/CapableDevices(
) - api/PowerService/PhysicalGroups/Actions/PhysicalGroup.AddMemberDevices
- api/PowerService/PhysicalGroups/Actions/PhysicalGroup.RemoveMemberDevices
- api/PowerService/PhysicalGroups/GroupDetails(
)/Devices - api/PowerService/PhysicalGroups/Actions/PhysicalGroup.UpdateSlots
- api/PowerService/PhysicalGroups/Actions/PhysicalGroup.MoveDevice
- Power Distribution Units
- Virtual machines
- Report Service
"Type": 1,
"Name": "Group Policy",
"Description": "Updated policy on group",
"Enabled": true,
"AssignedTo": "DeviceGroup",
"CreatedTime": "2019-06-19 12:07:23.935816",
"ExecutionState": 3,
"IsAssociatedToGroup": false
"PolicyDetails": {
"@odata.id": "/api/PowerService/Policies(30)/
PolicyDetails"
}
}
]
}
Table 40. Attributes
Attribute Name Description
PolicyId ID of policy
Name Name associated with the policy.
Type Type of policy.
Description Description associated with the policy
Enabled Indicates if the policy is enabled or disabled
AssignedTo Entity on which the policy is assigned to.
CreatedTime Time at which the policy is created.
ExecutionState State associated with the policy.
PolicyDetails Link to the detailed view of the policy.
IsAssociatedToGroup The policy is associated to group or not.
Table 41. Policy Execution State Enumeration
Enumeration Value Description
1 NOSTATE (Policy execution state is not yet determined).
2 EXECUTING (Policy execution is in progress or pending).
3 SUCCESS (Policy execution is successful).
5 FAILED (Policy execution failed).
Table 42. Filters
Field Operator
Name contains
Description contains
Enabled eq
AssignedTo contains
Type eq
Table 43. Type
Enumeration Value Description
1 Static policy
40 Power Policy