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 Chapter 1: Overview...................................................................................................................... 7 New in this release.............................................................................................................................................................. 7 Benefits...............................................................................................................................................................................
ComputerSystemCollection............................................................................................................................................ 36 Supported Action — Reset.......................................................................................................................................38 LogEntry..............................................................................................................................................................................
NetworkInterfaceCollection............................................................................................................................................84 PCIeDevice..........................................................................................................................................................................84 PCIeFunction....................................................................................................................................................
Example of Job Creation................................................................................................................................................123 Examples for $expand.................................................................................................................................................... 124 Examples for $select....................................................................................................................................................
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.
Redfish configuration You can configure the Redfish interface on iDRAC by enabling or disabling the iDRAC attribute. If this attribute is disabled, HTTPS requests to Redfish URIs fail with an HTTP status code of 404 and an error message indicating that this attribute is disabled. 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.
Table 1. Redfish authentication and authorization (continued) Redfish actions Authentication required Authorization required View OData service document No No View message registry No No View Redfish version URI No No View JSONSchemaFile resource URI No No View JSON schemas URI No No The Redfish service provides access to Redfish URLs by using the following methods: ● Basic authentication: In this method, user name and password are provided for each Redfish API request.
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.
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. HTTP headers The server response contains only basic information about related resources. Any metadata that is required to process a request or response is accessed by using HTTP headers.
SSL certificates of iDRAC iDRAC includes a web server that uses the industry-standard SSL security protocol to transfer encrypted data over a network. Built upon asymmetric encryption technology, SSL is widely accepted for providing authenticated and encrypted communication between clients and servers to prevent eavesdropping across a network. By default, the iDRAC web server has a Dell self-signed SSL digital certificate. Redfish service reuses this certificate installed on the iDRAC web server.
Configure iDRAC Eventing operations The Redfish event service provides the following URIs: Table 3. Eventing operations HTTP method type Description URI Metadata reference GET Get detailed information about Event Service /redfish/v1/ EventService EventService.xml PATCH Property Name: ServiceEnabled /redfish/v1/ EventService EventService_v1.xml Indicates whether this service is enabled POST Register an event notification receiver /redfish/v1/ EventService/ Subscriptions EventDestination.
4. Reboot the system to apply the update by executing POST on URL Reset (/redfish/v1/Managers/iDRAC.Embedded.1/ Actions/Manager.Reset). Updating firmware using HTTP share To perform a component firmware update using the image file from HTTP share: 1. Execute POST on URL SimpleUpdate (/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate) with an open HTTP share added in the payload. A job id gets created that can be used to check the status of the job.
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 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 ● 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. Properties and values for Reset Property Value ResetType ● On ● ForceOff Status codes Table 14.
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.
URL /redfish/v1/Managers//Jobs 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.
Status codes Table 28. Status codes for the instance of the resource HTTP status code Extended information 200 Base.1.0.Success 400 ● Base.1.0.PropertyValueTypeError ● Base.1.0.PropertyValueNotInList 403 Base.1.0. InsufficientPrivilege 404 Base.1.0.ResourceMissingAtURI 500 Base.1.0.InternalError 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.
Supported Action — ChangePassword Description This action is used to change the BIOS passwords. 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.
Supported Action — ResetBios Description This action is used to reset the BIOS attributes to default. URL /redfish/v1/Systems/System.Embedded.1/Bios/Actions/Bios.ResetBios 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.
Updatable properties Table 33. Properties for the Settings resource Property Description Attributes Collection of all the attributes and their values supported by the BIOS configuration Status codes Table 34. Status codes for the Settings resource HTTP status code Extended information Error Code 202 400 ● Base.1.2.PropertyMissing ● Base.1.0.PropertyValueTypeErr or ● Base.1.0.
HTTP Status Code Extended Information Error Code 500 Base.1.2.InternalError SYS446 503 Instance URL /redfish/v1/Systems/System.Embedded.1/BootOptions/ Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login 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.
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.
HTTP Status Code Extended Information 500 Base.1.0.InternalError Supported action — Reset Description This action is used to reset the chassis. This action resets the chassis, not Systems or other contained resources, although side effects may occur which affect those resources. URL /redfish/v1/Chassis/System.Embedded.1/Actions/Chassis.
URL /redfish/v1/Systems 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.
Property BootSourceOverrideTarget UefiTargetBootSourceOverride 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 Action — Reset on page 38 Supported Action — Reset Description This action is used to reset the system. URL /redfish/v1/Systems/System.Embedded.
Supported Status Codes HTTP Status Code Extended Information Error Message Code 204 400 PropertyValueTypeError 400 Base.1.2.PropertyValueNotInList SYS426 404 Base.1.2.ResourceMissingAtURI SYS403 409 500 PSU501, PSU502 Base.1.2.InternalError SYS446 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 Table 37. HTTP methods and privileges for the resource HTTP method Required privilege GET Login Status codes Table 38. Status codes for the resource HTTP status code Extended information 200 400 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.
URL /redfish/v1/Managers HTTP methods and privileges Table 41. HTTP methods and privileges for Manager HTTP method Required privilege GET Login Status codes Table 42. Status codes for Manager HTTP status code 200 400 500 Updatable properties Table 43.
HTTP methods and privileges Table 44. HTTP methods and privileges for Reset HTTP method Required privilege POST ConfigureManager Updatable properties Table 45. Properties and values for Reset Property Value ResetType GracefulRestart 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.
HTTP methods and privileges Table 48. HTTP methods and privileges for the instance of the resource HTTP method Required privilege PATCH ConfigureManager Updatable properties Table 49. Properties and values for instance of the resource Property Value UserName Updates account user name Password Updates account password RoleId Updates account role Enabled Enables or disables the user Status codes Table 50.
Status codes Table 52. 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.1#DIMMSlotA1/ HTTP methods and privileges Table 53.
HTTP methods and privileges Table 55. HTTP methods and privileges for the resource HTTP method Required privilege GET Login Status codes Table 56. 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.InternalError DellBootSources Description This resource is used to represent the Dell Boot Sources Configuration and the related resources to the settings resource.
URL /redfish/v1/Systems//BootSources/Settings HTTP methods and privileges Table 59. HTTP methods and privileges for the Settings resource HTTP method Required privilege GET Login PATCH SystemControl POST ConfigureComponents, Login Updatable properties Table 60. Properties for the Settings resource Property Description Attributes Collection of all the attributes and their values supported for Boot Sources. Status codes Table 61.
HTTP methods and privileges Table 62. HTTP methods and privileges for DellBootSourcesRegistry HTTP method Required privilege GET Login Status codes Table 63. Status codes for DellBootSourcesRegistry HTTP status code Extended information 200 Base.1.0.Success 500 Base.1.0.InternalError DellUpdateService Description This action is used to perform firmware updates. Supported action — Install Description This resource is used to represent extension of the Update Service schema of Redfish.
Updatable properties Table 65. Properties and values for Install Property Values InstallUpon ● Now ● NowAndReboot ● NextReboot Status codes Table 66. Status codes for Install 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.0.InsufficientPrivilege RAC0506 403 LIC501 404 Base.1.0.
Supported action — Export, Import, and Preview Table 67. Supported HTTP methods and features HTTP method Feature POST Exporting configuration POST Importing configuration POST Preview configuration Export resource URL and response details URL redfish/v1/Managers//Actions/Oem/EID_674_Manager.ExportSystemConfiguration Properties and values Table 68.
Properties and values Table 70. Properties and values for the action Property Values ImportBuffer Buffer content to perform import. Required only for LOCAL and not required for CIFS, NFS, HTTP, or HTTPS. 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. ShareParameters See Share parameters and values on page 51. Status codes Table 71.
Table 72. Status codes for the action (continued) HTTP status code Extended information Error Message Code 503 RAC0679 Share parameters and values Table 73. 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 LOCAL, 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.
Supported Status Codes HTTP Status Code Extended Information Error Message Code 202 Supported Action—SecureErase Description This action is used to securely erase the contents of the drive. URL /redfish/v1/Systems//Storage/Drives//Actions/Drive.
URL /redfish/v1/Systems/System.Embedded.1/EthernetInterfaces 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 NetworkAdapter collection Description This resource is used to represent the collection of server network adapters for a Redfish implementation.
Table 75. Status codes (continued) HTTP status code Extended information Error message code 405 Base.1.0.GeneralError SYS402 500 Base.1.0.InternalError NetworkAdapter — Instance Description This resource is used to represent an instance of a server network adapter for a Redfish implementation. URL /redfish/v1/Systems/System.Embedded.1/NetworkAdapters/ HTTP methods and privileges Table 76.
HTTP methods and privileges Table 78. HTTP methods and privileges for NetworkPort HTTP method Required privilege GET Login Status codes Table 79. Status codes HTTP status code Extended information Error message code 405 Base.1.0.GeneralError SYS402 500 Base.1.0.InternalError 200 NetworkPort — Instance Description This resource is used to represent discrete physical port capable of connecting to a network. URL /redfish/v1/Systems/System.Embedded.
HTTP methods and privileges Table 82. HTTP methods and privileges for the resource HTTP method Required privilege GET Login Status codes Table 83. Status codes HTTP status code Extended information 200 400 500 Base.1.0.InternalError NetworkDeviceFunctions Description This resource is used to represent the collection of NetworkDeviceFunction. URL /redfish/v1/Systems/System.Embedded.1/NetworkAdapters/
HTTP Status Code Extended Information Error Code 503 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 86.
Required parameters Table 88. 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.Ne tworkDeviceTechology) Capabilities of this network device function. NOTE: The values of NetDevFuncCapabilities are determined by the port that the partition belongs to.
Table 88. Parameters for NetworkDeviceFunction Settings (continued) Parameter Type Description PermanentMACAddress String This is the permanent MAC address assigned to this network device function (physical function). 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.
Table 88. Parameters for NetworkDeviceFunction Settings (continued) Parameter Type Description 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. This VLAN ID is only used if SecondaryVLANEnable is true. SecondaryDNS String The IPv6 or IPv4 address of the Secondary DNS server for the iSCSI boot initiator.
Status codes Table 91. Status codes HTTP status code Extended information Error message code 405 Base.1.0.GeneralError SYS402 500 Base.1.0.InternalError 200 NetworkInterface — Contained resources Description NetworkInterface contains references linking NetworkAdapter, NetworkPort, and NetworkDeviceFunction resources and represents the functionality available to the containing system. URL /redfish/v1/Systems/System.Embedded.
URL /redfish/v1/Managers//EthernetInterfaces HTTP methods and privileges Table 94. HTTP methods and privileges for EthernetInterfaces 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.
Table 96. Supported properties for EthernetInterfaces (continued) Property Type Readonly Description 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 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 SYS403 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.
Contained Resource Subscriptions on page 109 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.
URL /redfish/v1/Fabrics/PCIe 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 Contained resources Switches on page 110 HostInterfaceCollection Description A Collection of HostInterface resource instances. URL /redfish/v1/Managers/iDRAC.Embedded.
HTTP Status Code Extended Information 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 500 Error Code SYS403 SYS402 Base.1.2.InternalError SYS446 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.
HTTP Status Code Extended Information Error Code 500 Base.1.2.InternalError SYS446 503 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 SYS403 SYS402 500 Base.1.2.
Supported HTTP Method and Privileges HTTP Method Required Privilege POST ClearLogs, Login GET Login PATCH ConfigureManager, Login 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.
HTTP Status Code Extended Information Error Code 503 Supported Action — ClearLog Description This action is used to clear the log for this Log Service. URL /redfish/v1/Managers/iDRAC.Embedded.1/LogServices/Sel/Actions/LogService.
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 Action — Reset Description The reset action resets/reboots the manager. 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.
HTTP methods and privileges Table 100. HTTP methods and privileges for ManagerAccount 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 Navigation URL /redfish/v1/Managers//Accounts/ HTTP methods and privileges Table 101.
Table 103. Status codes for the instance of the resource (continued) HTTP status code Error message code 404 500 Role on page 91 ManagerNetworkProtocol Description This resource is used to obtain or modify the network services managed by a given manager. URL /redfish/v1/Managers/iDRAC.Embedded.
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 403 Insufficient privileges 500 Base.1.0.InternalError MemoryCollection Description A Collection of Memory resource instances. URL /redfish/v1/Systems/System.Embedded.
Supported HTTP Method and Privileges HTTP Method Required Privilege POST Login, ConfigureComponents GET Login Supported Parameters Parameter Value ErrorCorrection NoECC SingleBitECC MultiBitECC AddressParity 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.
MessageRegistryFile Description This is the schema definition for the Schema File locator resource. URL /redfish/v1/Registries/Messages 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 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 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 104.
NOTE: The Manufacturer, Model, Serial Number, and Part Number attributes are not applicable for embedded NICs. URL /redfish/v1/Systems/System.Embedded.1/NetworkAdapters 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 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 107.
URL /redfish/v1/Systems/System.Embedded.1/NetworkAdapters//Settings HTTP methods and privileges Table 108. HTTP methods and privileges for the resource HTTP method Required privilege GET Login PATCH Login + SystemControl Required parameters Table 109.
Table 109. Parameters for NetworkDeviceFunction Settings (continued) Parameter Type Description FCoE VLAN ID is found via the FIP VLAN Discovery Protocol. FCoEActiveVLANId Int64 The active FCoE VLAN ID. WWPN String World-Wide Port Name (WWPN) to boot from. 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.
Table 109. Parameters for NetworkDeviceFunction Settings (continued) Parameter Type Description PrimaryVLANId Int64 The 802.1q VLAN ID to use for iSCSI boot from the primary target. This VLAN ID is only used if PrimaryVLANEnable is true. PrimaryDNS String The IPv6 or IPv4 address of the primary DNS server for the iSCSI boot initiator. SecondaryTargetName String The name of the Secondary iSCSI boot target (iSCSI Qualified Name, IQN).
NetworkInterfaceCollection Description A Collection of NetworkInterface resource instances. URL /redfish/v1/Systems/System.Embedded.1/NetworkInterfaces 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 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 PCIeFunction Description This is the schema definition for the PCIeFunction resource. It represents the properties of a PCIeFunction attached to a System. URL /redfish/v1/Systems/System.Embedded.
Processor Description This schema defines the processor resource. It represents the properties of a processor attached to a system. URL /redfish/v1/Systems//Processors HTTP methods and privileges Table 111. HTTP methods and privileges for Processor HTTP method Required privilege GET Login Status codes Table 112. Status codes for Processor HTTP status code 200 400 500 Properties and values Table 113.
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 500 SYS403 SYS402 Base.1.2.InternalError SYS446 503 PortCollection Description PortCollection resource contains the members of selected pcie switch device.
HTTP Status Code Extended Information Error Code 500 Base.1.2.InternalError SYS446 503 Power Description This is the schema definition for the Power Metrics. It represents the properties for Power Consumption and Power Limiting. URL /redfish/v1/Chassis/System.Embedded.1/Power 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 PATCH ConfigureManager, Login Voltage Description This is the base type for addressable members of an array. URL /redfish/v1/Chassis/System.Embedded.1/Sensors/Voltages/ Supported HTTP Method and Privileges HTTP Method Required Privilege POST ConfigureManager, Login GET Login PATCH ConfigureManager, Login PrivilegeRegistry Description This is the schema definition for Operation to Privilege mapping.
HTTP Status Code Extended Information 401 Base.1.2.AccessDenied 404 Base.1.2.ResourceMissingAtURI 405 Error Code SYS403 SYS402 500 Base.1.2.InternalError SYS446 503 ProcessorCollection Description A Collection of Processor resource instances. 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.
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 Role Description This resource defines a user role to be used in conjunction with a Manager Account. URL /redfish/v1/Managers/iDRAC.Embedded.
URL /redfish/v1/Managers/iDRAC.Embedded.1/Roles 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 SecureBoot Description This resource contains UEFI Secure Boot information. It represents properties for managing the UEFI Secure Boot functionality of a system.
Supported Status Codes HTTP Status Code Extended Information 200 Base.1.0.Success 200 Base.1.2.Success 400 Base.1.0.PropertyValueTypeError, Base.1.0.PropertyValueNotInList 403 Base.1.0. InsufficientPrivilege 404 Base.1.0.ResourceMissingAtURI 405 Base.1.2.GeneralError 500 Base.1.0.InternalError Error Code SYS413 SYS402 Supported Action — ResetKeys on page 93 Supported Action — ResetKeys Description This action is used to reset the Secure Boot keys. URL /redfish/v1/Systems/System.
SerialInterfaceCollection Description A Collection of SerialInterface resource instances. URL /redfish/v1/Managers//SerialInterfaces 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.
Property Description PinOut Cisco Parity None DataBits 8 StopBits 1 FlowControl Hardware PinOut Cisco ConnectorType DB9 Male ServiceRoot Description This object represents the root Redfish service. URL /redfish/ 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 500 SYS403 SYS402 Base.1.2.
Description This resource is used to represent a session for a Redfish implementation. HTTP methods and privileges Table 114. HTTP methods and privileges for Session HTTP method Required privilege GET Login POST ConfigureManager Updatable properties Table 115. Properties and values for Session Parameter Description UserName Username Password Password Status codes Table 116. Status codes for Session HTTP status code Extended information 200 201 400 ● ● ● ● ● 500 Base.1.0.
HTTP methods and privileges Table 117. HTTP methods and privileges for Delete HTTP method Required privilege DELETE ConfigureManager, Login Status codes Table 118. Status codes for Delete HTTP status code 200 400 500 SessionService Description This is the schema definition for the Session Service. It represents the properties for the service itself and has links to the actual list of sessions.
SimpleStorage Description This property contains the UEFI device path used to identify and locate a specific storage controller. URL /redfish/v1/Systems/System.Embedded.1/SimpleStorage/Controllers HTTP methods and privileges Table 119. HTTP methods and privileges for SimpleStorage 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.
Status codes Table 120. Status codes for SoftwareInventory HTTP status code Extended information Error message code 201 400 ● ● ● ● SYS406 OSD35 SYS0604 SYS434 400 Base.1.2.InternalError SYS446 403 Base.1.0.InsufficientPrivilege RAC0506 403 LIC501 404 Base.1.0. ResourceMissingAtURI SYS403 405 SYS402 412 SYS400 415 SYS4011 428 SYS404 500 Base.1.0.
Status codes Table 121. Status codes for the action HTTP status code Extended information Error message code 200 400 ● SYS406 ● OSD35 ● RAC0604 400 Base.1.2.InternalError SYS446 403 InsufficientPrivilege RAC0506 404 Base.1.2.ResourceMissingAtURI SYS403 405 SYS402 412 SYS400 428 SYS404 500 Base.1.2.InternalError SYS446 SerialInterfaces Description This resource is used to represent serial resources as part of the Redfish specification.
Updatable properties Table 124. Properties for the instance of the resource Property Description BitRate Updates the bit-rate InterfaceEnabled Updates InterfaceEnabled Status codes Table 125. Status codes for the instance of the resource 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.
URL /redfish/v1/Systems/System.Embedded.1/Storage 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/Systems/System.Embedded.
URL /redfish/v1/Systems/System.Embedded.1/Storage HTTP methods and privileges Table 127. HTTP methods and privileges for Storage HTTP method Required privilege GET Login Status codes Table 128. Status codes HTTP status code Extended information Error message code 405 Base.1.0.GeneralError SYS402 500 Base.1.0.InternalError 200 NOTE: For more information on supported storage devices and operations, see the iDRAC User's Guide available at dell.com/idracmanuals.
Table 130. Status codes (continued) HTTP status code Extended information Error message code 405 Base.1.0.GeneralError SYS402 500 Base.1.0.InternalError StorageController Description This resource is used to represent the properties of the storage controller. NOTE: The Links property represents NULL, because the Redundancy is not supported for StorageController. NOTE: StorageController is not applicable for NVMe. URL /redfish/v1/Systems/System.Embedded.
HTTP methods and privileges Table 133. HTTP methods and privileges for Volume HTTP method Required privilege GET Login POST Login + SystemControl Parameters Table 134. Parameters for POST operation Parameter Description VolumeType The type of the associated volume CapacityBytes The size in bytes of this volume — Optional Name Name of the virtual disk — Optional OptimumIOSizeBytes Stripe size for virtual disk — Optional Drives An array of references to the drives that contain this volume.
HTTP methods and privileges Table 136. HTTP methods and privileges for the instance of Volume HTTP method Required privilege GET Login PATCH Login + SystemControl DELETE Login + SystemControl Required parameters Table 137. Required parameters Parameter Description Encrypted Whether the volume is encrypted. @Redfish.SettingsApplyTime Defines when the settings are applied. This is supported on the Settings URL. — Optional Status codes Table 138.
Required parameters Table 140. Required parameter for the action Parameter Description InitializeType The type of initialization to be performed either Fast or Slow Status codes Table 141. Status codes HTTP status code Extended information Error message code 202 400 ● Base.1.0.PropertyValueTypeError ● Base.1.0.PropertyUnknown 403 Base.1.0.InsufficientPrivilege RAC0506 405 Base.1.0.GeneralError SYS402 500 Base.1.0.
Drives Description This resource is used to represent the physical disks such as HDDs, SSDs, and NVMe SSDs. URL /redfish/v1/Systems/System.Embedded.1/Storage//Drives/ HTTP methods and privileges Table 144. HTTP methods and privileges for Drives HTTP method Required privilege GET Login Status codes Table 145. Status codes HTTP status code Extended information Error message code 405 Base.1.0.GeneralError SYS402 500 Base.1.0.
Table 147. Status codes (continued) HTTP status code Extended information Error message code ● Base.1.0.PropertyUnknown 403 Base.1.0.InsufficientPrivilege RAC0506 405 Base.1.0.GeneralError SYS402 500 Base.1.0.InternalError Storage chassis Description This resource is used to represent storage chassis such as backplanes and JBODs. NOTE: The storage chassis does not support Chassis Reset . URL /redfish/v1/Chassis/ HTTP methods and privileges Table 148.
HTTP methods and privileges Table 150. HTTP methods and privileges for EventDestination HTTP method Required privilege GET Login POST ConfigureManager Properties Table 151. Properties for EventDestination Property Description Destination Destination IP to send event EventTypes Contains the type of the event Context Client-supplied string — Optional Protocol Protocol type used by event Status codes Table 152.
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.ResourceMissingAtURI 405 500 SYS403 SYS402 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 Thermal Description This is the schema definition for the Thermal properties. It represents the properties for Temperature and Cooling. URL /redfish/v1/Chassis/Chassis.Embedded.
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 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. If you use this action to update iDRAC, the update is applied immediately and the system reboots. For other components, the update is applied at the next reboot.
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. URL /redfish/v1/Managers//VirtualMedia HTTP methods and privileges Table 155. HTTP methods and privileges for VirtualMedia HTTP method Required privilege GET Login POST ConfigureManager, Login Status codes Table 156.
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 158. HTTP methods and response content type for VLanNetworkInterface HTTP method Response content type GET application/json Status codes Table 159.
Navigation URL /redfish/v1/Systems/System.Embedded.
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.Success Error Message Code 200 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.
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 Input Output /redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.Reset {"ResetType":"ForceRestart"} 204: No Content Example for DELETE URL Output /redfish/v1/EventService/Subscriptions/ 200 Ok { "INFO": " subscription deleted successfully" } Example of Job Creation Request Method POST URI https://100.101.18.90/redfish/v1/Managers/iDRAC.Embedded.
Response HTTP Status code: 200 Headers OData-Version: 4.0 Keep-Alive: timeout=60, max=199 Content-Type: application/json;odata.metadata=minimal;charset=utf-8 Server: Appweb/4.5.4 Location: /redfish/v1/Managers/iDRAC.Embedded.1/Jobs/JID_471269252011 Date: Thu, 06 Jan 2000 02:48:49 GMT Cache-Control: no-cache Content-Length: 501 Connection: Keep-Alive Access-Control-Allow-Origin: * Accept-Ranges: bytes BODY { } "@Message.
Examples for $select Resource Type Resource.Resource Example ● https:///redfish/v1/Chassis/System.Embedded.1?$select=AssetTag ● https:///redfish/v1/Chassis/System.Embedded.1?$select=Status ● 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.