Skip to main content

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

FieldTypeDescription

Id

String

UpdateService

Name

String

Update Service

Description

String

Lenovo firmware update service

Actions

Object

Expanded.

 

#UpdateService.SimpleUpdate

Object

Expanded.

  

@Redfish.ActionInfo

Link

/redfish/v1/UpdateService/SimpleUpdateActionInfo

  

@Redfish.OperationApplyTimeSupport

Object

Expanded.

   

SupportedValues

Array

“Immediate”

“OnReset”

“OnStartUpdateRequest”

  

Targets@Redfish.AllowableValues

Link

/redfish/v1/UpdateService/FirmwareInventory/BMC-Backup

  

TransferProtocol @Redfish.AllowableValues

Array

Allowable values for SimpleUpdate action

Item: string

Item count: 2

  

target

String

/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate

  

title

String

SimpleUpdate

 

#UpdateService.StartUpdate

Object

Expanded.

  

@Redfish.ActionInfo

Link

Expanded.

  

target

String

/redfish/v1/UpdateService/Actions/UpdateService.StartUpdate

  

title

String

StartUpdate

FirmwareInventory

Object

URI to the firmware info on the server

MaxImageSizeBytes

Integer

838860800 (800MB)

MultipartHttpPushUri

String

The URI used to perform an HTTPS push update to the Service with a multipart formatted request body; value is “/redfish/v1/UpdateService/update”.

MultipartHttpPushUri@Redfish.OperationApplyTimeSupport

Object

Expanded.

 

SupportedValues

Array

String

“Immediate”

“OnReset”

“OnStartUpdateRequest”

ServiceEnabled

Boolean

True.

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 CodeError Message ID
500InternalError

Example

The following example JSON response is returned:

{
"@odata.context": "/redfish/v1/$metadata#UpdateService.UpdateService",
"@odata.etag": "\"05C6DF5C\"",
"@odata.id": "/redfish/v1/UpdateService",
"@odata.type": "#UpdateService.v1_11_1.UpdateService",
"Actions": {
"#UpdateService.SimpleUpdate": {
"@Redfish.ActionInfo": "/redfish/v1/UpdateService/SimpleUpdateActionInfo",
"@Redfish.OperationApplyTimeSupport": {
"@odata.type": "#Settings.v1_3_5.OperationApplyTimeSupport",
"SupportedValues": [
"Immediate",
"OnStartUpdateRequest",
"OnReset"
]
},
"Targets@Redfish.AllowableValues": [
"/redfish/v1/UpdateService/FirmwareInventory/BMC-Backup"
],
"TransferProtocol@Redfish.AllowableValues": [
"TFTP",
"SFTP",
"HTTP",
"HTTPS"
],
"target": "/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate",
"title": "SimpleUpdate"
},
"#UpdateService.StartUpdate": {
"@Redfish.ActionInfo": "/redfish/v1/UpdateService/StartUpdateActionInfo",
"target": "/redfish/v1/UpdateService/Actions/UpdateService.StartUpdate",
"title": "StartUpdate"
},
"Oem": {
...
}
}
},
"Description": "Service for Software Update",
"FirmwareInventory": {
"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory"
},
"Id": "UpdateService",
"MaxImageSizeBytes": 838860800,
"MultipartHttpPushUri": "/redfish/v1/UpdateService/update",
"MultipartHttpPushUri@Redfish.OperationApplyTimeSupport": {
"@odata.type": "#Settings.v1_3_5.OperationApplyTimeSupport",
"SupportedValues": [
"Immediate",
"OnReset",
"OnStartUpdateRequest"
]
},
"Name": "Update Service",
"Oem": {
...
}
},
"ServiceEnabled": true,
"VerifyRemoteServerCertificate": false
}