The GetClusterNodeState function returns the current state of a node.
CLUSTER_NODE_STATE WINAPI GetClusterNodeState(
HNODE hNode
);
If the operation was successful, GetClusterNodeState returns the current state of the node, which is represented by one of the following values:
| State | Description |
|---|---|
| ClusterNodeUp | The node is operational. |
| ClusterNodeDown | The node is not operational. |
| ClusterNodeJoining | The node is in the process of joining a cluster. |
| ClusterNodePaused | The node has temporarily suspended activity. |
If the operation was unsuccessful, GetClusterNodeState returns ClusterNodeStateUnknown. For more detailed information about the error, call the Win32 function GetLastError.
When a node is trying to form or rejoin a cluster or is down, it is in the ClusterNodeDown state. A node that is down is not an active cluster member and it may or may not be running. The Cluster Service may have started and then failed, or may have failed to start completely.
When a node is operating as an active member of a cluster, it is in the ClusterNodeUp state. An node that is up responds to updates to the cluster database, can host and manage groups, and can maintain communication with other nodes in the cluster.
When a node is operating as an active member of a cluster but cannot host any resources or resource groups, it is in the ClusterNodePaused state. Nodes that are undergoing maintenance are typically placed in this state.
Version: Use Windows NT Server Enterprise Edition 4.0.
Windows CE: Unsupported.
Header: Declared in clusapi.h.