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
Virtual machines
Topics:
• /api/PowerService/VirtualEntities/VirtualMachines
•
/api/PowerService/VirtualEntities/VirtualMachines(<VirtualMachine ID>)
• PowerService/VirtualEntities/VirtualMachines(<VirtualMachine ID>)/Details
/api/PowerService/VirtualEntities/VirtualMachines
URI to represent all the virtual machines.
Supported versions of Power Manager:
● 2.0
GET method to represent all the virtual machines
This method displays all the virtual machines that are monitored in Power Manager.
Description
Returns all the virtual machines.
Privilege VIEW
HTTP response
codes
200
Example
Input: None
Output:
{
"@odata.context": "/api/
$metadata#Collection(VirtualEntities.VirtualMachine)",
"@odata.count": 2,
"value": [
{
"@odata.type": "#VirtualEntities.VirtualMachine",
"@odata.id": "/api/PowerService/VirtualEntities/
VirtualMachines(1)",
"Id": 1,
"Uuid": "1798203e-dd65-4b5c-9772-07f578b91730",
"Name": "Lubuntu 18.04 01",
"DeviceId": 10207,
"DeviceName": "BR1H903",
"ServiceTag": "BR1H903",
"Details": {
"@odata.id": "/api/PowerService/VirtualEntities/
VirtualMachines(1)/Details"
}
},
{
"@odata.type": "#VirtualEntities.VirtualMachine",
"@odata.id": "/api/PowerService/VirtualEntities/
VirtualMachines(7)",
"Id": 7,
"Uuid": "cf43af93-97ae-4f6d-9c4a-21b9d374a4ad",
"Name": "Slitaz 01",
"DeviceId": 10207,
"DeviceName": "BR1H903",
"ServiceTag": "BR1H903",
"Details": {
12
Virtual machines 85