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
Example
Input: None
Output:
{
"@odata.type": "#VirtualEntities.VirtualMachine",
"@odata.id": "/api/PowerService/VirtualEntities/
VirtualMachines(4)",
"Id": 4,
"Uuid": "4d303ae2-7b2c-488b-9c09-c6d23f4e7fa3",
"Name": "pmp1-edited",
"DeviceId": 10207,
"DeviceName": "BR1H903",
"ServiceTag": "BR1H903",
"Details": {
"@odata.id": "/api/PowerService/VirtualEntities/
VirtualMachines(4)/Details"
}
}
Table 89. Attributes
Attribute Description
Id Device id
Name Device name
Uuid Unique identifier of device
DeviceId Device id or device name of the host server.
DeviceName Device name
ServiceTag Service tag of device
PowerService/VirtualEntities/
VirtualMachines(<VirtualMachine ID>)/Details
URI to represent virtual machine details
Supported versions of Power Manager:
● 2.0
GET method to retrieve virtual machine details by virtual machine
id
This method represents specific virtual machine details.
Description
Returns specific virtual machine details.
Privilege VIEW
HTTP response
codes
200
Example
Input: None
Output:
{
"@odata.context": "/api/$metadata#VirtualMachines.Details",
"@odata.type": "#VirtualMachines.Details",
"@odata.id": "/api/PowerService/VirtualMachines/MonitoredVMs(100)/
Details",
"Id": 100,
"Name": "VM_36",
Virtual machines 87