Using the Optable DCN command line tools
The Optable CLI (Command Line Interface) is a utility designed to enable an Optable data collaboration node (DCN) administrator to interact with the DCN and perform management tasks which would otherwise be done using the web-based DCN UI.
Using the Optable CLI requires authenticating to an Optable data collaboration node (DCN). The CLI is therefore designed to be used by DCN customers.
The latest version of the Optable CLI can be downloaded from Optable's CDN:
Optable CLI commands require authentication with a DCN user or service account. You can create and manage accounts from the Admin > Accounts section in your DCN UI.
You can login with your personal DCN user account by running
optable-cli login <dcn-hostname>
dcn-hostnameshould just be the hostname of your data collaboration node, without any protocol prefix. For example, if you login to your DCN UI by browsing to
https://my-dcn.cloud.optable.co/admin, then your DCN hostname is just
If you want to script using the CLI, it's recommended to authenticate using a service account instead of your personal user account. Logging into a service account has the advantage of not expiring and not requiring re-authentication.
You can create a service account from the Admin > Accounts section in your DCN UI. Once created, you will be able to create a service key and download a JSON file embedding a private key.
You can run the
optable-cli activate-service-account <path-to-key-file>command to add the service account private key file to the CLI configuration. You can then run CLI commands as the service account.
You can get a list of all supported commands by running
To get help on a specific command, run
optable-cli <command> --help
You can connect to multiple DCNs using the CLI. When you login with the CLI as explained further above, the default context is used. If you would like to login to another DCN you can pass the
-c <context-name>option to
optable-cliwhen logging in.