Active Cluster Guide > The cluster_util Command-Line Program > Using the cluster_util Program
 
Using the cluster_util Program
The cluster_util command-line program lets you perform many of the actions you need for working with Active Cluster. You can:
• Create a cluster
• Get cluster configuration information
• Join a cluster
• Remove a server from a cluster
• Repair a cluster
• Set the cluster name
All cluster_util commands require administrator (MANAGE_SERVER) privileges.
To view the cluster_util command-line syntax
1. Run TDV Server on the computer for which you want configuration information.
2. Open a DOS window or UNIX terminal and navigate to the /bin directory of the TDV installation.
3. Type one of these commands:
cluster_util.bat (Windows)
 
Or
cluster_util.sh (UNIX)
 
The following table shows the syntax to perform each task:
To ...
Syntax
Create a cluster
cluster_util -server <hostname> [ -port <port> ]
[ -encrypt ]
-user <username> -password <password> [ -domain <domain> ]
-create -clusterName <clustername> [ -debug ]
Get cluster configuration information
cluster_util -server <hostname> [ -port <port> ]
[ -encrypt ]
-user <username> -password <password> [ -domain <domain> ]
-getConfig [ -debug ]
Join a cluster
cluster_util -server <target server hostname>
[ -port <target server port> ]
[ -encrypt ]
-user <username> -password <password> [ -domain <domain> ]
-join -memberServer <cluster server hostname>
[ -memberPort <cluster server port> ]
-memberUser <username> -memberPassword <password>
[-memberDomain <domain> ] [ -debug ]
Remove a server from a cluster
cluster_util -server <hostname> [ -port <port> ]
[ -encrypt ]
-user <username> -password <password> [ -domain <domain> ]
-remove [ -memberServer <target server hostname> ]
[ -memberPort <target server port> ]
[ -debug ]
Set a cluster name
cluster_util -server <hostname> [ -port <port> ]
[ -encrypt ]
-user <username> -password <password> [ -domain <domain> ]
-setClusterName -clusterName <clusterName> [ -debug ]
Repair a cluster
cluster_util -server <target server hostname>
[ -port <target server port> ]
[ -encrypt ]
-user <username> -password <password> [ -domain <domain> ]
-repair
The options for creating a new cluster are described in the following table.
Cluster Option
Description
-clustername <cluster_name>
The name of the new cluster. This name appears in the Manager on the CLUSTER MANAGEMENT page.
-create
Subcommand to create a new cluster.
-debug
Use this option to turn on debugging. In case of an exception, stack trace is enabled.
-domain <domain name>
The domain on which this server resides or the domain on which the server you are repairing resides.
If creating a new cluster the domain on which the new cluster resides.
Default is composite.
-getConfig
Subcommand to get cluster configuration information.
-join
Subcommand to join an existing cluster.
-memberDomain <domain name>
The domain on which the cluster server resides. Default is composite.
-memberPassword <password>
The password of the administrative user on the cluster server.
-memberPort <cluster server port>
The port of the cluster server to which you are joining. Default is 9400.
-memberPort <target server port>
The port of the TDV Server you are removing. Default=9400.
-memberServer <cluster server hostname>
Specify the hostname for a TDV Server that is already a member of the cluster you are joining. “localhost” is not a valid entry.
-memberServer <target server hostname>
Specify the hostname for a TDV Server that you are removing.
-memberUser <user name>
The name of an administrative user on the cluster server.
-password <password>
The password of the user creating a cluster.
The password of the administrative user.
-password <password>
The password of the administrative user for this cluster.
-port <cluster server port>
The port of the server node to which you are connecting. Default is 9400.
-port <port>
The port defined for the TDV Server. Default is 9400.
-port <target server port>
The port of the server you are adding to the cluster. Default is 9400.
-remove
Subcommand to remove a TDV Server from a cluster.
-regroup
Subcommand to repair nodes in a cluster and set the timekeeper node.
-server <cluster server hostname>
Specify the hostname for a TDV Server in the cluster.
-server <cluster server hostname>
Specify the hostname for a functional TDV Server node in the cluster.
When using the remove command, this server is NOT the one you are removing with this command (unless it is the last server in the cluster, in which case you do not need to specify -memberServer or ‑memberPort), but it can be any other server that is a member of the cluster.
When using the repair command, this server is NOT the one you are repairing with this command, but can be any other server that is a member of the cluster.
-server <host_name>
Specify the hostname for the TDV Server that is to be the first server in the cluster.
-server <target server hostname>
Specify the hostname for a TDV Server that you are adding to the existing cluster.
-setClusterName
Command to change the cluster name.
-user <user name>
The name of an administrative user who has access to this TDV Server.