Updating Firmware

Function

This interface is used to update firmware.

Syntax

Operation type: POST

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

Request header:

X-Auth-Token: auth_value

Content-Type: header_type

Request message body:

    "ImageURI": filename,

    "TransferProtocol": protocol

Request Parameters

**Table 1** Request parameters
Parameter	Mandatory/Optional	Description	Value
ImageURI	Mandatory	Update package name.	Customized software package name, which is provided by the user. The file name is a string of 1 to 255 characters, including only uppercase and lowercase letters (a to z and A to Z), digits (0 to 9), and other characters (_.-). Two consecutive dots (..) are not allowed.
TransferProtocol	Mandatory	Protocol used to upload the upgrade package.	https

Usage Guidelines

None

Example

Request:

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

Request header:

X-Auth-Token: auth_value

Content-Type: application/json

Request message body:

{
    "ImageURI":"xxx_{_Version}_linux-aarch64.zip",
    "TransferProtocol":"https"
}

Response:

{
    "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
    "@odata.type": "#Task.v1_0_2.Task",
    "@odata.id": "/redfish/v1/TaskService/Tasks/1",
    "Id": "1",
    "Name": "Upgarde Task",
    "TaskState": "Running",
    "StartTime": "2023-03-26 14:35:34",
    "Messages": [{
        "upgradeState": "Running"
    }],
    "PercentComplete": 0,
    "Module": "",
    "Version": ""
}

Response code: 202

Output Description

**Table 2** Operation output description
Field	Type	Description
@odata.context	Character string	OData description of an update task resource model.
@odata.type	Character string	Type of an update task resource.
@odata.id	Character string	Description of the current update task resource.
Id	Number	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 Starting 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