Settings_Defaults_Clusters_Policies_Apply_Effective_EffectivePolicySpec

The Effective.EffectivePolicySpec structure contains fields that describe the effective policies to be used when the software and configuration specification documents are applied to ESXi clusters.

JSON Example

{
    "failure_action": {
        "action": "string",
        "retry_delay": 0,
        "retry_count": 0
    },
    "pre_remediation_power_action": "string",
    "enable_quick_boot": false,
    "disable_dpm": false,
    "disable_hac": false,
    "evacuate_offline_vms": false,
    "enforce_hcl_validation": false
}

Settings_Defaults_Clusters_Policies_Apply_Effective_FailureAction

failure_action

Required

The Effective.FailureAction structure contains fields that describe the actions to be taken when entering maintenance mode fails on a single host within the cluster.

Settings_Defaults_Clusters_Policies_Apply_Effective_EffectivePolicySpec_PreRemediationPowerAction

pre_remediation_power_action

Required

The Effective.EffectivePolicySpec.PreRemediationPowerAction enumerated type defines the possible actions to be taken, before entering maintenance mode.
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

boolean

enable_quick_boot

Required

Enable Quick Boot during remediation in the cluster.

boolean

disable_dpm

Required

Disable DPM on the cluster.

boolean

disable_hac

Required

Disable HA Admission control on the cluster.

boolean

evacuate_offline_vms

Required

Evacuate powered off/suspended VMs when attempting maintenance mode.

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.