API Guide

Other documents you may need
For more information about Redfish, see the DMTF website http://www.dmtf.org/standards/redfish. This website provides access to
schema files, white papers, technical notes, and so on.
To download or access a file, go to http://www.dmtf.org/standards/redfish, locate the desired section, and click the link to open or
download the files.
You can download the OEM schemas from the Dell website at http://downloads.dell.com/redfish/bmc/schemas/.
Redfish-based systems management
This section provides an overview of the 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 the
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. iDRAC supports the following URL patterns:
• /redfish — URL for the Redfish version object.
• /redfish/v1 — Root URL for version 1 of the Redfish services.
• /redfish/v1/odata — Redfish services expose an OData service document at this URI. This service document provides a
standard format for enumerating 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. The output is 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:
The Redfish standard implemented in iDRAC supports only HTTPS protocol.
NOTE: In previous versions of Redfish 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.
Redfish configuration
You can configure the Redfish interface on iDRAC by enabling or disabling the iDRAC attribute. If this attribute is disabled, HTTPS
requests to Redfish 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 Redfish attribute.
Configuring Redfish service using iDRAC web interface
To enable or disable the Redfish service on iDRAC, perform the following tasks:
1. In the iDRAC web interface, navigate to the following screen:
• 13
th
generation of PowerEdge servers: Overview > iDRAC Settings > Network > Services
• 14
th
generation of PowerEdge servers: iDRAC Settings > Services > Redfish
2. Under Redfish, select Enabled and click Apply to enable the service.
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
6