Set Policy
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Sets the automatic update checking and staging policy.
Request
URLURL
https://{api_host}/rest/appliance/update/policy
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains UpdatePolicySetRequestBody
of type application/json
(required)
{
"policy": {
"auto_stage": false,
"check_schedule": [
{
"day": "enum",
"hour": 0,
"minute": 0
}
]
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | policy | UpdatePolicyConfig |
Info structure containing the policy for the appliance update. |
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"policy":{"auto_stage":false,"check_schedule":[{"day":"enum","hour":0,"minute":0}],"custom_URL":"string","password":"string","username":"string"}}' https://{api_host}/rest/appliance/update/policy
Errors
| Code | Returns | Description |
|---|---|---|
| default | ErrorRest | Not available |
| 401 | ErrorRest | com.vmware.vapi.std.errors.unauthenticated : session is not authenticated | com.vmware.vapi.std.errors.unauthorized : session is not authorized to perform this operation |
| 404 | ErrorRest | com.vmware.vapi.std.errors.error : Generic error |
On This Page
Policy Operations
put
get
