Cluster node

  • Article

Applies To: Windows Server 2003, Windows Server 2003 R2, Windows Server 2003 with SP1, Windows Server 2003 with SP2

Cluster node

The cluster node command is used to administer a node in a server cluster or to view its status. Used without parameters, cluster node defaults to the /status command-line option and displays the status for all nodes is displayed.

Syntax

cluster[[/cluster:]ClusterName] node NodeName **/**Option

Parameters
  • /stat[us]
    Displays the cluster node status (for example, Up, Down, Paused).
  • /force[cleanup] [/wait**[**:Timeout_in_Seconds]]
    Manually restores the configuration of the Cluster service on the specified node to its original state.
  • /start [/wait**[**:Timeout_in_Seconds]]
    Starts the Cluster service on the specified node.
  • /stop [/wait**[**:Timeout_in_Seconds]]
    Stops the Cluster service on the specified node.
  • /pause
    Pauses a node.
  • /resume
    Resumes a paused node.
  • /evict [/wait**[**:Timeout_in_Seconds]]
    Evicts a node from a cluster.
  • /listint[erfaces]
    Lists the node's network interfaces.
  • /prop[erties] [PropertyList]
    Views or sets node common properties.
  • /priv[properties] [PropertyList]
    Views or sets node private properties.
  • /?
    Displays help at the command prompt.
Remarks

  • Using the cluster node command

    The cluster name is optional. If the name of your cluster is also a cluster command or its abbreviation, such as "node", use /cluster: to explicitly specify the cluster name. For a list of all the cluster commands, see Related Topics.

    With /force[cleanup], /start, /stop, and /evict, the command-line option /wait[:Timeout_in_Seconds] specifies how long Cluster.exe waits before canceling the command if it does not successfully complete. If a time-out is not specified, Cluster.exe waits indefinitely or until the node state changes.

    The node name (node_name) is optional for all commands except for /listint[erfaces] or when you use the /prop[erties] or /priv[properties] commands to set common or private properties.

  • Using the /stat[us] command-line option

    The node name is optional. The status of all nodes is displayed if you do not provide a node name.

  • Using the /evict command-line option

    If both the node and the cluster are up, this command evicts the node and removes the cluster configuration from the node. If the cluster is up, but the node is down, this command only evicts the node. The Cluster service will then remove the cluster configuration for the node when it detects that the node no longer belongs to the cluster.

  • Using the /force[cleanup], /start, /stop, /pause, /resume, or /evict command-line options

    If the node name is not specified, the command will take effect on the local node, that is, the node where the command is run.

  • Using the /prop[erties] [PropertyList] command-line option

    The node name is optional. If you do not specify a node name, properties for all nodes are displayed. For more information on property lists, see Related Topics.

  • Using the /priv[properties] [PropertyList] command-line option

    The node name is optional. If you do not provide a node name, private properties for all nodes are displayed . For more information on property lists, see Related Topics.

  • Using the /stat[us], /prop[erties], or /priv[properties] command-line options

    If the node name is not specified, the command will display results for all nodes in the cluster.

  • Using cluster node common property names

    The following table describes the common cluster node property names, their uses, and valid settings.

    Common property names Use

    Description

    Describes a node.

    EventEnableLogReplication

    Specifies if Event Log Replication is enabled or disabled on a node. (True (1) means enabled; False (0) means disabled.) If the cluster Event Log Replication is disabled, Event Log Replication on a node is disabled, regardless of property setting.

    NodeName

    Displays the name of the node.

    NodeHighestVersion

    NodeLowestVersion

    Displays the highest and lowest versions of the Cluster service with which a node is compatible.

    MajorVersion

    MinorVersion

    Displays the version of the operating system installed on the node (for example, MajorVersion=5 and MinorVersion=00 indicates a version number of 5.00).

    BuildNumber

    Displays the build number of the operating system installed on the node.

    CSDVersion

    Displays the version of the latest service pack installed on the node.

  • Using cluster node private property name

    By default, there are no private properties for cluster node. Software vendors can add private properties to extend cluster functionality.

Examples

To display the status of a node named OpsNode1, type:

cluster node opsnode1 /status

Formatting legend

Format Meaning

Italic

Information that the user must supply

Bold

Elements that the user must type exactly as shown

Ellipsis (...)

Parameter that can be repeated several times in a command line

Between brackets ([])

Optional items

Between braces ({}); choices separated by pipe (|). Example: {even|odd}

Set of choices from which the user must choose only one

Courier font

Code or program output

See Also

Concepts

Command-line reference A-Z
Command shell overview
Property lists

Other Resources

Cluster commands overview