Set Policy
DescriptionSets 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"
Request Body
Request Body
UpdatePolicyConfig of mimetype application/json
Required
Info structure containing the policy for the appliance update.
{
"auto_stage": false,
"check_schedule": [
{
"day": "MONDAY",
"hour": 0,
"minute": 0
}
]
}
boolean
auto_stage
Required
Automatically stage the latest update if available.
boolean
certificate_check
Optional
Indicates whether certificates will be checked during patching. Warning: Setting this field to false will result in an insecure connection to update repository which can potentially put the appliance security at risk.
certificateCheck If unset the certificate checks are enabled.
string
custom_URL
Optional
Current appliance update repository URL. If unset then default URL is assumed
string
password
Optional
Password for the update repository password If unset password will not be used to login
string
username
Optional
Username for the update repository If unset username will not be used to login
Authentication
This operation uses the following authentication methods.
Errors
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
$UpdatePolicyTime = Initialize-UpdatePolicyTime -Day "MONDAY" -Hour 0 -Minute 0
$UpdatePolicyConfig = Initialize-UpdatePolicyConfig -CheckSchedule $UpdatePolicyTime -AutoStage $false
Invoke-SetUpdatePolicy -UpdatePolicyConfig $UpdatePolicyConfig
PowerCLI Client SDK All Parameters Example
$UpdatePolicyTime = Initialize-UpdatePolicyTime -Day "MONDAY" -Hour 0 -Minute 0
$UpdatePolicyConfig = Initialize-UpdatePolicyConfig -CustomURL "MyCustomURL" -Username "MyUsername" -Password "MyPassword" -CheckSchedule $UpdatePolicyTime -AutoStage $false -CertificateCheck $false
Invoke-SetUpdatePolicy -UpdatePolicyConfig $UpdatePolicyConfig
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"auto_stage":false,"certificate_check":false,"check_schedule":[{"day":"MONDAY","hour":0,"minute":0}],"custom_URL":"string","password":"string","username":"string"}' https://{api_host}/api/appliance/update/policy
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: set
Availability
Added in 6.7
On This Page
Policy Operations
get
put
