Set Clusters Policies Apply
This API will set the configured policy specification for the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Write. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Write.
Request
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/policies/apply
Path Parameters
Path Parameters
string
cluster
Required
The cluster identifier.
The parameter must be an identifier for the resource type: ClusterComputeResource.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
vmware-api-session-id example
b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
SettingsClustersPoliciesApplyConfiguredPolicySpec of mimetype application/json
Required
The policy that needs to be configured.
{
"disable_dpm": false,
"disable_hac": false,
"enable_quick_boot": false,
"enforce_hcl_validation": false,
"evacuate_offline_vms": false,
"failure_action": {
"action": "enum",
"retry_count": 0,
"retry_delay": 0
},
"pre_remediation_power_action": "enum"
}
boolean
disable_dpm
Optional
Disable DPM on the cluster. If unset, configured value would be unset.
boolean
disable_hac
Optional
Disable HA Admission control on the cluster. If unset, configured value would be unset.
boolean
enable_quick_boot
Optional
Enable Quick Boot during remediation in the cluster. If unset, configured value would be unset.
boolean
enforce_hcl_validation
Optional
Enforce Hcl validation, when applicable, to prevent remediation if hardware compatibility issues are found. If unset, hardware compatibility issues will not prevent remediation.
boolean
evacuate_offline_vms
Optional
Evacuate powered off/suspended VMs when attempting maintenance mode. If unset, configured value would be unset.
failure_action
Optional
What action is to be taken if entering maintenance mode fails on a given host of the cluster. If unset, configured value would be unset.
pre_remediation_power_action
Optional
Specifies what should be done to the power state of the VM before entering maintenance mode. If unset, configured value would be unset.
Possible values are: POWER_OFF_VMS , SUSPEND_VMS , DO_NOT_CHANGE_VMS_POWER_STATE , SUSPEND_VMS_TO_MEMORY
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"disable_dpm":false,"disable_hac":false,"enable_quick_boot":false,"enforce_hcl_validation":false,"evacuate_offline_vms":false,"failure_action":{"action":"enum","retry_count":0,"retry_delay":0},"pre_remediation_power_action":"enum"}' https://{api_host}/api/esx/settings/clusters/{cluster}/policies/apply
Errors
404
com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster in the system.
500
com.vmware.vapi.std.errors.error : If there is an unknown internal error. The accompanying error message will give more details about the failure.
Availability
Added in 7.0.0
