Group Control Codes

  • Article

The Failover Cluster API defines the following external control codes for groups (there are no internal control codes defined for groups):

Group control codes use the CLUS_OBJECT_GROUP value of the CLUSTER_CONTROL_OBJECT enumeration to indicate that the control code applies to cluster groups. For more information about control codes, see Control Code Architecture.

Group control codes are enumerated by the CLUSCTL_GROUP_CODES enumeration.

In this section

CLUSCTL_GROUP_ENUM_COMMON_PROPERTIES

Retrieves a list of the read/write group common property names for a group.

CLUSCTL_GROUP_ENUM_PRIVATE_PROPERTIES

Retrieves a list of the private property names for a group.

CLUSCTL_GROUP_GET_CHARACTERISTICS

Retrieves the intrinsic characteristics of a group.

CLUSCTL_GROUP_GET_COMMON_PROPERTIES

Retrieves the read/write group common properties for a group. Applications use this control code as a ClusterGroupControl parameter.

CLUSCTL_GROUP_GET_COMMON_PROPERTY_FMTS

Retrieves a property list describing the format of each group common property.

CLUSCTL_GROUP_GET_FAILURE_INFO

Retrieves information about a group failure.

CLUSCTL_GROUP_GET_FLAGS

Retrieves the flags that are set for a group.

CLUSCTL_GROUP_GET_ID

Retrieves the cluster database subkey identifier for a group.

CLUSCTL_GROUP_GET_LAST_MOVE_TIME

Gets the last time a resource group moved.

CLUSCTL_GROUP_GET_NAME

Retrieves the name of a group.

CLUSCTL_GROUP_GET_PRIVATE_PROPERTIES

Retrieves the read/write private properties for a group.

CLUSCTL_GROUP_GET_PRIVATE_PROPERTY_FMTS

The CLUSCTL_NETINTERFACE_GET_PRIVATE_PROPERTY_FMTS control code is not supported and fails with ERROR_INVALID_FUNCTION.

CLUSCTL_GROUP_GET_PROVIDER_COLLECTIONS

Retrieves the collections that come from providers by specifying a group.

CLUSCTL_GROUP_GET_PROVIDER_GROUPS

Retrieves the groups that come from providers by specifying a group.

CLUSCTL_GROUP_GET_RO_COMMON_PROPERTIES

Retrieves the read-only common properties for a group.

CLUSCTL_GROUP_GET_RO_PRIVATE_PROPERTIES

Retrieves the read-only private properties for a group.

CLUSCTL_GROUP_QUERY_DELETE

The CLUSCTL_GROUP_QUERY_DELETE control code is reserved for future use.

CLUSCTL_GROUP_SET_COMMON_PROPERTIES

Updates the read/write common properties for a group.

CLUSCTL_GROUP_SET_PRIVATE_PROPERTIES

Updates the read/write private properties for a group.

CLUSCTL_GROUP_UNKNOWN

verifies that control codes are being processed on the node where execution of the control is directed.

CLUSCTL_GROUP_VALIDATE_COMMON_PROPERTIES

Verifies that a property list contains valid group property names and values and that the list is properly formatted.

CLUSCTL_GROUP_VALIDATE_PRIVATE_PROPERTIES

Verifies that a group private property list is properly formatted.

Failover Cluster Control Codes

ClusterGroupControl