GET – Properties for firmware update service
Use the GET method to retrieve the update service resource for Redfish service.
Request URL
GET https://<BMC_IPADDR>/redfish/v1/UpdateService
Response body
| Field | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
Id | String | “UpdateService” | ||||||
Name | String | "Update Service" | ||||||
Description | String | Lenovo firmware update service | ||||||
ServiceEnabled | Boolean | True. | ||||||
Status | Object | Expanded. | ||||||
HealthRollup | String | "OK". | ||||||
Health | String | "OK". | ||||||
State | String | "Enabled". | ||||||
Actions | Object | Expanded. | ||||||
#UpdateService.SimpleUpdate | Object | Expanded. | ||||||
@Redfish.ActionInfo | Link | “/redfish/v1/UpdateService/SimpleUpdateActionInfo” | ||||||
target | String | A link to the involved action. | ||||||
title | String | "SimpleUpdate". | ||||||
Targets@Redfish.AllowableValues | Link | "/redfish/v1/UpdateService/FirmwareInventory/BMC-Backup" | ||||||
TransferProtocol @Redfish.AllowableValues | Array | Allowable values for SimpleUpdate action Item: string Item count: 2 | ||||||
TransferProtocol @Redfish.AllowableValues[N] | String | "SFTP". "TFTP". | ||||||
HttpPushUri | Link | The URI used to perform an HTTP or HTTPS push update to the Update Service. Value is “/fwupdate”. | ||||||
HttpPushUriTargets | Array | Items: string Item count: 0-1 | ||||||
HttpPushUriTargets[N] | String | An array of URIs that indicate where to apply the update image. It is initially blank, and the value updated by client is not kept after XCC reset. | ||||||
HttpPushUriTargetsBusy | Boolean | An indication of whether any client has reserved the HttpPushUriTargets property. The value is initially false, and is not kept after XCC reset. | ||||||
HttpPushUriOptions | Object | Expanded | ||||||
HttpPushUriApplyTime | Object | Expanded | ||||||
ApplyTime | String | “Immediate” | ||||||
FirmwareInventory | Object | URI to the firmware info on the server | ||||||
MultipartHttpPushUri | String | The URI used to perform an HTTPS push update to the Service with a multipart formatted request body; value is “/mfwupdate”. | ||||||
MaxImageSizeBytes | Integer | 250000000 | ||||||
Status code
| HTTP Status Code | Error Message ID |
|---|---|
| 500 | InternalError |
Example
The following example JSON response is returned:
{
"MultipartHttpPushUri": "/mfwupdate",
"Id": "UpdateService",
"ServiceEnabled": true,
"HttpPushUri": "/fwupdate",
"HttpPushUriTargets": [],
"Description": "Lenovo firmware update service.",
"FirmwareInventory": {
"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory"
},
"Status": {
"HealthRollup": "OK",
"Health": "OK",
"State": "Enabled"
},
"Name": "Update Service",
"HttpPushUriTargetsBusy": false,
"Oem": {
"Lenovo": {
"FirmwareServices": {
"@odata.id": "/redfish/v1/UpdateService/Oem/Lenovo/FirmwareServices"
},
"@odata.type": "#LenovoUpdateService.v1_0_0.LenovoUpdateService"
}
},
"@odata.type": "#UpdateService.v1_6_0.UpdateService",
"Actions": {
"#UpdateService.SimpleUpdate": {
"target": "/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate",
"title": "SimpleUpdate",
"TransferProtocol@Redfish.AllowableValues": [
"TFTP",
"SFTP"
],
"Targets@Redfish.AllowableValues": [
"/redfish/v1/UpdateService/FirmwareInventory/BMC-Backup"
],
"@Redfish.ActionInfo": "/redfish/v1/UpdateService/SimpleUpdateActionInfo"
}
},
"MaxImageSizeBytes": 250000000,
"@odata.etag": "\"593b8fa08d40fe0001e39baf3ac3094a\"",
"HttpPushUriOptions": {
"HttpPushUriApplyTime": {
"ApplyTime": "Immediate"
}
},
"@odata.id": "/redfish/v1/UpdateService"
}