Share via

Group Management Functions

  • Article

The group management functions manage cluster groups.

In this section

AddClusterGroupDependency

Adds a dependency between two cluster groups.

CancelClusterGroupOperation

Enables a client to cancel a MoveClusterGroup or MoveClusterGroupEx operation that is pending for a group. The group is then returned to its persistent state.

CloseClusterGroup

Closes a group handle.

ClusterGroupCloseEnum

Closes a group enumeration handle.

ClusterGroupCloseEnumEx

Closes the enumeration and frees any memory held by the hGroupEnumEx handle.

ClusterGroupEnum

Enumerates the resources in a group or the nodes that are the preferred owners of a group, returning the name of the resource or node with each call.

ClusterGroupEnumEx

Retrieves an item in the enumeration.

ClusterGroupGetEnumCount

Returns the number of cluster objects associated with a group enumeration handle.

ClusterGroupGetEnumCountEx

Returns the number of elements in the enumeration.

ClusterGroupOpenEnum

Opens an enumerator for iterating through a group's resources and/or the nodes that are included in its list of preferred owners.

ClusterGroupOpenEnumEx

Opens a handle to the group enumeration.

CreateClusterGroup

Adds a group to a cluster and returns a handle to the newly added group.

CreateClusterGroupEx

Creates a new cluster group with the options specified in the CLUSTER_CREATE_GROUP_INFO structure in a single operation.

DeleteClusterGroup

Removes an offline and empty group from a cluster.

DestroyClusterGroup

Deletes the specified group from a cluster.

GetClusterFromGroup

Returns a handle to the cluster associated with a group.

GetClusterGroupState

Returns the current state of a group.

MoveClusterGroup

Moves a group and all of its resources from one node to another.

MoveClusterGroupEx

Extends the existing MoveClusterGroup method with the addition of flags and a buffer.

OfflineClusterGroup

Takes a group offline.

OfflineClusterGroupEx

Extends the OfflineClusterGroup method. The client can use the flags to control failover policies of the group and the input buffer to send specific instructions for the offline operation to the resources in the target group. For instance, the input buffer can be used to instruct a virtual machine to go offline by saving its state as opposed to shutting down.

OnlineClusterGroup

Brings a group online.

OnlineClusterGroupEx

Brings a group online.

OpenClusterGroup

Opens a failover cluster group and returns a handle to it.

OpenClusterGroupEx

Opens a failover cluster group and returns a handle to it.

RemoveClusterGroupDependency

Removes a dependency between two cluster groups.

SetClusterGroupName

Sets the name for a group.

SetClusterGroupNodeList

Sets the preferred node list for a group.

SetGroupDependencyExpression

Sets the dependency expression for a cluster group.

Failover Cluster Object Management Functions