To assist in performing various functions for the Enterprise Server Edition (ESE) client for Linux, the client can be driven from the command-line (as in "headless" Linux environments) after being installed.
Command-line options
Use the following command:
backupprocli
Here are some standard command-line options available:
| Option | Purpose |
|---|---|
create_account |
Creates a new backup account. (See example below.) |
show_account |
Displays current account details. |
remote_tunnel |
Enables or disables the remote access. (See example below.) |
reconnect_account |
Reconnects the current client to an existing account. From v18.9, also restore the workspace (See example below.) |
backup |
Initiate a backup from the command line (from v18.9) |
about |
Display client version, brand ID and Java version. |
-r file |
JSON file containing responses to prompts. Linux only. (See example below.) |
-q |
Used in conjunction with -r when you want to fail on missing values instead of prompting the user. Useful when invoking CLI from a non-interactive script. |
-h |
Shows additional command-line arguments. |
Responses
A success or failure message is presented upon completion. In case of an error, the command will exit and will need to be rerun.
Examples
A few example command-line usages are illustrated below:
Creating a backup account
backupprocli create_accountThe user will be prompted for the following information:
| No. | Value | Description |
|---|---|---|
| 1 | Storage Platform address | Use the IP or DNS of your Storage Platform. |
| 2 | Backup Group | Must be the full path, e.g.: COLLECTION\Group. |
| 3 | Account Create Key | As per the group's setting in the Management Console. |
| 4 | Backup Account Name | Defaults to the host name of the machine - can be changed. |
| 5 | Backup Account Password | (Hidden when entered. Re-type to confirm.) |
| 6 | Account Encryption Key | (Hidden when entered. Re-type to confirm.) |
Reconnecting to a backup account
backupprocli reconnect_accountThe user will be prompted for the following information:
| No. | Value | Description |
|---|---|---|
| 1 | Storage Platform address | Use the IP or DNS of your Storage Platform. |
| 2 | Backup Group | Must be the full path, e.g.: COLLECTION\Group. |
| 3 | Backup Account Name | Must be the name of the existing account. |
| 4 | Backup Account Password | The account's password. (Hidden when entered.) |
| 6 | Account Encryption Key | The account's encryption key. (Hidden when entered.) |
c) Allowing remote connections
When enabled, this allows remote connections to the current client from the Storage Platform Management Console, even from a Windows machine.
backupprocli remote_tunnelYou will be prompted to enable or disable the "remote tunnel" with a choice of access restriction:
- "platform": Requires Storage Platform authentication
- "password": Configures a password which will be required when connecting from a remote client
d) Using a response file
By default, the user is prompted for required information. If you want to provide some or all of this information without prompting the user, specify a response file.
The response file is a JSON file containing keys and values. Options not required by the current command are ignored, so you can use the same response file, for example, when invoking create_account and remote_tunnel.
backupprocli -r response.json create_accountA sample JSON response file with all values populated would look as follows:
{
"storage_platform_address": "192.168.21.87",
"group": "Dev",
"create_key": "secret",
"account_name": "myserver",
"account_password": "password",
"encryption_key": "password123",
"remote_tunnel_enabled": true,
"remote_tunnel_access_type": "password",
"remote_tunnel_password": "stay_out"
}
The following file would set the Storage Platform and group, but prompt the user for the account details (see note below):
{
"storage_platform_address": "192.168.21.87",
"group": "Dev",
"create_key": "secret",
}
Note: If -q (quiet) option is specified, the command will fail if there are missing keys in the response file, as per the response file above:
backupprocli -r -q response.json create_accountTo prompt the user for the missing information, do not include the -q option.
Comments
0 comments
Please sign in to leave a comment.