Cluster Control Codes
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
-
Queries the server for whether taking a quorum resource offline or stopping an active node will cause the cluster to lose quorum.
-
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.
-
TBD. Applications use this control code as a parameter to the ClusterControl function.
-
Retrieves a list of the read/write cluster common property names.
-
Retrieves a list of the cluster private property names.
-
Retrieves a cluster database timestamp for a cluster.
-
Retrieves the read/write cluster common properties for a cluster.
-
Retrieves a property list describing the format of each cluster common property.
-
Retrieves the fully qualified domain name (FQDN) of a cluster.
-
Retrieves the name of the current Global Update Manager (GUM) lock owner for a cluster.
-
Retrieves the read/write private properties for a cluster.
-
The CLUSCTL_CLUSTER_GET_PRIVATE_PROPERTY_FMTS control code is not supported and fails with ERROR_INVALID_FUNCTION.
-
Retrieves the read-only common properties for a cluster.
-
Retrieves the read-only private properties for a cluster.
-
verifies that a path is on a CSV and returns the resource identifier of the CSV and the volume offset of the specific volume
-
Retrieves the storage configuration attributes for a cluster.
-
Retrieves the storage configuration for a cluster.
-
Removes a node from a cluster.
-
Updates the account access settings for a cluster.
-
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.
-
Enables or disabled Storage Spaces Direct (S2D) on a cluster.
-
Updates the read/write common properties for a cluster.
-
Updates the read/write private properties for a cluster.
-
Updates a storage configuration for a cluster.
-
Instructs the server to inform every active node in the cluster to stop participating in the cluster.
-
verifies that control codes are being processed on the node where execution of the control is directed.
-
Verifies that a property list contains valid cluster property names and values and that the list is properly formatted.
-
Verifies that a property list is properly formatted. Applications use this control code as a ClusterControl parameter.
Related topics