Data Object Description

Virtual Machine Health Monitoring service checks the VMware Tools heartbeat of a virtual machine. If heartbeats have not been received within a specified time interval, Virtual Machine Health Monitoring service declares the virtual machine as failed and resets the virtual machine.

VmToolsMonitoringSetting consists of configuration settings for Virtual Machine Health Monitoring Service.

All fields are defined as optional. In case of a reconfiguration, fields left unset are not changed.

Properties

Name	Type	Description
clusterSettings*	xsd:boolean	Flag indicating whether to use the cluster settings or the per VM settings The default value is true.
enabled*	xsd:boolean	Deprecated. As of vSphere API 4.1, use vmMonitoring Flag indicating whether or not the Virtual Machine Health Monitoring service is enabled. The default value is false.
failureInterval*	xsd:int	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.
maxFailures*	xsd:int	Maximum number of failures and automated resets allowed during the time that maxFailureWindow specifies. If maxFailureWindow 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.
maxFailureWindow*	xsd:int	The number of seconds for the window during which up to maxFailures resets can occur before automated responses stop. If set to -1, no failure window is specified. The default value is -1.
minUpTime*	xsd:int	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.
vmMonitoring*	xsd:string	Indicates the type of vm monitoring configured. This can be one fo three values disabled, vmMonitoringOnly or vmAndAppMonitoring The default value is vmMonitoringDisabled Please see ClusterDasConfigInfoVmMonitoringState *Since* vSphere API 4.1
Properties inherited from DynamicData
dynamicProperty, dynamicType

Name

Type

Description

clusterSettings*

xsd:boolean

Flag indicating whether to use the cluster settings or the per VM settings

The default value is true.

enabled*

xsd:boolean

Deprecated. As of vSphere API 4.1, use vmMonitoring

Flag indicating whether or not the Virtual Machine Health Monitoring service is enabled.

The default value is false.

failureInterval*

xsd:int

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.

maxFailures*

xsd:int

Maximum number of failures and automated resets allowed during the time that maxFailureWindow specifies. If maxFailureWindow 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.

maxFailureWindow*

xsd:int

The number of seconds for the window during which up to maxFailures resets can occur before automated responses stop.

If set to -1, no failure window is specified.

The default value is -1.

minUpTime*

xsd:int

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.

vmMonitoring*

xsd:string

Indicates the type of vm monitoring configured. This can be one fo three values disabled, vmMonitoringOnly or vmAndAppMonitoring The default value is vmMonitoringDisabled Please see ClusterDasConfigInfoVmMonitoringState

Since vSphere API 4.1

Properties inherited from DynamicData

dynamicProperty, dynamicType

Need not be set

Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="ClusterVmToolsMonitoringSettings">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                     <element name="enabled" type="xsd:boolean" minOccurs="0"/>
                     <element name="vmMonitoring" type="xsd:string" minOccurs="0"/>
                     <element name="clusterSettings" type="xsd:boolean" minOccurs="0"/>
                     <element name="failureInterval" type="xsd:int" minOccurs="0"/>
                     <element name="minUpTime" type="xsd:int" minOccurs="0"/>
                     <element name="maxFailures" type="xsd:int" minOccurs="0"/>
                     <element name="maxFailureWindow" type="xsd:int" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Data Object - ClusterVmToolsMonitoringSettings

Data Object Description