REST API - get
  1. Operations
  2. esx
  3. settings
  4. clusters
  5. policies
  6. apply
  7. effective

esx settings clusters policies apply effective: get

Returns the effective apply policy based on system defaults and what has been configured for the cluster.

Request:

HTTP request

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

Path Parameters

Name Type Description
Required
cluster string The cluster identifier.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "enforce_hcl_validation" : true,
    "disable_dpm" : true,
    "evacuate_offline_vms" : true,
    "failure_action" : {
        "retry_delay" : 1,
        "retry_count" : 1,
        "action" : "FAIL"
    },
    "pre_remediation_power_action" : "POWER_OFF_VMS",
    "disable_hac" : true,
    "enable_quick_boot" : true
}

Headers:

None

Type:

Name Type Description
bold = required
- effective_policy_spec The effective policies that impact the apply operation on this cluster.
-.failure_action failure_action What action is to be taken if entering maintenance mode fails on a given host of the cluster.
-.failure_action.action string What action (FAIL, RETRY) is to be taken if entering maintenance mode fails on a single host within the cluster.

Defines the actions to be taken when entering maintenance mode fails on a single host within the cluster. Value is one of:
FAIL: Fail the apply operation
RETRY: Retry the task Apply.FailureAction#retryCount number of times on the failed host after Apply.FailureAction#retryDelay.
-.failure_action.retry_delay long Time to wait to retry the failed operation in seconds.

Optional. It is only relevant when action has value [RETRY]. This field is optional and it is only relevant when the value of action is RETRY.
-.failure_action.retry_count long Number of times to retry the failed operation.

Optional. It is only relevant when action has value [RETRY]. This field is optional and it is only relevant when the value of action is RETRY.
-.pre_remediation_power_action string Specifies what should be done to the power state of the VM before entering maintenance mode.

Defines the possible actions to be taken, before entering maintenance mode. Value is one of:
POWER_OFF_VMS: Power off VMs before entering maintenance mode.
SUSPEND_VMS: Suspend VMs before entering maintenance mode
DO_NOT_CHANGE_VMS_POWER_STATE: Do not change the VM power state
SUSPEND_VMS_TO_MEMORY: Suspend VMs to Memory before entering maintenance mode. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.enable_quick_boot boolean Enable Quick Boot during remediation in the cluster.
-.disable_dpm boolean Disable DPM on the cluster.
-.disable_hac boolean Disable HA Admission control on the cluster.
-.evacuate_offline_vms boolean Evacuate powered off/suspended VMs when attempting maintenance mode.
-.enforce_hcl_validation boolean Enforce Hcl validation, when applicable, to prevent remediation if hardware compatibility issues are found. This attribute was added in vSphere API 7.0.1.0.

Optional. This field is optional because it was added in a newer version than its parent node.

Errors:

HTTP Status Code Type Description
500 error If there is an unknown internal error. The accompanying error message will give more details about the failure.
404 not_found If there is no cluster associated with cluster in the system.
503 service_unavailable If the service is not available.
401 unauthenticated if the caller is not authenticated.