iDRAC8/7 with Lifecycle Controller Version 2.60.60.
Notes, cautions, and warnings NOTE: A NOTE indicates important information that helps you make better use of your product. CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. Copyright © 2018 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries.
Contents 1 Overview........................................................................................................................................................ 6 New in this release............................................................................................................................................................. 6 Benefits.......................................................................................................................................................
EventDestination..............................................................................................................................................................35 EventService.....................................................................................................................................................................37 JSONSchemas................................................................................................................................................
VirtualMedia......................................................................................................................................................................89 4 Examples......................................................................................................................................................91 Example for GET.........................................................................................................................................................
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.
Key technologies Redfish uses web and cloud-based technologies that enable communications with servers using common programming and scripting languages such as Python, JAVA, and C. The key technologies are as follows: • REpresentational State Transfer (REST) interface — REST is a web based API, which provides a way to interact with a system over a normal web connection. It supports both HTTPS and HTTP.
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: In previous versions of Redfish implementation, # character was parsed as #. Because this character is treated as a break character by the code, any characters after # were ignored. Now, # character is automatically converted to %23. This conversion allows the consoles or REST clients to use the URL without any errors. Redfish configuration You can configure the Redfish interface on iDRAC by enabling or disabling the iDRAC attribute.
Table 1.
GET Use the GET method to retrieve a representation of a resource. The representation can either be a single resource or a collection. Depending on the media type, the service returns the resource representation by using one of the media types specified in the Accept 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.
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. iDRAC supports the following request headers: Header Description If-Match Supported only for AccountService URI. If-None-Match Supported only for AccountService and metadata URIs. Content-Length Returned on all responses except responses that have Transfer-Encoding: chunked.
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. You can replace the default SSL certificate with a certificate signed by a well-known Certificate Authority (CA). You can replace SSL certificates using the iDRAC interfaces such as web interface, RACADM, or WSMan. For more information on managing SSL certificates of iDRAC, see the latest iDRAC User’s Guide available at Dell.com/idracmanuals.
Table 2. 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 Indicates whether this service is enabled /redfish/v1/ EventService EventService_v1.xml POST Register an event notification receiver /redfish/v1/ EventService/ Subscriptions EventDestination.
3 Redfish resources This section describes the resource URIs and related operations that are available in the iDRAC implementation of a Redfish service API.
• UpdateService • VirtualMedia AccountService Description This resource is used to represent a management account service for a Redfish implementation. URL /redfish/v1/Managers//AccountService Methods and privileges Table 3. HTTP methods and privileges for AccountService HTTP method Required privilege GET Login AttributeRegistry Description An Attribute Registry is a set of key-value pairs that are specific to a particular implementation or product.
Supported status codes Table 5. Status codes and error message codes for AttributeRegistry HTTP status code Extended information 200 Base.1.0.Success 500 Base.1.0.InternalError 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 6. HTTP methods and privileges for BaseMessages HTTP method Required privilege GET Login Status codes Table 7.
BIOS Description This resource is used for representing the BIOS configuration and the related resources to Reset BIOS, Change Password, and the Settings resource. URL /redfish/v1/Systems//Bios Methods and privileges Table 8. Methods and privileges for BIOS HTTP method Required privilege GET Login Status codes Table 9. Status codes for BIOS HTTP status code Extended information 200 500 Base.1.0.
Methods and privileges Table 10. Methods and privileges for ResetBIOS HTTP method Required privilege POST SystemControl Status codes Table 11. Status codes for ResetBIOS 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 Supported action — ChangePassword Description This action is used for changing the BIOS passwords.
Updatable properties Table 13. Parameters for ChangePassword Property Description PasswordName The name of the BIOS password to change OldPassword The value of the existing password NewPassword The value of the new BIOS password Status codes Table 14. Status codes for ChangePassword 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.
Status codes Table 16. Status codes for ClearPending 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 Settings resource Description This resource is used for representing the BIOS pending configuration and related resources to clear pending and navigation to Jobs resource.
Status codes Table 19. Status codes for the Settings resource HTTP status code Extended information 200 Base.1.0.Success 400 • • 403 Base.1.0. InsufficientPrivilege 500 Base.1.0.InternalError Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList Chassis Description This resource is used to represent a chassis or other physical enclosure for a Redfish implementation. URL /redfish/v1/Chassis HTTP methods and privileges Table 20.
Status codes Table 22. Status codes for Chassis 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 23.
HTTP methods and privileges Table 24. HTTP methods and privileges for Reset HTTP method Required privilege POST ConfigureComponent Properties and values Table 25. Properties and values for Reset Property Value ResetType • • On ForceOff Status codes Table 26. 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.
Status codes Table 28. Status codes for the instance HTTP status code 200 400 500 NOTE: On PowerEdge FX2 systems, iDRAC can display additional instrumentation data from the sensors on the server only if the Chassis Monitoring setting is set to enabled on iDRAC and CMC. Contained resources • Power • Thermal 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 29.
HTTP methods and privileges Table 30. HTTP methods and privileges for the instance of the resource HTTP method Required privilege PATCH ConfigureManager, ConfigureSelf Status codes Table 31. 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.
Property Values • BiosSetup BootSourceOverrideMode • • UEFI Legacy BootSourceOverrideEnabled • • • Disabled Once Continuous UefiTargetBootSourceOverride Any valid UEFI-device path IndicatorLed • • Lit Off Implementation notes Some of the properties in this schema are dependent on the installed BIOS version. If a compatible BIOS version is not installed, the UefiTargetBootSourceOverride property is not supported in this resource. Supported action — Reset Description Resets computer system.
Property Value • • • GracefulRestart PushPowerButton NMI Status codes Table 35. Status codes for Reset HTTP status code Extended information 200 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.
Status codes Table 37. Status codes for DellBootSources HTTP status code Extended information 200 500 Base.1.0.InternalError Supported action — ClearPending Description This action is used to clear the pending values. URL /redfish/v1/Systems//BootSources/Actions/Oem/DellManager.ClearPending HTTP methods and privileges Table 38. HTTP methods and privileges for ClearPending HTTP method Required privilege POST SystemControl Status codes Table 39.
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 40. HTTP methods and privileges for the Settings resource HTTP method Required privilege GET Login PATCH SystemControl Updatable properties Table 41.
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 43.
HTTP methods and privileges Table 45. HTTP methods and privileges for DellJob HTTP method Required privilege GET Login POST SystemControl Properties required for job creation Table 46. 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 47. Status codes for DellJob HTTP status code Extended information 200 Base.1.0.Success 400 • • 403 Base.1.0.
HTTP methods and privileges Table 48. HTTP methods and privileges for the instance of the resource HTTP method Required privilege GET Login DELETE SystemControl Status codes Table 49. 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.
HTTP methods and privileges Table 50. HTTP methods and privileges for EthernetInterfaces HTTP method Required privilege GET Login Ethernet — Instance URL /redfish/v1/Managers//EthernetInterfaces/ HTTP methods and privileges Table 51. HTTP methods and privileges for instance of EthernetInterfaces HTTP method Required privilege PATCH ConfigureManager Properties Table 52.
HTTP status code 500 Extended information Error Message Code • • • Base.1.0.PropertyValueFormatError RAC0259 SWC0296 Base.1.0.InternalError Reference Properties /Systems//EthernetInterfaces Description This resource is used to represent NIC resources as part of the Redfish specification. HTTP methods and privileges Table 54. HTTP methods and privileges HTTP method Required privilege GET Login Status codes Table 55.
URL /redfish/v1/EventService/Subscriptions HTTP methods and privileges Table 56. HTTP methods and privileges for EventDestination HTTP method Required privilege GET Login POST ConfigureManager Properties Table 57. 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 58.
EventService Description It represents the properties for the service itself and has links to the actual list of subscriptions. NOTE: You can use the IgnoreCertificateErrors attribute in OEMAttributes to ignore certificate errors. URL /redfish/v1/EventService HTTP methods and privileges Table 59. HTTP methods and privileges for EventService HTTP method Required privilege GET Login Status codes Table 60.
HTTP methods and privileges Table 61. HTTP methods and privileges for JSONSchemas HTTP method Required privilege GET Login Status codes Table 62. Status codes for JSONSchemas HTTP status code 200 400 500 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 63.
Status codes Table 64. Status codes for LogEntry HTTP status code 200 400 500 Reference Properties /redfish/v1/Managers//Logs/Lclog Description This resource represents the Lifecycle Controller logs for the manager in a Redfish implementation. HTTP methods and privileges Table 65. HTTP methods and privileges for the resource HTTP method Required privilege GET Login Status codes Table 66.
Description This resource represents the System Event Logs for the manager in a Redfish implementation. HTTP methods and privileges Table 67. HTTP methods and privileges for the resource HTTP method Required privilege GET Login Status codes Table 68. Status codes for the resource HTTP status code Extended information 200 400 500 LogService Description This resource is used to represent a log service for a Redfish implementation.
Status codes Table 70. Status codes for LogService HTTP status code 200 400 500 Reference Properties /redfish/v1/Managers//LogServices/Lclog Description This resource represents the Lifecycle Controller log service in a Redfish implementation. HTTP methods and privileges Table 71. HTTP methods and privileges for the resource HTTP method Required privilege GET Login Status codes Table 72.
HTTP methods and privileges Table 73. HTTP methods and privileges for resource HTTP method Required privilege GET Login Status codes Table 74. Status codes for the resource HTTP status code 200 400 500 Supported action — ClearLog URL /redfish/v1/Managers//LogServices/Sel/Actions/LogService.ClearLog Description Performs clear operation on logs. HTTP methods and privileges Table 75.
HTTP status code Extended information • • • 500 Base.1.0.PropertyUnknown Base.1.0.PropertyNotWritable Base.1.0.PropertyValueFormatError Base.1.0.InternalError Manager Description This resource is used to represent a management sub-system for a Redfish implementation. URL /redfish/v1/Managers HTTP methods and privileges Table 77. HTTP methods and privileges for Manager HTTP method Required privilege GET Login Status codes Table 78.
Property Values • IPMI GraphicalConnectTypesSupported KVMIP ResetType GracefulRestart Supported action — Reset Description This defines the name of the custom action supported when used in conjunction with a POST operation to this resource. When issued, this operation performs a reset of the manager. URL /redfish/v1/Managers//Actions/Manager.Reset HTTP methods and privileges Table 80.
HTTP status code Extended information 500 Base.1.0.InternalError ManagerAccount Description This resource represents the BMC user accounts collection for a Redfish implementation. URL /redfish/v1/Managers//Accounts HTTP methods and privileges Table 83. HTTP methods and privileges for ManagerAccount HTTP method Required privilege GET Login Navigation URL /redfish/v1/Managers//Accounts/ HTTP methods and privileges Table 84.
Status codes Table 86. Status codes for the instance of the resource HTTP status code Error message code 200 400 • • RAC0288 RAC0291 404 500 Contained resources Role ManagerNetworkProtocol Description This object is used to represent the network service settings for the manager. URL /redfish/v1/Managers//NetworkProtocol HTTP methods and privileges Table 87.
Updatable properties Table 88. Properties for ManagerNetworkProtocol Property FQDN Hostname HTTP HTTPS IPMI KVMIP SNMP SSH Telnet VirtualMedia Status codes Table 89. Status codes for ManagerNetworkProtocol HTTP status code Extended information 200 Base.1.0.success 400 • • • • • 403 Insufficient privilegess. 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 90. HTTP methods and privileges for Role HTTP method Required privilege GET Login Status codes Table 91. Status codes for Role HTTP status code 200 400 500 SerialInterfaces Description This resource is used to represent serial resources as part of the Redfish specification. URL /redfish/v1/Managers//SerialInterfaces HTTP methods and privileges Table 92.
HTTP methods and privileges Table 93. HTTP methods and privileges for the instance of the resource HTTP method Required privilege PATCH ConfigureManager Updatable properties Table 94. Properties for the instance of the resource Property Description BitRate Updates the bit-rate InterfaceEnabled Updates InterfaceEnabled Status codes Table 95. 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.
Property Values Parity None DataBits 8 StopBits 1 FlowControl Hardware PinOut Cisco ConnectorType DB9 Male Memory collection Description This resource is used to represent the collection of server memory, including DIMMs and nonvolatile DIMMs (NVDIMMs), for a Redfish implementation. URL /redfish/v1/Systems/System.Embedded.1/Memory HTTP methods and privileges Table 97. HTTP methods and privileges for the resource HTTP method Required privilege GET Login Status codes Table 98.
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 99. HTTP methods and privileges for the instance of the resource HTTP method Required privilege GET Login Status codes Table 100. Status codes HTTP status code Extended information Error message code 200 Base.1.0.0.Success 404 Base.1.0.InternalError SYS403 405 Base.1.0.
Status codes Table 102. 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 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 103. HTTP methods and privileges for Messages HTTP method Required privilege GET Login Status codes 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 HTTP methods and privileges Table 105. HTTP methods and privileges for NetworkAdapter HTTP method Required privilege GET Login Status codes Table 106. Status codes HTTP status code Extended information Error message code 405 Base.1.0.GeneralError SYS402 500 Base.1.0.
Status codes Table 108. 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 109.
HTTP methods and privileges Table 111. HTTP methods and privileges for the instance of NetworkPort HTTP method Required privilege GET Login Status codes Table 112. 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.
URL /redfish/v1/Systems/System.Embedded.1/NetworkAdapters/
NetworkDeviceFunctions — Settings Description This resource is used to set the new value and create job to update the attributes of the logical interface exposed by the network adapter. URL /redfish/v1/Systems/System.Embedded.1/NetworkAdapters//Settings HTTP methods and privileges Table 119.
Parameter Type Description WWNN String The effective current World-Wide Node Name (WWNN) of this network device function (physical function). If an assignable WWNN is not supported, WWNN is a read only alias of the PermanentWWNN. WWNSource NetworkDeviceFunction.v1_0_0.WWNSourc e The configuration source of the World-Wide Names (WWNs) for this connection (WWPN and WWNN). FCoELocalVLANId Int64 For FCoE connections, The VLAN ID configured locally by setting this property.
Parameter Type Description InitiatorDefaultGateway String The IPv6 or IPv4 iSCSI boot default gateway. InitiatorNetmask String The IPv6 or IPv4 netmask of the iSCSI boot initiator. TargetInfoViaDHCP String A boolean indicating whether the iSCSI boot target name, LUN, IP address, and netmask should be obtained from DHCP. PrimaryTargetName String The name of the primary iSCSI boot target (iSCSI Qualified Name, IQN).
Parameter Type Description CHAPSecret String The shared secret for CHAP authentication. Extended information Error message code Status codes Table 121. Status codes HTTP status code 200 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.
HTTP status code Extended information 500 Base.1.0.InternalError Error message code 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.1/NetworkInterfaces/ HTTP methods and privileges Table 124.
Supported action — Export, Import, and Preview Table 126. 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 Supported status codes Table 127. Status codes for the action HTTP status code Extended information 202 Accepted Supported properties and values Table 128.
Supported properties and values Table 130. Supported properties and values for the action Property Values ImportBuffer Buffer content to perform import. Required only for local store 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.
Power Description This resource is used to represent a power metrics resource for a Redfish implementation. URL /redfish/v1/Chassis//Power HTTP methods and privileges Table 133. HTTP methods and privileges for Power HTTP method Required privilege GET Login Status codes Table 134. Status codes for Power HTTP status code Extended information 200 Base.1.0.Success 400 • • • • • 403 Insufficient privileges.
Description Updates the properties of PowerControl in Chassis Collection. HTTP methods and privileges Table 135. HTTP methods and privileges for the action HTTP method Required privilege GET Login PATCH ConfigureManager Updatable properties Table 136. Properties and values for the action Property Description PowerLimit Updates PowerLimit Status codes Table 137. Status codes for the action HTTP status code Extended information 200 Base.1.0.success 400 • • • • • 500 Base.1.0.
HTTP methods and privileges Table 138. HTTP methods and privileges for PowerSupplies HTTP method Required privilege GET Login Status codes Table 139. Status codes for PowerSupplies HTTP status code Extended information 200 400 403 Insufficient privileges. 500 Power — Voltage Sensor URL /redfish/v1/Chassis//Sensors/Voltages/ Description Provides the voltage sensor information. HTTP methods and privileges Table 140.
Power — Redundancy URL /redfish/v1/Chassis//Power/Redundancy/ Description This object represents the Redundancy element property. HTTP methods and privileges Table 142. HTTP methods and privileges for Power Redundancy HTTP method Required privilege GET Login Status codes Table 143. Status codes for Power Redundancy HTTP status code 200 400 500 SecureBoot Description This resource contains UEFI Secure Boot information.
Updatable properties Table 145. Properties and values for SecureBoot Property Description SecureBootEnable Enable or disable UEFI Secure Boot (takes effect on next boot). Status codes Table 146. Status codes for SecureBoot 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.
Updatable properties Table 148. Updatable properties Parameter Description ResetKeysType ResetAllKeysToDefault DeleteAllKeys DeletePK Supported status codes Table 149. Status codes and error messages for the action 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.
HTTP methods and privileges Table 150. HTTP methods and privileges for ServiceRoot HTTP method Required privilege GET Login Status codes Table 151. Status codes for ServiceRoot HTTP status code Extended information 200 400 403 Insufficient privileges. 500 Session URL /redfish/v1/Sessions Description This resource is used to represent a session for a Redfish implementation. HTTP methods and privileges Table 152.
Updatable properties Table 153. Properties and values for Session Parameter Description username User name password Password Status codes Table 154. Status codes for Session HTTP status code Extended information 200 201 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.
Status codes Table 156. Status codes for Delete HTTP status code 200 400 500 SessionService Description This resource is used to represent the Session Service properties for a Redfish implementation. URL /redfish/v1/SessionService HTTP methods and privileges Table 157. HTTP methods and privileges for SessionService HTTP method Required privilege GET Login PATCH ConfigureManager NOTE: The properties for this resource are inherited from the web-server properties. Updatable properties Table 158.
Status codes Table 159. Status codes for SessionService 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 Storage collection Description This resource is used to represent the collection of the storage subsystem under ComputerSystem. URL /redfish/v1/Systems/System.Embedded.
NOTE: For more information on supported storage devices and operations, see the iDRAC User's Guide available at www.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. NOTE: AutoExpand is True for StorageController. URL /redfish/v1/Systems/System.Embedded.
URL /redfish/v1/Systems/System.Embedded.1/StorageControllers/ HTTP methods and privileges Table 164. HTTP methods and privileges for StorageController HTTP method Required privilege GET Login Status codes Table 165. 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.
Parameters Table 167. 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. This references drives that either wholly or partly contain this volume. Status codes Table 168.
HTTP methods and privileges Table 169. HTTP methods and privileges for the instance of Volume HTTP method Required privilege GET Login PATCH Login + SystemControl DELETE Login + SystemControl Required parameters Table 170. 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 171.
Table 173. Required parameter for the action Parameter Description InitializeType The type of initialization to be performed either Fast or Slow Status codes Table 174. 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.
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 177. HTTP methods and privileges for Drives HTTP method Required privilege GET Login Status codes Table 178. Status codes HTTP status code Extended information Error message code 405 Base.1.0.GeneralError SYS402 500 Base.1.0.
Status codes Table 180. 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 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 .
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 183. HTTP methods and privileges for Processor HTTP method Required privilege GET Login Status codes Table 184. Status codes for Processor HTTP status code 200 400 500 Properties and values Table 185.
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 186. HTTP methods and privileges for SimpleStorage HTTP method Required privilege GET Login Status codes Table 187. Status codes for SimpleStorage HTTP status code Extended information 200 400 403 Insufficient privileges.
HTTP methods and response content type Table 188. HTTP methods and response content type for VLanNetworkInterface HTTP method Response content type GET application/json Status codes Table 189. Status codes for VLanNetworkInterface HTTP status code 200 400 500 TaskService Description This resource represents a task service for a Redfish implementation. URL /redfish/v1/TaskService HTTP methods and privileges Table 190.
Status codes Table 191. Status codes for TaskService HTTP status code 200 400 500 Tasks URL /redfish/v1/TaskService/Tasks/ Status codes Table 192. Status codes for Tasks HTTP status code Extended information 200 Ok 202 Accepted 404 Not Found Thermal Description This resource is used to represent the thermal matrices resource for a Redfish implementation.
HTTP methods and privileges Table 193. HTTP methods and privileges for Thermal HTTP method Required privilege GET Login Status codes Table 194. Status codes for Thermal HTTP status code 200 400 500 Reference properties /redfish/v1/Chassis//Sensors/Fans/ Description Provides details of the fan that is associated with the system or chassis. HTTP methods and privileges Table 195. HTTP methods and privileges for Fans HTTP method Required privilege GET Login Status codes Table 196.
NOTE: On PowerEdge FX2 systems, iDRAC can display additional instrumentation data from the sensors on the server only if the Chassis Monitoring setting is set to enabled on iDRAC and CMC. Thermal — Temperatures sensors URL /redfish/v1/Chassis//Sensors/Temperatures/ Description Represents the properties for temperature sensors. HTTP methods and privileges Table 197. HTTP methods and privileges for Temperatures Sensors HTTP method Required privilege GET Login Status codes Table 198.
Status codes Table 200. Status codes for Redundancy HTTP status code Extended information 200 400 403 Insufficient privileges. 500 UpdateService Description This represents the properties of the update service for the Redfish implementation. URL /redfish/v1/UpdateService HTTP methods and privileges Table 201. HTTP methods and privileges for UpdateService HTTP method Required privilege GET Login Required parameters Table 202.
Status codes Table 203. Status codes for UpdateService HTTP status code Extended information Error Message Code 200 OSD35, SUP024 403 Base.1.0. InsufficientPrivilege RAC0506 405 Base.1.0.GeneralError 404 Base.1.0. ResourceMissingAtURI SYS403 500 Base.1.0.InternalError RAC964 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.
Status codes Table 205. Status codes for SimpleUpdate 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 404 LIC501 Base.1.0. ResourceMissingAtURI 415 500 SYS403 SYS401 Base.1.0.
Status codes Table 207. Status codes for VirtualMedia HTTP status code Extended information 200 400 403 Insufficient privileges. 500 Properties and values Table 208.
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 Example for GET URL /redfish/v1/Managers/iDRAC.Embedded.1/SerialInterfaces Output { "@odata.
} } Example for POST URL /redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.Reset Input {"ResetType":"GracefulRestart"} 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.
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.
