Share via

Cluster Control Codes

  • Article

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

Cluster control codes use the CLUS_OBJECT_CLUSTER value of the CLUSTER_CONTROL_OBJECT enumeration to indicate that the control code applies to clusters. For more information about control codes, see Control Code Architecture.

Cluster control codes are enumerated by the CLUSCTL_CLUSTER_CODES enumeration.

In this section

CLUSCTL_CLUSTER_CHECK_VOTER_DOWN

Queries the server for whether taking a quorum resource offline or stopping an active node will cause the cluster to lose quorum.

CLUSCTL_CLUSTER_CHECK_VOTER_EVICT

Queries the server for whether evicting the designated configured node from the cluster or changing the cluster quorum configuration will cause the loss of quorum.

CLUSCTL_CLUSTER_CLEAR_NODE_CONNECTION_INFO

TBD. Applications use this control code as a parameter to the ClusterControl function.

CLUSCTL_CLUSTER_ENUM_COMMON_PROPERTIES

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

CLUSCTL_CLUSTER_ENUM_PRIVATE_PROPERTIES

Retrieves a list of the cluster private property names.

CLUSCTL_CLUSTER_GET_CLUSDB_TIMESTAMP

Retrieves a cluster database timestamp for a cluster.

CLUSCTL_CLUSTER_GET_COMMON_PROPERTIES

Retrieves the read/write cluster common properties for a cluster.

CLUSCTL_CLUSTER_GET_COMMON_PROPERTY_FMTS

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

CLUSCTL_CLUSTER_GET_FQDN

Retrieves the fully qualified domain name (FQDN) of a cluster.

CLUSCTL_CLUSTER_GET_GUM_LOCK_OWNER

Retrieves the name of the current Global Update Manager (GUM) lock owner for a cluster.

CLUSCTL_CLUSTER_GET_PRIVATE_PROPERTIES

Retrieves the read/write private properties for a cluster.

CLUSCTL_CLUSTER_GET_PRIVATE_PROPERTY_FMTS

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

CLUSCTL_CLUSTER_GET_RO_COMMON_PROPERTIES

Retrieves the read-only common properties for a cluster.

CLUSCTL_CLUSTER_GET_RO_PRIVATE_PROPERTIES

Retrieves the read-only private properties for a cluster.

CLUSCTL_CLUSTER_GET_SHARED_VOLUME_ID

verifies that a path is on a CSV and returns the resource identifier of the CSV and the volume offset of the specific volume

CLUSCTL_CLUSTER_GET_STORAGE_CONFIG_ATTRIBUTES

Retrieves the storage configuration attributes for a cluster.

CLUSCTL_CLUSTER_GET_STORAGE_CONFIGURATION

Retrieves the storage configuration for a cluster.

CLUSCTL_CLUSTER_REMOVE_NODE

Removes a node from a cluster.

CLUSCTL_CLUSTER_SET_ACCOUNT_ACCESS

Updates the account access settings for a cluster.

CLUSCTL_CLUSTER_SET_DNS_DOMAIN

Updates the DNS domain settings for a cluster.

CLUSCTL_CLUSTER_SET_CLUSTER_S2D_CACHE_METADATA_RESERVE_BYTES

Sets the size of Storage Spaces Direct (S2D) metadata reserve.

CLUSCTL_CLUSTER_SET_CLUSTER_S2D_ENABLED

Enables or disabled Storage Spaces Direct (S2D) on a cluster.

CLUSCTL_CLUSTER_SET_COMMON_PROPERTIES

Updates the read/write common properties for a cluster.

CLUSCTL_CLUSTER_SET_PRIVATE_PROPERTIES

Updates the read/write private properties for a cluster.

CLUSCTL_CLUSTER_SET_STORAGE_CONFIGURATION

Updates a storage configuration for a cluster.

CLUSCTL_CLUSTER_SHUTDOWN

Instructs the server to inform every active node in the cluster to stop participating in the cluster.

CLUSCTL_CLUSTER_UNKNOWN

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

CLUSCTL_CLUSTER_VALIDATE_COMMON_PROPERTIES

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

CLUSCTL_CLUSTER_VALIDATE_PRIVATE_PROPERTIES

Verifies that a property list is properly formatted. Applications use this control code as a ClusterControl parameter.

Failover Cluster Control Codes

ClusterControl