iDRAC 8/7 v2.40.40.
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. © 2016 Dell Inc. All rights reserved. This product is protected by U.S. and international copyright and intellectual property laws.
Contents Overview........................................................................................................................... 5 What is new in this release................................................................................................................................................. 5 Benefits..............................................................................................................................................................................
Reference Properties.................................................................................................................................................. 31 Processor......................................................................................................................................................................... 32 Role............................................................................................................................................................
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.
• For more information about Redfish Specification v1.0.2 (errata), see http://Redfish.dmtf.org/schemas/DSP8010_1.0.0.zip • For information about Redfish API, see the DMTF Redfish white paper available at https://www.dmtf.org/sites/default/files/ standards/documents/DSP2044_1.0.0.pdf.
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.
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 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.
is no sufficient privileges. In other cases, some of the properties in certain resource may not be returned in a response. The service may also return errors when such properties are modified. For information of specific license requirements for the resources, see Redfish Resources. 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.
DELETE Use the DELETE method to remove a resource. Services support the DELETE method for resources that can be deleted. If the resource cannot be deleted, status code 405 is returned. Services return a representation of the deleted resource in the response body. Services may return status code 404 or a success code if the resource is deleted successfully. HTTP Headers The server response contains only basic information about related resources.
replaced using the iDRAC interfaces such as web interface, RACADM, or WS-MAN. For more information on managing SSL certificates of iDRAC, see the latest iDRAC User’s Guide available at dell.com/idracmanuals. Eventing The Redfish service generates asynchronous notifications (events) that are defined by Redfish subscription for the eventing service. These events are sent to an event destination by using HTTP POST method.
HTTP Method Type Description URI Metadata Reference GET Get Event Service detailed information /redfish/v1/EventService EventService.xml POST Register an event notification receiver /redfish/v1/EventService/Subscriptions EventDestination.xml DELETE Remove a subscription /redfish/v1/EventService/ Subscriptions / EventService.
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 iDRAC Service Module (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.
NOTE: For SCP export, import and preview, if the Lifecycle Controller is disabled, ensure you enable the Lifecycle Controller and retry the operation. To enable Lifecycle Controller, run the following command: racadm set LifeCycleController.LCAttributes.LifecycleControllerState 1 URL redfish/v1/Managers//Actions/Oem/ Redfish SCP is an OEM action and requires OEM privileges ALL and role as ADMIN. NOTE: SCP is a OEM feature and OEM privileges are applicable. Redfish privileges are not applicable.
Table 7. Supported Status Codes HTTP Status Code Extended Information 202 Accepted Table 8. Supported Attributes and Values Attributes Values ImportBuffer [Buffer content to perform import. Required only for local store and not required for CIFS/NFS.] ShutdownType Graceful, Forced, NoReboot HostPowerState On, Off TimeToWait The time to wait for the host to shut down. Default and minimum value is 300 seconds. Maximum value is 3600 seconds.
Attributes Values Password [Password to log on to the share] Workgroup [Workgroup name to log on to the share] Target ALL, IDRAC, BIOS, NIC, RAID, SYSTEM, LIFECYCLECONTROLLER, EVENTFILTERS, FC ManagerAccount Description This resource represents the BMC user accounts collection for a Redfish implementation.
URL /redfish/v1/Managers//NetworkProtocol Supported HTTP Methods and Privileges HTTP Method Required Privilege GET Login PATCH ConfigureManager 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
URL /redfish/v1/Registries/Messages/En Supported HTTP Methods and Privileges HTTP Method Required Privilege GET Login 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.
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 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.
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//Power/Redundancy/ Description This object represents the Redundancy element property.
HTTP Status Code 500 Supported Attributes and Values Attributes Values ProcessorType CPU ProcessorArchitecture x86 InstructionSet x86-64 Implementation Notes Some of the properties in this schema are dependent on the installed BIOS version. If a compatible BIOS version is not installed, some of the properties may not be supported on this resource. Role Description This resource is used to represent resources that represent the user role for the user account.
Supported HTTP Methods and Privileges HTTP Method Required Privilege GET Login Navigation URL /redfish/v1/Managers//SerialInterfaces/ Supported HTTP Methods and Privileges HTTP Method Required Privilege PATCH ConfigureManager 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.
Attributes Values ConnectorType DB9 Male ServiceRoot Description This object represents the root Redfish service. All values for resources described by 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 No sufficient privileges.
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 /redfish/v1/Sessions/ Description Performs delete operation on session-id.
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 SimpleStorage Description This property contains the UEFI device path used to identify and locate a specific storage controller.
Supported Status Codes HTTP Status Code 200 400 500 Thermal Description This resource is used to represent the thermal matrices 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.
/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 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.
Supported Status Codes HTTP Status Code Extended Information 200 400 403 No sufficient privileges. 500 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 13. 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 16. POST Usage Examples URL /redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.
