CLUSTER RESOURCE

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.

CLUSTER RES[OURCE] [/? | /HELP]

CLUSTER [[/CLUSTER:]cluster_name] RES[OURCE]
[/NODE:node_name
| /PRIV[PROPERTIES]
| /PROP[ERTIES]]

CLUSTER [[/CLUSTER:]cluster_name] RES[OURCE] [resource_name]
[/CHECK[POINTS]
| /CRYPTOCHECK[POINTS]
| [/STAT[US]]]

CLUSTER [[/CLUSTER:]cluster_name] RES[OURCE] resource_name
[/ADDCHECK[POINTS]:key[\subkey...[,key[\subkey... ...]]
| /ADDCRYPTOCHECK[POINTS]:key[\subkey...[,key[\subkey... ...]]
| /ADDDEP[ENDENCY]:resource_name
| /ADDOWNER:node_name
| /CREATE /GROUP:group_name /TYPE:resource_type [/SEPARATE]
| /DELETE
| /FAIL
| /LISTDEP[ENDENCIES]
| /LISTOWNERS
| /MOVE[TO]:group_name
| /OFF[LINE] [/WAIT[:time_seconds]]
| /ON[LINE] [/WAIT[:time_seconds]]
| /PRIV[PROPERTIES] [property_list]
| /PRIV[PROPERTIES] [:propname[,propname ...] [/USEDEFAULT]]
| /PROP[ERTIES] [property_list]
| /PROP[ERTIES] [:propname[,propname ...] [/USEDEFAULT]]
| /REMOVECHECK[POINTS]:key[\subkey...[,key[\subkey... ...]]
| /REMOVECRYPTOCHECK[POINTS]:key[\subkey...[,key[\subkey... ...]]
| /REMOVEDEP[ENDENCY]:resource_name
| /REMOVEOWNER:node_name
| /REN[AME]:resource_name]

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

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

• 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

resource_name (NT2000)

?

/HELP | /? (NT2000)

Display cluster group syntax. Default.

/ADDCHECK[POINTS]:key[\subkey...[,key[\subkey... ...] (NT2000)

Add a registry checkpoint for a resource.

/ADDCRYPTOCHECK[POINTS]:key[\subkey...[,key[\subkey... ...] (NT2000)

Add a cryptographic key checkpoint for a resource.

/ADDDEP[ENDENCY]:resource_name (NT2000)

Add a dependency for a resource.

/ADDOWNER:node_name (NT2000)

Add a node name to the list of possible owners.

/CHECK[POINTS] (NT2000)

List registry checkpoints for a resource. Checkpoints for all cluster resources are displayed if you do not provide a resource name.

/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 /GROUP:group_name /TYPE:resourcetype (NT2000)

Create a new resource in a specified group.

/CRYPTOCHECK[POINTS] (NT2000)

List cryptographic key checkpoints for a resource. If you do not provide a resource name, checkpoints for all cluster resources are displayed.

/DELETE (NT2000)

Delete a resource.

/FAIL (NT2000)

Initiate resource failure.

/LISTDEPENDENCIES (NT2000)

List the dependencies for a resource.

/LISTOWNERS (NT2000)

Display a list of possible owners.

/MOVE[TO]:group_name (NT2000)

Move the resource to a different group.

/NODE:node_name (NT2003)

?

/OFF[LINE] (NT2000)

Take the resource offline.

/ON[LINE] (NT2000)

Bring the resource online.

/PRIV[PROPERTIES] (NT2000)

View or set the resource private properties.

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

/PROP[ERTIES] (NT2000)

View or set the resource common properties.

/REMOVECHECK[POINTS]:key[\subkey...[,key[\subkey... ...] (NT2000)

Remove a registry checkpoint for a resource.

/REMOVECRYPTOCHECK[POINTS]:key[\subkey...[,key[\subkey... ...] (NT2000)

Remove a cryptographic key checkpoint for a resource.

/REMOVEDEP[ENDENCY]:resource_name (NT2000)

Remove a dependency for a resource.

/REMOVEOWNER:node_name (NT2000)

Remove a node name from the list of possible owners.

/REN[AME]:resource_name (NT2000)

Rename a resource.

/SEPARATE (NT2000)

The resource should run in a separate Resource Monitor.

/STATUS (NT2000)

Display the status of a cluster resource (Online, Offline, or Failed). If you do not provide a resource name, the status of all cluster resources is displayed.

/USEDEFAULT (NT2000)

To revert to the default value of a common property or to delete a private property.

/WAIT[:time_seconds] (NT2000)

How long to wait before canceling the command if it does not successfully complete. If a time-out is not specified, waits indefinitely or until the group state changes.

Cluster
Cluster Group
Cluster Netinterface
Cluster Network
Cluster Node
Cluster Resourcetype

Common resource property names:

• Name Name of the cluster resource object
• DebugPrefix Specifies the appropriate debugger for the resource. For more information, see the Microsoft Platform Software Development Kit
• Description Describes a resource
• IsAlivePollInterval Interval (in milliseconds) that the Cluster service polls a resource to determine if it is operational. If a value is not specified, a default value is taken from the IsAlivePollInterval property for the specific resource type. IsAlivePollInterval cannot be zero
• LooksAlivePollInterval Recommended interval in milliseconds that the Cluster service polls a resource to determine if it appears operational. If a value is not specified, a default value is taken from the LooksAlivePollInterval property for the resource type
• PendingTimeout The amount of time that a Pending Online or Pending Offline resource has to resolve its status before the Cluster service puts the resource in Offline or Failed status. The default value is 3 minutes
• PersistentState Describes the last known persistent state of a resource. In order to save the resource's PersistentState property, the resource must be offline
• RestartAction Describes the action to perform if the resource fails. The choices are:
  • ClusterResourceDontRestart (0): Do not restart after a failure
  • ClusterResourceRestartNoNotify (1): If the resource exceeds its restart threshold within its restart period, the Cluster service does not attempt to failover the group to another node
  • ClusterResourceRestartNotify (2): If the resource exceeds its restart threshold within its restart period, the Cluster service attempts to failover the group to another node
  If you do not enter a value, the default allows the resource to affect the group, which can cause the group to fail over to another system.
• RestartPeriod Specifies the amount of time allowed for the restart attempts to reach the RestartThreshold before the Cluster service fails over the group
• RestartThreshold Specifies how many times the Cluster service attempts to restart the resource in the RestartPeriod before failing over the group
• SeparateMonitor Indicates whether or not a resource shares a Resource Monitor. Valid values are True (1) and False (0)
• Type Specifies the resource type

none.

none.

External

DOS

none

Windows

none

Windows NT

NT2000 NT2003