Querying the Upgrade Resource Collection

Function

This interface is used to query a firmware upgrade resource collection.

Syntax

Operation type: GET

URL: https://device_ip/redfish/v1/UpdateService

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

Request header:

X-Auth-Token: auth_value

Request message body: None

Response:

{
    "@odata.context": "/redfish/v1/$metadata#UpdateService",
    "@odata.id": "/redfish/v1/UpdateService",
    "@odata.type": "#UpdateService.v1_0_0.UpdateService",
    "Actions": {
        "#UpdateService.Reset": {
            "target": "/redfish/v1/UpdateService/Actions/UpdateService.Reset"
        },
        "#UpdateService.SimpleUpdate": {
            "target": "/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate"
        }
    },
    "FirmwareInventory": {
        "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory"
    },
    "Id": "UpdateService",
    "Name": "Update Service",
    "ServiceEnabled": null,
    "Status": {
        "Health": null,
        "Status": null
    }
}

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.
Actions.#UpdateService.Reset.target	Character string	URL for the firmware to take effect.
Actions.#UpdateService.SimpleUpdate.target	Character string	URL of the firmware to be upgraded.
FirmwareInventory.@odata.id	Character string	URL for file upload.
Id	Character string	Resource ID of the current task.
name	Character string	Name of the current task resource.
ServiceEnabled	Character string	Whether to enable the upgrade service.
Status.Health	Character string	health status of the upgrade service.
Status.Status	Character string	Upgrade service status.

Parent topic: Software Management