API Guide

Redfish Based Systems Management
This section provides an overview of Redfish service implemented in the iDRAC firmware. It includes information about the Redfish
API, schema, configuration, authentication, authorization, and so on.
URL support
Redfish is a web-based API which implies that resources are accessed using client supplied URLs. URLs are required to identify
Redfish resources. The Redfish API uses a simple URL hierarchy which follows a
/redfish/v1/ pattern for all resources. To
access a Redfish resource, use the URL pattern https://<iDRAC IP>/redfish/v1/<Resource Path>. For more
information on the supported resources, see
Redfish Resources. The following are the list of URI patterns that are supported by
iDRAC:
• /redfish — URL for the Redfish version object.
• /redfish/v1 — Root URL for version 1 of Redfish services.
• /redfish/v1/odata — Redfish services expose an OData service document at this URI. This service document provides a
standard format for enumerating the resources that are exposed by the service by enabling all generic hypermedia-driven OData
clients to navigate to the resources of the service.
• /redfish/v1/$metadata — Redfish services expose a metadata document in XML format. This document describes the
resources and collections that are available at the service root URI. It also provides references to other metadata documents,
which describe the complete set of resource types that are exposed by the service.
• /redfish/v1/$metadata#<Collection or a Singleton resource> — Metadata URL specified as a part of
@odata.context property for all resources. This URL returns data in XML format.
• /redfish/v1/JsonSchemas — This URL returns data in JSON format. This returns a collection of JsonSchemaFile
resource instances.
• /redfish/v1/JsonSchemas/<resource URI> — The JSON Schema File resource instance describes the location
(URI) of a particular Redfish schema definition being implemented or referenced by a Redfish service. This URL returns data in
JSON format.
• /redfish/v1/<other resource specific URIs> — All instrumentation resources follow this pattern.
NOTE: iDRAC's implementation of Redfish supports only HTTPs protocol.
Redfish Configuration
You can configure the Redfish interface on iDRAC by enabling or disabling the iDRAC attribute. If this attribute is disabled, HTTP
requests to Redfish URIs will fail with a HTTP status code of 404 and an error message indicating that this attribute is currently
disabled.
NOTE: You do not need to restart the web server when enabling or disabling Redfish attribute.
Configuring Redfish service by using iDRAC web interface
To enable or disable the Redfish service on iDRAC, perform the following tasks:
1. In iDRAC web interface, click Overview → iDRAC Settings → Network → Services. The Services page is displayed.
2. Under Redfish, select the Enabled check box to enable the service. To disable the service, clear the check-box.
3. Click Apply to apply the changes.
Configuring Redfish service by using iDRAC RACADM
You can enable or disable the Redfish service using the iDRAC attribute iDRAC.Redfish.Enable (Read or Write).
Configuring Redfish service by using WS-MAN
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.
6