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
Overview
RESTful API support in Dell EMC OpenManage Enterprise
Power Manager
Power Manager supports RESTful API. APIs on these products enhance the systems management capabilities. The RESTful
interface is provided over HTTPS in JSON format that is based on ODATA v4 usable by clients, scripts, and browser-based
GUIs. The APIs enable you to build console management tools that are based on common programming and scripting languages
such as Python, Java, and C.
NOTE: If you are using the REST APIs to create objects while the Power Manager User Interface (UI) is open, ensure that
you refresh the UI before viewing the changes made through APIs.
For more information about REST, see publically available resources.
Topics:
• Introduction to Power Manager
• RESTful application programming interface
• OData
• JSON data
• HTTPS communication
Introduction to Power Manager
Dell EMC OpenManage Enterprise Power Manager is a plugin to the Dell EMC OpenManage Enterprise (OME) console and uses
fine-grained instrumentation to provide increased visibility to power consumption, system anomalies, and resource utilization on
Dell EMC servers. Also, Power Manager supports virtual machine monitoring, and alerts and reports about power and thermal
events in servers, chassis, and custom groups consisting of servers and chassis. This reporting enables increased control, faster
response times, greater accuracy, and broader decision-making intelligence than is otherwise possible.
When used with PowerEdge servers, modular systems with an iDRAC Enterprise or iDRAC Datacenter license, or supported
chassis and OpenManage Enterprise Advanced license, Power Manager leverages information from the OME console to deliver
platform-level power reporting. Power Manager then communicates with Integrated Dell Remote Access Controller (iDRAC) or
Chassis Management Controller (CMC) on each managed device to provide power-management data and execution of control
policy—making it easy for administrators to identify areas in which they can gain efficiencies and cut wasteful costs. Also,
Power Manager supports monitoring and managing power load on Power Distribution Units (PDUs) by communicating with the
PDU firmware.
RESTful application programming interface
Representational State Transfer or REST is a software architectural style used within the World Wide Web. REST architectures
are commonly used for many IT solutions, including the definition of web-based APIs. Systems that adhere to REST practices
are often referred to as RESTful interfaces. RESTful interfaces use the HTTP methods—GET, POST, DELETE, and so on—that
web browsers use to access web pages.
OData
OData is an open protocol standard for the definition and exchange of information using RESTful APIs. When implementing
a common interface across multiple vendors, it is important to standardize the data formats. Standardizing the data formats
ensure that the data structures remain interchangeable between different manufacturers.
2
8 Overview