Cluster Administrative Tool

The cluster administrative tool is an auxiliary tool for cluster administration. Add and remove projects and workspaces, and query, start, and stop existing projects.

The cluster administrative tool operates in interactive mode or command line mode. In interactive mode, connect to the cluster manager once and execute commands until you exit. In command line mode, the utility logs you out after each command; you must connect to the cluster manager every time you specify a command.

Note: The parameters, excluding supported commands, are case-insensitive.

To connect the cluster manager with RSA authentication:

esp_cluster_admin --uri=esp(s)://<host>:<port> --keyalias=
<keyalias> --storepass=<storepass> --keystore=<keystore>

To connect the cluster manager with LDAP, or Native OS (user name/password) authentication:

esp_cluster_admin --uri=esp(s)://<host>:<port> --username=<user> --password=<password>

Supported Commands
Command	Function
Interactive mode: get managers Command line mode: --get_managers	Returns the host-name:rpc-port pairs for the managers in the cluster.
Interactive mode: get controllers Command line mode: --get_controllers	Returns the list of controllers in the cluster.
Interactive mode: get workspaces Command line mode: --get_workspaces	Returns the names of the workspaces in the cluster.
Interactive mode: get projects Command line mode: --get_projects	Returns the list of projects, with their state, matching the argument list.
Interactive mode: get project <workspace-name>/<project-name> Command line mode: --get_projectdetail	Shows a project within an associated workspace.
Interactive mode: get streams <workspace-name>/<project name> Command line mode: --get_streams	Shows a stream within an associated workspace.
Interactive mode: get schema <workspace-name>/<project-name> <stream-name> Command line mode: --get_schema	Shows the schema of an associated stream.
Interactive mode: add workspace <workspace-name> Command line mode: --add_workspace	Adds a workspace.
Interactive mode: add project <workspace-name>/<project-name> <ccx> [<ccr>] Command line mode: --add_project	Adds a project. The controller name is optional. If not specified, a controller is randomly chosen at the start of the application. A randomly chosen controller has weak affinity once started. If a controller name is specified, the default controller affinity is weak.
Interactive mode: remove workspace <workspace-name> Command line mode: --remove_workspace	Removes a workspace.
Interactive mode: remove project <workspace-name>/<project-name> Command line mode: --remove_project	Removes the project. The user must first stop the project.
Interactive mode: start project <workspace-name>/<project-name> [timeout (sec)] [<instance-index>] Command line mode: --start_project	Starts the project. If the project is added with a strong controller affinity and the controller is not available, start-up fails.
Interactive mode: stop project <workspace-name>/<project-name> [timeout (sec)] [<instance-index>] Command line mode: --stop_project	Stops the project.
Interactive mode: stop node <node-name> Command line mode: --stop_node	Stops a node.
Interactive mode: encrypt <clear-text> Command line mode: --encrypt_text	Encrypts plain text data. Use to encrypt passwords in configuration files.
Interactive mode: deploykey <new-username> <keystore> <storepass> <key-alias> [<store-type>] Command line mode: --deploy_key	Adds a new user by deploying a new user key to the keystore.
Interactive mode: reload policy Command line mode: --reload_policy	Reloads the policy.xml file in a running cluster. If you have recently updated the existing policy file, the cluster is reverified against the new policy configuration upon reload.
Interactive mode: connect	Connect or reconnect a project to a cluster. This command is in interactive mode only.
Interactive mode: quit or exit	Logs you out of interactive mode. To reaccess the utility, provide your user name and password.
Interactive mode: > help Command line mode: --help	Retrieves plain-text description of utility commands and usage information.

These interactive mode commands demonstrate the use of some of the parameters and commands:

esp_cluster_admin --uri=esp://cluster_server:19011 --username=me --password=sybase get managers
esp_cluster_admin --uri=esp://cluster_server:19011 --username=me --password=sybase get workspaces
esp_cluster_admin --uri=esp://cluster_server:19011 --username=me --password=sybase get projects

These command line mode commands demonstrate the use of some of the parameters and commands:

esp_cluster_admin --uri=esp://cluster_server:19011 --username=me --password=sybase --get_managers
esp_cluster_admin --uri=esp://cluster_server:19011 --username=me --password=sybase --get_workspaces
esp_cluster_admin --uri=esp://cluster_server:19011 --username=me --password=sybase --get_projects