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
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
Indicates whether this service
is enabled
/redfish/v1/
EventService
EventService_v1.xml
POST Register an event notification
receiver
/redfish/v1/
EventService/
Subscriptions
EventDestination.xml
DELETE Remove a subscription
/redfish/v1/
EventService/
Subscriptions/
<Subscription ID>
EventService.xml
Updating firmware using SimpleUpdate
Using Redfish API you can update the iDRAC, BIOS, and all device firmware. The firmware image can be uploaded locally or
using HTTP share. Depending on the component, to apply the update the system automatically reboots or requires a manual
reboot.
NOTE: Redfish API only supports uploading one firmware image at a time.
Updating firmware using a local image
To perform a component firmware update using the image file available on the local system:
1. To get the value of header ETag, execute GET on SoftwareInventoryCollection URL
/redfish/v1/UpdateService/FirmwareInventory
2. Upload the package by executing POST on SoftwareInventoryCollection with additional header as Content-Type
and value multipart/form-data and header if-Match with ETag as value.
Once the upload is complete, the firmware image is represented with (available package)
/redfish/v1/UpdateService/FirmwareInventory/Available
along with component and version ids.
3. Execute POST on URL SimpleUpdate with the available package URL (/redfish/v1/UpdateService/Actions/
UpdateService.SimpleUpdate) added in 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 status of the job.
Redfish-based systems management 15