VcenterSettingsV1ConfigComponentsInventoryClusterHaFailuresAndResponses

The FailuresAndResponses structure contains fields describing the Failures and responses specific configurations of a cluster. It contains cluster-wide configurations for vsphere HA.


Properties

integer as int64
additional_delay Optional

After condition has been met, a mandatory delay before starting the next VM restart priority.


apd_failure_response Required

The VM policy settings that determine the response to storage failures.
DISABLED : VM Component Protection service will not monitor or react to the component failure. This setting does not affect other vSphere HA services such as Host Monitoring or VM Health Monitoring.
WARNING : VM Component Protection service will monitor component failures but will not restart an affected VM. Rather it will notify users about the component failures. This setting does not affect other vSphere HA services such as Host Monitoring or VM Health Monitoring.
RESTART_CONSERVATIVE : VM Component Protection service protects VMs conservatively. With this setting, when the service can’t determine that capacity is available to restart a VM, it will favor keeping the VM running.
RESTART_AGGRESSIVE : VM Component Protection service protects VMs aggressively. With this setting, the service will terminate an affected VM even if it can’t determine that capacity exists to restart the VM.
CLUSTER_DEFAULT : VM will use the cluster default setting. This option is only meaningful for per-VM settings.

Possible values are: DISABLEDWARNINGRESTART_CONSERVATIVERESTART_AGGRESSIVECLUSTER_DEFAULT


datastore_with_pdl_failure_response Required

The VM policy settings that determine the response to storage failures.
DISABLED : VM Component Protection service will not monitor or react to the component failure. This setting does not affect other vSphere HA services such as Host Monitoring or VM Health Monitoring.
WARNING : VM Component Protection service will monitor component failures but will not restart an affected VM. Rather it will notify users about the component failures. This setting does not affect other vSphere HA services such as Host Monitoring or VM Health Monitoring.
RESTART_CONSERVATIVE : VM Component Protection service protects VMs conservatively. With this setting, when the service can’t determine that capacity is available to restart a VM, it will favor keeping the VM running.
RESTART_AGGRESSIVE : VM Component Protection service protects VMs aggressively. With this setting, the service will terminate an affected VM even if it can’t determine that capacity exists to restart the VM.
CLUSTER_DEFAULT : VM will use the cluster default setting. This option is only meaningful for per-VM settings.

Possible values are: DISABLEDWARNINGRESTART_CONSERVATIVERESTART_AGGRESSIVECLUSTER_DEFAULT


default_vm_restart_priority Optional

The enum defines virtual machine restart priority values to resolve resource contention. The priority determines the preference that HA gives to a virtual machine if sufficient capacity is not available to power on all failed virtual machines. For example, high priority virtual machines on a host get preference over low priority virtual machines.
DISABLED : vSphere HA is disabled for this virtual machine.
LOWEST : Virtual machines with this priority have the lowest chance of powering on after a failure if there is insufficient capacity on hosts to meet all virtual machine needs.
LOW : Virtual machines with this priority have a lower chance of powering on after a failure if there is insufficient capacity on hosts to meet all virtual machine needs.
MEDIUM : Virtual machines with this priority have an intermediate chance of powering on after a failure if there is insufficient capacity on hosts to meet all virtual machine needs.
HIGH : Virtual machines with this priority have a higher chance of powering on after a failure if there is insufficient capacity on hosts to meet all virtual machine needs.
HIGHEST : Virtual machines with this priority have the highest chance of powering on after a failure if there is insufficient capacity on hosts to meet all virtual machine needs.
CLUSTER_RESTART_PRIORITY : Virtual machines with this priority use the default restart priority defined for the cluster that contains this virtual machine.

Possible values are: DISABLEDLOWESTLOWMEDIUMHIGHHIGHESTCLUSTER_RESTART_PRIORITY


host_isolation_response Optional

The enum defines values that indicate whether or not the virtual machine should be powered off if a host determines that it is isolated from the rest of the cluster.
NONE : Do not power off the virtual machine in the event of a host network isolation.
POWER_OFF : Power off the virtual machine in the event of a host network isolation.
SHUTDOWN : Shut down the virtual machine guest operating system in the event of a host network isolation. If the guest operating system fails to shutdown within five minutes, HA will initiate a forced power off. When you use the shutdown isolation response, failover can take longer (compared to the response) because the virtual machine cannot fail over until it is shutdown.
CLUSTER_ISOLATION_RESPONSE : Use the default isolation response defined for the cluster that contains this virtual machine.

Possible values are: NONEPOWER_OFFSHUTDOWNCLUSTER_ISOLATION_RESPONSE


host_monitoring Optional

Possible states of an HA service. All services support the disabled and enabled states.
DISABLED : HA service is disabled.
ENABLED : HA service is enabled.

Possible values are: DISABLEDENABLED


integer as int64
response_delay Optional

The time interval after an APD timeout has been declared and before VM Component Protection service will terminate the VM. The default value is 180 seconds if not specified. To use cluster setting for a VM override, set to -1 in per-VM setting.


response_recovery Optional

If an APD condition clears after an APD timeout condition has been declared and before VM Component Protection service terminated the VM, the guestOS and application may no longer be operational.
NONE : VM Component Protection service will not react after APD condition is cleared.
RESET : VM Component Protection service will reset the VM after APD condition is cleared. Note this only applies if the subject VM is still powered on.
USE_CLUSTER_DEFAULT : VM will use the cluster default setting. This option is only meaningful for per-VM settings.

Possible values are: NONERESETUSE_CLUSTER_DEFAULT


integer as int64
restart_priority_condition_timeout Optional

This setting is used to specify a maximum time the lower priority VMs should wait for the higher priority VMs to be ready. If the higher priority Vms are not ready by this time, then the lower priority VMs are restarted irrespective of the VM ready state. This timeout can be used to prevent the failover of lower priority VMs to be stuck infinitely. Timeout specified in seconds. To use cluster setting for a VM override, set to -1 in per-VM. setting.

If unset or empty, the value is skipped.


vm_monitoring Optional

The enum defines values that indicate the state of Virtual Machine Health Monitoring. Health Monitoring uses the vmTools (guest) and application agent heartbeat modules. You can configure HA to respond to heartbeat failures of either one or both modules. You can also disable the HA response to heartbeat failures.
VM_MONITORING_DISABLED : Virtual machine health monitoring is disabled. In this state, HA response to guest and application heartbeat failures are disabled.
VM_MONITORING_ONLY : HA response to guest heartbeat failure is enabled.
VM_AND_APP_MONITORING : HA response to both guest and application heartbeat failure is enabled.

Possible values are: VM_MONITORING_DISABLEDVM_MONITORING_ONLYVM_AND_APP_MONITORING


vm_tools_monitoring_settings Optional

The vim.cluster.VmToolsMonitoringSettings data object contains virtual machine monitoring settings that are used by the Virtual Machine Health Monitoring Service. The Service checks the VMware Tools heartbeat of a virtual machine. If heartbeats have not been received within a specified time interval, the Service declares the virtual machine as failed and resets the virtual machine. All fields are optional. In case of a reconfiguration, fields left unset are not changed.

JSON Example

{
	"apd_failure_response": "DISABLED",
	"datastore_with_pdl_failure_response": "DISABLED"
}

Feedback

Was this page helpful?