This API has a deprecated equivalent from v7.0U1.
Get Policy
Gets the automatic update checking and staging policy.
Request
URLURL
https://{api_host}/api/appliance/update/policy
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
UpdatePolicyInfo
of type application/json
Structure containing the policy for the appliance update.
{
"auto_stage": false,
"auto_update": false,
"certificate_check": false,
"check_schedule": [
{
"day": "MONDAY",
"hour": 0,
"minute": 0
}
],
"custom_URL": "string",
"default_URL": "string",
"manual_control": false,
"username": "string"
}
boolean
auto_stage
Required
Automatically stage the latest update if available.
boolean
auto_update
Required
Is the appliance updated automatically. If set the appliance may ignore the check schedule or auto-stage settings.
boolean
certificate_check
Required
Indicates whether certificates will be checked during patching. Warning: If this field is set to false, an insecure connection is made to the update repository which can potentially put the appliance security at risk.
string
default_URL
Required
Current appliance update default repository URL.
boolean
manual_control
Required
Whether API client should allow the user to start update manually
string
custom_URL
Optional
Current appliance update custom repository URL. If unset update is checked at defaut URL.
string
username
Optional
Username for the update repository If unset username will not be used to login
Errors
403
com.vmware.vapi.std.errors.unauthorized : session is not authorized to perform this operation
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetUpdatePolicy
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/appliance/update/policy
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/appliance/update/policy
x-vmw-doc-operation: get
Availability
Added in 7.0U2
On This Page
Policy Operations
get
put
