API Guide

Table Of Contents

The Redfish attribute iDRAC.Redfish.Enable is modeled under the existing DCIM_iDRACCardEnumeration class. You can

configure the Redfish service using existing methods such as SetAttribute, SetAttributes, and ApplyAttributes of

DCIM_iDRACCardService class.

Redfish schema

The Schemas for the Redfish resources are defined according to the OData Schema representation, which can be directly translated to a

JSON Schema representation.

Redfish authentication and authorization

For certain resources, the Redfish clients may require to authenticate access. Redfish relies on the managed system for the required

credentials and supported forms of authentication. In iDRAC, authentication is based on local credentials and remote protocols such as

Active Directory and LDAP.

NOTE:

You must have the required iDRAC license to use Active Directory and LDAP.

Authorization includes both user privilege and license authorization. Redfish support is included in all levels of iDRAC licensing. The

following table details the authentication and authorization required for each Redfish action:

Table 1. Redfish authentication and authorization

Redfish actions Authentication required Authorization required

Read operation on any instrumentation data Yes Yes

Modify instrumentation data Yes Yes

Invoke actions Yes Yes

View service root No No

View metadata document No No

View OData service document No No

View message registry No No

View Redfish version URI No No

View JSONSchmeaFile resource URI No No

View JSON schemas URI No No

The Redfish service provides access to Redfish URLs by using the following methods:

• Basic authentication: In this method, user name and password are provided for each Redfish API request.

• Session-based authentication: This method is used while issuing multiple Redfish operation requests.

• Session login is initiated by accessing the Create session URI. The response for this request includes an X-Auth-Token header with

a session token. Authentication for subsequent requests is made using the X-Auth-Token header.

• Session logout is performed by issuing a DELETE of the Session resource provided by the Login operation including the X-Auth-

Token header.

NOTE:

The iDRAC firmware incorporates the concept of application sessions for various existing interfaces such as the

web interface, WSMan, and RACADM. With the introduction of Redfish-specific sessions, Redfish inherits the

characteristics of web server sessions and the property Session Timeout inherits the web server session timeout value.

NOTE: To ensure a secure connection, Dell recommends using TLS 1.1 or later.

iDRAC licensing

Redfish support is included in all license types of iDRAC. However, some of the iDRAC features require specific licenses. If a required

license is not present, certain Redfish APIs may not be accessible and return an HTTP 403 status code. 403 implies that there is no

sufficient privileges. In other cases, some of the properties in certain resource may not be returned in a response. The service may also

return errors when such properties are modified. For information of specific license requirements for the resources, see

Redfish resources.