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
/api/PowerService/Actions/PowerService.AddGroups......................................................................................... 28
POST method to add Groups................................................................................................................................... 28
/api/PowerService/Actions/PowerService.RemoveGroups................................................................................. 29
POST method to remove Monitored Groups........................................................................................................29
/api/PowerService/CapableGroups.............................................................................................................................29
GET method for Representing Capable Groups.................................................................................................. 30
/api/PowerService/CapableGroups(<Group ID>)/Devices................................................................................... 30
GET method for Representing All Devices from Capable Group......................................................................31
/api/PowerService/Groups(<Group ID>)/Devices.................................................................................................. 32
GET method for Representing All Power Manager capable devices from a Group.................................... 32
/api/PowerService/MonitoredGroups.........................................................................................................................34
GET method for Representing Monitored Groups.............................................................................................. 34
/api/PowerService/MonitoredGroups(<Group ID>)/Devices...............................................................................35
GET method for Representing All Devices from a MonitoredGroup...............................................................36
Chapter 7: Power Policy.............................................................................................................. 38
api/PowerService/PowerBounds..................................................................................................................................38
POST method for retrieving Power Bounds......................................................................................................... 38
/api/PowerService/Policies .......................................................................................................................................... 39
GET method for retrieving Policies.........................................................................................................................39
/api/PowerService/Policies(<PolicyId>)..................................................................................................................... 41
GET method for Policies(<PolicyId>)......................................................................................................................41
/api/PowerService/Policies(<PolicyId>)/PolicyDetails ......................................................................................... 42
GET method for Policies(<PolicyId>)/PolicyDetails of a specific policy ...................................................... 42
/api/PowerService/MonitoredDevices(<DeviceId>)/Policies...............................................................................44
GET method for policies created on specified devices .....................................................................................44
/api/PowerService/MonitoredGroups(<GroupId>)/Policies................................................................................. 45
GET method for policies created on specified groups....................................................................................... 45
/api/PowerService/Actions/PowerService.CreatePolicy...................................................................................... 46
POST method for creating Policy............................................................................................................................46
/api/PowerService/Actions/PowerService. EditPolicy.......................................................................................... 48
POST method for Editing Policy.............................................................................................................................. 48
/api/PowerService/Actions/PowerService.EnablePolicies....................................................................................49
POST method for Enabling Policy...........................................................................................................................50
/api/PowerService/Actions/PowerService.DisablePolicies...................................................................................50
POST method for Disabling Policy.......................................................................................................................... 50
/api/PowerService/Actions/PowerService.DeletePolicies.....................................................................................51
POST method for Deleting Policy............................................................................................................................ 51
Chapter 8: Emergency Power Reduction..................................................................................... 53
/api/PowerService/MonitoredDevices(<DeviceId>)/EPRStatus........................................................................ 53
GET method for EPR Status of specified Devices..............................................................................................53
/api/PowerService/MonitoredGroups(<GroupId>)/EPRStatus...........................................................................54
GET method for EPR Status of specified Groups...............................................................................................54
/api/PowerService/EPR.................................................................................................................................................55
GET method for retrieving the targets where EPR is applied..........................................................................55
/api/PowerService/Actions/PowerService.EnableEPR..........................................................................................57
POST method to Enable EPR................................................................................................................................... 57
/api/PowerService/Actions/PowerService.DisableEPR.........................................................................................57
4
Contents