SettingsClustersPoliciesApplyEffectiveEffectivePolicySpec

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


Properties

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

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

Possible values are: POWER_OFF_VMSSUSPEND_VMSDO_NOT_CHANGE_VMS_POWER_STATESUSPEND_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.

JSON Example

{
	"disable_dpm": false,
	"disable_hac": false,
	"enable_quick_boot": false,
	"evacuate_offline_vms": false,
	"failure_action": {
		"action": "FAIL"
	},
	"pre_remediation_power_action": "POWER_OFF_VMS"
}

Feedback

Was this page helpful?