Skip to main content

PATCH– Update update service status

Use the PATCH method to update the updateservice resource properties and status.

Request URL​

PATCH https://<BMC_IPADDR>/redfish/v1/UpdateService

Request body​

FieldTypeDescription

HttpPushUriTargets

ArrayItems: string Item count: 0-1
 

HttpPushUriTargets[N]

StringAn array of URIs that indicate where to apply the update image. It is initially blank, and the value updated by client is not kept after XCC reset.

HttpPushUriTargetsBusy

BooleanAn indication of whether any client has reserved the HttpPushUriTargets property. The value is initially false, and is not kept after XCC reset.

Response​

The response returns same content as GET operation with updated properties.

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example is PATCH body

{
   "HttpPushUriTargets" : [ 
    "/redfish/v1/UpdateService/FirmwareInventory/BMC-Backup"
   ]
}

After the PATCH operation runs successfully, querying the update service resource returns below example JSON response:

{
    "MultipartHttpPushUri": "/mfwupdate",
    "Id": "UpdateService",
    "ServiceEnabled": true,
    "HttpPushUri": "/fwupdate",
    "HttpPushUriTargets": [
        "/redfish/v1/UpdateService/FirmwareInventory/BMC-Backup"
    ],
    "Description": "Lenovo firmware update service.",
    "FirmwareInventory": {
        "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory"
    },
    "Status": {
        "HealthRollup": "OK",
        "Health": "OK",
        "State": "Enabled"
    },
    "Name": "Update Service",
    "HttpPushUriTargetsBusy": false,
    "Oem": {
        "Lenovo": {
            "FirmwareServices": {
                "@odata.id": "/redfish/v1/UpdateService/Oem/Lenovo/FirmwareServices"
            },
            "@odata.type": "#LenovoUpdateService.v1_0_0.LenovoUpdateService"
        }
    },
    "@odata.type": "#UpdateService.v1_6_0.UpdateService",
    "HttpPushUriOptions": {
        "HttpPushUriApplyTime": {
            "ApplyTime": "Immediate"
        }
    },
    "MaxImageSizeBytes": 250000000,
    "@odata.etag": "\"7dd4c1a358b13e95cc1c93d70426ad56\"",
    "Actions": {
        "#UpdateService.SimpleUpdate": {
            "target": "/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate",
            "title": "SimpleUpdate",
            "TransferProtocol@Redfish.AllowableValues": [
                "TFTP",
                "SFTP"
            ],
            "Targets@Redfish.AllowableValues": [
                "/redfish/v1/UpdateService/FirmwareInventory/BMC-Backup"
            ],
            "@Redfish.ActionInfo": "/redfish/v1/UpdateService/SimpleUpdateActionInfo"
        }
    },
    "@odata.id": "/redfish/v1/UpdateService"
}