Group Management Functions

The group management functions in the Cluster API provide access to each of the groups in a cluster. These functions allow callers to change a group's membership or state and retrieve a variety of information. The group management functions are implemented primarily by the Cluster Service's Resource and Failover Managers and are briefly described in the following table:

Function Description
CloseClusterGroup Closes a group by invalidating its handle, a handle returned from either OpenClusterGroup or CreateClusterGroup.
ClusterGroupCloseEnum Closes a group enumerator object by invalidating its handle, a handle returned from ClusterGroupOpenEnum.
ClusterGroupControl Initiates an operation that affects a group.
ClusterGroupEnum Enumerates the resources in a group and/or the nodes that are possible owners of a group, returning the name of the resource or node with each call.
ClusterGroupOpenEnum Opens an enumerator for iterating through a group's resources and/or the nodes that are included in its list of possible owners.
CreateClusterGroup Adds a group to a cluster and returns a handle to the newly added group.
DeleteClusterGroup Removes a group from a cluster.
GetClusterGroupState Returns the current state of a group.
MoveClusterGroup Moves a group and all of its resources from one node to another.
OfflineClusterGroup Takes an online group offline.
OnlineClusterGroup Takes an offline group online.
OpenClusterGroup Opens a group and returns a handle to it.
SetClusterGroupName Sets the name for a group.
SetClusterGroupNodeList Sets the preferred node list for a group.