Share via


CheckHeartbeat

Indicates whether the heartbeat of the virtual machine (VM) should be used to determine the health of the VM. To enable the CheckHeartbeat property, the Heartbeat Integration Component must be installed in the guest VM. The following table summarizes the attributes of the CheckHeartbeat property.

Attribute Value
Data type DWORD
Access Read/write
Status Required
Structure CLUSPROP_DWORD
Minimum 0
Maximum 1
Default 0

Remarks

The following table summarizes the values for CheckHeartbeat.

Name Value Description
Don't Check Heartbeat
0 (Default)
The heartbeat is not checked.
Check Heartbeat
1
The heartbeat is checked; if the heartbeat fails, a resource failure is signaled.

Examples

The property value portion of a property list entry for CheckHeartbeat can be set with the following example code.

DWORD          CheckHeartbeatData = 1;
CLUSPROP_DWORD CheckHeartbeatValue;

CheckHeartbeatValue.Syntax.dw = CLUSPROP_SYNTAX_LIST_VALUE_DWORD;
CheckHeartbeatValue.cbLength  = sizeof(DWORD);
CheckHeartbeatValue.dw        = CheckHeartbeatData;

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2008 R2 Datacenter, Windows Server 2008 R2 Enterprise

See also

Virtual Machine Private Properties

CLUSPROP_DWORD