Settings_Clusters_Policies_Apply_Effective_EffectivePolicySpec

Settings_Clusters_Policies_Apply_Effective_EffectivePolicySpec
Settings_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 an ESXi cluster.

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,
    "parallel_remediation_action": {
        "enabled": false,
        "max_hosts": 0
    },
    "enforce_quick_patch": false,
    "config_manager_policy_spec": {
        "serial_remediation": false
    }
}
Settings_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_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.

Settings_Clusters_Policies_Apply_Effective_ParallelRemediationAction
parallel_remediation_action
Optional

parallel_remediation_action

boolean
enforce_quick_patch
Optional

Enforce quick patch on the cluster for images that support it. This field is optional because it was added in a newer version than its parent node.

Settings_Clusters_Policies_ConfigManagerPolicySpec
config_manager_policy_spec
Optional

This specification defines the settings to manage the com.vmware.esx.settings.clusters.Configuration.apply API behaviour.

Returned By