Share via


ClusResGroup.State property

[The State property is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions.]

Returns the state of a group.

This property is read-only.

Syntax

ClusResGroup.State As CLUSTER_GROUP_STATE

Property value

The State property returns one of the following values.

ClusterGroupStateUnknown (-1)

The State property has failed; the state of the group is unknown.

ClusterGroupOnline (0)

All of the resources in the group are online.

ClusterGroupOffline (1)

All of the resources in the group are offline or there are no resources in the group.

ClusterGroupFailed (2)

At least one resource in the group has failed.

ClusterGroupPartialOnline (3)

At least one resource in the group is online. No resources are pending or failed.

ClusterGroupPending (4)

At least one resource in the group is in a pending state. There are no failed resources.

To retrieve the state of a node or resource, use the State property of the appropriate ClusNode or ClusResource object.

Remarks

For information on making constants defined by the Cluster Automation Server type library (MsClus.tlb) available to scripts, see Creating a Cluster Automation Server Script.

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Header
MsClus.h
IDL
MsClus.idl
Type library
MsClus.tlb
DLL
MsClus.dll
IID
IID_ISClusResGroup is defined as F2E60706-2631-11D1-89F1-00A0C90D061E

See also

ClusNode

ClusResGroup

ClusResource

CLUSTER_GROUP_STATE