Syntax: Cluster Tools

ClusterState


Tool name:
  ClusterState

Description: 
  Checks the cluster state by a given RNAME, which is part of a cluster.
 
Usage: 
  runUMTool ClusterState -rname=<rname> [optional_args] 
 
Examples: 
  ClusterState -rname=nsp://localhost:8080 
 
Required arguments: 

  rname : 
    Name of a realm, which is part of a cluster.
 
Optional Parameters: 

  username : 
    Your Universal Messaging server username. 

  password : 
    Your Universal Messaging server password. 

CreateCluster


Tool name:
  CreateCluster

Description: 
  Creates a cluster with the specified name, consisting of the specified realms. 
 
Usage: 
  runUMTool CreateCluster -clustername=<clustername> -convertlocal=<convertlocal>
    -rnames=<rnames> [optional_args] 
 
Examples: 
  CreateCluster -clustername=cluster0 -convertlocal=true 
    -rnames=nsp://localhost:8080,nsp://localhost:9090 
 
Required arguments: 

  clustername : 
    Name of the cluster to be created.

  convertlocal : 
    Whether the local stores of the master should be converted 
    to cluster-wide stores. 

  rnames : 
    Server URLs to be included in the cluster. Can be more than one, 
    separated by a comma. 
    The proper format is [nsp/nhp/nsps/nhps]://[hostname]:[port] or 
    shm://[path/to/file].
 
Optional Parameters: 

  username : 
    Your Universal Messaging server username.

  password : 
    Your Universal Messaging server password.

DeleteCluster

Tool name: 
  DeleteCluster 

Description: 
  Deletes the cluster with the specified name. 
  The RNAME of a server in the cluster must also be given.

Usage: 
  runUMTool DeleteCluster -clustername=<clustername> 
    -rname=<rname> -deletestores=<deletestores> [optional_args] 
  
Examples: 
  DeleteCluster -clustername=cluster0 -rname=nsp://localhost:8080 -deletestores=true 
  
Required arguments: 

  clustername : 
    Name of the cluster to be deleted.
 
  rname : 
    The URL of a server which belongs to the cluster to be deleted. 
    The proper format is [nsp/nhp/nsps/nhps]://[hostname]:[port] or shm://[path/to/file].
 
  deletestores : 
    True/false flag indicating whether or not cluster-wide stores should be deleted 
    when the cluster is destroyed.
  
Optional Parameters: 

  username : 
    Your Universal Messaging server username.
 
  password : 
    Your Universal Messaging server password. 

DumpClusterNamedObjectsState


Tool name:
  DumpClusterNamedObjectsState

Description: 
  Dumps the state of named objects (also called durable subscriptions)
  on channels present on the specified cluster servers.
 
Usage: 
  runUMTool DumpClusterNamedObjectsState -rnames=<rnames> 
    -verbosemode=<verbosemode> [optional_args] 
 
Examples: 
  DumpClusterNamedObjectsState -rnames=nsp://localhost:8080,nsp://localhost:9090 
    -verbosemode=true 
 
Required arguments: 

  rnames : 
    Comma-separated list of rNames of clustered nodes.

  verbosemode : 
    Set true to see all node states; set false to see only those 
    with mismatched node states. 
 
Optional Parameters: 

  username : 
    Your Universal Messaging server username. 

  password : 
    Your Universal Messaging server password.

GetServerClusterState


Tool name:
  GetServerClusterState

Description: 
  Determines the cluster state of the server with the specified rname.
 
Usage: 
  runUMTool GetServerClusterState -rname=<rname> [optional_args] 
 
Examples: 
  GetServerClusterState -rname=nsp://localhost:9000 
 
Required arguments: 

  rname: 
    The URL of the server for which you want to retrieve the cluster state.

Optional Parameters: 

  username : 
    Your Universal Messaging server username. 

  password : 
    Your Universal Messaging server password.