GET – Firmware inventory properties
Use the GET method to retrieve each firmware info.
Request URL
GET https://<BMC_IPADDR>/redfish/v1/UpdateService/FirmwareInventory/{Id}
Response body
Field | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
Description | String | Description for the firmware. | ||||||
Id | String | The Id property uniquely identifies this firmware. | ||||||
Manufacturer | String | A string representing the manufacturer/producer of this firmware. | ||||||
Name | String | The name of this firmware. | ||||||
RelatedItem | Array | URI of the resources associated with this software inventory item. | ||||||
RelatedItem[N] | Object | Link to the manager resource. | ||||||
RelatedItem@odata.count | Number | The number of related items. | ||||||
ReleaseDate | String | Release date of this firmware. | ||||||
SoftwareId | String | A specific ID for identifying this firmware. | ||||||
Status | Object | Expanded. | ||||||
Health | String | "OK" | ||||||
State | String | The firmware inventory status such as “Enabled”, “Disabled”, “StandbySpare”. | ||||||
Updateable | Boolean | Indicates whether the firmware can be updated by redfish. | ||||||
Version | String | The firmware version number. In order to be identified by management software, the Version property value can be different to the Version string displayed in Web or Legacy CLI. | ||||||
WriteProtected | Boolean | true |
Status code
HTTP Status Code | Error Message ID |
---|---|
500 | InternalError |
Example
The following example JSON response describes the BMC (Primary) firmware information.
{
"@odata.context": "/redfish/v1/$metadata#SoftwareInventory.SoftwareInventory",
"@odata.etag": "\"2D7BADF2\"",
"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/BMC-Backup",
"@odata.type": "#SoftwareInventory.v1_3_0.SoftwareInventory",
"Description": "The information of Firmware:BMC firmware.",
"Id": "BMC-Backup",
"Manufacturer": "Lenovo",
"Name": "Firmware:BMC",
"Oem": {
...
}
},
"RelatedItem": [
{
"@odata.id": "/redfish/v1/Managers/1"
}
],
"RelatedItem@odata.count": 1,
"ReleaseDate": "2024-11-28T00:00:00Z",
"SoftwareId": "BMC-IHX4-10",
"Status": {
"Health": "OK",
"State": "StandbySpare"
},
"Updateable": true,
"Version": "07Y-0.80",
"WriteProtected": true
}
The following example JSON response describes firmware information of a network adapter.
{
"@odata.context": "/redfish/v1/$metadata#SoftwareInventory.SoftwareInventory",
"@odata.etag": "\"4FCB14A9\"",
"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/PCIeDevice_slot5_0x460000.Bundle",
"@odata.type": "#SoftwareInventory.v1_3_0.SoftwareInventory",
"Description": "The information of Firmware:DEVICE-Broadcom NetXtreme PCIe 1Gb 4-Port RJ45 Ethernet Adapter firmware.",
"Id": "PCIeDevice_slot5_0x460000.Bundle",
"Manufacturer": "Broadcom Limited",
"Name": "Firmware:DEVICE-Broadcom NetXtreme PCIe 1Gb 4-Port RJ45 Ethernet Adapter",
"RelatedItem": [
{
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot5_0x460000"
},
{
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot5_0x460000"
}
],
"RelatedItem@odata.count": 2,
"SoftwareId": "DEVICE-14E4-1657-17AA-402D-13",
"Status": {
"Health": "OK",
"State": "Enabled"
},
"Updateable": false,
"Version": "230.0.3.1",
"WriteProtected": true
}