Querying Firmware Update Status

Function

This interface is used to query the firmware update status.

Syntax

Operation type: GET

URL: https://device_ip/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate

Request header:

X-Auth-Token: auth_value

Request message body: None

Usage Guidelines

None

Instruction

Request:

GET https://10.10.10.10/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate

Request header:

X-Auth-Token: auth_value

Request message body: None

Response:

{
    "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
    "@odata.type": "#Task.v1_6_0.Task",
    "@odata.id": "/redfish/v1/TaskService/Tasks/1",
    "Id": "1",
    "Name": "Upgrade Task", 
    "TaskState": "New",
    "StartTime": "",
    "Messages": {
        "upgradeState": "ERR.0-1-Not upgraded"
    },
    "PercentComplete": 0,
    "Module": "",
    "Version": ""
}

Response code: 200

Output Description

**Table 1** Operation output description
Field	Type	Description
@odata.context	Character string	OData description of an update task resource model.
@odata.id	Character string	Path to access the current task resource. NOTE: You can access the resource to obtain the details of the task.
@odata.type	Character string	Type of an update task resource.
Id	Character string	ID of an update task resource.
Name	Character string	Name of an update task resource.
TaskState	Character string	Status of an update task resource. New Success Running Failed
StartTime	Character string	Start time of an update task.
Messages	Object	Information about an update task.
Messages.upgradeState	Character string	Detailed description of the update task status.
PercentComplete	Number	Update progress.
Module	Character string	Firmware type.
Version	Character string	Version of the update package.

Parent topic: Software Management