FailoverPeriod Property for Groups

The FailoverPeriod property specifies a number of hours during which the Cluster Service can attempt to failover the group.

Quick Info

Type: DWORD
Access: Read/write
Function: ClusterGroupControl
Structure: CLUSPROP_DWORD
Control Code: CLUSCTL_GROUP_GET_COMMON_PROPERTIES

Remarks

When ClusterGroupControl processes the CLUSCTL_GROUP_GET_COMMON_PROPERTIES control code, it returns a property list that includes the FailoverPeriod property as one of the entries. The property value portion of the entry contains a CLUSPROP_DWORD structure that is set as follows:

DWORD FailoverPeriodData = 5;
CLUSPROP_DWORD FailoverPeriodValue;
FailoverPeriodValue.Syntax = CLUSPROP_SYNTAX_LIST_VALUE_DWORD;
FailoverPeriodValue.cbLength = sizeof(DWORD);
FailoverPeriodValue.dw = FailoverPeriodData;
 

The FailoverThreshold property specifies the number of attempts within a number of hours defined by the FailoverPeriod property that the Cluster Service can try to failover the group. For example, if FailoverThreshold is set to two and RestartPeriod is set to one, then a node can tolerate two failover attempts of the group within any one hour interval. On the third failover attempt within one hour, the node will not attempt to move the group. More than three failover attempts can occur, as long as they occur over an interval that is greater than one hour.

If a value for FailoverPeriod is not specified, the default value is six hours.

QuickInfo

  Version: Use Windows NT Server Enterprise Edition 4.0.
  Windows CE: Unsupported.
  Header: Declared in clusapi.h.