more than half documented
Get Clusters Policies Apply Effective
DescriptionReturns the effective apply policy based on system defaults and what has been configured for the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read.
Request
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/policies/apply/effective
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
Response
Response
Response BodyResponse Body
200 OK returns
SettingsClustersPoliciesApplyEffectiveEffectivePolicySpec of type application/json
The effective policies that impact the apply operation on this cluster.
{
"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
Required
Disable DPM on the cluster.
boolean
disable_hac
Required
Disable HA Admission control on the cluster.
boolean
enable_quick_boot
Required
Enable Quick Boot during remediation in the cluster.
boolean
evacuate_offline_vms
Required
Evacuate powered off/suspended VMs when attempting maintenance mode.
failure_action
Required
What action is to be taken if entering maintenance mode fails on a given host of the cluster.
pre_remediation_power_action
Required
Specifies what should be done to the power state of the VM before entering maintenance mode.
Possible values are: POWER_OFF_VMS , SUSPEND_VMS , DO_NOT_CHANGE_VMS_POWER_STATE , SUSPEND_VMS_TO_MEMORY
boolean
enforce_hcl_validation
Optional
Enforce Hcl validation, when applicable, to prevent remediation if hardware compatibility issues are found. This field is optional because it was added in a newer version than its parent node.
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/clusters/{cluster}/policies/apply/effective
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
