API Guide
Table Of Contents
- iDRAC8 with Lifecycle Controller Version 2.70.70.70 Redfish API Guide
- Contents
- Overview
- Redfish-based systems management
- Redfish resources
- AccountService
- DellJobCollection
- AttributeRegistry
- BaseMessages
- AssemblyCollection
- Chassis
- ComputerSystem
- DellJob
- EventDestination
- Bios
- BIOS-Settings resource
- BootOption
- ChassisCollection
- ComputerSystemCollection
- LogEntry
- Manager
- ManagerAccount
- Memory collection
- DellBootSources
- Settings resource
- DellBootSourcesRegistry
- DellUpdateService
- DellManager
- Drive
- EthernetInterfaceCollection
- NetworkAdapter collection
- NetworkInterface collection
- EthernetInterfaces
- EventService
- FabricCollection
- PCIe
- HostInterfaceCollection
- JSONSchemas
- LogEntryCollection
- LogService
- LogServiceCollection
- ManagerCollection
- ManagerAccountCollection
- ManagerNetworkProtocol
- MemoryCollection
- MessageRegistryFile
- MessageRegistryFileCollection
- Messages
- NetworkAdapterCollection
- NetworkInterfaceCollection
- 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
- NetworkDeviceFunctionCollection
- Redundancy
- Examples
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.
NOTE: The name of the component being updated is not displayed in the JOB ID, instead it is displayed as a Firmware
update.
NOTE: While the firmware update job is in process, the JobState displays the status as scheduled, check the
PercentComplete function to get the status of the job.
2.
Reboot the system to apply the update by executing POST on URL Reset (/redfish/v1/Managers/iDRAC.Embedded.1/
Actions/Manager.Reset).
Query Parameters
There are various query parameters available that can be used to request information from a service. Features like filtering,
selecting, and expansion add support for query parameters on GET request to receive additional information. These features are
explained below:
● Select— The $select parameter indicates to the implementation that it should return a subset of the properties of the
resource based on the value of the select clause.
● Filter— The $filter parameter indicates to the implementation that it should include a subset of the members of a collection
based on the expression specified as the value of the filter clause. The $query parameter is a set of properties and literal
values with an operator.
● 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.
Supported Status Codes
HTTP Status Code
Extended Information Error Code
200
400 QueryNotSupported SYS457
400 MalformedJSON SYS405
401 Base.1.2.AccessDenied
404 Base.1.2.ResourceMissingAtURI SYS403
405 SYS402
500 Base.1.2.InternalError SYS446
503
16 Redfish-based systems management