API Guide

NOTE: In previous versions of Redsh implementation, # character was parsed as #. Because this character is treated as a break
character by the code, any characters after # were ignored. Now, # character is automatically converted to %23. This conversion
allows the consoles or REST clients to use the URL without any errors.
Redsh conguration
You can congure the Redsh interface on iDRAC by enabling or disabling the iDRAC attribute. If this attribute is disabled, HTTPS requests
to Redsh URIs fail with an HTTP status code of 404 and an error message indicating that this attribute is disabled.
NOTE: You do not need to restart the web server when enabling or disabling Redsh attribute.
Conguring Redsh service using iDRAC web interface
To enable or disable the Redsh service on iDRAC, perform the following tasks:
1 In the iDRAC web interface, navigate to Overview > iDRAC Settings > Network > Services.
2 Under Redsh, select Enabled and click Apply to enable the service.
Conguring Redsh service by using iDRAC RACADM
You can enable or disable the Redsh service using the iDRAC attribute iDRAC.Redfish.Enable (Read or Write).
Conguring Redsh service by using WS-MAN
The Redsh attribute iDRAC.Redfish.Enable is modeled under the existing DCIM_iDRACCardEnumeration class. You can
congure the Redsh service using existing methods such as SetAttribute, SetAttributes, and ApplyAttributes of
DCIM_iDRACCardService class.
Redsh schema
The Schemas for the Redsh resources are dened according to the OData Schema representation, which can be directly translated to a
JSON Schema representation.
Redsh authentication and authorization
For certain resources, the Redsh clients may require to authenticate access. Redsh 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. Redsh support is included in all levels of iDRAC licensing. The following
table details the authentication and authorization required for each Redsh action:
Redsh-based
systems management 9