Home
> Commands A-M
> Commands Ch-Cz
CLUSTER GROUP
Description
| Syntax
| Parameters
| Switches
| Related
| Notes
| Examples
| Errorlevels
| Availability
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
GROUP
[/HELP
| /?]
CLUSTER
[[/CLUSTER:]cluster_name]
GROUP
[/NODE:node_name
| /PRIV[PROPERTIES]
| /PROP[ERTIES]]
CLUSTER
[[/CLUSTER:]cluster_name]
GROUP
[group_name]
[/STAT[US]]
CLUSTER
[[/CLUSTER:]cluster_name]
GROUP
group_name
[/CREATE
| /DELETE
| /LISTOWNERS
| /MOVE[TO][:node_name]
[/WAIT[:time_seconds]]
| /OFF[LINE][:node_name]
[/WAIT[:time_seconds]]
| /ON[LINE][:node_name]
[/WAIT[:time_seconds]]
| /PRIV[PROPERTIES]
[property_list]
| /PRIV[PROPERTIES]
[:propname[,propname ...]]
| /PROP[ERTIES]
[property_list]
| /PROP[ERTIES]
[:propname[,propname ...]]
| /REN[AME]:node_name
| /SETOWNERS[:node_name[,node_name ...]]]
Parameters
- group_name
(NT2000)
- Online, Offline, or Partially Online.
- 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:
- ULarge Unsigned 64-bit value
Switches
- /HELP | /?
(NT2000)
- Display cluster group syntax. Default.
- /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
(NT2000)
- Create a new group.
- /DELETE
(NT2000)
- Delete a group.
- /LISTOWNERS
(NT2000)
- Display a list of preferred owners.
- /MOVE[TO][:node_name]
(NT2000)
- Move a group to another node.
- /NODE:node_name
(NT2003)
- Specifies the node that owns the group.
- /OFF[LINE][:node_name]
(NT2000)
- Take a group offline.
- /ON[LINE][:node_name]
(NT2000)
- Bring a group online.
- /PRIV[PROPERTIES]
(NT2000)
- View or set the cluster private properties.
- By default, there are no private properties for cluster
group. Software vendors can add private properties to extend
cluster functionality.
- /PROP[ERTIES]
(NT2000)
- View or set the cluster common properties.
- /REN[AME]:group_name
(NT2000)
- Rename a group.
- /SETOWNERS:node_name[,node_name ...]
(NT2000)
- Specify a preferred owner.
- /STAT[US]
(NT2000)
- ?
- /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.
Related
Cluster
Cluster Netinterface
Cluster Network
Cluster Node
Cluster Resource
Cluster ResourceType
Notes
Common group property names:
- AutoFailbackType Set to ClusterGroupPreventFailback (0) to prevent failback. Set to ClusterGroupAllowFailback (1) to allow failback
- Description Describes a group
- FailoverPeriod Specifies the interval (in hours) over which the Cluster service attempts to fail over a group
- FailoverThreshold Specifies the number of times the Cluster service attempts to fail over a group before it concludes that the group cannot be brought online anywhere in the cluster
- FailbackWindowEnd Specifies the end time (on a 24-hour clock) for failback of a group to its preferred node. These values must be between 0 (midnight) and 23 (11:00 p.m.) in local time. For immediate failback, set to -1
- FailbackWindowStart Specifies the start time (on a 24-clock) for failback of a group to its preferred node. These values must be between 0 (midnight) and 23 (11:00 p.m.) in local time. For immediate failback, set to -1
- Name Name of the cluster group object
- PersistentState Describes the last known persistent state of a group (1, (true) means online; 0 (false) means offline)
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