iDRAC9 with Lifecycle Controller Version 3.00.00.
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 ................................................................................................................................................... 5 Overview.................................................................................................................................................................................5 What is new in this release.........................................................................................................................................
DellBootSources.............................................................................................................................................................43 DellManager....................................................................................................................................................................44 DellServiceRoot................................................................................................................................................
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.
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/.
The Redfish attribute iDRAC.Redfish.Enable is modeled under the existing DCIM_iDRACCardEnumeration class. You can configure the Redfish service using existing methods such as SetAttribute, SetAttributes, and ApplyAttributes of DCIM_iDRACCardService class. Redfish schema The Schemas for the Redfish resources are defined according to the OData Schema representation, which can be directly translated to a JSON Schema representation.
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 accessed by using the following HTTP methods: • • • • • • GET HEAD 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.
Header Behavior If-Match Supported only for AccountService and FirmwareInventory URIs. If-None-Match Supported only for AccountService, FirmwareInventory, and metadata URIs. iDRAC supports the following response headers: Header Behavior Content-Length Returned on all responses except responses that have Transfer-Encoding: chunked. Content-Type • • ETag Supported on AccountService, FirmwareInventory, and metadata URIs.
If an event delivery fails, the event service of iDRAC retries delivering the failed event. The number of retries and delivery intervals can be configured using the following attributes: • • iDRAC.RedfishEventing.DeliveryRetryAttempts iDRAC.RedfishEventing.DeliveryRetryIntervalInSeconds Event delivery retry settings in RACADM iDRAC.RedfishEventing.DeliveryRetryAttempts (Read or Write) iDRAC.RedfishEventing.
URL /redfish/v1/Chassis Supported HTTP methods and privileges HTTP method Required privilege GET Login 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.
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.PropertyValueFormatError 500 Base.1.0.
ComputerSystem Description This resource is used to represent resources that represent a computing system in the Redfish specification. URL /redfish/v1/Systems Supported HTTP methods and privileges HTTP method Required privilege GET Login Navigation URL /redfish/v1/Systems/ 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.
Property Values BootSource • • • • • • • • PXE Floppy CD USB HDD Utilities UefiTarget BiosSetup BootSourceOverrideMode • • UEFI Legacy BootSourceOverrideEnabled • • • Disabled Once Continuous UefiTargetBootSourceOverride Any valid UEFI-device path IndicatorLed • • Lit Off Implementation notes Some of the properties in this schema are dependent on the installed BIOS version.
HTTP status code Extended information 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 EthernetInterfaces Description This resource is used to represent NIC resources as part of the Redfish specification. It also updates the properties of Manager Ethernet Interface.
Supported status codes and Error Message Codes HTTP status code Extended information Error Message Code 200 Base.1.0.success 400 Base.1.0.PropertyValueTypeError ISM0013 Base.1.0.PropertyValueNotInList RAC0253 Base.1.0.PropertyUnknown RAC0254 Base.1.0.PropertyNotWritable RAC0255 Base.1.0.PropertyValueFormatError RAC0259 SWC0296 500 Base.1.0.
Supported HTTP methods and privileges HTTP method Required privilege GET Login Supported status codes HTTP status code 200 400 500 EventDestination Description This property contains an URL to the destination where the events are sent.
JSONSchemas Description This resource is used for representing the Schema File locator resource for a Redfish implementation. URL /redfish/v1/JSONSchemas Supported HTTP methods and privileges HTTP method Required privilege GET Login Supported status codes HTTP status code 200 400 500 LogEntry Description This resource represents the log format for log services 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 /redfish/v1/Managers//Logs/Sel Description This resource represents the System Event Logs for the manager in a Redfish implementation.
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 /redfish/v1/Managers//LogServices/Sel Description This resource represents the SEL log service in a Redfish implementation.
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 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.
Export resource URL and response details URL redfish/v1/Managers//Actions/Oem/ EID_674_Manager.ExportSystemConfiguration Supported status codes HTTP status code Extended information 202 Accepted Supported properties and values Property Values ExportFormat XML, JSON ExportUse Default, Clone, Replace IncludeInExport Default, IncludeReadOnly, IncludePasswordHashValues ShareParameters See Share parameters and values.
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, HTTP, HTTPS 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 Error message code 400 RAC0288 RAC0291 404 500 Contained resources Role ManagerNetworkProtocol Description This object is used to represent the network service settings for the manager.
HTTP status code Extended information 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 MessageRegistry Description This resource is used to represent a message registry for a Redfish implementation.
HTTP status code Extended information 400 Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList Base.1.0.PropertyUnknown Base.1.0.PropertyNotWritable Base.1.0.PropertyValueFormatError 403 Insufficient privileges. 500 Reference Properties /redfish/v1/Chassis//Power/PowerControl Description Updates the properties of PowerControl in Chassis Collection.
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.
URL /redfish/v1/Systems//Processors Supported HTTP methods and privileges HTTP method Required privilege GET Login Supported status codes HTTP status code 200 400 500 Supported properties and values Property Values ProcessorType CPU ProcessorArchitecture x86 InstructionSet x86-64 Implementation notes Some of the properties in this schema depend on the installed BIOS version. If a compatible BIOS version is not installed, some of the properties may not be supported on this resource.
SerialInterfaces Description This resource is used to represent serial resources as part of the Redfish specification.
Property Values Parity None DataBits 8 StopBits 1 FlowControl Hardware PinOut Cisco ConnectorType DB9 Male 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.
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.InternalError /redfish/v1/Sessions/ Description Performs delete operation on the session ID.
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. 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.
URL /redfish/v1/TaskService Supported HTTP methods and privileges HTTP method Required privilege GET Login Supported status codes HTTP status code 200 400 500 Tasks URL /redfish/v1/TaskService/Tasks/ 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.
Reference properties /redfish/v1/Chassis//Sensors/Fans/ Description Provides details of the fan that is associated with the system or chassis. 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.
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. URL /redfish/v1/Managers//VirtualMedia 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 response content type HTTP method Response content type GET application/json Supported status codes HTTP status code 200 400 500 BIOS Description This resource is used for representing the BIOS configuration and the related resources to Reset BIOS, Change Password, and the Settings resource.
HTTP status code Extended information 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 500 Base.1.0.InternalError Settings Resource Description This resource is used for representing the BIOS pending configuration and related resources to clear pending and navigation to Jobs resource.
Updatable properties Property Description SecureBootEnable Enable or disable UEFI Secure Boot (takes effect on next boot). 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.InternalError Supported action — ResetKeys Description This action is used to reset the Secure Boot keys. URL /redfish/v1/Systems//SecureBoot/Actions/SecureBoot.
UpdateService Description This represents the properties of the update service for the Redfish implementation. URL /redfish/v1/UpdateService Supported HTTP methods and privileges HTTP method Required privilege GET Login Supported status codes HTTP status code Extended information 200 Error Message Code OSD35, SUP024 403 Base.1.0. InsufficientPrivilege RAC0506 404 Base.1.0. ResourceMissingAtURI SYS403 500 Base.1.0.
HTTP method Required privilege DELETE .d9 file type — ConfigureManager .pm file type — ConfigureManager .exe file type — ConfigureSelf Supported status codes HTTP status code Extended information Error message code 200 RAC0604, SYS422 200 Base.1.0.Success SYS413 201 Base.1.0.Created SYS414 304 400 403 OSD35, SYS400, SYS404, SYS406, SYS434 Base.1.0.InsufficientPrivilege RAC0506 403 404 LIC501 Base.1.0. ResourceMissingAtURI SYS403 405 SYS402 415 SYS401 500 Base.1.0.
DellBootSourcesRegistry Description A Boot Sources Registry is a set of key-value pairs that are specific to a particular implementation or product. This schema describes the structure of a registry and also includes mechanisms for building user interfaces allowing consistent navigation of the contents.
Supported HTTP methods and privileges HTTP method Required privilege POST SystemControl Supported status codes HTTP status code Extended information 200 Base.1.0.Success 500 Base.1.0.InternalError Settings Resource Description This resource is used to represent the Boot Sources pending configuration and related resources to clear pending and navigation to Jobs resource.
Supported action — ResetToDefaults Description This defines the name of the OEM action supported when used in conjunction with a POST operation to this resource. When issued, this operation resets the Manager attributes to default settings. URL /redfish/v1/Managers//Actions/Oem/DellManager.ResetToDefaults 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.
Property Description ServiceTag System Service Tag DellAttributes Description This resource is used to represent the iDRAC Configuration and the related settings resource for pending configuration. URL /redfish/v1/Managers//Attributes 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 iDRAC configuration.
HTTP status code Extended information 500 Base.1.0.InternalError Settings Resource Description This resource is used to represent the Dell Attributes pending configuration and related resources to clear pending and navigation to Jobs resource.
Supported HTTP methods and privileges HTTP method Required privilege POST .d9 file type — ConfigureManager .pm file type — ConfigureManager .exe file type — ConfigureSelf Supported properties and values Property Values InstallUpon Now NowAndReboot NextReboot Supported status codes HTTP status code Extended information Error Message Code 202 SYS408 400 SUP024, SYS406, OSD35 400 Base.1.0. PropertyValueTypeError 400 Base.1.0. PropertyMissing 400 Base.1.0.MalformedJSON SYS405 403 Base.1.
HTTP status code Extended information 500 Base.1.0.InternalError URL /redfish/v1/Systems//SecureBoot/Certificates/ Supported HTTP methods and privileges HTTP method Required privilege GET Login POST SystemControl Updatable properties Parameter Description CryptographicHash A string providing the Cryptographic Hash value of SHA256, SHA384, or SHA512. Supported status codes HTTP status code Extended information 200 Base.1.0.Success 400 Base.1.0.
DellJob Description This resource represents the Dell-specific implementation of a scheduling resource for pending configuration. URL /redfish/v1/Managers//Jobs Supported HTTP methods and privileges HTTP method Required privilege GET Login POST SystemControl Updatable properties Parameter Description TargetSettingsURI Settings object resource URI StartTime Scheduled start time EndTime Scheduled end time Supported status codes HTTP status code Extended information 200 Base.1.0.
HTTP status code Extended information 403 Base.1.0. InsufficientPrivilege 404 Base.1.0.ResourceMissingAtURI 500 Base.1.0.InternalError 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: GET Table 4. GET usage examples URL Output /redfish/v1/Managers/iDRAC.Embedded.
Output { "Success": { "Message": "Successfully Completed Request", "MessageId": "Base.1.0.Success", "Resolution": "None", "Severity": "Ok" } } POST Table 7. POST usage examples URL Input Output 52 /redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.
