MX7000 REST-ful Interface APIs Dell EMC Technical White Paper
Revisions Revisions Date Description Jan 2019 Initial release Acknowledgements This paper was produced by the following members of the Dell EMC storage engineering team: Author: Heidi Maeder, Andy Drysdale, Vijayasimha Naga and Christopher Poblete 2 MX7000 Deployment of Management Module Network using the LCD control panel | Document ID
Table of contents Table of contents Revisions.............................................................................................................................................................................2 Acknowledgements .............................................................................................................................................................2 Introduction ......................................................................................................
Introduction Introduction In the past years Intelligent Platform Management Interface (IPMI) unified server management by common commands to control servers from multiple manufacturers. With growing demands from cloud- and webbased data center infrastructure the RESTful and Redfish interface of the Management Module in the PowerEdge MX7000 is a modern standard.
OME-M REST schema Accessing the Redfish service root in Postman OME-M REST schema The OME-M RESTful interface comprises of the Redfish schema compliant APIs under the resource URI “/redfish/v1” and OEM APIs under resource URI “/api”.. The following sections provide an introduction to the commonly used URI’s. OEM resources URIs /api/DeviceService All the devices managed by the Chassis can be found using the /api/DeviceService/Devices URI.
/api/GroupService The Id for each device can further be used when performing certain actions on devices such as power control operations, blink actions, firmware updates and more. Additional information on how the device ID is used to run an action or ‘Job’ can be found in /api/JobService section. The other URI’s within /api/DeviceService/ are useful to translate enumeration codes for certain attributes in the /api/DeviceService/Devices URI.
/api/ApplicationService Example POST to create a Job using Postman /api/ApplicationService This URI provides a path for user to know the status of the Application, retrieve audit logs, configure and retrieve network & time configuration, generate, apply & retrieve Certificates etc.,. /api/AlertService The alert log information of the entire system can be retrieved. Template configuration on logs will notify a user base using alert types SNTP, SNMP, or syslog.
/api/AccountService /api/AccountService The user account can be retrieved and configured. Accounts can be deleted, enabled, disabled, and the permissions can be retrieved. Active-Directory services can be configured and retrieved. /api/ManagementDomainService The open manage enterprise modular can be added or deleted to a domain group. A member can be disconnected or added to the domain group. Configuration types of the management domain service can be viewed and configured.
/redfish/v1/AccountService /redfish/v1/AccountService This resource enables you to access the account configuration for OpenManage Enterprise—Modular. Using this resource, you can view the accounts and their roles, update the configuration of accounts, delete accounts, and so on Odata Filter Support MX7000 REST implementation allows filtering per Odata constructs on certain APIs that returns a collection of Entities. This feature is limited to only a selected set of APIs in the 1.0 release.
References Ex: Get first 4 Devices from the Device Collection /api/DeviceService/Devices?$top=4 References https://www.dmtf.org/sites/default/files/standards/documents/DSP2052_1.0.0.pdf https://www.dmtf.org/standards/redfish http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.
