API Guide

Redsh-based systems management

This section provides an overview of the Redsh service implemented in the iDRAC rmware. It includes information about the Redsh API,

schema, conguration, authentication, authorization, and so on.

Topics:

• URL support

• Redsh conguration

• Redsh schema

• Redsh authentication and authorization

• iDRAC licensing

• HTTP methods

• HTTP headers

• HTTP status codes and error messages

• SSL certicates of iDRAC

• Eventing

• PowerEdge FX2 and FX2s chassis management using iDRAC Redsh

URL support

Redsh is a web-based API which implies that resources are accessed using client supplied URLs. URLs are required to identify the Redsh

resources. The Redsh API uses a simple URL hierarchy which follows a /redfish/v1/ pattern for all resources. To access a Redsh

resource, use the URL pattern https://<iDRAC IP>/redfish/v1/<Resource Path>. For more information on the supported

resources, see

Redsh resources. iDRAC supports the following URL patterns:

• /redfish — URL for the Redsh version object.

• /redfish/v1 — Root URL for version 1 of the Redsh services.

• /redfish/v1/odata — Redsh 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 — Redsh 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 specied 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 the JsonSchemaFile resource

instances.

• /redfish/v1/JsonSchemas/<resource URI> — The JSON Schema File resource instance describes the location (URI) of a

particular Redsh schema denition being implemented or referenced by a Redsh service. This URL returns data in JSON format.

• /redfish/v1/<other resource specific URIs> — All instrumentation resources follow this pattern.

NOTE

: The Redsh standard implemented in iDRAC supports only HTTPS protocol.

8 Redsh-based systems management