esp_cluster

A command line utility you can use to interact with the cluster manager, in either interactive mode or command line mode.

The esp_cluster_admin utility supports several commands you can use to set up your project environment, encrypt sensitive data, and deploy a keystore. To access the utility, provide the required authentication credentials (Kerberos, RSA, or username/password).

Once you log into the ESP Server, you can run commands on the server side continually until you exit by executing exit or quit.

Note: In interactive mode, you can log in and execute commands continuously; the utility maintains the session with the cluster manager. Password credentials may have alpha numeric characters, but must always begin with an alphabetic character. In command line mode, the utility logs you out after each command is run; you must log in again to perform the next operation.

Syntax

Call esp_cluster_admin:

$ESP_HOME/bin/esp_cluster_admin <uri|help|helpi> [credentials] [command] [options]

If the cluster node is SSL enabled, call esp_cluster_admin:

esp_cluster_admin --uri=esps://<host>:<port> [...]

To administer clusters with RSA authentication, call the esp_cluster_admin:

esp_cluster_admin --uri=esp://<host>:<port> --key-alias=serverkey --storepass=<storepass> --keystore=keystore.jks

To administer clusters with Kerberos or LDAP authentication, call the esp_cluster_admin:

esp_cluster_admin --uri=esp://<host>:<port> --user name=<user name> --password=<password>

Note: If you omit the password parameter when you call the esp_cluster_admin tool, Event Stream Processor prompts you for the password and hides it as you type, which improves security.

Commands

get managers – lists the cluster managers.
get controllers – lists the cluster controllers.
get workspaces – lists all existing workspaces.
get projects – lists all existing projects independent of a workspace.
get project <workspace-name>/<project-name> – shows a project within an associated workspace.
Enter the command followed by the workspace name, a forward slash, and the project name. Do not use spaces in the variable entries.
For example, to show the project sample from the workspace tradespace, enter:
```
get project tradespace/sample
```
get streams <workspace-name>/<project-name> – shows all streams within a project.
Enter the command followed by the workspace name, a forward slash, and the stream name. Do not use spaces in the variable entries.
For example, to show the stream tradedata from the workspace tradespace, enter:
```
get streams tradespace/tradedata
```
get schema <workspace-name>/<project-name> <stream-name> – shows the schema of an associated stream.
Enter the command followed by the workspace name, a forward slash, and the schema name. Do not use spaces in the variable entries.
For example, to show the schema (dataformat) for tradedata, enter:
```
get schema tradespace/tradedata/dataformat
```
add workspace <workspace-name> – adds a new workspace.
Enter the command followed by the workspace name. Do not use spaces in the variable entries.
For example, to add the workspace stockspace, enter:
```
add workspace stockspace
```
add project <workspace-name>/<project-name> <ccx> [<ccr>] – adds a project to a workspace.
Enter the command, followed by the workspace name to which to add the project, a forward slash, followed by the project name and file name with extension. Do not use spaces in the variable entries.
For example, to add the project tradeanalysis with the same file name to the workspace tradespace, enter:
```
add project tradespace/tradeanalysis tradeanalysis.ccx
```
The ccr file is the project configuration file for the ccx file.
remove workspace <workspace-name> – removes a workspace.
Enter the command, followed by the name of the workspace to remove. Do not use spaces in the variable entries.
For example, to remove the workspace stockspace, enter:
```
remove workspace stockspace
```
remove project <workspace-name>/<project-name> – removes a project.
Enter the command, followed by the name of the project to remove. Do not use spaces in the variable entries.
For example, to remove the project tradeanalysis from the workspace tradespace, enter:
```
remove project tradespace/tradeanalysis
```
start project <workspace-name>/<project-name> [timeout(sec)] [<instance-index>] – starts a project.
Enter the command, followed by the workspace name, a forward slash, and the name of the project to start. Do not use spaces in the variable entries.
For example, to start the project sample from the workspace tradespace, enter:
```
start project tradespace/sample
```
The timeout option indicates the number of seconds to wait for the project to start before the command times out. In the event of a timeout, consider setting a higher timeout value before issuing the command again. If you issue the command without specifying a timeout, the default of 20 seconds is used. You cannot disable the timeout; a value of 0 returns an error. Decimals are not supported
stop project <workspace-name>/<project-name> [timeout(sec)] [<instance-index>] – stops a project.
Enter the command, followed by the workspace name, a forward slash, and the name of the project to stop. Do not use spaces in the variable entries.
For example, to stop the project sample from the workspace tradespace, enter:
```
stop project tradespace/sample
```
The timeout option indicates the number of seconds to wait for the project to stop before the command times out. In the event of a timeout, consider setting a higher timeout value before issuing the command again. If you issue the command without specifying a timeout, the default of 20 seconds is used. You cannot disable the timeout; a value of 0 returns an error. Decimals are not supported.
stop node <node-name> – stops a node (controllers or managers, or both). Stops a node but does not stop any projects running on this node unless this node is the only manager node.
Enter the command, followed by the node name.
Example
```
stop node node1
```
encrypt <clear-text> – encrypts plain text data.
Enter the command, followed by the sensitive data you want to encrypt. When you run the command, the utility produces encrypted text you can use to replace the sensitive data in the associated file. This command can be used to encrypt passwords in all configuration files except CSI configuration files.
For example, to encrypt the password 1234, enter:
```
encrypt 1234
```
encode <clear-text> – encodes plain text passwords.
Enter the command, followed by the password you want to encode. This command encodes passwords for CSI configuration files, which are stored by default in ESP_HOME/security.
For example, to encode the password MyPassword, enter:
```
--encode_text --text=MyPassword
```
deploykey <new-username> <keystore> <storepass> <key-alias> [<store-type>] – adds a new user by deploying a new user key to the keystore.
Enter the command, followed by the new user name, keystore file path, and storepass key-alias.

All nodes in a cluster must share the same keystore file path. The node to which the deploy command is sent updates the keystore and the other nodes then reload that file. To test if the deploy key is working properly, log in to the cluster with the new key, but through a different node.
For example, to deploy the new key 123456 under the new user name jdoe, with store key-alias jdoe, enter:
```
deploykey jdoe ./mykeystore.jks 123456 jdoe
```
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.
connect – reconnects the utility to the cluster it was started with if the connection has expired. This command is in interactive mode only.
quit or exit – logs you out of interactive mode. To reaccess the utility, provide your user name and password, unless you chose not to set up authentication.
help – retrieves a plain-text description of utility commands and usage information for interactive mode.