API Guide

Overview

RESTful API support in Dell EMC OpenManage

Enterprise Power Manager

Power Manager supports RESTful API. APIs on these products enhances the systems management capabilities. The RESTful interface is

provided over HTTPS in JSON format based on ODATA v4 usable by clients, scripts, and browser-based GUIs. The APIs enable you to

build console management tools based on common programming and scripting languages such as Python, Java, and C.

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 an extension to the Dell EMC OpenManage Enterprise (OME) console and uses fine-

grained instrumentation to provide increased visibility to power consumption, anomalies, and utilization. Also, Power Manager 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 or 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.

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.

JSON data

Console API represents data using JSON. JSON is a lightweight data-interchange format that is readable and can also be easily parsed by

machines. JSON is based on a subset of the JavaScript Programming Language. JSON uses a text format that is language independent

but uses conventions familiar to programmers of the C-family of languages such as C, C++, C#, Java, JavaScript, PERL, and Python.

These properties make JSON an ideal data-interchange language.

Overview 7