REST API - get
  1. Operations
  2. esx
  3. settings
  4. defaults
  5. clusters
  6. policies
  7. apply
  8. reset info

esx settings defaults clusters policies apply reset info: get

Returns the information describing the outcome when configured policies are reset.

Request:

HTTP request

GET https://{server}/api/esx/settings/defaults/clusters/policies/apply/reset-info

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "enforce_hcl_validation" : {
        "from" : true,
        "to" : true
    },
    "disable_dpm" : {
        "from" : true,
        "to" : true
    },
    "evacuate_offline_vms" : {
        "from" : true,
        "to" : true
    },
    "failure_action" : {
        "from" : {
            "retry_delay" : 1,
            "retry_count" : 1,
            "action" : "FAIL"
        },
        "to" : {
            "retry_delay" : 1,
            "retry_count" : 1,
            "action" : "FAIL"
        }
    },
    "pre_remediation_power_action" : {
        "from" : "POWER_OFF_VMS",
        "to" : "POWER_OFF_VMS"
    },
    "disable_hac" : {
        "from" : true,
        "to" : true
    },
    "enable_quick_boot" : {
        "from" : true,
        "to" : true
    }
}

Headers:

None

Type:

Name Type Description
bold = required
- configured_policy_reset_info The reset information.
-.failure_action failure_action_reset_info Describes the outcome when the configured value for the action to be taken when entering maintenance mode fails is reset.

Optional. If unset indicates that there is no user configured value for esx.settings.defaults.clusters.policies.apply.configured_policy_spec.failure_action.

-.failure_action.from failure_action The configured value for what action should be taken when entering maintenance mode fails.
-.failure_action.from.action string What action (FAIL, RETRY) is to be taken if entering maintenance mode fails on a single host within the cluster.

Defines the actions to be taken when entering maintenance mode fails on a single host within the cluster. Value is one of:
FAIL: Fail the apply operation
RETRY: Retry the task esx.settings.defaults.clusters.policies.apply.reset_info.failure_action.retry_count number of times on the failed host after esx.settings.defaults.clusters.policies.apply.reset_info.failure_action.retry_delay.
-.failure_action.from.retry_delay long Time to wait to retry the failed operation in seconds.

Optional. It is only relevant when action has value [RETRY]. This field is optional and it is only relevant when the value of action is RETRY.
-.failure_action.from.retry_count long Number of times to retry the failed operation.

Optional. It is only relevant when action has value [RETRY]. This field is optional and it is only relevant when the value of action is RETRY.
-.failure_action.to failure_action The value for what action should be taken when entering maintenance mode fails, when the configured value is reset.
-.failure_action.to.action string What action (FAIL, RETRY) is to be taken if entering maintenance mode fails on a single host within the cluster.

Defines the actions to be taken when entering maintenance mode fails on a single host within the cluster. Value is one of:
FAIL: Fail the apply operation
RETRY: Retry the task esx.settings.defaults.clusters.policies.apply.reset_info.failure_action.retry_count number of times on the failed host after esx.settings.defaults.clusters.policies.apply.reset_info.failure_action.retry_delay.
-.failure_action.to.retry_delay long Time to wait to retry the failed operation in seconds.

Optional. It is only relevant when action has value [RETRY]. This field is optional and it is only relevant when the value of action is RETRY.
-.failure_action.to.retry_count long Number of times to retry the failed operation.

Optional. It is only relevant when action has value [RETRY]. This field is optional and it is only relevant when the value of action is RETRY.
-.pre_remediation_power_action pre_remediation_power_action_reset_info 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.

Optional. If unset indicates that there is no user configured value for esx.settings.defaults.clusters.policies.apply.configured_policy_spec.pre_remediation_power_action.

-.pre_remediation_power_action.from string The configured value for what should be done to the power state of the VM before entering maintenance mode.

Defines the possible actions to be taken on VMs before entering maintenance mode. Value is one of:
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. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.pre_remediation_power_action.to string The value for what should be done to the power state of the VM before entering maintenance mode, when the configured value is reset.

Defines the possible actions to be taken on VMs before entering maintenance mode. Value is one of:
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. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.enable_quick_boot enable_quick_boot_reset_info Describes the outcome when the configured value for whether Quick Boot should be enabled during remediation is reset.

Optional. If unset indicates that there is no user configured value for esx.settings.defaults.clusters.policies.apply.configured_policy_spec.enable_quick_boot.

-.enable_quick_boot.from boolean The configured value for whether Quick Boot should be used during remediation.
-.enable_quick_boot.to boolean The value for whether Quick Boot should be used during remediation, when the configured value is reset.
-.disable_dpm disable_dpm_reset_info Describes the outcome when the configured value for whether DPM should be disabled during remediation is reset.

Optional. If unset indicates that there is no user configured value for esx.settings.defaults.clusters.policies.apply.configured_policy_spec.disable_dpm.

-.disable_dpm.from boolean The configured value for whether DPM should be disabled during remediation.
-.disable_dpm.to boolean The value for whether DPM should be disabled during remediation, when the configured value is reset.
-.disable_hac disable_hac_reset_info Describes the outcome when the configured value for whether HA admission control should be disabled during remediation is reset.

Optional. If unset indicates that there is no user configured value for esx.settings.defaults.clusters.policies.apply.configured_policy_spec.disable_hac.

-.disable_hac.from boolean The configured value for whether HA admission control should be disabled during remediation.
-.disable_hac.to boolean The value for whether HA admission control should be disabled during remediation, when the configured value is reset.
-.evacuate_offline_vms evacuate_offline_vms_reset_info Describes the outcome when the configured value for what should be done to powered off/suspended VMs is reset.

Optional. If unset indicates that there is no user configured value for esx.settings.defaults.clusters.policies.apply.configured_policy_spec.evacuate_offline_vms.

-.evacuate_offline_vms.from boolean The configured value for what should be done to powered off/suspended VMs when attempting maintenance mode.
-.evacuate_offline_vms.to boolean The value for what should be done to powered off/suspended VMs when attempting maintenance mode, when the configured value is reset.
-.enforce_hcl_validation enforce_hcl_validation_reset_info 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 attribute was added in vSphere API 7.0.1.0.

Optional. If unset indicates that there is no user configured value for esx.settings.defaults.clusters.policies.apply.configured_policy_spec.enforce_hcl_validation and the hardware compatibility issues will not prevent remediation.
-.enforce_hcl_validation.from boolean The configured value for whether Hcl Validation should be used during remediation. This attribute was added in vSphere API 7.0.1.0.
-.enforce_hcl_validation.to boolean The value for whether Hcl validation should be used during remediation, when the configured value is reset. This attribute was added in vSphere API 7.0.1.0.

Errors:

HTTP Status Code Type Description
500 error If there is an unknown internal error. The accompanying error message will give more details about the failure.
503 service_unavailable If the service is not available.
401 unauthenticated if the caller is not authenticated.