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". | ||||||
| @Redfish.OperationApplyTimeSupport | Object | Expanded | ||||||
| SupportedValues | Array | Items: string Item count: 3 | ||||||
| SupportedValues[N] | String | “Immediate” “OnReset” “OnStartUpdateRequest” | ||||||
| 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 XCC2 reset. | ||||||
| HttpPushUriTargetsBusy | Boolean | An indication of whether any client has reserved the HttpPushUriTargets property. The value is initially false, and is not kept after XCC2 reset. | ||||||
| HttpPushUriOptions | Object | Expanded | ||||||
| HttpPushUriApplyTime | Object | Expanded | ||||||
| ApplyTime | String | “Immediate” | ||||||
| ApplyTime@Redfish.AllowableValues | Array | Items: string Item count: 2 | ||||||
| ApplyTime@Redfish.AllowableValues[N] | String | “Immediate” “OnReset” | ||||||
| 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”. | ||||||
| MultipartHttpPushUri@Redfish.OperationApplyTimeSupport | Object | Expanded | ||||||
| SupportedValues | Array | Items: string Item count: 3 | ||||||
| SupportedValues[N] | String | “Immediate” “OnReset” “OnStartUpdateRequest” | ||||||
| MaxImageSizeBytes | Integer | 250000000 | ||||||
| RemoteServerCertificates | Link | The link of the collection of CertificateCollection. | ||||||
| VerifyRemoteServerCertificate | Boolean | Indicates whether the Service will verify the certificate of the HTTPS server referenced by the ImageURI property in SimpleUpdate prior to sending the transfer request. Default value is false. | ||||||
Status code
| HTTP Status Code | Error Message ID |
|---|---|
| 500 | InternalError |
Example
The following example JSON response is returned:
{
"RemoteServerCertificates": {
"@odata.id": "/redfish/v1/UpdateService/RemoteServerCertificates"
},
"HttpPushUriTargets": [],
"FirmwareInventory": {
"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory"
},
"ServiceEnabled": true,
"MultipartHttpPushUri@Redfish.OperationApplyTimeSupport": {
"@odata.type": "#Settings.v1_3_4.OperationApplyTimeSupport",
"SupportedValues": [
"Immediate",
"OnReset",
"OnStartUpdateRequest"
]
},
"@odata.type": "#UpdateService.v1_11_0.UpdateService",
"@odata.id": "/redfish/v1/UpdateService",
"Actions": {
"#UpdateService.SimpleUpdate": {
"target": "/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate",
"title": "SimpleUpdate",
"Targets@Redfish.AllowableValues": [
"/redfish/v1/UpdateService/FirmwareInventory/BMC-Backup"
],
"TransferProtocol@Redfish.AllowableValues": [
"TFTP",
"SFTP",
"HTTPS",
"HTTP"
],
"@Redfish.ActionInfo": "/redfish/v1/UpdateService/SimpleUpdateActionInfo",
"@Redfish.OperationApplyTimeSupport": {
"@odata.type": "#Settings.v1_3_4.OperationApplyTimeSupport",
"SupportedValues": [
"Immediate",
"OnReset",
"OnStartUpdateRequest"
]
}
},
"Oem": {
"#LenovoUpdateService.BundleRollback": {
"target": "/redfish/v1/UpdateService/Actions/Oem/LenovoUpdateService.BundleRollback",
"title": "BundleRollback"
},
"#LenovoUpdateService.UpdateFromRepository": {
"target": "/redfish/v1/UpdateService/Actions/Oem/LenovoUpdateService.UpdateFromRepository",
"title": "UpdateFromRepository"
},
"#LenovoUpdateService.GetRepoUpdateDetail": {
"target": "/redfish/v1/UpdateService/Actions/Oem/LenovoUpdateService.GetRepoUpdateDetail",
"title": "GetRepoUpdateDetail"
}
},
"#UpdateService.StartUpdate": {
"target": "/redfish/v1/UpdateService/Actions/UpdateService.StartUpdate",
"title": "StartUpdate",
"@Redfish.ActionInfo": "/redfish/v1/UpdateService/StartUpdateActionInfo"
}
},
"MaxImageSizeBytes": 250000000,
"HttpPushUriOptions": {
"HttpPushUriApplyTime": {
"ApplyTime": "Immediate",
"ApplyTime@Redfish.AllowableValues": [
"Immediate",
"OnReset"
]
}
},
"@odata.etag": "\"12fc6cd9e7d7735944e43b\"",
"HttpPushUri": "/fwupdate",
"MultipartHttpPushUri": "/mfwupdate",
"Description": "Lenovo firmware update service.",
"HttpPushUriTargetsBusy": false,
"Name": "Update Service",
"Oem": {
"Lenovo": {
"BundleRepoAvailableSpaceInKB": 2004634,
"FirmwareServices": {
"@odata.id": "/redfish/v1/UpdateService/Oem/Lenovo/FirmwareServices"
},
"@odata.type": "#LenovoUpdateService.v1_0_0.LenovoUpdateService"
}
},
"VerifyRemoteServerCertificate": false,
"@odata.context": "/redfish/v1/$metadata#UpdateService.UpdateService",
"Status": {
"HealthRollup": "OK",
"State": "Enabled",
"Health": "OK"
},
"Id": "UpdateService"
}