Esx.Settings.Defaults.Clusters.Policies.Apply.ResetInfo.ConfiguredPolicyResetInfo

Esx.Settings.Defaults.Clusters.Policies.Apply.ResetInfo.ConfiguredPolicyResetInfo
Esx.Settings.Defaults.Clusters.Policies.Apply.ResetInfo.ConfiguredPolicyResetInfo

The Esx.Settings.Defaults.Clusters.Policies.Apply.ResetInfo.ConfiguredPolicyResetInfo schema contains properties that describe the outcome when configured policies are reset.

This schema was added in vSphere API 7.0.0.0.

Note: this schema is restricted for VMware internal use only.

JSON Example
{
    "failure_action": {
        "from": {
            "action": "string",
            "retry_delay": 0,
            "retry_count": 0
        },
        "to": {
            "action": "string",
            "retry_delay": 0,
            "retry_count": 0
        }
    },
    "pre_remediation_power_action": {
        "from": "string",
        "to": "string"
    },
    "enable_quick_boot": {
        "from": false,
        "to": false
    },
    "disable_dpm": {
        "from": false,
        "to": false
    },
    "disable_hac": {
        "from": false,
        "to": false
    },
    "evacuate_offline_vms": {
        "from": false,
        "to": false
    },
    "enforce_hcl_validation": {
        "from": false,
        "to": false
    },
    "parallel_remediation_action": {
        "from": {
            "enabled": false,
            "max_hosts": 0
        },
        "to": {
            "enabled": false,
            "max_hosts": 0
        }
    },
    "enforce_quick_patch": {
        "from": false,
        "to": false
    },
    "software_policy_spec": {
        "from": {
            "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
            }
        },
        "to": {
            "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": {
        "from": {
            "serial_remediation": false,
            "auto_remediate_on_host_add": false
        },
        "to": {
            "serial_remediation": false,
            "auto_remediate_on_host_add": false
        }
    }
}
failure_action
Optional

Describes the outcome when the configured value for the action to be taken when entering maintenance mode fails is reset.

This property was added in vSphere API 7.0.0.0.

If missing or null indicates that there is no user configured value for Esx.Settings.Defaults.Clusters.Policies.Apply.ConfiguredPolicySpec.failure_action

pre_remediation_power_action
Optional

Describes the outcome when the configured value for what action should be taken on the power state of VMs before entering maintenance mode is reset.

This property was added in vSphere API 7.0.0.0.

If missing or null indicates that there is no user configured value for Esx.Settings.Defaults.Clusters.Policies.Apply.ConfiguredPolicySpec.pre_remediation_power_action

enable_quick_boot
Optional

Describes the outcome when the configured value for whether Quick Boot should be enabled during remediation is reset.

This property was added in vSphere API 7.0.0.0.

If missing or null indicates that there is no user configured value for Esx.Settings.Defaults.Clusters.Policies.Apply.ConfiguredPolicySpec.enable_quick_boot

disable_dpm
Optional

Describes the outcome when the configured value for whether DPM should be disabled during remediation is reset.

This property was added in vSphere API 7.0.0.0.

If missing or null indicates that there is no user configured value for Esx.Settings.Defaults.Clusters.Policies.Apply.ConfiguredPolicySpec.disable_dpm

disable_hac
Optional

Describes the outcome when the configured value for whether HA admission control should be disabled during remediation is reset.

This property was added in vSphere API 7.0.0.0.

If missing or null indicates that there is no user configured value for Esx.Settings.Defaults.Clusters.Policies.Apply.ConfiguredPolicySpec.disable_hac

evacuate_offline_vms
Optional

Describes the outcome when the configured value for what should be done to powered off/suspended VMs is reset.

This property was added in vSphere API 7.0.0.0.

If missing or null indicates that there is no user configured value for Esx.Settings.Defaults.Clusters.Policies.Apply.ConfiguredPolicySpec.evacuate_offline_vms

enforce_hcl_validation
Optional

Describes the outcome when the configured value for whether HCL validation should be enforced during remediation is reset. If the value is enabled, it will prevent remediation if hardware compatibility issues are found.

This property was added in vSphere API 7.0.1.0.

If missing or null indicates that there is no user configured value for Esx.Settings.Defaults.Clusters.Policies.Apply.ConfiguredPolicySpec.enforce_hcl_validation and the hardware compatibility issues will not prevent remediation.

parallel_remediation_action
Optional

Describes the outcome when the configured value for whether parallel remediation should be done is reset.

This property was added in vSphere API 8.0.0.1.

If missing or null indicates that there is no user configured value for Esx.Settings.Defaults.Clusters.Policies.Apply.ConfiguredPolicySpec.parallel_remediation_action

enforce_quick_patch
Optional

Describes the outcome when the configured value for whether quick patch should be enforced is reset.

This property was added in vSphere API 8.0.3.0.

If missing or null indicates that there is no user configured value for Esx.Settings.Defaults.Clusters.Policies.Apply.ConfiguredPolicySpec.enforce_quick_patch

software_policy_spec
Optional

Describes the outcome when the configured settings that govern the software-specific behavior in the POST /esx/settings/clusters/{cluster}/software?action=apply API are reset. field.optional If missing or null indicates that there are no user configured values for Esx.Settings.Clusters.Policies.Apply.ConfiguredPolicySpec.software_policy_spec

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.

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

config_manager_policy_spec
Optional

Describes the outcome when the configured settings that govern the config-specific behavior in the POST /esx/settings/clusters/{cluster}/configuration?action=apply API are reset. field.optional If missing or null indicates that there are no user configured values for com.vmware.esx.settings.clusters.policies.Apply.ConfiguredPolicySpec#ConfigManagerPolicySpec

This property was added in vSphere API 8.0.3.0.

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