Share via


Node Control Codes

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

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

Node control codes are enumerated by the CLUSCTL_NODE_CODES enumeration.

In this section

CLUSCTL_NODE_INJECT_GEM_FAULT

TBD.

CLUSCTL_NODE_SEND_DUMMY_GEM_MESSAGES

TBD.

CLUSCTL_NODE_INTRODUCE_GEM_REPAIR_DELAY

TBD.

CLUSCTL_NODE_GET_GEMID_VECTOR

TBD.

CLUSCTL_NODE_BLOCK_GEM_SEND_RECV

TBD.

CLUSCTL_NODE_ENUM_COMMON_PROPERTIES

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

CLUSCTL_NODE_ENUM_PRIVATE_PROPERTIES

Retrieves a list of node private property names.

CLUSCTL_NODE_GET_CHARACTERISTICS

Retrieves the intrinsic characteristics of a node.

CLUSCTL_NODE_GET_CLUSTER_SERVICE_ACCOUNT_NAME

Retrieves the user account name under which the cluster service is running on a node.

CLUSCTL_NODE_GET_COMMON_PROPERTIES

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

CLUSCTL_NODE_GET_COMMON_PROPERTY_FMTS

Reserved for future use.

CLUSCTL_NODE_GET_FLAGS

Retrieves the flags that are set for a node.

CLUSCTL_NODE_GET_ID

Retrieves the unique cluster identifier for a node.

CLUSCTL_NODE_GET_NAME

Retrieves the name of a node.

CLUSCTL_NODE_GET_PRIVATE_PROPERTIES

Retrieves the read/write private properties for a node.

CLUSCTL_NODE_GET_PRIVATE_PROPERTY_FMTS

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

CLUSCTL_NODE_GET_RO_COMMON_PROPERTIES

Retrieves the read-only common properties for a node.

CLUSCTL_NODE_GET_RO_PRIVATE_PROPERTIES

Retrieves the read-only private properties for a node.

CLUSCTL_NODE_GET_STUCK_NODES

Retrieves the bitmap that represents the set of nodes that the current Global Update Manager (GUM) lock owner is waiting for.

CLUSCTL_NODE_SET_COMMON_PROPERTIES

Updates the read/write common properties for a node.

CLUSCTL_NODE_SET_PRIVATE_PROPERTIES

Updates the read/write private properties for a node.

CLUSCTL_NODE_UNKNOWN

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

CLUSCTL_NODE_VALIDATE_COMMON_PROPERTIES

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

CLUSCTL_NODE_VALIDATE_PRIVATE_PROPERTIES

Verifies that a property list is properly formatted.

Failover Cluster Control Codes

ClusterNodeControl