Esx.Settings.Defaults.Clusters.Policies.Apply.ConfiguredPolicySpec

Esx.Settings.Defaults.Clusters.Policies.Apply.ConfiguredPolicySpec
Esx.Settings.Defaults.Clusters.Policies.Apply.ConfiguredPolicySpec

The Esx.Settings.Defaults.Clusters.Policies.Apply.ConfiguredPolicySpec schema contains properties that describe the policies configured to be used when the software and configuration specification documents are applied to ESXi clusters.

This schema was added in vSphere API 7.0.0.0.

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,
    "software_policy_spec": {
        "enforce_hcl_validation": false,
        "parallel_remediation_action": {
            "enabled": false,
            "max_hosts": 0
        },
        "live_patch_action": {
            "live_patch_mode": "string"
        },
        "skip_reserved_vibs_caching": false,
        "remediation_failure_tolerance": {
            "failed_hosts_tolerance_percentage_enabled": false,
            "failed_hosts_tolerance_percentage": 0
        }
    },
    "config_manager_policy_spec": {
        "serial_remediation": false,
        "auto_remediate_on_host_add": false
    }
}
failure_action
Optional

What action is to be taken if entering maintenance mode fails on a given host of the cluster.

This property was added in vSphere API 7.0.0.0.

If missing or null, configured value would be unset.

string
pre_remediation_power_action
Optional

Specifies what should be done to the power state of the VM before entering maintenance mode.

Possible values:

  • 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

This constant was added in vSphere API 7.0.2.0.

For more information see: Esx.Settings.Defaults.Clusters.Policies.Apply.ConfiguredPolicySpec.PreRemediationPowerAction.

This property was added in vSphere API 7.0.0.0.

If missing or null, configured value would be unset.

boolean
enable_quick_boot
Optional

Enable Quick Boot during remediation in the cluster.

This property was added in vSphere API 7.0.0.0.

If missing or null, configured value would be unset.

boolean
disable_dpm
Optional

Disable DPM on the cluster.

This property was added in vSphere API 7.0.0.0.

If missing or null, configured value would be unset.

boolean
disable_hac
Optional

Disable HA Admission control on the cluster.

This property was added in vSphere API 7.0.0.0.

If missing or null, configured value would be unset.

boolean
evacuate_offline_vms
Optional

Evacuate powered off/suspended VMs when attempting maintenance mode.

This property was added in vSphere API 7.0.0.0.

If missing or null, configured value would be unset.

boolean
enforce_hcl_validation
Optional

Enforce HCL validation, when applicable, to prevent remediation if hardware compatibility issues are found.

This property was added in vSphere API 7.0.1.0.

If missing or null, hardware compatibility issues will not prevent remediation.

parallel_remediation_action
Optional

Enable parallel remediation of hosts in maintenance mode. Set max hosts when applicable.

This property was added in vSphere API 8.0.0.1.

If missing or null, parallel remediation will not happen.

boolean
enforce_quick_patch
Optional

Enforce quick patch on the cluster for images that support it.

This property was added in vSphere API 8.0.3.0.

If missing or null, configured value would be unset.

software_policy_spec
Optional

Software-specific policy settings applicable to the POST /esx/settings/clusters/{cluster}/software?action=apply API.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

If missing or null, software-specific policy values will be unset.

config_manager_policy_spec
Optional

Configure settings applicable to the POST /esx/settings/clusters/{cluster}/configuration?action=apply API.

This property was added in vSphere API 8.0.3.0.

If missing or null, configured values will be unset.