Share via


IVMGuestOS::IsHeartbeating property

The IsHeartbeating property indicates whether the guest operating system appears live. The Additions will send a periodic heartbeat to Virtual Server while the guest operating system is running.

This property is read-only.

Syntax

HRESULT get_IsHeartbeating(
  [out] VARIANT_BOOL *heartBeating
);

VB
VMGuestOS.IsHeartbeating( _
  ByRef heartBeating _
)

Property value

Contains vbTrue if a heartbeat is detected.

This property value is read-only.

Error codes

Name Meaning
S_OK
The operation was successful.
E_POINTER
The heartBeating parameter is NULL.
VM_E_VM_UNKNOWN
The configuration is unknown.
VM_E_VM_NOT_RUNNING
The virtual machine is not running.
VM_E_ADDITIONS_NOT_AVAIL
The virtual machine is not fully booted, Additions are not installed, or the installed version does not support this feature.
DISP_E_EXCEPTION
An unexpected error has occurred.

Remarks

When Additions is installed in the guest operating system, a regular 'tick' or heartbeat is sent from the virtual machine session to Virtual Server. If the guest operating system is heavily loaded, it's possible that Virtual Server will receive fewer heartbeats than expected. If no heartbeat is detected, it is possible that the guest operating system has stopped responding or has crashed.

By default, a virtual machine produces ten heartbeat ticks per minute. If no heartbeat ticks are detected for an entire minute, Virtual Server will attempt to restart the virtual machine session once every ten seconds for up to two minutes. This behavior is controlled by the following key values in the virtual machine session's configuration file.

Configuration key Default Description
integration/microsoft/heartbeat/time 60 seconds Length of the block of time in seconds used to generate heartbeat ticks.
integration/microsoft/heartbeat/rate 10 Number of ticks generated in each heartbeat time block.
integration/microsoft/heartbeat/failure_interval 10 seconds Number of seconds between restart attempts, once no heartbeat ticks are received within a specific heartbeat time block.
integration/microsoft/heartbeat/failure_attempts 12 Number of restart attempts made.

The virtual machine must be running (that is, fully booted and not shutting down) and Additions must be installed when this method is invoked.

Requirements

Product
Microsoft Virtual Server 2005 onWindows Server 2003
Download
Microsoft Virtual Server 2005 R2 SP1 Update onWindows Server 2008orWindows Server 2003
Header
VsComInterfaces.h

See also

IVMGuestOS