Page 1
i DRAC9 with Lifecycle Controller Version 3.00.00.00 Redfish API Guide
Page 2
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 d...
Page 3
Contents 1 ................................................................................................................................................... Overview....................................
Page 4
Dell Boot Sources.............................................................................................................................................................43 Dell Manager..............
Page 5
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 ...
Page 6
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...
Page 7
The Redfish attribute i DRAC.Redfish.Enable is modeled under the existing DCIM_i DRACCard Enumeration class. You can configure the Redfish service using existing methods such as Set Attribute, Set Att...
Page 8
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 by accessing URIs that can be ...
Page 9
Header Behavior If-Match Supported only for Account Service and Firmware Inventory URIs. If-None-Match Supported only for Account Service, Firmware Inventory, and metadata URIs. i DRAC supports the fo...
Page 10
If an event delivery fails, the event service of i DRAC retries delivering the failed event. The number of retries and delivery intervals can be configured using the following attributes: i DRAC.Redfi...
Page 11
/redfish/v1/Chassis Supported HTTP methods and privileges HTTP method Required privilege GET Login Navigation URL /redfish/v1/Chassis/<ID> Supported HTTP methods and privileges HTTP method Requi...
Page 12
Description This action is used to reset the chassis. Supported HTTP methods and privileges HTTP method Required privilege POST Configure Component Updatable properties Property Value Reset Type On Fo...
Page 13
Computer System Description This resource is used to represent resources that represent a computing system in the Redfish specification. /redfish/v1/Systems Supported HTTP methods and privileges HTTP ...
Page 14
Property Values Boot Source PXE Floppy CD USB HDD Utilities Uefi Target Bios Setup Boot Source Override Mode UEFI Legacy Boot Source Override Enabled Disabled Once Continuous Uefi Target Boot Source O...
Page 15
HTTP status code Extended information Base.1.0.Property Value Type Error Base.1.0.Property Value Not In List Base.1.0.Property Unknown Base.1.0.Property Not Writable Base.1.0.Property Value Format Err...
Page 16
Supported status codes and Error Message Codes HTTP status code Extended information Error Message Code Base.1.0.success Base.1.0.Property Value Type Error ISM0013 Base.1.0.Property Value Not In List ...
Page 17
Supported HTTP methods and privileges HTTP method Required privilege GET Login Supported status codes HTTP status code Event Destination Description This property contains an URL to the destination wh...
Page 18
JSONSchemas Description This resource is used for representing the Schema File locator resource for a Redfish implementation. /redfish/v1/JSONSchemas Supported HTTP methods and privileges HTTP method ...
Page 19
Supported HTTP methods and privileges HTTP method Required privilege GET Login Supported status codes HTTP status code Extended information /redfish/v1/Managers/<ID>/Logs/Sel Description This re...
Page 20
Reference Properties /redfish/v1/Managers/<ID>/Log Services/Lclog Description This resource represents the Lifecycle Controller log service in a Redfish implementation. Supported HTTP methods an...
Page 21
Supported status codes HTTP status code Extended information Base.1.0.Property Value Type Error Base.1.0.Property Value Not In List Base.1.0.Property Unknown Base.1.0.Property Not Writable Base.1.0.Pr...
Page 22
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 ...
Page 23
Export resource URL and response details redfish/v1/Managers/<id>/Actions/Oem/ EID_674_Manager.Export System Configuration Supported status codes HTTP status code Extended information Accepted S...
Page 24
Share parameters and values Parameter Values IPAddress IP address of the network share Share Name Name of network share File Name File name for the SCP Share Type CIFS, NFS, HTTP, HTTPS Username User ...
Page 25
HTTP status code Error message code RAC0288 RAC0291 Contained resources Role Manager Network Protocol Description This object is used to represent the network service settings for the manager. /redfis...
Page 26
HTTP status code Extended information Base.1.0.Property Value Type Error Base.1.0.Property Value Not In List Base.1.0.Property Unknown Base.1.0.Property Not Writable Base.1.0.Property Value Format Err...
Page 27
HTTP status code Extended information Base.1.0.Property Value Type Error Base.1.0.Property Value Not In List Base.1.0.Property Unknown Base.1.0.Property Not Writable Base.1.0.Property Value Format Err...
Page 28
Supported status codes HTTP status code Extended information Insufficient privileges. /redfish/v1/Chassis/<ID>/Sensors/Voltages/<ID> Description Provides the voltage sensor information. Su...
Page 29
/redfish/v1/Systems/<ID>/Processors Supported HTTP methods and privileges HTTP method Required privilege GET Login Supported status codes HTTP status code Supported properties and values Propert...
Page 30
Serial Interfaces Description This resource is used to represent serial resources as part of the Redfish specification. /redfish/v1/Managers/<ID>/Serial Interfaces Supported HTTP methods and pri...
Page 31
Property Values Parity Data Bits Stop Bits Hardware Flow Control Cisco Pin Out DB9 Male Connector Type Service Root Description This object represents the root Redfish service. All values for resource...
Page 32
Updatable properties Parameter Description username User name password Password Supported status codes HTTP status code Extended information Base.1.0.Property Value Type Error Base.1.0.Property Value ...
Page 33
Supported HTTP methods and privileges HTTP method Required privilege GET Login PATCH Configure Manager NOTE: The properties for this resource are inherited from the web-server properties. Supported st...
Page 34
/redfish/v1/Task Service Supported HTTP methods and privileges HTTP method Required privilege GET Login Supported status codes HTTP status code Tasks URL /redfish/v1/Task Service/Tasks/<Task ID>...
Page 35
Reference properties /redfish/v1/Chassis/<ID>/Sensors/Fans/<ID> Description Provides details of the fan that is associated with the system or chassis. Supported HTTP methods and privileges...
Page 36
Supported status codes HTTP status code Extended information Insufficient privileges. Virtual Media Description This resource is used to represent a virtual media service for a Redfish implementation....
Page 37
Supported HTTP methods and response content type HTTP method Response content type GET application/json Supported status codes HTTP status code BIOS Description This resource is used for representing ...
Page 38
HTTP status code Extended information Base.1.0.Internal Error Supported action — Change Password Description This action is used for changing the BIOS passwords. /redfish/v1/Systems/<ID>/Bios/Ac...
Page 39
HTTP status code Extended information Base.1.0.Internal Error Settings Resource Description This resource is used for representing the BIOS pending configuration and related resources to clear pending...
Page 40
Updatable properties Property Description Secure Boot Enable Enable or disable UEFI Secure Boot (takes effect on next boot). Supported status codes HTTP status code Extended information Base.1.0.Succe...