Redfish API Reference Guide v1.
Notes, cautions, and warnings NOTE: A NOTE indicates important information that helps you make better use of your computer. CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. © 2016 Dell Inc. All rights reserved. This product is protected by U.S. and international copyright and intellectual property laws.
Contents Overview........................................................................................................................... 5 Benefits..............................................................................................................................................................................5 Key Technologies...............................................................................................................................................................
SerialInterfaces................................................................................................................................................................ 30 ServiceRoot...................................................................................................................................................................... 31 Session................................................................................................................................................
Overview The Redfish Scalable Platforms Management API is a standard defined by the Distributed Management Task Force (DMTF). Redfish is a next-generation systems management interface standard, which enables scalable, secure, and open server management. It is a new interface that uses RESTful interface semantics to access data that is defined in model format to perform out-of-band systems management.
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.
Redfish Schema This is the Schema definitions for Redfish resources. It is defined according to OData Schema representation that can be directly translated to a JSON Schema representation. Redfish Authentication and Authorization For certain resources, Redfish clients may require to authenticate access. Redfish relies on the managed system for the required credentials and supported forms of authentication.
HTTP Methods The REST API allows you to specify the type of request. It adheres to the Create, Retrieve, Update, and Delete (CRUD) standard format. The data is generated via access to URIs, which can be accessed by using the following HTTP methods: • GET • POST • PUT • PATCH • DELETE GET Use the GET method to retrieve a representation of a resource. The representation can either be a single resource or a collection.
HTTP Headers The server response contains only basic information about related resources. Any metadata, which is required to process a request or response is accessed by using HTTP headers. iDRAC supports the following request headers: Header Behavior If-Match Supported for AccountService requests. Ignored for all other URIs. If-None-Match Supported for AccountService and metadata URIs. Ignored for all other URIs.
change or error condition typically of time critical nature occurs. When an event occurs on the service, it notifies the clients. Redfish service must be enabled and iDRAC must be configured to create event subscriptions and to gain read-only privilege for viewing event subscriptions. The iDRAC implementation of a Redfish service supports only HTTPS notifications. In certain situations, iDRAC may not be able to verify certificates sent by a peer.
PowerEdge FX2/FX2s Chassis Management using iDRAC Redfish On a PowerEdge FX2/FX2s chassis, iDRAC can monitor and manage chassis components such as fans, power supplies, and so on. Redfish service provides information about chassis components when Chassis Management and Monitoring is set to Enabled on iDRAC. This setting allows you to monitor and manage the chassis even if the CMC is not on the network.
Redfish Resources This section describes the resource URIs and related operations that are available in the iDRAC implementation of a Redfish service API. AccountService Description This resource is used to represent a management account service for a Redfish implementation.
Supported Status Codes HTTP Status Code Extended Information 200 Base.1.0.success 400 Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList Base.1.0.PropertyUnknown Base.1.0.PropertyNotWritable Base.1.0.PropertyValueFormatError 500 Base.1.0.InternalError Supported Attributes and Values Attributes Values ResetType On ForceOff IndicatorLed Lit Off ChassisType Rack StandAlone Blade Enclosure sled Supported Action — Reset URL /redfish/v1/Chassis/System.Embedded.1/Actions/Chassis.
HTTP Status Code Extended Information Base.1.0.PropertyNotWritable Base.1.0.PropertyValueFormatError 500 Base.1.0.
Supported HTTP Methods and Privileges HTTP Method Required Privilege PATCH ConfigureManager Supported Status Codes and Error Messages HTTP Status Code Extended Information 200 Base.1.0.success 400 Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList Base.1.0.PropertyUnknown Base.1.0.PropertyNotWritable Base.1.0.PropertyValueFormatError 500 Base.1.0.
Supported Action — Reset Description Resets computer system. URL /redfish/v1/Systems//Actions/ComputerSystem.Reset Supported HTTP Methods and Privileges HTTP Method Required Privilege POST ConfigureComponent Updatable Properties Parameter Value ResetType On ForceOff GracefulRestart PushPowerButton NMI Supported Status Codes HTTP Status Code Extended Information 200 400 Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList Base.1.0.PropertyUnknown Base.1.0.PropertyNotWritable Base.
Supported HTTP Methods and Privileges HTTP Method Required Privilege GET Login URL /redfish/v1/Managers//EthernetInterfaces/ Supported HTTP Methods and Privileges HTTP Method Required Privilege PATCH ConfigureManager Updatable Properties Parameter Description HostName updates HostName IPv4 updates IPv4 IPv6 updates IPv6 IPv6Static updates IPv6Static Supported Status Codes and Error Message Codes HTTP Status Code Extended Information 200 Base.1.0.
Supported Status Codes HTTP Status Code 200 400 500 Implementation Notes Some of the properties in this schema are dependent on the installed BIOS and iSM version. If a compatible version of BIOS is not installed, UefiDevicePath is not supported in this resource. If a compatible version of iSM is not installed, certain properties may not be supported. EventService Description It represents the properties for the service itself and has links to the actual list of subscriptions.
Updatable Properties Parameter Value MessageId Supported Status Codes HTTP Status Code Extended Information 204 400 Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList Base.1.0.PropertyUnknown Base.1.0.PropertyNotWritable Base.1.0.PropertyValueFormatError 500 Base.1.0.InternalError Contained Resources EventDestination EventDestination Description This property contain an URI to the destination where the events are sent.
Supported Status Codes HTTP Status Code Extended Information 200 201 400 Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList Base.1.0.PropertyUnknown Base.1.0.PropertyNotWritable Base.1.0.PropertyValueFormatError 500 Base.1.0.InternalError 503 JSONSchemas Description This resource is used for representing the Schema File locator resource for a Redfish implementation.
Supported HTTP Methods and Privileges HTTP Method Required Privilege GET Login Supported Status Codes HTTP Status Code 200 400 500 Reference Properties /redfish/v1/Managers//Logs/Lclog Description This resource represents the Lifecycle Controller logs for the manager in a Redfish implementation.
LogService Description This resource is used to represent a log service for a Redfish implementation. URL /redfish/v1/Managers//LogService Supported HTTP Methods and Privileges HTTP Method Required Privilege GET Login Supported Status Codes HTTP Status Code 200 400 500 Reference Properties /redfish/v1/Managers//LogServices/Lclog Description This resource represents the Lifecycle Controller log service in a Redfish implementation.
Supported Status Codes HTTP Status Code 200 400 500 Supported Action — ClearLog URL /redfish/v1/Managers//LogServices/Sel/Actions/LogService.ClearLog Description Performs clear operation on logs. Supported HTTP Methods and Privileges HTTP Method Required Privilege POST ConfigureManager Updatable Properties Parameter Description ClearLog ClearLog Supported Status Codes HTTP Status Code Extended Information 204 400 Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList Base.1.0.
Supported Status Codes HTTP Status Code 200 400 500 Supported Attributes and Values Attributes Values ManagerType BMC CommandConnectTypesSupported SSH Telnet IPMI GraphicalConnectTypesSupported KVMIP ResetType GracefulRestart Supported Action — Reset Description This defines the name of the custom action supported when used in conjunction with a POST operation to this resource. When issued, this operation will perform a reset of the manager. URL /redfish/v1/Managers//Actions/Manager.
URL /redfish/v1/Managers//Accounts Supported HTTP Methods and Privileges HTTP Method Required Privilege GET Login Navigation URL /redfish/v1/Managers//Accounts/ Supported HTTP Methods and Privileges HTTP Method Required Privilege PATCH ConfigureManager Supported Status Codes HTTP Status Code Error Message Code 200 400 RAC0288 RAC0291 404 500 Contained Resources Role ManagerNetworkProtocol Description This object is used to represent the network service settings for the ma
Updatable Properties Parameter Description FQDN updates FQDN hostname updates hostname HTTP updates HTTP HTTPS updates HTTPS IPMI updates IPMI KVMIP updates KVMIP SNMP updates SNMP SSH updates SSH Telnet updates Telnet VirtualMedia updates VirtualMedia Supported Status Codes and Error Messages HTTP Status Code Extended Information 200 Base.1.0.success 400 Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList Base.1.0.PropertyUnknown Base.1.0.PropertyNotWritable Base.1.0.
Supported Status Codes HTTP Status Code 200 400 500 Power Description This resource is used to represent a power metrics resource for a Redfish implementation. URL /redfish/v1/Chassis//Power Supported HTTP Methods and Privileges HTTP Method Required Privilege GET Login PATCH ConfigureManager Supported Status Codes HTTP Status Code Extended Information 200 Base.1.0.Success 400 Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList Base.1.0.PropertyUnknown Base.1.0.
Updatable Properties Parameter Description PowerLimit updates PowerLimit Supported Status Codes HTTP Status Code Extended Information 200 Base.1.0.success 400 Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList Base.1.0.PropertyUnknown Base.1.0.PropertyNotWritable Base.1.0.PropertyValueFormatError 500 Base.1.0.InternalError /redfish/v1/Chassis//Power/PowerSupplies/ Description Provides details of the power supplies that are associated with the system or device.
/redfish/v1/Chassis//Power/Redundancy/ Description This object represents the Redundancy element property. Supported HTTP Methods and Privileges HTTP Method Required Privilege GET Login Supported Status Codes HTTP Status Code 200 400 500 Processor Description This is the schema definition for the Processor resource. It represents the properties of a processor attached to a system.
Role Description This resource is used to represent resources that represent the user role for the user account. URL /redfish/v1/Managers//Roles Supported HTTP Methods and Privileges HTTP Method Required Privilege GET Login Supported Status Codes HTTP Status Code 200 400 500 SerialInterfaces Description This resource is used to represent serial resources as part of the Redfish specification.
Updatable Properties Parameter Description BitRate updates BitRate InterfaceEnabled updates InterfaceEnabled Supported Status Codes HTTP Status Code Extended Information 200 Base.1.0.success 400 Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList Base.1.0.PropertyUnknown Base.1.0.PropertyNotWritable Base.1.0.PropertyValueFormatError 500 Base.1.0.
Supported HTTP Methods and Privileges HTTP Method Required Privilege GET Login Supported Status Codes HTTP Status Code 200 400 403 500 Session URL /redfish/v1/Sessions Description This resource is used to represent a session for a Redfish implementation.
/redfish/v1/Sessions/ Description Performs delete operation on session-id. Supported HTTP Methods and Privileges HTTP Method Required Privilege DELETE Login Supported Status Codes HTTP Status Code 200 400 500 SessionService Description This resource is used to represent the Session Service properties for a Redfish implementation.
SimpleStorage Description This property contains the UEFI device path used to identify and locate a specific storage controller. URL /redfish/v1/Systems//Storage/Controllers Supported HTTP Methods and Privileges HTTP Method Required Privilege GET Login Supported Status Codes HTTP Status Code 200 400 403 500 TaskService Description This resource represents a task service for a Redfish implementation.
Thermal Description This resource is used to represent the thermal metrics resource for a Redfish implementation. URL /redfish/v1/Chassis//Thermal Supported HTTP Methods and Privileges HTTP Method Required Privilege GET Login Supported Status Codes HTTP Status Code 200 400 500 Reference Properties /redfish/v1/Chassis//Sensors/Fans/ Description Provides details of the fan that is associated with the system or chassis.
Supported Status Codes and Error Messages HTTP Status Code 200 400 500 NOTE: On PowerEdge FX2 systems, iDRAC can display additional instrumentation data from the sensors on the server, only if the Chassis Monitoring setting is set to enabled on iDRAC and CMC. /redfish/v1/Chassis//Thermal/Redundancy/ Description Provides redundant information that is available for fans and other elements in this resource.
Supported Attributes and Values Attributes Values MediaTypes CD DVD USBStick ConnectedVia NotConnected Applet VLanNetworkInterface Description The value of this property indicates if VLAN is enabled for this interface.
Examples The following table provides usage examples for the HTTP supported methods such as GET, POST, PATCH, and DELETE: GET Table 3. GET Usage Examples URL /redfish/v1/Managers/iDRAC.Embedded.1/SerialInterfaces Output { "@odata.context": "/redfish/v1/$metadata#Managers/Members/iDRAC.Embedded.1/ SerialInterfaces/$entity", "@odata.count": 1, "@odata.id": "/redfish/v1/Managers/iDRAC.Embedded.1/SerialInterfaces", "@odata.type": "#SerialInterface.1.0.0.
POST Table 6. POST Usage Examples URL /redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.
