iDRAC8/7 with Lifecycle Controller Version 2.50.50.
Notes, cautions, and warnings NOTE: A NOTE indicates important information that helps you make better use of your product. 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. Copyright © 2017 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries.
Contents 1 Overview........................................................................................................................................................5 What is new in this release................................................................................................................................................5 Benefits..............................................................................................................................................................
JSONSchemas................................................................................................................................................................. 33 LogEntry............................................................................................................................................................................34 Reference Properties.....................................................................................................................................
1 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.
Key technologies Redfish uses web and cloud-based technologies that enable communications with servers using common programming and scripting languages such as Python, JAVA, and C. The key technologies are as follows: • REpresentational State Transfer (REST) interface — REST is a web based API, which provides a way to interact with a system over a normal web connection. It supports both HTTPS and HTTP.
2 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.
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.
Table 1.
GET Use the GET method to retrieve a representation of a resource. The representation can either be a single resource or a collection. Depending on the media type, the service returns the resource representation by using one of the media types specified in the Accept header. If the Accept header is not present, the service returns the resource representations either as application/json or application/xml. The resources support the formats defined by the Redfish standard.
HTTP headers The server response contains only basic information about related resources. Any metadata that is required to process a request or response is accessed by using HTTP headers. iDRAC supports the following request headers: Header Description If-Match Supported only for AccountService URI. If-None-Match Supported only for AccountService and metadata URIs. Content-Length Returned on all responses except responses that have Transfer-Encoding: chunked.
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. To handle such situations, iDRAC can be configured to skip certificate verification by using the attribute iDRAC.RedfishEventing.IgnoreCertificateErrors. This attribute can be configured to True or False (Default) using RACADM or the WS-MAN interface. Set this attribute to True if certificate validation is not required.
setting allows you to monitor and manage the chassis even if the CMC is not on the network. On an FX2/FX2s CMC, ensure that the Chassis Management at Server setting is set to Monitor or Manage and Monitor. While this feature is enabled, iDRAC also generates Redfish notifications for chassis events. Configuring chassis management and monitoring using iDRAC web interface 1 In iDRAC web interface, navigate to Overview > iDRAC Settings > CMC.
3 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. URL /redfish/v1/Managers//AccountService Supported HTTP methods and privileges HTTP method Required privilege GET Login AttributeRegistry Description An Attribute Registry is a set of key-value pairs that are specific to a particular implementation or product.
BIOS Description This resource is used for representing the BIOS configuration and the related resources to Reset BIOS, Change Password, and the Settings resource. URL /redfish/v1/Systems//Bios Supported HTTP methods and privileges HTTP method Required privilege GET Login Supported status codes HTTP status code Extended information 200 500 Base.1.0.InternalError Supported action — ResetBIOS Description This action is used for resetting the BIOS attributes to default.
Supported status codes HTTP status code Extended information 200 Base.1.0.Success 400 Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList 403 Base.1.0.InsufficientPrivilege 404 Base.1.0.ResourceMissingAtURI 500 Base.1.0.InternalError Supported action — ChangePassword Description This action is used for changing the BIOS passwords. URL /redfish/v1/Systems//Bios/Actions/Bios.
HTTP status code Extended information Base.1.0.PropertyValueNotInList 403 Base.1.0.InsufficientPrivilege 404 Base.1.0.ResourceMissingAtURI 500 Base.1.0.InternalError Supported action — ClearPending Description This action is used for clearing the pending values. URL /redfish/v1/Systems//Bios/Actions/Oem/DellManager.ClearPending Supported HTTP methods and privileges HTTP method Required privilege POST SystemControl Supported status codes HTTP status code Extended information 200 Base.1.
URL /redfish/v1/Systems//Bios/Settings Supported HTTP methods and privileges HTTP method Required privilege GET Login PATCH SystemControl Updatable properties Property Description Attributes Collection of all the attributes and their values supported by the BIOS configuration Supported status codes HTTP status code Extended information 200 Base.1.0.Success 400 Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList 403 Base.1.0. InsufficientPrivilege 500 Base.1.0.
Navigation URL /redfish/v1/Chassis/ Supported HTTP methods and privileges HTTP method Required privilege 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.PropertyNotWritable Base.1.0.PropertyValueFormatError 500 Base.1.0.
Supported action — Reset URL /redfish/v1/Chassis/System.Embedded.1/Actions/Chassis.Reset Description This action is used to reset the chassis. Supported HTTP methods and privileges HTTP method Required privilege POST ConfigureComponent Updatable properties Property Value ResetType On ForceOff 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.
Supported HTTP methods and privileges HTTP method Required privilege GET Login Supported status codes 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. Contained resources • Power • Thermal ComputerSystem Description This resource is used to represent resources that represent a computing system in the Redfish specification.
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.
Property Values BootSourceOverrideEnabled • • • UefiTargetBootSourceOverride Any valid UEFI-device path IndicatorLed • • Disabled Once Continuous Lit Off Implementation notes Some of the properties in this schema are dependent on the installed BIOS version. If a compatible BIOS version is not installed, the UefiTargetBootSourceOverride property is not supported in this resource. Supported action — Reset Description Resets computer system. URL /redfish/v1/Systems//Actions/ComputerSystem.
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.1.0.PropertyValueFormatError 500 Base.1.0.InternalError Contained resources • Processor • EthernetInterfaces • SimpleStorage • LogService DellBootSources Description This resource is used to represent the Dell Boot Sources Configuration and the related resources to the settings resource.
Supported action — ClearPending Description This action is used to clear the pending values. URL /redfish/v1/Systems//BootSources/Actions/Oem/DellManager.ClearPending Supported HTTP methods and privileges HTTP method Required privilege POST SystemControl Supported status codes HTTP status code Extended information 200 Base.1.0.Success 400 Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList 403 Base.1.0.InsufficientPrivilege 404 Base.1.0.ResourceMissingAtURI 500 Base.1.0.
Supported HTTP methods and privileges HTTP method Required privilege GET Login PATCH SystemControl Updatable properties Property Description Attributes Collection of all the attributes and their values supported for Boot Sources. Supported status codes HTTP status code Extended information 200 Base.1.0.Success 400 Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList 403 Base.1.0. InsufficientPrivilege 404 Base.1.0.ResourceMissingAtURI 500 Base.1.0.
Supported status codes HTTP status code Extended information 200 Base.1.0.Success 500 Base.1.0.InternalError DellJob Description This resource represents the Dell-specific implementation of a scheduling resource for pending configuration.
HTTP status code Extended information 500 Base.1.0.InternalError Navigation URL /redfish/v1/Managers//Jobs Supported HTTP methods and privileges HTTP method Required privilege GET Login DELETE SystemControl Supported status codes HTTP status code Extended information 200 Base.1.0.Success 400 Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList 403 Base.1.0. InsufficientPrivilege 404 Base.1.0.ResourceMissingAtURI 500 Base.1.0.
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 Property 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.
Reference Properties /Systems//EthernetInterfaces Description This resource is used to represent NIC resources as part of the Redfish specification. Supported HTTP methods and privileges HTTP method Required privilege GET Login 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 iDRAC Service Module (iSM) version.
Supported HTTP methods and privileges HTTP method Required privilege GET Login POST ConfigureManager Updatable properties Property Description Destination Destination IP to send event EventTypes Contains the type of the event Context Client-supplied string Protocol Protocol type used by event Supported status codes HTTP status code Extended information 200 201 Base.1.0.PropertyValueTypeError 400 Base.1.0.PropertyValueNotInList Base.1.0.PropertyUnknown Base.1.0.PropertyNotWritable Base.1.
URL /redfish/v1/EventService Supported HTTP methods and privileges HTTP method Required privilege GET Login Supported status codes HTTP status code 200 400 500 JSONSchemas Description This resource is used for representing the Schema File locator resource for a Redfish implementation.
LogEntry Description This resource represents the log format for log services in a Redfish implementation. URL /redfish/v1/Managers//Logs 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.
Supported status codes HTTP status code Extended information 200 400 500 /redfish/v1/Managers//Logs/Sel Description This resource represents the System Event Logs for the manager in a Redfish implementation. Supported HTTP methods and privileges HTTP method Required privilege GET Login Supported status codes HTTP status code Extended information 200 400 500 LogService Description This resource is used to represent a log service 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//LogServices/Lclog Description This resource represents the Lifecycle Controller log service in a Redfish implementation.
Supported HTTP methods and privileges HTTP method Required privilege GET Login 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 Supported status codes HTTP status code Extended information 204 400 Base.1.0.PropertyValueTypeError Base.1.0.
Manager Description This resource is used to represent a management sub-system for a Redfish implementation.
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 performs a reset of the manager. URL /redfish/v1/Managers//Actions/Manager.Reset Supported HTTP methods and privileges HTTP method Required privilege POST ConfigureManager Updatable properties Property Value ResetType GracefulRestart HTTP status code Extended information 204 400 Base.1.0.
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 Updatable properties Property Value UserName Updates account user name Password Updates account password RoleId Updates account role Enabled Enables or disables the user Supported status codes HTTP status code Error me
Contained resources Role ManagerNetworkProtocol Description This object is used to represent the network service settings for the manager.
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 403 Insufficient privilegess. 500 Base.1.0.InternalError Role Description This resource is used to represent resources that represent the user role for the user account.
SerialInterfaces Description This resource is used to represent serial resources as part of the Redfish specification.
HTTP status code Extended information Base.1.0.PropertyNotWritable Base.1.0.PropertyValueFormatError 500 Base.1.0.InternalError Supported properties and values Property Values SignalType Rs232 BitRate • • • • • 9600 19200 38400 57600 115200 Parity None DataBits 8 StopBits 1 FlowControl Hardware PinOut Cisco ConnectorType DB9 Male MessageRegistry Description This resource is used to represent a message registry for a Redfish implementation.
Supported status codes HTTP status code 200 400 500 OEMManager Description This resource is used to export, import, and preview the Server Configuration Profile (SCP) files Redfish implementation. NOTE: For SCP export, import, and preview, if Lifecycle Controller is disabled, ensure that you enable Lifecycle Controller and retry the operation. To enable Lifecycle Controller, run the following command: racadm set LifecycleController.LCAttributes.
Supported properties and values Property Values ExportFormat XML, JSON ExportUse Default, Clone, Replace IncludeInExport Default, IncludeReadOnly, IncludePasswordHashValues ShareParameters See Share parameters and values. Import resource URL and response details URL redfish/v1/Managers//Actions/Oem/EID_674_Manager.
Share parameters and values Parameter Values IPAddress IP address of the network share ShareName Name of network share FileName File name for the SCP ShareType CIFS, NFS Username User name to log on to the share — for CIFS share only. Password Password to log on to the share — for CIFS share only. Workgroup Workgroup name to log on to the share Target Can be the component name or an FQDD. The default value is ALL.
HTTP status code Extended information 403 Insufficient privileges. 500 Reference Properties /redfish/v1/Chassis//Power/PowerControl Description Updates the properties of PowerControl in Chassis Collection. Supported HTTP methods and privileges HTTP method Required privilege GET Login PATCH ConfigureManager Updatable properties Property Description PowerLimit Updates PowerLimit Supported status codes HTTP status code Extended information 200 Base.1.0.success 400 Base.1.0.
Supported HTTP methods and privileges HTTP method Required privilege GET Login Supported status codes HTTP status code Extended information 200 400 403 Insufficient privileges. 500 /redfish/v1/Chassis//Sensors/Voltages/ Description Provides the voltage sensor information.
Supported status codes HTTP status code 200 400 500 SecureBoot Description This resource contains UEFI Secure Boot information. It represents properties for managing the UEFI Secure Boot functionality of a system. URL /redfish/v1/Systems//SecureBoot Supported HTTP methods and privileges HTTP method Required privilege GET Login PATCH SystemControl Updatable properties Property Description SecureBootEnable Enable or disable UEFI Secure Boot (takes effect on next boot).
Supported action — ResetKeys Description This action is used to reset the Secure Boot keys. URL /redfish/v1/Systems//SecureBoot/Actions/SecureBoot.ResetKeys Supported HTTP methods and privileges HTTP method Required privilege POST SystemControl Updatable properties Parameter Description ResetKeysType ResetAllKeysToDefault DeleteAllKeys DeletePK Supported status codes HTTP status code Extended information 200 Base.1.0.Success 400 Base.1.0.PropertyValueTypeError Base.1.0.
ServiceRoot Description This object represents the root Redfish service. All values for resources in this schema must comply with the requirements described in the Redfish specification. URL /redfish/v1 Supported HTTP methods and privileges HTTP method Required privilege GET Login Supported status codes HTTP status code Extended information 200 400 403 Insufficient privileges.
Supported HTTP methods and privileges HTTP method Required privilege GET Login POST ConfigureManager Updatable properties Parameter Description username User name password Password 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.
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. URL /redfish/v1/SessionService Updatable properties Property Description SessionTimeout Updates web server timeout Supported HTTP methods and privileges HTTP method Required privilege GET Login PATCH ConfigureManager NOTE: The properties for this resource are inherited from the web-server properties.
HTTP status code Extended information Base.1.0.PropertyNotWritable Base.1.0.PropertyValueFormatError 500 Base.1.0.InternalError Processor Description This schema defines the processor resource. It represents the properties of a processor attached to a system.
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 Extended information 200 400 403 Insufficient privileges. 500 VLanNetworkInterface Description The value of this property indicates if VLAN is enabled for this interface.
Supported status codes HTTP status code 200 400 500 TaskService Description This resource represents a task service for a Redfish implementation.
Supported status codes HTTP status code Extended information 200 Ok 202 Accepted 404 Not Found Thermal Description This resource is used to represent the thermal matrices 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 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//Sensors/Temperatures/ Description Represents the properties for temperature sensors.
Supported HTTP methods and privileges HTTP method Required privilege GET Login Supported status codes HTTP status code Extended information 200 400 403 Insufficient privileges. 500 VirtualMedia Description This resource is used to represent a virtual media service for a Redfish implementation.
Supported properties and values Property Values MediaTypes • • • CD DVD USBStick ConnectedVia • • NotConnected Applet Redfish resources 61
4 Examples NOTE: For more information about Redfish and detailed examples, see the white papers available at https://www.dmtf.org/ standards/redfish. The following table provides usage examples for the HTTP supported methods such as GET, POST, PATCH, and DELETE: Topics: • Example for GET • Example for PATCH • Example for POST • Example for DELETE • Example of Job Creation Example for GET URL /redfish/v1/Managers/iDRAC.Embedded.1/SerialInterfaces Output { "@odata.
} } Example for POST URL /redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.Reset Input {"ResetType":"GracefulRestart"} Output 204: No Content Example for DELETE URL /redfish/v1/EventService/Subscriptions/ Output 200 Ok { "INFO": " subscription deleted successfully" } Example of Job Creation Request Method POST URI https://100.101.18.90/redfish/v1/Managers/iDRAC.Embedded.
Response HTTP Status code: 200 Headers OData-Version: 4.0 Keep-Alive: timeout=60, max=199 Content-Type: application/json;odata.metadata=minimal;charset=utf-8 Server: Appweb/4.5.4 Location: /redfish/v1/Managers/iDRAC.Embedded.1/Jobs/JID_471269252011 Date: Thu, 06 Jan 2000 02:48:49 GMT Cache-Control: no-cache Content-Length: 501 Connection: Keep-Alive Access-Control-Allow-Origin: * Accept-Ranges: bytes BODY { } 64 "@Message.
