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": filepath,
"TransferProtocol": protocol
}
Parameters
Parameter |
Description |
Value |
|---|---|---|
device_ip |
IP address for logging in to a device |
An IPv4 or IPv6 address |
auth_value |
Authentication parameter contained in the request |
You can obtain the value from the session created by using /redfish/v1/SessionService/Sessions. |
header_type |
Request format |
Supported formats include:
|
filepath |
Path of the update package |
URL of the update package. The value can contain a maximum of 256 characters and can be the local tmp directory. Example: sftp://username:password@10.10.10.191/tmp/package/cpldimage.hpm Local update: /tmp/cpldimage.hpm |
protocol |
Protocol used to download the upgrade package |
https |
Usage Guidelines
None
Example
Example request:
POST https://10.10.10.10/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate
Request header:
X-Auth-Token: 6599174c38c36838737d9749179e1ee1
Content-Type: application/json
Request message body:
{
"ImageURI": "sftp://username:password@10.10.10.191/tmp/package/cpldimage.hpm",
"TransferProtocol": "SFTP"
}
Response example:
{
@odata.context: "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity"
@odata.id: "/redfish/v1/TaskService/Tasks/1"
@odata.type: "#Task.v1_0_2.Task"
Id: "1"
KernelVersion: null
McuVersion: null
Messages: [{upgradeState: "Running", upgradeProgress: 0}]
MinidVersion: null
Name: "Upgarde Task"
Oem: {Huawei: {TaskPercentage: 0, Version: null}}
RootfsVersion: null
StartTime: "2019-07-10 09:46:49"
TaskState: "Running"
UbootVersion: null
}
Response code: 202
Output Description
Attribute |
Type |
Description |
|---|---|---|
@odata.context |
Character string |
OData description of the upgrade task resource model |
@odata.id |
Character string |
Access path of 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 |
Number |
Identifies an update task resource |
Name |
Character string |
Name of an update task resource |
TaskState |
Character string |
Status of an update task resource
|
StartTime |
Character string |
Start time of an update task |
Messages |
Object |
Information about an update task |
upgradeState |
Character string |
Status of an update task |
upgradeProgress |
Character string |
Update progress |
KernelVersion |
Character string |
OS kernel version |
McuVersion |
Character string |
MCU firmware version |
MinidVersion |
Character string |
Atlas 200 AI Accelerator Module (Model 3000) firmware version |
RootfsVersion |
Character string |
RootFS firmware version |
UbootVersion |
Character string |
U-Boot firmware version |
Oem |
Object |
Custom information |
TaskPercentage |
Character string |
Update progress percentage |
Version |
Character string |
Version of the update package |
