API Guide

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.
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.
Redfish-based systems management
15