esp_cluster_admin in Command Line Mode

Run command line operations for the esp_cluster_admin utility supported commands.

Run one command for each instance of the esp_cluster_admin call. Repeat the esp_cluster_admin call as many times as needed.

Syntax

Run esp_cluster_admin commands for command line mode:

$ESP_HOME/bin/esp_cluster_admin --uri=esp://<host>:<port> --username=<user-name> --password=<password> --<command> <required-parameters>

If the cluster node is SSL enabled, call esp_cluster_admin:

$ESP_HOME/bin/esp_cluster_admin --uri=esp://<host>:<port> [...]

To administer clusters with RSA authentication, call esp_cluster_admin:

esp_cluster_admin --uri=esp://<host>:<port> --key-alias=mytest --storepass=<password> --keystore=<key_store> --<command> [options]

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

esp_cluster_admin --uri=esp://<host>:<port> --username=<username> --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.

Options

--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_projectdetail – lists project details for the specified project within the specified workspace.
For example, to show project details of project project1 from workspace ws1, enter:
```
esp_cluster_admin --uri=esp://localhost:19011 --username=user --password=pass --get_projectdetail --workspace-name=ws1 --project-name=project1
```
--get_streams – enter the command, followed by the workspace name, then the desired project name.
For example, to show a stream of project project1 from workspace ws1, enter:
```
esp_cluster_admin --uri=esp://localhost:19011 --username=user --password=pass --get_streams --workspace-name=ws1 --project-name=project1
```
--get_schema – enter the command, followed by the workspace name, the project name, then the stream name.
For example, to show a schema of a streamwin of project project1 from workspace ws1, enter:
```
esp_cluster_admin --uri=esp://localhost:19011 --username=user --password=pass --get_schema --workspace-name=ws1 --project-name=project1 --stream-name=win
```

--add_workspace – enter the command, followed by the workspace name.

For example, to add a workspace ws2, enter:

esp_cluster_admin --uri=esp://localhost:19011 --username=user --password=pass --add_workspace --workspace-name=ws2

--remove_workspace – enter the command, followed by the workspace name.
For example, to remove workspace ws1, ignoring any errors encountered, enter:
```
esp_cluster_admin --uri=esp://localhost:19011 --username=user --password=pass --remove_workspace --workspace-name=ws1 --ignore-error
```
--add_project – enter the command, followed by the workspace name, the project name, then the project file name with extension.
For example, to add project project1 to workspace ws2, enter:
```
esp_cluster_admin --uri=esp://localhost:19011 --username=user --password=pass --add_project --workspace-name=ws2 --project-name=project1 --ccx=project1.ccx --ccr=project1.ccr
```
The CCX file is the compiled project file; it is required. The CCR file is the project’s runtime configuration file. Include the CCR file for an HA (active-active) project or a project with affinities.
--remove_project – enter the command, followed by the workspace name, then the project name.
For example, to remove project project1 from workspace ws1, enter:
```
esp_cluster_admin --uri=esp://localhost:19011 --username=user --password=pass --remove_project --workspace-name=ws1 --project-name=project1
```
--start_project – enter the command, followed by the workspace name, then the project name.
For example, to start project project1 in workspace ws1, enter:
```
esp_cluster_admin --uri=esp://localhost:19011 --username=user --password=pass --start_project --workspace-name=ws1 --project-name=project1
```
--stop_project – enter the command, followed by the workspace name, then the project name.
For example, to stop project project1 in workspace ws1, enter:
```
esp_cluster_admin --uri=esp://localhost:19011 --username=user --password=pass --stop_project --workspace-name=ws1 --project-name=project1
```
--stop_node – enter the command, followed by the node name.
For example, to stop node node1, enter:
```
esp_cluster_admin --uri=esp://localhost:19011 --username=user --password=pass --stop_node --node-name=node1
```
Stopping a node this way does not stop any projects running on the node unless the node is the only manager node. A warning appears if there are active projects on the node.
--encrypt_text – enter the command, followed by the sensitive data you want to encrypt. This command can be used to encrypt passwords in all configuration files except CSI configuration files.
For example, to encrypt text 1234, enter:
```
esp_cluster_admin --uri=esp://localhost:19011 --username=user --password=pass --encrypt_text --text=1234
```
--encode_text – enter the command, followed by the password you want to encode. If you don’t include a password after the command, you are prompted for one. This command encodes passwords for CSI configuration files, which are stored by default in ESP_HOME/security.
For example, to encode text MyPassword, enter:
```
esp_cluster_admin --uri=esp://localhost:19011 --username=user --password=pass --encode_text --text=MyPassword
```
--reload_policy – reloads the policy.xml file.
--deploy_key – enter the command, followed by the new username, keystore filepath, and storepass key-alias.
For example, to deploy a new storepass key-alias user to keystore mykeystore.jks, enter:
```
esp_cluster_admin --uri=esp://localhost:19011 --username=user --password=pass --deploy_key --new-user=user --keystore=mykeystore.jks --storepass=123456 --key-alias=user
```
--help – retrieves plain-text description of utility commands and usage information.