Get Clusters Policies Apply Effective

Released in v7.0.0

Returns 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

URL

GET

https://{api_host}/api/esx/settings/clusters/{cluster}/policies/apply/effective

Path Parameters

Required	Parameter Name	Type	Description
required	cluster	string	The cluster identifier. The parameter must be an identifier for the resource type: ClusterComputeResource.

Header Parameters

Required	Parameter Name	Type	Description
required	vmware-api-session-id	string	Required session ID, obtained by first calling Create Session API

Response

Response 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,
    "evacuate_offline_vms": false,
    "failure_action": {
        "action": "enum",
        "retry_count": 0,
        "retry_delay": 0
    },
    "pre_remediation_power_action": "enum"
}

Property Name	Type	Description
disable_dpm	boolean	Disable DPM on the cluster.
disable_hac	boolean	Disable HA Admission control on the cluster.
enable_quick_boot	boolean	Enable Quick Boot during remediation in the cluster.
evacuate_offline_vms	boolean	Evacuate powered off/suspended VMs when attempting maintenance mode.
failure_action	SettingsClustersPoliciesApplyEffectiveFailureAction	What action is to be taken if entering maintenance mode fails on a given host of the cluster.
pre_remediation_power_action	SettingsClustersPoliciesApplyEffectiveEffectivePolicySpecPreRemediationPowerAction Enum	Specifies what should be done to the power state of the VM before entering maintenance mode.

cURL Command

curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/clusters/{cluster}/policies/apply/effective

Errors

Code	Returns	Description
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