Making Firmware Update Take Effect

Function

This interface is used to make firmware update take effect.

Syntax

Operation type: POST

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

Request header:

X-Auth-Token: auth_value

Content-Type: header_type

Request message body:

    "ResetType":type

Request Parameters

**Table 1** Request parameters
Parameter	Mandatory/Optional	Description	Value
ResetType	Mandatory	Reset type.	The value is a character string. The supported type is GracefulRestart.

Usage Guidelines

None

Example

Request:

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

Request header:

X-Auth-Token: auth_value

header_type: application/json

Request message body:

{
    "ResetType":"GracefulRestart"
}

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": null,
    "Name": "Upgrade Task",
    "TaskState": null,
    "StartTime": null,
    "Messages": null,
    "PercentComplete": null,
    "Module": null,
    "Version": null
}

Response code: 200

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	Path to access the current task resource. NOTE: You can access the resource to obtain the details of the task.
Id	Character string	ID of an update task resource.
Name	Character string	Name of a drive resource collection.
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.
PercentComplete	Number	Update progress.
Module	Character string	Firmware type.
Version	Character string	Version of the update package.

Parent topic: Software Management