tscli command reference
Overview
Explains what the feature is or what its benefits are to the user or customer.
Feature
The tscli command line interface is an administration interface for the ThoughtSpot instance. Use tscli to take snapshots (backups) of data, apply updates, stop and start the services, and view information about the system.
tscli syntax
Usage for tscli is:
tscli [-h] [--helpfull] [--verbose] [--noautoconfig] [--autoconfig] [--yes] [--cluster <cluster>] [--zoo <zookeeper>] {alert, backup, callhome, cluster, command, etl, event, fileserver, firewall, ldap, logs, monitoring, nas, node, os, release, saml, security, smtp, snapshot, ssl, storage, support} ...
tscli commands
Command | Description |
---|---|
tscli [<command>] -h |
Shows help, optionally for the specified command. |
tscli alert count |
Shows counts of generated alerts by type. |
tscli alert info |
Lists all alerts. |
tscli alert list |
Lists the generated alerts. |
tscli alert off |
Disables all alerts from the cluster. |
tscli alert on |
Enables alerts from the cluster. |
tscli alert silence --name <alert_name> |
Silences the alert with <alert_name>. For example, DISK_ERROR. Silenced alerts are still recorded in postgres, however emails are not sent out. |
tscli alert status |
Shows the status of cluster alerts. |
tscli alert unsilence-name <alert_name> |
Unsilences the alert with <alert_name>. For example, DISK_ERROR. |
tscli backup create [--mode {full|light|dataless}] <name> <directory> |
Same as the tscli snapshot backup command. Pulls a
snapshot and saves it as a backup where:
Use --mode to specify the type of backup. |
tscli backup disable-periodic |
Disables periodic backups. Restarts the cluster when applied. |
tscli backup mirror-status |
Checks whether the current cluster is running in mirror mode or not. |
tscli backup periodic-config |
Shows the periodic backup configuration. |
tscli backup periodic-status |
Shows the periodic backup status. |
tscli backup set-periodic --at <hour1, hour2, ...> --directory <directory> [--num_backups <num_backups>] [--mode {full|light|dataless}] |
Enables or updates a periodic full backup configuration where:
Use --mode to specify the type of backup. |
tscli backup start-mirror <directory> <node1, node2, ...> <cluster_name> <cluster_id> |
Starts a mirror cluster which will continuously pull backups generated from a
primary cluster where:
|
tscli backup stop-mirror |
Stops mirroring on the local cluster. Used only in systems specifically architected for disaster recovery. |
tscli callhome disable |
Turns off the periodic call home feature. |
tscli callhome enable --customer_name <customer_name> |
Enables the "call home" feature, which sends usage statistics to ThoughtSpot Support every six hours via the secure file server. Before using this command for the first time, you need to set up the file server connection using tscli fileserver configure. The parameter <customer_name> takes the form Shared/<customer_name>/stats. Contact ThoughtSpot if you do not know the customer name to specify. |
tscli callhome generate-bundle --d <directory> --since <num_of_days> |
Generates a tar file of the cluster metrics and writes it to the specified
directory where:
|
tscli cluster start |
Starts the cluster. |
tscli cluster status |
Gives the status of the cluster, including release number, date last updated, number of nodes, pending tables time, and services status. |
tscli cluster stop |
Pauses the cluster (but does not stop storage services). |
tscli command run |
Runs a command on all nodes. |
tscli etl change-password --admin_username <admin_user> --username <Informatica_user> |
Changes the Informatica Cloud account password used by ThoughtSpot Data Connect. |
tscli etl disable-lw |
Disables ThoughtSpot Data Connect. |
tscli etl download-agent |
Downloads the ThoughtSpot Data Connect agent to the cluster. |
tscli etl enable-lw
--admin_username <admin_user>
--username <Informatica_user>
--thoughtspot_url <URL>
[--org_id <informatica_org_id>]
[--pin_to <IP_address>]
[--proxy_host <proxy_server_hostname>]
[--proxy_port <proxy_server_port>]
|
Enables ThoughtSpot Data Connect. Some parameters are given below, but you should contact ThoughtSpot Support for assistance in setting this up. Required parameters are:
Optional parameters are:
|
tscli etl show-lw |
Shows the status of ThoughtSpot Data Connect. It also returns the Informatica username and OrgId. |
tscli event list [--include <all|config|notification>] [--since <hours,minutes,days> | --from <yyyymmdd-HH:MM> --to <yyyymmdd-HH:MM>] [--detail] [--summary_contains <'string1'| 'string2' ...>] [--detail_contains <'string1'| 'string2' ...>] [--attributes <key1='value1'| key2='value2' ...>] |
Optional parameters are:
|
tscli feature get-all-config |
Gets the configured features in a cluster. The command will return a list of features, such as custom branding, Data Connect, and call home, and tell you whether they are enabled or disabled. |
tscli fileserver configure --user <user_name> [--password <password>] |
Configures the secure file server username and password for file upload/download and the call home feature. You only need to issue this command once, to set up the connection to the secure file server. You only need to reissue this command if the password changes. The parameter <password> is optional. If a password is not specified, you will be prompted to enter it. |
tscli fileserver download-release <release> [--user <user_name> --password <password>] |
Downloads the specified release file and its checksum. Specify the release by
number, to the second decimal point (e.g. 3.1.0, 3.0.5, etc.). You may optionally
specify the --user and --password to bypass the
credentials that were specified when configuring the file server connection with
tscli fileserver configure. Before using this command for the first time, you need to set up the file server connection using tscli fileserver configure. |
tscli fileserver purge-config |
Removes the file server configuration. |
tscli fileserver show-config |
Shows the file server configuration. |
tscli fileserver upload --file_name <file> --server_dir_path <path> [--user <user_name> --password <password>] |
Uploads the file specified to the directory specified on the secure file
server. The <path> parameter specifies the
directory to which you want to upload the file. It is based on your customer name,
and takes the form
/Shared/support/<customer_name>. If you
don't know the path to specify, Contact ThoughtSpot. You may optionally specify
the --user and --password to bypass the
credentials that were specified when configuring the file server connection with
tscli fileserver configure. Before using this command for the first time, you need to set up the file server connection using tscli fileserver configure. |
tscli firewall close-ports |
Closes given ports through firewall on all nodes. Takes a list of ports to close, comma separated. Only closes ports which were previously opened using "open-ports". Ignores ports which were not previously opened with "open-ports" or were already closed. |
tscli firewall disable |
Disable firewall. |
tscli firewall enable |
Enable firewall. |
tscli firewall open-ports <ports> |
Opens given ports through firewall on all nodes. Takes a list of ports to open, comma separated. Ignores ports which are already open. Some essential ports are always kept open (e.g. ssh), they are not affected by this command or by "close-ports". |
tscli firewall status |
Shows whether firewall is currently enabled or disabled. |
tscli ldap add-cert <name> <certificate> |
Adds an SSL certificate for LDAP. Use only if LDAP has been configured without SSL and you wish to add it. Use <name> to supply an alias for the certificate you are installing. |
tscli ldap configure |
Configures LDAP using an interactive script. You can see detailed instructions for setting up LDAP in About LDAP integration. |
tscli ldap purge-configuration |
Purges (removes) any existing LDAP configuration. |
tscli logs collect --include <selector | glob> [--exclude <selector | glob>] [--since <hours,minutes,days> | --from <yyyymmdd-HH:MM> --to <yyyymmdd-HH:MM>] [--out <path>] [--maxsize <size_in_MB_or_GB>] [--sizeonly] |
Extracts logs from the cluster. Does not include any logs that have been
deleted due to log rotation. Required parameters are:
And a time window made up of either:
Or both:
Optional parameters are:
|
tscli logs runcmd --cmd command> [--include selector | glob>] [--exclude selector | glob>] [--since hours,minutes,days> | --from yyyymmdd-HH:MM> --to yyyymmdd-HH:MM>] [--outfile <path>] [--outdir <directory_path>] [--cmd_infmt [C | U]] [--cmd_outfmt [C | U]] |
Runs a Unix command on logs in the cluster matching the given constraints.
Results are reported as text dumped to standard out, the specified output file, or
as tarballs dumped into the specified directory. Required parameters are:
And a time window made up of either:
Or both:
Optional parameters are:
|
tscli map-tiles enable |
Enables ThoughtSpot's map tiles, which are used when constructing geomap charts. If you don't have interest access, you must download the map tiles tar and md5 files. Then you must append the following to the tscli command --offline --<tar_file> --md5 <md5_file>, where <tar_file> and <md5_file> are the locations of the two files. |
tscli monitoring set-config --email <email> --clear_email --heartbeat_interval <heartbeat_interval> --heartbeat_disable --report_interval <report_interval> --report_disable |
Sets the monitoring configuration. Parameters are:
|
tscli monitoring show-config |
Shows the monitoring configuration. |
tscli nas mount-cifs --server <server_CIFS_address> --path_on_server <path> --mount_point <target> --username <user> --password <password> --uid <uid> --gid <gid> |
Mounts a CIFS device on all nodes. Parameters are:
|
tscli nas mount-nfs --server <server_NFS_address> --path_on_server <path> --mount_point <target> |
Mounts a NFS device on all nodes. Parameters are: |
tscli nas unmount --dir <directory> |
Unmounts all devices from the specified directory location. |
tscli node ls |
Lists all nodes in the cluster. |
tscli os find-package <package_name> |
Lists all packages and versions included in the product image whose name
contains <package_name>. Package names you
can specify are:
|
tscli os list-packages |
Lists all packages and versions included in the product image. |
tscli release info <release> |
Prints information about the release contained in the specified release file. |
tscli saml configure |
Configures SAML. |
tscli saml purge-configuration |
Purges any existing SAML configuration. |
tscli scheduled-pinboards |
Enables scheduled pinboards, which is disabled in prod clusters by default. |
tscli security clear-min-tls-version |
Clears any customizations for the minimum TLS version to support. |
tscli security set-min-tls-version {1.0|1.1|1.2} |
Sets the minimum SSL version to be supported by the ThoughtSpot application. Please ensure that client browsers are enabled for this version or newer. It is recommended that you set the version to 1.2. |
tscli security ssl-off |
Disables SSL authentication for the ThoughtSpot application. |
tscli security ssl-on |
Enables SSL authentication for the ThoughtSpot application. |
tscli security ssl-status |
Shows whether of SSL authentication is enabled or disabled for the ThoughtSpot application. |
tscli security tls-status |
Prints the status of TLS support. |
tscli smtp reset-canonical-mapping |
Deletes the current postmap mapping. |
tscli smtp set-canonical-mapping <new_key> <new_value> |
Sets a new postmap mapping. |
tscli smtp set-mailfromname <email_address> |
Sets the mailname, from which email alerts are sent, for the cluster. |
tscli smtp set-mailname <domain> |
Sets the mailname, where email alerts are sent, for the cluster. |
tscli smtp set-relayhost <IP_address> |
Sets the relayhost for SMTP (email) sent from the cluster. |
tscli smtp show-canonical-mapping |
Shows the current postmap mapping. |
tscli smtp show-mailfromname |
Shows the mailname, from which email alerts are sent, for the cluster. |
tscli smtp show-mailname |
Shows the mailname, where email alerts are sent, for the cluster. |
tscli smtp show-relayhost |
Shows the relayhost for SMTP (email) sent from the cluster. If there is no relayhost configured, the command shows "NOT FOUND". |
tscli snapshot backup [--mode {full|light|dataless}] <name> <directory> |
Same as the tscli backup create command. Pulls a snapshot
and saves it as a backup where:
Use --mode to specify the type of backup. |
tscli snapshot create <name> <reason> |
Creates a new snapshot with the name and reason provided. This command does not accept periods (.), but does accept dashes (-). |
tscli snapshot delete <name> |
Deletes the named snapshot. |
tscli snapshot ls |
Lists available snapshots and their size. |
tscli ssl add-cert <key> <certificate> |
Adds SSL certificate, key pair. |
tscli ssl off |
Disables SSL. Disabling SSL will stop users from seeing a security warning when accessing ThoughtSpot from a browser if there is no SSL certificate installed. |
tscli ssl on |
Enable SSL. If SSL is enabled and there is no certificate, users will see a security warning when accessing ThoughtSpot from a browser. |
tscli ssl rm-cert |
Removes the existing SSL certificate, if any. |
tscli ssl status |
Shows whether SSL authentication is enabled or disabled. |
tscli storage gc [--log_age <hours>] [--localhost_only>] |
Before issuing this command, you must stop the cluster using tscli cluster stop. After garbage collection has completed, you can restart the cluster with tscli cluster start. Garbage collects unused storage. Accepts these optional flags: --log_age <hours> Specifies the number of elapsed hours after which logs will be deleted. Default is 24 hours. --localhost_only If used, only the logs on the localhost will be removed. If not specified, the command acts on the entire cluster. The command frees space in these
directories:
/tmp /usr/local/scaligent/logs/ /export/logs/orion /export/logs/oreo /export/logs/hadoop /export/logs/zookeeper cores |
tscli support restart-remote |
Restarts remote support. |
tscli support rm-admin-email |
Removes the email address for contacting the customer administrator. Replaces it with the default ThoughtSpot Support email address. |
tscli support rm-admin-phone |
Removes the phone number for contacting the customer administrator. Replaces it with the default ThoughtSpot Support phone number. |
tscli support set-admin-email <email> |
Sets the email address for contacting the customer administrator. If you would like to display a blank email address, issue the command tscli support set-admin-email ' '. |
tscli support set-admin-phone <phone_number> |
Sets the phone number for contacting the customer administrator. Specify a phone number using any value (e.g. +1 800-508-7008 Ext. 1). If you would like to display a blank phone number, issue the command tscli support set-admin-phone ' '. |
tscli support set-remote --addr <support_address> --user <support_user> |
Configures the cluster for remote support through SSH tunneling, where <support_address> is the address of support, e.g. tunnel.thoughtspot.com, and <support_user> is the support username. |
tscli support show-admin-email |
Shows the email address for customer administrator, if set. |
tscli support show-admin-phone |
Shows the phone number for customer administrator, if set. |
tscli support show-remote |
Prints the status and configuration of remote support. |
tscli support start-remote |
Starts remote support. |
tscli support stop-remote |
Stops remote support. |
Argument | Description |
---|---|
--verbose | Turns on verbose logging to the console. By default, logs are written to both the console and log files, with the log files containing the highest verbosity log messages. |
--helpfull | Shows the full help text for all command sections. |
--noautoconfig | Will prompt for a y or n for each configuration question. |
--autoconfig | Automatically configure properties of the cluster when possible. User may still be prompted for certain inputs. |
--yes | Same as --autoconfig. Automatically configure properties of the cluster when possible. User may still be prompted for certain inputs. |
--cluster <cluster_name> | Optional. Used to designate the cluster to operate on by name, if it is not detected automatically. |
--zoo <zookeeper_servers> | Optional. Used to provide a comma-separated list of Zookeeper servers, when a cluster is not detected automatically. |