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.


cluster_settings Optional

Flag indicating whether to use the cluster settings or the per VM settings. The default value is true.

enabled Optional

Flag indicating whether or not the Virtual Machine Health Monitoring service is enabled. The Server does not use this property.

failure_interval Optional

If no heartbeat has been received for at least the specified number of seconds, the virtual machine is declared as failed. The default value is 30.

max_failure_window Optional

The number of seconds for the window during which up to VmToolsMonitoringSettings.max-failures resets can occur before automated responses stop. If set to -1, no failure window is specified.

The default value is -1.

max_failures Optional

Maximum number of failures and automated resets allowed during the time that VmToolsMonitoringSettings.max-failure-window specifies. If VmToolsMonitoringSettings.max-failure-window is -1 (no window), this represents the absolute number of failures after which automated response is stopped. If a virtual machine exceeds this threshold, in-depth problem analysis is usually needed.

The default value is 3.

min_up_time Optional

The number of seconds for the virtual machine’s heartbeats to stabilize after the virtual machine has been powered on. This time should include the guest operating system boot-up time. The virtual machine monitoring will begin only after this period. The default value is 120.

JSON Example

    "cluster_settings": false,
    "enabled": false,
    "failure_interval": 0,
    "max_failure_window": 0,
    "max_failures": 0,
    "min_up_time": 0

Was this page helpful?