This has the advantage that the client does not need to know a set of fixed URLs. The rest of the data model is discoverable by following clearly identified “links” in the data. This architecture allows the client to interact with iLO through a simple fixed URL (rest/v1) and several other top-level URIs documented in the iLO Data Model. The iLO RESTful API is designed using a REST architecture called HATEOS (Hypermedia as the Engine of Application State). Representational State Transfer (REST) is a web service that uses basic CRUD (Create, Read, Update, Delete, and Patch) operations performed on resources using HTTP commands such as POST, GET, PUT, PATCH, and DELETE. Returning only Redfish conformant properties (with Hewlett Packard Enterprise extensions) if the Redfish-required OData header is included in the request ( OData-Version: 4.0).įull details on how Redfish 1.0 was implemented in iLO 4 2.30 and how it impacts clients written for previous versions is found here: REST APIs Architected using HATEOS.Returning both compatibility and Redfish properties by default.Mirroring the resource model at both /redfish/v1/ and /rest/v1.ILO 4 2.30 achieves Redfish 1.0 conformance and backward compatibility by: iLO will eventually remove any properties that do not match the Redfish schema definitions (while preserving the OEM extensions.)
You should plan to update your client code to confirm to the Redfish standard. While conforming to the Redfish 1.0 standard, the iLO RESTful API is extended with Hewlett Packard Enterprise-specific features such as BIOS configuration. Moving forward, the iLO RESTful API will become the iLO 4 enhanced implementation of Redfish.
ILO 4 2.30 is Redfish 1.0 conformant while remaining backward compatible with the existing iLO RESTful API.
The iLO RESTful API also functioned as the starting point for the new Redfish 1.0 DMTF standard at Since the introduction of the iLO RESTful API, a number of changes were introduced into the Redfish standard by the DMTF SPMF members. The iLO RESTful API was first released with iLO 4 2.00 on HPE Gen9 servers.
This document has been updated with examples from iLO 4 version 2.30 firmware. This enables you to write custom code directly to the iLO RESTful API, instead of using intermediate tools such as HPE’s HPQLOCFG or CONREP. Most languages, like Python, can transform JSON into internal-data structures, like dictionaries, allowing for easy access to data. With modern scripting languages, you can easily write simple REST clients for RESTful APIs. The iLO RESTful API uses the basic HTTP operations (GET, PUT, POST, DELETE, and PATCH) to submit or return a JSON formatted resource to or from a URI on iLO 4.
This document contains helpful information about how to interact with the iLO RESTful API. The iLO RESTful API for HPE iLO 4 is a programming interface enabling state-of-the-art server management.