Developer Documentation
Set Clusters Policies Apply
Released in v7.0.0This 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
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | The cluster identifier. The parameter must be an identifier for the resource type: ClusterComputeResource. |
Request Body
Request Body
Contains
ApplyConfiguredPolicySpec
of type application/json
(required)
{
"disable_dpm": false,
"disable_hac": false,
"enable_quick_boot": false,
"evacuate_offline_vms": false,
"failure_action": {
"action": "enum",
"retry_count": 0,
"retry_delay": 0
},
"pre_remediation_power_action": "enum"
}| Required | Property Name | Type | Description |
|---|---|---|---|
| optional | disable_dpm | boolean |
Disable DPM on the cluster. If unset, configured value would be unset. |
| optional | disable_hac | boolean |
Disable HA Admission control on the cluster. If unset, configured value would be unset. |
| optional | enable_quick_boot | boolean |
Enable Quick Boot during remediation in the cluster. If unset, configured value would be unset. |
| optional | evacuate_offline_vms | boolean |
Evacuate powered off/suspended VMs when attempting maintenance mode. If unset, configured value would be unset. |
| optional | failure_action | ApplyFailureAction |
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. |
| optional | pre_remediation_power_action | ConfiguredPolicySpecPreRemediationPowerAction |
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: |
Errors
| Code | Returns | Description |
|---|---|---|
| 400 | Error | com.vmware.vapi.std.errors.invalid_argument : If invalid value is provided. |
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : If the caller is not authenticated. |
| 404 | Error | com.vmware.vapi.std.errors.error : If there is an unknown internal error. The accompanying error message will give more details about the failure. | com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster in the system. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : If the service is not available. |
| default | Error | Not available |
