Quincy Center for Technical Education
Computer Technology Department

Cluster resource

The basic cluster resource syntax is:

cluster [[/cluster:]cluster name] resource resource name /option

The cluster name is optional. If no option is specified, the default option is /status.

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

With /online and /offline the option /wait[:timeout in seconds] specifies how long Cluster.exe waits before canceling the command if it does not successfully complete. If no time-out is specified, Cluster.exe waits indefinitely or until the resource state changes.

The following table describes the available cluster resource options:

Option

Use to...

/status

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

/create /group: group name /type: resource type [/separate]

Create a new resource in a specified group. Use /separate to specify that the resource should run in a separate Resource Monitor.

/delete

Delete a resource.

/rename: new resource name

Rename a resource.

/addowner:node name

Add a node name to the list of possible owners.

/removeowner:node name

Remove a node name from the list of possible owners.

/listowners

Display a list of possible owners.

/moveto:group

Move the resource to a different group.

/properties [property list]

View or set the resource common properties. The resource name is optional. If you do not provide a resource name, properties for all resources are displayed. For more information on property lists, see Property lists.

/privproperties [property list]

View or set the resource private properties. Resource name is optional. If you do not provide a resource name, private properties for all resources are displayed. For more information on property lists, see Property lists.

/fail

Initiate resource failure.

/online [/wait[:timeout in seconds]]

Bring the resource online.

/offline [/wait[:timeout in seconds]]

Take the resource offline.

/listdependencies

List the dependencies for a resource.

/adddependency: resource

Add a dependency for a resource.

/removedependency:resource

Remove a dependency for a resource.

/addcheckpoints:key[\subkey...][,key[\subkey...]...]

Add a registry checkpoint for a resource.

/removecheckpoints:key[\subkey...][,key[\subkey...]...]

Remove a registry checkpoint for a resource.

/checkpoints

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

/addcryptocheckpoints:key[\subkey...][,key[\subkey...]...]

Add a cryptographic key checkpoint for a resource.

/removecryptocheckpoints:key[\subkey...][,key[\subkey...]...]

Remove a cryptographic key checkpoint for a resource.

/cryptocheckpoints

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

/? or /help

Display cluster resource syntax.

For example, to create a Print Spooler resource in the Ops Print Spoolers group, type the following at the Windows 2000 command prompt:

cluster resource /create /group:"Ops Print Spoolers" /Type:"print spooler"

Cluster resource common property names

The following table describes the common cluster resource property names, their uses, and valid settings:

Common property names

Use

Name

Name of the cluster resource object.

Description

Describes a resource.

Type

Specifies theresource type.

DebugPrefix

Specifies the appropriate debugger for the resource. For more information, see the Microsoft Platform Software Development Kit.

SeparateMonitor

Indicates whether or not a resource shares a Resource Monitor. Valid values are True (1) and False (0).

PersistentState

Describes the last known persistent state of a resource. In order to save the resource's PersistentState property, the resource must be offline.

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.

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.

RestartAction

Describes the action to perform if the resource fails. The choices are:

ClusterResourceDontRestart (0): Do not restart following 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 fail over 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.

RestartThreshold

Specifies how many times the Cluster service attempts to restart the resource in the RestartPeriod before failing over the group.

RestartPeriod

Specifies the amount of time allowed for the restart attempts to reach the RestartThreshold before the Cluster service fails over the group.

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.

Cluster resource private property name

Some resources store private properties. For example, to see the disk signature for the Disk L: resource, type the following at the Windows 2000 command prompt:

cluster resource "disk l:" /priv