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
GET method for Representing Capable Groups
This method represents the capable groups.
Description Returns a list of capable groups.
Privilege VIEW
HTTP response
codes
200
Example
Input: None
Output:
{
"@odata.context":"/api/$metadata#Collection(PowerService.CapableGroups)",
"@odata.count": 1,
"value": [
{
"@odata.type": "#PowerService.CapableGroups",
"@odata.id": /api/PowerService/CapableGroups(10690)",
"Id": 10690,
"ParentId": 10689,
"Name": "Aisle - A",
"Description": "Aisle - A",
"DeviceCount": 7,
"PmPluginDeviceCount": 7,
"Devices@odata.navigationLink":"/api/PowerService/CapableGroups
(10690)/Devices"
}
]
}
Table 27. Attributes
Attribute name Description
Id Group ID
ParentId Group Parent ID
Name Group Name
Description Description of the group
DeviceCount Total device in the group
PmPluginDeviceCount Total Power Manager capable devices in group
/api/PowerService/CapableGroups(<Group ID>)/
Devices
This URI represents the device from a capable group
Table 28. Filters
Filter Name Description
Top Required number of records
Skip Number of records to skip. Default value is zero.
Supported versions of Power Manager:
● 2.0
● 1.2
● 1.1
30
Monitored Groups