iDRAC8 with Lifecycle Controller Version 2.70.70.70 Redfish API Guide November 2019 Rev.
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. © 2019 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries.
Contents 1 Overview......................................................................................................................................7 New in this release.................................................................................................................................................................7 Benefits.......................................................................................................................................................................
ComputerSystemCollection............................................................................................................................................... 36 Supported Action — Reset..........................................................................................................................................38 LogEntry........................................................................................................................................................................
Messages..............................................................................................................................................................................79 NetworkAdapterCollection................................................................................................................................................. 79 NetworkDeviceFunctions....................................................................................................................................
Example for PATCH...........................................................................................................................................................122 Example for POST............................................................................................................................................................. 123 Example for DELETE............................................................................................................................................
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.
• OData — It is important to standardize the data format when implementing a common interface across multiple vendors. OData provides the required framework to ensure that the data structure remains interchangeable between server vendors. Other documents you may need For more information about Redfish, see the DMTF website https://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 https://www.dmtf.
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: You do not need to restart the web server when enabling or disabling Redfish attribute. Configuring Redfish service using iDRAC web interface To enable or disable the Redfish service on iDRAC, perform the following tasks: 1. In the iDRAC web interface, navigate to the following screen: • 13th generation of PowerEdge servers: Overview > iDRAC Settings > Network > Services • 14th generation of PowerEdge servers: iDRAC Settings > Services > Redfish 2.
• • Basic authentication: In this method, user name and password are provided for each Redfish API request. Session-based authentication: This method is used while issuing multiple Redfish operation requests. ○ Session login is initiated by accessing the Create session URI. The response for this request includes an X-Auth-Token header with a session token. Authentication for subsequent requests is made using the X-Auth-Token header.
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. The HTTP GET method is used to retrieve a resource. The service ignores the content of the body on a GET. The GET operation is unchanged in the absence of external changes to the resource. HEAD All URLs support the HEAD method. This method returns the response headers.
Header Description ETag Supported on AccountService, FirmwareInventory, and metadata URIs. Location Service sets this header when resources are created or when HTTP requests are redirected to other resources. Cache-Control Returned on all responses. Metadata URIs support cached responses. Instrumentation resources cannot be cached. X-Auth-Token Used for authentication of user sessions. See “Session-based authentication” under Redfish authentication and authorization on page 10.
resource. Examples of these kinds of event are a chassis being opened, button being pressed, cable being unplugged, or threshold being exceeded. iDRAC supports up to 20 event subscriptions. NOTE: In this release, iDRAC supports only Alert event notifications. 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.
Updating firmware using SimpleUpdate Using Redfish API you can update the iDRAC, BIOS, and all device firmware. The firmware image can be uploaded locally or using HTTP share. Depending on the component, to apply the update the system automatically reboots or requires a manual reboot. NOTE: Redfish API only supports uploading one firmware image at a time. Updating firmware using a local image To perform a component firmware update using the image file available on the local system: 1.
• Expand— The $expand parameter indicates to the implementation that it should include a hyperlink as well as the contents of that hyperlink in the current response as if a GET had been performed and included in line with that hyperlink. NOTE: The $expand parameter is not supported for resources under OEM section. See the section Examples for the examples of the above parameters.
3 Redfish resources This section describes the resource URIs and related operations that are available in the iDRAC implementation of a Redfish service API.
• • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • PCIeDevice PCIeFunction Processor Port PortCollection Power PrivilegeRegistry ProcessorCollection Role RoleCollection SecureBoot SerialInterfaceCollection ServiceRoot Session SessionService SimpleStorage SoftwareInventoryCollection SerialInterfaces StorageCollection Storage collection Subscriptions Switches TaskCollection TaskService Thermal UpdateService VirtualMedia VLanNetworkInterface VolumeCollection NetworkPort NetworkPortCollection Ne
Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 SYS403 SYS402 500 Base.1.2.InternalError SYS446 503 DellJobCollection Description A Collection of Job resource instances. URL /redfish/v1/Managers/iDRAC.Embedded.
Navigation URL /redfish/v1/Managers/iDRAC.Embedded.1/Jobs/ Supported HTTP Method and Privileges HTTP Method Required Privilege DELETE ConfigureComponents, Login GET Login Table 5. Status codes HTTP status code 200 404 AttributeRegistry Description An Attribute Registry is a set of key-value pairs that are specific to a particular implementation or product.
HTTP Status Code Extended Information Error Code 500 Base.1.2.InternalError SYS446 503 BaseMessages Description This resource is used to represent the base message registry for a Redfish implementation. URL /redfish/v1/Registries/BaseMessages HTTP methods and privileges Table 7. HTTP methods and privileges for BaseMessages HTTP method Required privilege GET Login Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.
Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 SYS403 SYS402 500 Base.1.2.InternalError SYS446 503 Navigation URL /redfish/v1/Chassis/System.Embedded.
URL /redfish/v1/Chassis HTTP methods and privileges Table 8. HTTP methods and privileges for Chassis HTTP method Required privilege GET Login Navigation URL /redfish/v1/Chassis/ HTTP methods and privileges Table 9. HTTP methods and privileges for instance of Chassis HTTP method Required privilege PATCH ConfigureManager Status codes Table 10. Status codes for Chassis HTTP status code Extended information 200 Base.1.0.success 400 • • • • • 500 Base.1.0.InternalError Base.1.0.
Table 11. Properties and values for Chassis(continued) Property Values • • • Blade Enclosure Sled Supported action — Reset URL /redfish/v1/Chassis/System.Embedded.1/Actions/Chassis.Reset Description This action is used to reset the chassis. HTTP methods and privileges Table 12. HTTP methods and privileges for Reset HTTP method Required privilege POST ConfigureComponent Properties and values Table 13.
HTTP methods and privileges Table 15. HTTP methods and privileges for the instance HTTP method Required privilege GET Login Status codes Table 16. Status codes for the instance HTTP status code 200 400 500 ComputerSystem Description This resource is used to represent resources that represent a computing system in the Redfish specification. URL /redfish/v1/Systems HTTP methods and privileges Table 17.
Status codes Table 19. Status codes for ComputerSystem HTTP status code Extended information 200 Base.1.0.success 400 • • • • • 500 Base.1.0.InternalError Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList Base.1.0.PropertyUnknown Base.1.0.PropertyNotWritable Base.1.0.PropertyValueFormatError Updatable properties Table 20.
Supported action — Reset Description Resets computer system. URL /redfish/v1/Systems//Actions/ComputerSystem.Reset HTTP methods and privileges Table 21. HTTP methods and privileges for Reset HTTP method Required privilege POST ConfigureComponent, ConfigureSelf Properties and values Table 22. Properties and values for Reset Property Value ResetType • • • • • On ForceOff GracefulRestart PushPowerButton NMI Status codes Table 23.
HTTP methods and privileges Table 24. HTTP methods and privileges for DellJob HTTP method Required privilege GET Login POST SystemControl Properties required for job creation Table 25. Properties required for job creation for DellJob Parameter Description TargetSettingsURI Settings object resource URI StartTime Scheduled start time EndTime Scheduled end time Status codes Table 26. Status codes for DellJob HTTP status code Extended information 200 Base.1.0.Success 400 • • 403 Base.1.0.
Status codes Table 28. Status codes for the instance of the resource HTTP status code Extended information 200 Base.1.0.Success 400 • • 403 Base.1.0. InsufficientPrivilege 404 Base.1.0.ResourceMissingAtURI 500 Base.1.0.InternalError Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList EventDestination Description This property contains a URL to the destination where the events are sent. URL /redfish/v1/EventService/Subscriptions HTTP methods and privileges Table 29.
Table 31. Status codes for EventDestination(continued) HTTP status code Extended information 201 400 • • • • • 404 Base.1.0.ResourceMissingAtURI 500 Base.1.0.InternalError Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList Base.1.0.PropertyUnknown Base.1.0.PropertyNotWritable Base.1.0.PropertyValueFormatError 503 Bios Description The Bios schema contains properties related to the BIOS Attribute Registry.
URL /redfish/v1/Systems/System.Embedded.1/Bios/Actions/Bios.ChangePassword Supported HTTP Method and Privileges HTTP Method Required Privilege POST ConfigureComponents, Login Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.2.Success RAC1133 405 Base.1.2.GeneralError SYS402 Supported Action — ClearPending Description This action is used to clear all the pending values. URL /redfish/v1/Systems/System.Embedded.1/Bios/Settings/Actions/Oem/DellManager.
Supported HTTP Method and Privileges HTTP Method Required Privilege POST ConfigureComponents, Login Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.2.Success RAC1133 405 Base.1.2.GeneralError SYS402 Settings resource Description This resource is used for representing the pending configuration and related resources to clear pending and navigation to Jobs resource.
Table 34. Status codes for the Settings resource(continued) HTTP status code Extended information 400 • • • Error Code Base.1.2.PropertyMissing Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList 400 SYS426, SYS011, SYS428, SYS405, SUP017, SUP447 403 500 BootOption Description A Collection of BootOption resource instances. URL /redfish/v1/Systems/System.Embedded.
HTTP Method Required Privilege PATCH ConfigureComponents, Login Updatable Properties • BootOptionEnabled Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.2.Success SYS430, SYS455 400 Base.1.2.InternalError SYS446 400 Base.1.2.PropertyMissing 400 Base.1.2.MalformedJSON 400 SYS405 SYS406, SYS434 403 InsufficientPrivilege RAC0506 403 LIC501 404 Base.1.2.ResourceMissingAtURI 405 SYS403 SYS402 500 Base.1.2.
HTTP Status Code Extended Information 405 500 Error Code SYS402 Base.1.2.
URL /redfish/v1/Chassis/System.Embedded.1/Actions/Chassis.Reset Supported HTTP Method and Privileges HTTP Method Required Privilege POST ConfigureComponents, Login Action Parameters Parameter Value ResetType On, ForceOff Supported Status Codes HTTP Status Code Extended Information Error Message Code 400 Base.1.2.PropertyValueNotInList SYS426 404 Base.1.2.ResourceMissingAtURI SYS403 204 409 PSU501, PSU502 500 Base.1.2.
Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 500 SYS403 SYS402 Base.1.2.
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 Supported Action — Reset on page 38 Supported Action — Reset Description This action is used to reset the system. URL /redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.
LogEntry Description This resource represents the log format for log services in a Redfish implementation. URL /redfish/v1/Managers//Logs HTTP methods and privileges Table 35. HTTP methods and privileges for LogEntry HTTP method Required privilege GET Login Status codes Table 36.
Table 38. Status codes for the resource(continued) HTTP status code Extended information 500 Logs — System Event Logs URL /redfish/v1/Managers//Logs/Sel Description This resource represents the System Event Logs for the manager in a Redfish implementation. HTTP methods and privileges Table 39. HTTP methods and privileges for the resource HTTP method Required privilege GET Login Status codes Table 40.
Status codes Table 42. Status codes for Manager HTTP status code 200 400 500 Updatable properties Table 43. Properties and values for Manager Property Values ManagerType BMC CommandConnectTypesSupported • • • GraphicalConnectTypesSupported KVMIP ResetType GracefulRestart SSH Telnet IPMI Supported action — Reset Description This defines the name of the custom action supported when used in conjunction with a POST operation to this resource.
Status codes Table 46. Status codes for Reset HTTP status code Extended information 204 400 • • • • • 500 Base.1.0.InternalError Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList Base.1.0.PropertyUnknown Base.1.0.PropertyNotWritable Base.1.0.PropertyValueFormatError ManagerAccount Description This resource represents the BMC user accounts collection for a Redfish implementation. URL /redfish/v1/Managers//Accounts HTTP methods and privileges Table 47.
Table 49. Properties and values for instance of the resource(continued) Property Value Password Updates account password RoleId Updates account role Enabled Enables or disables the user Status codes Table 50. Status codes for the instance of the resource HTTP status code Error message code 200 400 • • RAC0288 RAC0291 404 500 DellAttributes Description DellAttributes contains properties of additional properties to complement the Attribute Registry DMTF schema.
Table 51. Status codes(continued) HTTP status code Extended information 400 Base.1.0.PropertyValueNotInList, Base.1.0.PropertyValueTypeError 500 Base.1.0.InternalError Supported action —ClearPending Description This action is used to clear all the pending values. URL /redfish/v1/Managers/System.Embedded.1/Attributes/Settings/Actions/Oem/ DellManager.ClearPending Supported HTTP Method and Privileges HTTP Method Required Privilege POST ConfigureManager, Login Status codes Table 52.
HTTP methods and privileges Table 53. HTTP methods and privileges for the resource HTTP method Required privilege GET Login Status codes Table 54. Status codes HTTP status code Extended information 200 Base.1.0.0.Success 405 Base.1.0.GeneralError 500 Base.1.0.InternalError Error message code SYS402 Memory — Instance Description This resource is used to represent the memory instance for a Redfish implementation. URL /redfish/v1/Systems/System.Embedded.1/Memory/iDRAC.Embedded.
URL /redfish/v1/Systems/System.Embedded.1/Memory/iDRAC.Embedded.1#DIMMSlotA1/Metrics HTTP methods and privileges Table 57. HTTP methods and privileges for the resource HTTP method Required privilege GET Login Status codes Table 58. Status codes HTTP status code Extended information Error message code 200 Base.1.0.0.success RAC0690 405 Base.1.0.GeneralError SYS402 500 Base.1.0.
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. URL /redfish/v1/Systems//BootSources/Settings HTTP methods and privileges Table 61. HTTP methods and privileges for the Settings resource HTTP method Required privilege GET Login PATCH SystemControl POST ConfigureComponents, Login Updatable properties Table 62.
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. URL /redfish/v1/Systems//BootSources/BootSourcesRegistry HTTP methods and privileges Table 64.
HTTP methods and privileges Table 66. HTTP methods and privileges for Install HTTP method Required privilege POST • • • .d9 file type — ConfigureComponents, Login .pm file type — ConfigureComponents, Login .exe file type — ConfigureComponents, Login Updatable properties Table 67. Properties and values for Install Property Values InstallUpon • • • Now NowAndReboot NextReboot Status codes Table 68.
For more information about this schema, the location header, and other details, see the RESTful Server Configuration with iDRAC REST API white paper at dell.com/support. 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.
Export resource URL and response details URL redfish/v1/Managers//Actions/Oem/EID_674_Manager.ExportSystemConfiguration Properties and values Table 73. Properties and values for the action Property Values ExportFormat XML, JSON ExportUse Default, Clone, Replace IncludeInExport Default, IncludeReadOnly, IncludePasswordHashValues ShareParameters See Share parameters and values on page 52. Status codes Table 74.
Status codes Table 76. Status codes for the action HTTP status code Extended information Error Message Code 202 400 Base.1.2.PropertyMissing 400 Base.1.2.PropertyValueTypeError 400 Base.1.2.PropertyValueNotInList 400 RAC013, SYS406, SYS433, RAC1155 500 Base.1.2.InternalError SWC0058 503 RAC052 503 RAC0679 Preview resource URL and response details URL redfish/v1/Managers//Actions/Oem/EID_674_Manager.ImportSystemConfigurationPreview Status codes Table 77.
Table 78. Share parameters and values(continued) Parameter Values Target Can be the component name or an FQDD. The default value is ALL. Drive Description The Drive schema represents a single physical disk drive for a system, including links to associated Volumes.
Supported HTTP Method and Privileges HTTP Method Required Privilege POST ConfigureComponents, Login Supported Parameters Parameter Value HotspareType None, Global, Dedicated, EncryptionStatus Unencrypted, Unlocked, Locked, Foregin, EncryptionAbility None, SelfEncryptingDrive, MediaType HDD, SSD Supported Status Codes HTTP Status Code Extended Information 200 Base.1.0.
NetworkAdapter collection Description This resource is used to represent the collection of server network adapters for a Redfish implementation. NOTE: The Manufacturer, Model, Serial Number, and Part Number attributes are not applicable for embedded NICs. URL /redfish/v1/Systems/System.Embedded.1/NetworkAdapters HTTP methods and privileges Table 79. HTTP methods and privileges for NetworkAdapter HTTP method Required privilege GET Login Status codes Table 80.
Status codes Table 82. Status codes HTTP status code Extended information Error message code 405 Base.1.0.GeneralError SYS402 500 Base.1.0.InternalError 200 NetworkPort Description This resource is used to represent the collection of NetworkPort. URL /redfish/v1/Systems/System.Embedded.1/NetworkInterfaces//NetworkPorts (Logical) /redfish/v1/Systems/System.Embedded.1/NetworkAdapters//NetworkPorts (Physical) HTTP methods and privileges Table 83.
Status codes Table 86. Status codes HTTP status code Extended information Error message code 405 Base.1.0.GeneralError SYS402 500 Base.1.0.InternalError 200 NetworkPort — Settings Description This resource is used to set new values and create jobs to update the attributes of the discrete physical port. URL /redfish/v1/Systems/System.Embedded.1/NetworkAdapters//Settings HTTP methods and privileges Table 87.
Updatable properties Table 90. Properties for the Settings resource Property Description @Redfish.SettingsApplyTime Define when the settings are applied. This is supported on the Settings URL. Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 SYS403 SYS402 500 Base.1.2.
HTTP methods and privileges Table 92. HTTP methods and privileges for the resource HTTP method Required privilege GET Login PATCH Login + SystemControl Required parameters Table 93. Parameters for NetworkDeviceFunction Settings Parameter Type Description MaxVirtualFunctions Int64 The number of virtual functions (VFs) that are available for this Network Device Function. NetDevFuncCapabilities Collection(NetworkDeviceFunction.v1_0_0.Netwo Capabilities of this network device function.
Table 93. Parameters for NetworkDeviceFunction Settings(continued) Parameter Type Description LUNID String The Logical Unit Number (LUN) ID to boot from on the device referred to by the corresponding WWPN. MACAddress String The effective current MAC Address of this network device function. If an assignable MAC address is not supported, this is a read-only alias of the PermanentMACAddress.
Table 93. Parameters for NetworkDeviceFunction Settings(continued) Parameter Type Description SecondaryTargetTCPPort Int64 The TCP port for the Secondary iSCSI boot target. SecondaryLUN Int64 The logical unit number (LUN) for the Secondary iSCSI boot target. SecondaryVLANEnable Boolean It indicates if this VLAN is enabled for the Secondary iSCSI boot target. SecondaryVLANId Int64 The 802.1q VLAN ID to use for iSCSI boot from the Secondary target.
HTTP methods and privileges Table 95. HTTP methods and privileges for NetworkInterface HTTP method Required privilege GET Login Status codes Table 96. Status codes HTTP status code Extended information Error message code 405 Base.1.0.GeneralError SYS402 500 Base.1.0.
NOTE: Only device FQDDs that are associated with physical network controllers are displayed. If iSM is installed and running, and there are only software Ethernet interfaces available on the system, a response code of 200 and an empty collection is returned. URL /redfish/v1/Managers//EthernetInterfaces HTTP methods and privileges Table 99.
Table 101. Supported properties for EthernetInterfaces(continued) Property Type Read-only Description IPv6Static Array No Updates IPv6Static IPv6DefaultGateway String Yes This is the IPv6 default gateway address that is currently in use on this interface. IPv6StaticAddresses Array Yes Represents in an array all of the IPv6 static addresses to be assigned on this interface. LinkStatus String Yes The link status of this interface, or port.
HTTP Status Code Extended Information Error Code 405 SYS402 500 Base.1.2.InternalError SYS446 503 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.
Supported Action — SubmitTestEvent Description This action is used to generate a test event. URL /redfish/v1/EventService/Actions/EventService.SubmitTestEvent Supported HTTP Method and Privileges HTTP Method Required Privilege POST ConfigureManager, Login FabricCollection Description A Collection of Fabric resource instances.
Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 500 SYS403 SYS402 Base.1.2.InternalError SYS446 503 Contained resources Switches on page 111 HostInterfaceCollection Description A Collection of HostInterface resource instances. URL /redfish/v1/Managers/iDRAC.Embedded.
HTTP Status Code Extended Information Error Code 503 Navigation URL /redfish/v1/Managers/iDRAC.Embedded.1/HostInterfaces/ Supported HTTP Method and Privileges HTTP Method Required Privilege POST GET Login PATCH JSONSchemas Description This resource is used for representing the Schema File locator resource for a Redfish implementation. URL /redfish/v1/JSONSchemas HTTP methods and privileges Table 104.
LogEntryCollection Description A Collection of LogEntry resource instances. URL /redfish/v1/Managers/iDRAC.Embedded.1/Logs/FaultList Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 500 SYS403 SYS402 Base.1.2.
Supported Parameters Parameter Value OverWritePolicy WrapsWhenFull Supported Status Codes HTTP Status Code Extended Information Error Message Code 204 LogServiceCollection Description A Collection of LogService resource instances. URL /redfish/v1/Managers/iDRAC.Embedded.1/LogServices Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Supported Action — ClearLog on page 70 Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.
URL /redfish/v1/Managers/iDRAC.Embedded.1/LogServices/Sel/Actions/LogService.ClearLog Supported HTTP Method and Privileges HTTP Method Required Privilege POST ClearLogs, Login Supported Parameters Parameter Value OverWritePolicy WrapsWhenFull Supported Status Codes HTTP Status Code Extended Information Error Message Code 204 ManagerCollection Description A Collection of Manager resource instances.
Navigation URL /redfish/v1/Managers/ Supported HTTP Method and Privileges HTTP Method Required Privilege POST ConfigureManager, Login GET Login PATCH ConfigureManager, Login Updatable properties Property Value ManagerType BMC CommandConnectTypesSupported SSH, Telnet, IPMI GraphicalConnectTypesSupported KVMIP ResetType GracefulRestart Supported Status Codes HTTP Status Code Extended Information Error Message Code 400 MalformedJSON SYS405 400 Base.1.2.
URL /redfish/v1/Managers/iDRAC.Embedded.1/Actions/Manager.Reset Supported HTTP Method and Privileges HTTP Method Required Privilege POST ConfigureManager, Login Supported Status Codes Supported Status Codes HTTP Status Code Extended Information Error Message Code 400 MalformedJSON SYS405 400 Base.1.2.PropertyValueNotInList SYS426 204 400 SYS406 400 PropertyValueTypeError 403 InsufficientPrivilege 403 RAC0506 LIC501 404 Base.1.2.ResourceMissingAtURI SYS403 500 Base.1.2.
Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 SYS403 SYS402 500 Base.1.2.InternalError SYS446 503 Navigation URL /redfish/v1/Managers//Accounts/ HTTP methods and privileges Table 106. HTTP methods and privileges for the instance of the resource HTTP method Required privilege GET Login Updatable properties Table 107.
ManagerNetworkProtocol Description This resource is used to obtain or modify the network services managed by a given manager. URL /redfish/v1/Managers/iDRAC.Embedded.1/NetworkProtocol Supported HTTP Method and Privileges HTTP Method Required Privilege POST ConfigureManager, Login GET Login NOTE: For information about the DHCP version, execute GET on URL /redfish/v1/Managers/iDRAC.Embedded.
HTTP status code Extended information 500 Base.1.0.InternalError MemoryCollection Description A Collection of Memory resource instances. URL /redfish/v1/Systems/System.Embedded.1/Memory Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 SYS403 SYS402 500 Base.1.2.
Parameter Value MemoryDeviceType ROM SDRAM DDR DDR2 DDR3 DDR4 MemoryMedia null OperatingMemoryModes Null BaseModuleType Null MemoryType null Supported Status Codes HTTP Status Code Extended Information Error Message Code 405 Base.1.2.GeneralError IDRAC.1.6.SYS402 Supported Action — MemoryMetrics on page 77 Supported Action — MemoryMetrics Description MemoryMetrics contains usage and health statistics for a single Memory module or device instance. URL /redfish/v1/Systems/System.Embedded.
Supported HTTP Method and Privileges HTTP Method Required Privilege GET Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 SYS403 SYS402 500 Base.1.2.InternalError SYS446 503 MessageRegistryFileCollection Description A Collection of MessageRegistryFile resource instances.
Messages Description This resource is used to represent a Event and Error message registry for a Redfish implementation. URL /redfish/v1/Registries/Messages HTTP methods and privileges Table 109. HTTP methods and privileges for Messages HTTP method Required privilege GET Login Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 500 SYS403 SYS402 Base.1.2.
Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 SYS403 SYS402 500 Base.1.2.InternalError SYS446 503 NetworkDeviceFunctions Description This resource is used to represent the collection of NetworkDeviceFunction. URL /redfish/v1/Systems/System.Embedded.1/NetworkAdapters/
NetworkDeviceFunctions — Instance Description This resource is used to represent a logical interface exposed by the network adapter. URL /redfish/v1/Systems/System.Embedded.1/NetworkAdapters/ HTTP methods and privileges Table 112. HTTP methods and privileges for the instance of NetworkDeviceFunctions HTTP method Required privilege GET Login Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.
Table 114. Parameters for NetworkDeviceFunction Settings(continued) Parameter Type Description MaxVirtualFunctions Int64 The number of virtual functions (VFs) that are available for this Network Device Function. NetDevFuncCapabilities Collection(NetworkDeviceFunction.v1_0_0.Netwo Capabilities of this network device function. rkDeviceTechology) NOTE: The values of NetDevFuncCapabilities are determined by the port that the partition belongs to.
Table 114. Parameters for NetworkDeviceFunction Settings(continued) Parameter Type Description MTUSize Int64 The Maximum Transmission Unit (MTU) configured for this Network Device Function. This value serves as a default for the OS driver when booting. The value only takes effect on boot. IPAddressType NetworkDeviceFunction.v1_0_0.IPAddressType The type of IP address (IPv6 or IPv4) being populated in the iSCSIBoot IP address fields.
Table 114. Parameters for NetworkDeviceFunction Settings(continued) Parameter Type Description SecondaryDNS String The IPv6 or IPv4 address of the Secondary DNS server for the iSCSI boot initiator. IPMaskDNSViaDHCP Boolean A boolean indicating whether the iSCSI boot initiator uses DHCP to obtain the iniator name, IP address, and netmask. AuthenticationMethod NetworkDeviceFunction.v1_0_0.AuthenticationM ethod The iSCSI boot authentication method for this network device function.
HTTP Status Code Extended Information Error Code 404 Base.1.2.ResourceMissingAtURI SYS403 405 500 SYS402 Base.1.2.InternalError SYS446 503 PCIeDevice Description This is the schema definition for the PCIeDevice resource. It represents the properties of a PCIeDevice attached to a System. URL /redfish/v1/Systems/System.Embedded.1/PCIeDevice/ NOTE: Response for a Get operation for PCIe device will not report Part number or Model for any entry.
URL /redfish/v1/Systems/System.Embedded.1/PCIeFunction/ NOTE: If you execute Get on the above URL, the properties Bus /Device/ Function are not displayed. However, their value is displayed in the format for property id (for example <24-0-1>). Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.
Table 117. Status codes for Processor(continued) HTTP status code 400 500 Properties and values Table 118. Properties and values for Processor 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.
PortCollection Description PortCollection resource contains the members of selected pcie switch device. URL /redfish/v1/Fabrics/PCIe/Switches//Ports Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 SYS403 SYS402 500 Base.1.2.
Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 500 SYS403 SYS402 Base.1.2.InternalError SYS446 503 Reference Properties PowerControl on page 89 Voltage on page 89 PowerControl Description This is the base type for addressable members of an array. URL /redfish/v1/Chassis/System.Embedded.
PrivilegeRegistry Description This is the schema definition for Operation to Privilege mapping. The Privileges displayed for each entity are in accordance to the capabilities furnished in the corresponding schema and does not mandatorily imply support for that operation in the implementation. URL /redfish/v1/Managers/iDRAC.Embedded.
Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 500 SYS403 SYS402 Base.1.2.InternalError SYS446 503 Navigation URL /redfish/v1/Systems/System.Embedded.1/Processors/ Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.
Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 SYS402 500 Base.1.2.InternalError SYS446 503 RoleCollection Description A Collection of Role resource instances. URL /redfish/v1/Managers/iDRAC.Embedded.
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/System.Embedded.1/SecureBoot/Actions/SecureBoot.ResetKeys Supported HTTP Method and Privileges HTTP Method Required Privilege POST ConfigureComponents, Login Supported Status Codes HTTP Status Code Extended Information 200 Base.1.0.Success 400 Base.1.0.PropertyValueTypeError Error Message Code Base.1.0.PropertyValueNotInList 403 Base.1.0. InsufficientPrivilege 404 Base.1.0.ResourceMissingAtURI 500 Base.1.0.
Navigation URL /redfish/v1/Managers//SerialInterfaces/ Supported HTTP Method and Privileges HTTP Method Required Privilege POST ConfigureManager, Login GET Login PATCH ConfigureManager, Login Updatable properties Property Description SignalType Rs232 BitRate 9600, 19200, 38400, 57600, 115200 PinOut Cisco Parity None DataBits 8 StopBits 1 FlowControl Hardware PinOut Cisco ConnectorType DB9 Male ServiceRoot Description This object represents the root Redfish servic
Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI SYS403 405 SYS402 500 Base.1.2.InternalError SYS446 503 Session URL /redfish/v1/Sessions Description This resource is used to represent a session for a Redfish implementation. HTTP methods and privileges Table 119. HTTP methods and privileges for Session HTTP method Required privilege GET Login POST ConfigureManager Updatable properties Table 120.
Table 121. Status codes for Session(continued) HTTP status code Extended information • • • • 500 Base.1.0.PropertyValueNotInList Base.1.0.PropertyUnknown Base.1.0.PropertyNotWritable Base.1.0.PropertyValueFormatError Base.1.0.InternalError Action — Delete URL /redfish/v1/Sessions/ Description Performs delete operation on the session ID. HTTP methods and privileges Table 122.
Supported HTTP Method and Privileges HTTP Method Required Privilege PATCH ConfigureManager, Login Updatable properties Property Description SessionTimeout Updates web server timeout 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.
HTTP Status Code Extended Information Error Code 500 Base.1.2.InternalError SYS446 503 SoftwareInventoryCollection Description Collection of Firmware Inventory. URL /redfish/v1/UpdateService/FirmwareInventory Supported HTTP Method and Privileges HTTP Method Required Privilege POST ConfigureComponents, Login GET Login Status codes Table 125. Status codes for SoftwareInventory HTTP status code Extended information Error message code 201 400 • • • • SYS406 OSD35 SYS0604 SYS434 400 Base.1.
Navigation URL /redfish/v1/UpdateService/FirmwareInventory/ Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 SYS403 SYS402 500 Base.1.2.InternalError SYS446 503 Status codes Table 126. Status codes for the action HTTP status code Extended information Error message code 200 400 • • • SYS406 OSD35 RAC0604 400 Base.
URL /redfish/v1/Managers//SerialInterfaces HTTP methods and privileges Table 127. HTTP methods and privileges for SerialInterfaces HTTP method Required privilege GET Login Navigation URL /redfish/v1/Managers//SerialInterfaces/ HTTP methods and privileges Table 128. HTTP methods and privileges for the instance of the resource HTTP method Required privilege PATCH ConfigureManager Updatable properties Table 129.
Updatable properties Table 131. Properties and values for SerialInterfaces Property Values SignalType Rs232 BitRate • • • • • Parity None DataBits 8 StopBits 1 FlowControl Hardware PinOut Cisco ConnectorType DB9 Male 9600 19200 38400 57600 115200 StorageCollection Description A Collection of Storage resource instances. URL /redfish/v1/Systems/System.Embedded.
HTTP Status Code Extended Information Error Code 503 Navigation URL /redfish/v1/Systems/System.Embedded.1/Storage/ Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login POST ConfigureComponents, Login PATCH ConfigureComponents, Login Supported Status Codes HTTP Status Code Extended Information Error Code Base.1.2.
Table 133. Status codes(continued) HTTP status code Extended information 500 Base.1.0.InternalError Error message code NOTE: For more information on supported storage devices and operations, see the iDRAC User's Guide available at dell.com/idracmanuals. Storage — Instance Description This resource is used to return the status of the storage subsystem. It also returns the navigation URLs to the StorageContoller, Drive, and Volume collections, and the link to Chassis.
HTTP methods and privileges Table 136. HTTP methods and privileges for StorageController HTTP method Required privilege GET Login Status codes Table 137. Status codes HTTP status code Extended information Error message code 405 Base.1.0.GeneralError SYS402 500 Base.1.0.InternalError 200 Volume Description This resource is used to represent the collection of Volumes, as presented in the operating system.
Table 140. Status codes(continued) HTTP status code Extended information Error message code 202 400 • • 403 Base.1.0.InsufficientPrivilege RAC0506 405 Base.1.0.GeneralError SYS402 500 Base.1.0.InternalError Base.1.0.PropertyValueTypeError Base.1.0.PropertyUnknown Volume — Instance Description Volume instance represent the properties used to describe a volume. The volume can be a virtual disk or other logical storage entities as presented to the operating system.
Table 143. Status codes(continued) HTTP status code Extended information Error message code 403 Base.1.0.InsufficientPrivilege RAC0506 405 Base.1.0.GeneralError SYS402 500 Base.1.0.InternalError Supported action — Initialize Description This action is used to prepare the contents of the volume for use by the system. URL /redfish/v1/Systems/System.Embedded.1/Storage//Volumes// Actions/Volume.Initialize HTTP methods and privileges Table 144.
Table 147. HTTP methods and privileges for the action HTTP method Required privilege POST Login + SystemControl Status codes Table 148. Status codes HTTP status code Extended information Error message code 202 400 • • 403 Base.1.0.InsufficientPrivilege RAC0506 405 Base.1.0.GeneralError SYS402 500 Base.1.0.InternalError Base.1.0.PropertyValueTypeError Base.1.0.PropertyUnknown Drives Description This resource is used to represent the physical disks such as HDDs, SSDs, and NVMe SSDs.
HTTP methods and privileges Table 151. HTTP methods and privileges for SecureErase HTTP method Required privilege POST Login + SystemControl Status codes Table 152. Status codes HTTP status code Extended information Error message code 202 400 • • 403 Base.1.0.InsufficientPrivilege RAC0506 405 Base.1.0.GeneralError SYS402 500 Base.1.0.InternalError Base.1.0.PropertyValueTypeError Base.1.0.
Subscriptions Description This property contains a URL to the destination where the events are sent. URL /redfish/v1/EventService/Subscriptions HTTP methods and privileges Table 155. HTTP methods and privileges for EventDestination HTTP method Required privilege GET Login POST ConfigureManager Properties Table 156.
Switches Description A Collection of Switch resource instances. URL /redfish/v1/Fabrics/PCIe/Switches Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login TaskCollection Description A Collection of Task resource instances. URL /redfish/v1/TaskService/Tasks Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.
TaskService Description This is the schema definition for the Task Service. It represents the properties for the service itself and has links to the actual list of tasks. URL /redfish/v1/TaskService Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 SYS403 SYS402 500 Base.1.2.
Supported Parameters Parameter Value ReadingUnits RPM Reference Properties Temperature on page 113 Temperature Description Above normal range. URL /redfish/v1/Chassis/System.Embedded.1/Sensors/Temperatures/ Supported HTTP Method and Privileges HTTP Method Required Privilege POST ConfigureManager, Login GET Login PATCH ConfigureManager, Login Supported Parameters Parameter Value ReadingUnits RPM UpdateService Description This is the schema definition for the Update Service.
Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Supported action — SimpleUpdate Description This resource is used to represent extension of the UpdateService schema of Redfish. You can use the this action to update only one component at a time. If you attempt to update multiple components at once, error SYS442 is returned. To update multiple components, perform the updates one at a time.
Table 159. Status codes for SimpleUpdate(continued) HTTP status code Extended information Error Message Code 405 500 SYS402 Base.1.2.InternalError • • 503 SYS446 SUP1907 SUP0108 VirtualMedia Description This resource is used to represent a virtual media service for a Redfish implementation. NOTE: HTTP shares with authentication are not supported for virtual media. NOTE: Using the character '@' in virtual media User name or Password is not supported.
Table 162. Properties and values for VirtualMedia(continued) Property ConnectedVia Values • USBStick • • NotConnected Applet VLanNetworkInterface Description The value of this property indicates if VLAN is enabled for this interface. URL /redfish/v1/Systems//EthernetInterfaces//Vlans HTTP methods and response content type Table 163.
Supported HTTP Method and Privileges HTTP Method Required Privilege POST ConfigureComponents, Login GET Login Navigation URL /redfish/v1/Systems/System.Embedded.
Supported HTTP Method and Privileges HTTP Method Required Privilege POST ConfigureComponents, Login Supported Parameters Parameter Value VolumeType RawDevice, NonRedundant, Mirrored, StripedWithParity, SpannedMirrors, SpannedStripesWithParity EncryptionTypes NativeDriveEncryption, ControllerAssisted, SoftwareAssisted Supported Status Codes HTTP Status Code Extended Information 200 Base.1.0.
NetworkPort Description A Network Port represents a discrete physical port capable of connecting to a network. URL /redfish/v1/Systems/System.Embedded.1/NetworkAdapters/NIC.Embedded.2/NetworkPorts/ NIC.Embedded.2-1 Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 500 SYS403 SYS402 Base.1.2.
Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 SYS403 SYS402 500 Base.1.2.InternalError SYS446 503 NetworkDeviceFunctionCollection Description A Collection of NetworkDeviceFunction resource instances. URL /redfish/v1/Systems/System.Embedded.1/NetworkAdapters/NIC.Embedded.
URL /redfish/v1/Chassis/System.Embedded.1/Thermal/Redundancy/ iDRAC.Embedded.1%23SystemBoardFanRedundancy Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Supported Status Codes HTTP Status Code Extended Information Error Code 200 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 500 SYS403 SYS402 Base.1.2.
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 Examples for $expand Examples for $select Examples for $filter Example for GET URL /redfish/v1/Managers/iDRAC.Embedded.
} } Example for POST URL /redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.Reset Input {"ResetType":"ForceRestart"} 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.
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 { } "@Message.ExtendedInfo": [ { "Message": "Successfully Completed Request", "MessageArgs": [], "MessageArgs@odata.
Resource Type Example • https:///redfish/v1/Chassis/System.Embedded.1?$select=Status/State • https:///redfish/v1/Chassis/System.Embedded.1?$select=Assembly • https:///redfish/v1/Chassis/System.Embedded.1?$select=Links/ ComputerSystems • https:///redfish/v1/Chassis/System.Embedded.1?$select=Links/Oem/ Dell/DellEnclosureEMMCollection • https:///redfish/v1/Chassis/System.Embedded.1?$select=Location/ Placement • https:///redfish/v1/Chassis/System.Embedded.