REST API - get
  1. Operations
  2. appliance
  3. update
  4. policy

appliance update policy: get

Gets the automatic update checking and staging policy. This operation was added in vSphere API 6.7.

Request:

HTTP request

GET https://{server}/rest/appliance/update/policy
No request parameters

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "auto_stage" : true,
        "auto_update" : true,
        "default_URL" : "string",
        "check_schedule" : [
            {
                "hour" : 1,
                "day" : "MONDAY",
                "minute" : 1
            },
            {
                "hour" : 1,
                "day" : "MONDAY",
                "minute" : 1
            }
        ],
        "custom_URL" : "string",
        "manual_control" : true,
        "username" : "string"
    }
}

Response Type:

Name Type Description
bold = required
value info Structure containing the policy for the appliance update.
value.custom_URL string Current appliance update custom repository URL. This attribute was added in vSphere API 6.7.

Optional. If unset update is checked at defaut URL.
value.default_URL string Current appliance update default repository URL. This attribute was added in vSphere API 6.7.
value.username string Username for the update repository. This attribute was added in vSphere API 6.7.

Optional. If unset username will not be used to login.

value.check_schedule time[] Schedule when the automatic check will be run. This attribute was added in vSphere API 6.7.
value.auto_stage boolean Automatically stage the latest update if available. This attribute was added in vSphere API 6.7.
value.auto_update boolean Is the appliance updated automatically. If set the appliance may ignore the check schedule or auto-stage settings. This attribute was added in vSphere API 6.7.
value.manual_control boolean Whether API client should allow the user to start update manually. This attribute was added in vSphere API 6.7.

Errors:

HTTP Status Code Type Description
500 error Generic error
401 unauthenticated session is not authenticated
403 unauthorized session is not authorized to perform this operation