CLUSTER

You can use cluster commands to administer server clusters from the Windows command prompt. You can also call the program from command scripts to automate many cluster administration tasks. Cluster is provided on all Windows computers.

You can administer clusters from a node of the cluster, from nodes of other clusters, or from other computers running Windows NT 4.0 with Service Pack 3 or later.

Syntax

CLUSTER /LIST[:domain_name]

CLUSTER /HELP | /?

CLUSTER [/CLUSTER:]cluster_name /ADD[NODES][:node_name[,node_name, ...]] /PASS[WORD]:pass_word [/VERB[OSE]] [/UNATTEND[ED]] [/MIN[IMUM]]

CLUSTER [/CLUSTER:]cluster_name /CHANGEPASS[WORD][:new_password[,old_password]] [/SKIPDC] [/FORCE] [/TEST] [/QUIET] [/VERB[OSE]] [/UNATTEND[ED]] [/HELP]

CLUSTER [/CLUSTER:]cluster_name /CREATE /IPADDR[ESS]:Static_IP_Address[,SubnetMask,NetworkConnectionName] /PASS[WORD]:pass_word /USER:{domain\user_name | user_name@domain} [/NODE:node_name] [/VERB[OSE]] [/UNATTEND[ED]] [/MIN[IMUM]]

Parameters

name=value[,value ...][:format][name=value[,value ...][:format] ...] (NT2000)

:name[,name ...] /userdefault (NT2000)

To revert to the default value of a common property or to delete a private property, use the /usedefault option.

Binary Separated list of values from 0 to 255
DWord Double word
Str[ing] Double quotation marks are required around strings with spaces
ExpandStr[ing] Expanded by Cluster
MultiStr[ing] List of strings separated by commas
Security Set access privileges.
- Access types:
  - grant
  - deny
  - set
  - revoke (Does not require Access mask)
- Access masks:
  - R read
  - C change
  - F full
ULarge Unsigned 64-bit value

Switches

/HELP | /? (NT2000)

Display cluster syntax. Default.

CHANGEPASS[WORD]: help for change password option only.

/ADD[NODES][:node_name[,node_name, ...]] (NT2003)

Creates a cluster.

/CHANGEPASS[WORD][:new_password[,old_password]] (NT2003)

For one or more clusters, changes the Cluster service account password on the domain controller and all the cluster nodes from old_password to new_password. If not supplied as part of the command, you will be prompted to provide the new_password or the old_password. You can specify a blank password by supplying two double quotes (""). If multiple clusters are specified in one operation, they must all use the same Cluster service account.

/CLUSTER (NT2000)

If you do not specify a cluster, attempts to connect to the cluster running on the node that is running the command.

If the name of your cluster is also a cluster command or its abbreviation, use /cluster: to explicitly specify the cluster name.

/CREATE (NT2003)

Creates a cluster.

/FORCE (NT2003)

Force execution of the password change command on the available nodes in a cluster even if some of the cluster nodes are not available.

/IPADDR[ESS]:Static_IP_Address[,SubnetMask,NetworkConnectionName] (NT2000)

/LIST[:domain_name] (NT2000)

Display a list of clusters in the computer's domain or a specified domain. Do not use the cluster name with this option.

/LISTNETPRI[ORITY] (NT2003)

Lists the priority of all internal (private and mixed) networks.

/MAXLOGSIZE:max_size_kb (NT2000)

Change the size of the quorum resource log.

/MIN[IMUM] (NT2003)

Creates a cluster using the Advanced (minimum) Configuration option. Use when creating clusters with complex storage configurations.

/NODE:node_name (NT2003)

The name of the server to be configured as the first cluster node. Will default to use the name of the current computer.

/PASS[WORD]:pass_word (NT2003)

/PATH:path (NT2000)

Change the location of the quorum resource.

/PRIV[PROPERTIES] (NT2000)

View or set the cluster private properties.

/PROP[ERTIES] (NT2000)

View or set the cluster common properties.

/QUIET (NT2003)

No output, unless an error occurs.

/QUORUM[RESOURCE][:resource_name] (NT2000)

Change the name of the quorum resource.

/[UN]REG[ADMIN]EXT:admin_extension_dll[,admin_extension_dll ...] (NT2000)

/REN[AME]:cluster_name (NT2000)

Rename a cluster.

/SETFAIL[UREACTIONS][:node_name[,node_name ...]] (NT2000)

Resets the restart actions settings that the Services Microsoft Management Console snap-in uses for the Cluster service to the original values used at setup.

Resets the Cluster service restart settings for one or more nodes to the values:

First failure Restart the service
Second failure Restart the service
Subsequent failure Restart the service
Reset fail count after N days 0 days
Restart service after N minutes 1 minute

/SETNETPRI[ORITY]:node_name[,node_name, ...] (NT2003)

Sets the priority order for all internal networks. If you use this option, you must supply all the internal networks in the cluster.

/SKIPDC (NT2003)

Change the Cluster service account password only on the cluster nodes. It will not change the password on the domain controller. Use to complete a previous password update that was only partially completed.

Note If used, you do not have to supply the old_password.

/TEST (NT2003)

Open a connection to the specified cluster(s), verify that an appropriate domain controller is available, check the version of the operating system installed on each node, and verify that all the cluster nodes are online and use the same Cluster service account.

/UNATTEND[ED] (NT2003)

Will not be prompted for passwords not supplied at the command prompt.

/USER:{domain\user_name | user_name@domain} (NT2003)

/VERB[OSE] (NT2003)

Writes all event messages to the cluster log. Use for troubleshooting cluster configuration issues.

CHANGEPASS[WORD]: Outputs detailed information about the cluster nodes to the screen. Use for troubleshooting password change issues.

/VER[SION] (NT2000)

Display the Cluster service version number.

/WIZ[ARD] (NT2003)

Starts the Cluster Configuration Wizard. Must be used with either the /create or /add[nodes].

Important You cannot supply the subnet mask or network connection name to create a cluster. The program will use the information from the network connection with the same subnet mask as the cluster to supply the subnet mask, and network connection name.

Notes

Common cluster property names:

AdminExtensions Describes one or more class identifiers (CLSIDs) of Cluster Administrator extension for the cluster object
DefaultNetworkRole Specifies the default role to assign to networks
Description Specifies administrative description of the cluster
EnableEventLogReplication Specifies if Event Log Replication is enabled or disabled cluster wide. (True (1) means enabled; False (0) means disabled.)
Groups\AdminExtensions Describes one or more class identifiers (CLSIDs) of Cluster Administrator extensions for the groups
NetInterfaces\AdminExtensions Describes one or more class identifiers (CLSIDs) of Cluster Administrator extensions for the netinterfaces
Networks\AdminExtensions Describes one or more class identifiers (CLSIDs) of Cluster Administrator extensions for the networks
Nodes\AdminExtensions Describes one or more class identifiers (CLSIDs) of Cluster Administrator extensions for the nodes
Resources\AdminExtensions Describes one or more class identifiers (CLSIDs) of Cluster Administrator extensions for the resources
ResourceTypes\AdminExtensions Describes one or more class identifiers (CLSIDs) of Cluster Administrator extensions for the resource types
Security Describes Windows 2000-compatible security descriptor
SecurityDescriptor Describes Windows NT-SP4 and Windows 2000-compatible security descriptor

Examples

none.

Errorlevels

none.

Availability

External

DOS: none
Windows: none
Windows NT: NT2000 NT2003

Last Updated: 2003/07/28
Direct corrections or suggestions to: Rick Lively