tscli command reference

The ThoughtSpot command line interface, or `tscli`, is an administration interface for the cluster. Use `tscli` to take snapshots (backups) of data, apply updates, stop and start the services, and view information about the system. This reference defines each subcommand.

The command returns 0 on success, and a non-zero exit codes on failure. The tscli command logs errors to the stderr directory.

How to use the tscli command

The tscli command has the following syntax:

tscli [-h]
      [--helpfull]
      [--verbose]
      [--noautoconfig]
      [--autoconfig]
      [--yes]
      [--cluster <cluster>]
      [--zoo <zookeeper>]
      [--username <username>]
      [--identity_file <identity_file>]
      {access, alert, ansible, backup, backup-policy, callhome, cassandra,
       cluster, command, dr-mirror, etl, event, feature, fileserver,
       firewall, hdfs, ipsec, ldap, logs, map-tiles, monitoring, nas,
       node, patch, rpackage, saml, scheduled-pinboards, smtp, snapshot,
       snapshot-policy, sssd, ssl, storage, support,
       tokenauthentication}

The tscli command has several subcommands, such as alert, backup, and so on.

Issue subcommands using the following format:

tscli [subcommand]

Subcommands have their own additional options and actions, such as tscli backup create or tscli backup delete.

Each subcommand may have several options.

To view help for a subcommand, type -h for the subcommand option:

tscli [subcommand] -h

tscli subcommands

This section lists each subcommand and its syntax.

access

tscli access [-h] {list}

This subcommand has the following option:

tscli access list: Lists objects by last access time.

alert

tscli alert [-h] {count,info,list,off,on,refresh,silence,status,unsilence}

This subcommand has the following options:

tscli alert info: Lists all alerts.
tscli alert list: Lists the generated alerts.
tscli alert off: Disables all alerts from the cluster in the cluster's timezone.
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.

ansible

   tscli ansible [-h] {checkout,commit} [--local]

Use this subcommand to install and configure third-party software on the ThoughtSpot cluster.

For details, see these articles:

backup

tscli backup [-h] {create,delete,ls,restore}

This subcommand has the following options:

tscli backup create [-h] [--mode {full,light,dataless}] [--type {full,incremental}] [--base BASE] [--storage_type {local,nas}] [--remote] name out: Pulls a snapshot and saves it as a backup, with these parameters:

--mode {full,light,dataless}

Mode of backups.

--type {full,incremental}

Type of backup.

Note: incremental is not implemented.

The default setting is full.

--base BASE

Based snapshot name for incremental backup.

Note: Because incremental is not implemented, neither is this option.

There is no default setting.

--storage_type {local,nas}

Storage type of output directory.

The default setting is local.

--remote

Take backup through orion master.

The default setting is True.
tscli backup delete name: Deletes the named backup.
tscli backup ls: List all backups taken by the system. Note that this command only shows periodic backups, and not manual backups.
tscli backup restore: Restore cluster using backup.

backup-policy

tscli backup-policy [-h] {create,delete,disable,enable,ls,show,status,update}

Manages the backup policy.

This subcommand has the following options:

tscli backup-policy create: Prompts an editor for you to edit the parameters of the backup policy.
tscli backup-policy delete name: Deletes the backup policy with name.
tscli backup-policy disable name: Disables the policy name.
tscli backup-policy enable name: Enables the policy name.
tscli backup-policy ls: List backup policies.
tscli backup-policy show name: Show the policy name.
tscli backup-policy status name: Enables the policy name.
tscli backup-policy update name: Prompts an editor for you to edit the policy name.

callhome

Provides usage statistics to ThoughtSpot by uploading the callhome bundle data daily into Egnyte.

tscli callhome [-h] {disable,enable,generate-bundle}

This subcommand has the following options:

tscli callhome enable --customer_name CUSTOMER_NAME: Enables the callhome feature.

This feature is enabled by default.

The parameter customer_name takes the form Shared/CUSTOMER_NAME/stats.
tscli callhome disable: Turns off the callhome feature.
tscli callhome generate-bundle [--d D] [--since SINCE]: Generates the callhome stats tar file, with the following parameters:

--d D

Destination folder for the tar file.

There is no default setting.

--since SINCE

Grabs callhome data from the specified time window in the past.

This should be a human-readable duration string, such as 4h (4 hours), 30m (30 minutes), 1d (1 day).

This option generates a tar file of the cluster metrics and writes it to the specified directory, where SINCE is how many days back the file must start.

There is no default setting.

cassandra

tscli cassandra [-h] {backup,restore}

Backs up cassandra.

This subcommand has the following options:

tscli cassandra backup: Take a backup of cassandra.
tscli cassandra restore: Restore cassandra from a backup.

cluster

tscli cluster [-h] {abort-reinstall-os,check,create,get-config,load,
                    reinstall-os,report,restore,resume-reinstall-os,
                    resume-update,set-config,set-min-resource-spec,
                    show-resource-spec,start,status,stop,update,
                    update-hadoop}

This subcommand has the following options:

tscli cluster abort-reinstall-os: Abort in-progress reinstall.
tscli cluster check --includes {all,disk,zookeeper,hdfs,orion-cgroups,orion-oreo}: Check the status nodes in the cluster.

You must specify a component to check.
tscli cluster create release: Creates a new cluster from the release file specified by release.

Used by ThoughtSpot Support when installing a new cluster. For example, tscli cluster create 5.3.2.tar.gz.
tscli cluster get-config: Get current cluster network and time configuration. Prints JSON configuration to stdout.

If the system cannot be connected to all interfaces, the command returns an error but continues to function.
tscli cluster load: Load state from specified backup onto existing cluster.
tscli cluster reinstall-os: Reinstall OS on all nodes of the cluster.
tscli cluster report: Generate cluster report.
tscli cluster restore --release release_tarball backupdir: Restores a cluster using the backup in the specified directory backupdir. If you're restoring from a dataless backup, you must supply the release tarball for the corresponding software release.
tscli cluster resume-reinstall-os: Resume in-progress reinstall.
tscli cluster resume-update: Resume in-progress updates.
tscli cluster set-config: Set cluster network and time configuration. Takes JSON configuration from stdin.
tscli cluster set-min-resource-spec: Sets min resource configuration of the cluster.
tscli cluster show-resource-spec: Prints default or min.
tscli cluster start: Start 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 cluster update: Update existing cluster.
tscli cluster update-hadoop: Updates Hadoop/Zookeeper on the cluster.

command

tscli command [-h] {run}

Command to run on all nodes.

This subcommand has the following option:

tscli command run [-h] [--nodes NODES] --dest_dir DEST_DIR [--copyfirst COPYFIRST] [--timeout TIMEOUT] command: These are the parameters:

--nodes NODES

Space-separated IPs of nodes where to run the command.

The default setting is all.

--dest_dir DEST_DIR

Directory to save the files that contain the output from each node.

This is a mandatory parameter.

--copyfirst COPYFIRST

Copy the executable to required nodes first.

The default setting is False.

--timeout TIMEOUT

Timeout waiting for the command to finish.

The default setting is 60.

dr-mirror

tscli dr-mirror [-h] {start,status,stop}

This subcommand has the following options:

tscli dr-mirror start: Starts a mirror cluster which will continuously recover from a primary cluster.
tscli dr-mirror status: Checks whether the current cluster is running in mirror mode.
tscli dr-mirror stop: Stops mirroring on the local cluster.

etl

tscli etl [-h] {change-password,disable-lw,download-agent,enable-lw,show-lw}

This subcommand has the following options:

tscli etl change-password --admin_username admin_user --username Informatica_user: Changes the Informatica Cloud account password used by ThoughtSpot Data Connect.

Required parameters are:

--admin_username admin_user

Specifies the Administrator username for ThoughtSpot.

--username Informatica_user

Specifies the username for the Informatica Cloud.
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 [-h] --username USERNAME --thoughtspot_url THOUGHTSPOT_URL --admin_username ADMIN_USERNAME [--groupname GROUPNAME] --org_id ORG_ID [--pin_to PIN_TO] [--proxy_host PROXY_HOST] [--proxy_port PROXY_PORT] [--proxy_username PROXY_USERNAME] [--max_wait MAX_WAIT]: Contact ThoughtSpot Support for assistance in setting this up.

Required parameters are:

--username USERNAME

Username for Informatica Cloud

--thoughtspot_url THOUGHTSPOT_URL

URL to reach thoughtspot.

--admin_username ADMIN_USERNAME

Admin username for ThoughtSpot

--groupname GROUPNAME

--org_id ORG_ID

Specifies the Informatica id of the company.

--pin_to PIN_TO

Specifies the IP address to pin to. If you specify an IP to pin to, that node becomes sticky to the Informatica agent, and will always be used. Defaults to the public IP address of the localhost where this command was run.

--proxy_host PROXY_HOST

Proxy server host for network access.

--proxy_port PROXY_PORT

Proxy server port.

--proxy_username PROXY_USERNAME

Proxy server username.

--max_wait MAX_WAIT

Maximum time in seconds to wait for Data Connect agent to start.
tscli etl show-lw: Shows the status of ThoughtSpot Data Connect.

It also returns the Informatica username and OrgId.

event

tscli event [-h] {list}

This subcommand and its options manage event notifications.

This subcommand has the following option:

tscli event list [-h] [--include INCLUDE] [--since SINCE] [--from FROM] [--to TO] [--limit LIMIT] [--detail] [--summary_contains SUMMARY_CONTAINS] [--detail_contains DETAIL_CONTAINS] [--attributes ATTRIBUTES]: The event subcommand accepts these optional flags:

--include INCLUDE

Options are all, config, notification. Default config. (default: config)

--since SINCE

Grab events from this time window in the past. Should be a human readable duration string, such as 4h (4 hours), 30m (30 minutes), 1d (1 day).

--from FROM

Begin timestamp. Must be of the form: yyyymmdd-HH:MM.

--to TO

End timestamp. Must be of the form: yyyymmdd-HH:MM.

--limit LIMIT

Maximum number of events to fetch.

The default setting is 0.

--detail

Print events in detail format. This is not tabular. Default is a tabular summary.

The default setting is False.

--summary_contains SUMMARY_CONTAINS

Summary of the event will be checked for this string. Multiple strings to check for can be specified by separating them with | (pipe). The event is returned if it matchesALL. Put single quotes around the param value to prevent undesired glob expansion.

--detail_contains DETAIL_CONTAINS

Details of the event will be checked for this string. Multiple strings to check for can be specified by separating them with | (pipe). The event is returned if it matches ALL. Put single quotes around the param value to prevent undesired glob expansion.

--attributes ATTRIBUTES

Specify attributes to match as key=value. Multiple strings to check for can be specified by separating them with | (pipe). The event is returned if it matches ALL. Put single quotes around the param value to prevent undesired glob expansion.

feature

tscli feature [-h] {get-all-config}

This subcommand has the following option:

tscli feature get-all-config: Gets the configured features in a cluster. The command returns a list of features, such as custom branding, Data Connect, and call home, and informs whether they are enabled or disabled.

fileserver

tscli fileserver [-h] {configure,download-release,purge-config,show-config,upload}

This subcommand has the following options:

tscli fileserver configure [-h] --user USER [--password PASSWORD]: Configures the secure file server username and password for file upload/download, and the call home feature.

You only have to issue this command one time, to set up the connection to the secure file server. 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 [-h] [--user USER] [--password PASSWORD] release: Downloads the specified release file, including its checksum, and verifies the integrity of release bundle.

You must specify the exact release number, such as 5.1.3.

Before using this command for the first time, you must set up the file server connection using tscli fileserver configure. You can then work with a member of the ThoughtSpot Support team becuase a privileged user and a corresponding password must be specified to download releases.
tscli fileserver purge-config: Removes the file server configuration.
tscli fileserver show-config: Shows the file server configuration.
tscli fileserver upload [-h] [--user USER] [--password PASSWORD] --file_name FILE_NAME --server_dir_path SERVER_DIR_PATH: Uploads the specified file to the directory specified on the secure file server.

You may optionally specify the user and password to bypass the credentials specified when configuring the file server connection with tscli fileserver configure. Before using this command for the first time, you must set up the file server connection using tscli fileserver configure.

This uses the following flags:

--user USER

Username of the fileserver.

--password PASSWORD

Password of the fileserver. This is required and the command prompts you for it if you do not supply it.

--file_name FILE_NAME

Local file to upload.

--server_dir_path SERVER_DIR_PATH

Directory path on fileserver. The SERVER_DIR_PATH parameter specifies the directory for file upload. It is based on customer name, and takes the form /Shared/support/customer_name.

firewall

tscli firewall [-h] {close-ports,disable,enable,open-ports,status}

This subcommand has the following options:

tscli firewall close-ports: Closes specified ports through firewall on all nodes.

Accepts a comma-separated list of ports. Only closes ports that were previously opened using open-ports, and ignores ports that were not opened with open-port, or closed ports.

Some essential ports are always kept open, such as ssh; they are not affected by this command or by open-ports.
tscli firewall disable: Disable firewall.
tscli firewall enable: Enable firewall.
tscli firewall open-ports --ports ports: Opens specified ports through a firewall on all nodes.

Accepts a comma-separated list of ports.

Ignores open ports.

Some essential ports are always kept open, such as ssh; they are not affected by this command or by close-ports.
tscli firewall status: Shows whether firewall is currently enabled or disabled.

hdfs

tscli hdfs [-h] {leave-safemode}

This subcommand has the following option:

tscli hdfs leave-safemode: Command to get HDFS namenodes out of safemode.

ipsec

tscli ipsec [-h] {disable,enable,status}

This subcommand has the following options:

tscli ipsec disable: Disable IPSec
tscli ipsec enable: Enable IPSec
tscli ipsec status: Show IPSec status on all nodes

ldap

tscli ldap [-h] {add-cert,configure,purge-configuration}

This subcommand has the following options:

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.
tscli ldap purge-configuration: Purges (removes) any existing LDAP configuration.

logs

tscli logs [-h] {collect,runcmd}

Manages the logging behavior.

This subcommand has the following options:

tscli logs collect [-h] [--include INCLUDE] [--exclude EXCLUDE] [--since SINCE] [--from FROM] [--to TO] [--out OUT] [--maxsize MAXSIZE] [--sizeonly] [--nodes NODES]: Extracts logs from the cluster. Does not include any logs that have been deleted due to log rotation.

These parameters have the following values:

--include INCLUDE

Specifies a comma separated list of logs to include. Each entry is either a "selector" or a glob for matching files. Selectors must be among: `all`, `orion`, `system`, `ts`. Anything starting with `/` is assumed to be a glob pattern, and it is interpreted through `find(1)`. Other entries are ignored. Put single quotes around the param value to prevent undesired glob expansion (default: `all`)

--exclude EXCLUDE

Comma separated list of logs to exclude. Applies to the list selected by --include. Params are interpreted just like in --include.

--since SINCE

Grab logs from this time window in the past. Should be a human-readable duration string, such as 4h (4 hours), 30m (30 minutes), 1d (1 day). (default: None)

--from FROM

Timestamp where collection begins; must be of the form yyyymmdd-HH:MM.

--to TO

Timestamp where collection ends; must be of the form yyyymmdd-HH:MM.

--out OUT

Tarball path for writing logs from each node.

The default setting is /tmp/logs.tar.gz.

--maxsize MAXSIZE

Only fetch logs if size is smaller that this value. Can be specified in megabytes or gigabytes, such as 100MB, 10GB.

--sizeonly

Do not collect logs. Just report the size.

The default setting is False.

--nodes NODES

Comma separated list of nodes from where to collect logs. Skip this to use all nodes.
tscli logs runcmd [-h] --cmd CMD [--include INCLUDE] [--exclude EXCLUDE] [--since SINCE] [--from FROM] [--to TO] [--outfile OUTFILE] [--outdir OUTDIR] [--cmd_infmt CMD_INFMT] [--cmd_outfmt CMD_OUTFMT] [--nodes NODES]: 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.

Accepts these optional flags:

--cmd CMD

Unix-Command to be run on the selected logs. Use single quotes to escape spaces etc. Note the language used to specify CMDSTR has following rules.

A logfile and its corresponding result file can be referred by keywords SRCFILE and DSTFILE. For example, cp SRCFILE DSTFILE.

Without any reference to DSTFILE in CMDSTR, DSTFILE will be appended to CMDSTR for output redirection. For example, du -sch SRCFILE gets auto-transtalted to du -sch SRCFILE > DSTFILE.

Without any reference to SRCFILE, content of log is streamed to CMDSTR by pipe. For example, tail -n100 | grep ERROR gets auto-transtalted to cat SRCFILE | tail -n100 | grep ERROR > DSTFILE.

--include INCLUDE

Comma-separated list of logs to include,each entry is either a "selector" or a glob for matching files.

Selectors must be one of all, orion, system, ts.

Anything that starts with / (forward slash) is assumed to be a glob pattern and interpreted through find(1). Other entries are ignored.

TIP: use single quotes around the parameter value to prevent undesired glob expansion.

The default setting is all.

--exclude EXCLUDE

Comma separated list of logs to exclude. Applies to the list selected by --include. Params are interpreted just like in --include.

--since SINCE

Grab logs from this time window in the past. Should be a human-readable duration string, such as 4h (4 hours), 30m (30 minutes), 1d (1 day).

--from FROM

Timestamp where collection begins; must be of the form yyyymmdd-HH:MM.

--to TO

Timestamp where collection ends; must be of the form yyyymmdd-HH:MM.

--outfile OUTFILE

File path for printing all results. By default printed to stdout

--outdir OUTDIR

Directory path for writing results with original directory structure from each node. Used as an alternative to printing output to outfile/stdout.

--cmd_infmt CMD_INFMT

Specify if the input file should be compressed or uncompressed before running CMD. C for compressed, U for uncompressed. Don't use this flag if CMD works on both.

--cmd_outfmt CMD_OUTFMT

Specify if OUTFILE generated by CMD should be compressed or uncompressed. C for compressed, U for uncompressed. Don't use this flag if output file is of the same format as the input file.

--nodes NODES

Comma separated list of nodes where to run command. Skip this to use all nodes.

map-tiles

tscli map-tiles [-h] {disable,enable,status}

This subcommand has the following options:

tscli map-tiles enable [-h] [--online] [--offline] [--tar TAR] [--md5 MD5]: Enables ThoughtSpot's map tiles, used when constructing geomap charts.

If you don't have internet access, you must download the map tiles tar and md5 files, and append the following to the tscli command:

--online

Download maptiles tar from internet.

The default setting is True

--offline

Using maptiles tar from local disk.

The default setting is False

--tar TAR

Specified tar file for map-tiles.

--md5 MD5

Specified md5 file for map-tiles.
tscli map-tiles disable: Disable map-tiles functionality.
tscli map-tiles status: Check whether map-tiles are enabled.

monitoring

tscli monitoring [-h] {set-config,show-config}

This subcommand has the following options:

tscli monitoring set-config [-h] [--email EMAIL] [--clear_email] [--heartbeat_interval HEARTBEAT_INTERVAL] [--heartbeat_disable] [--report_interval REPORT_INTERVAL] [--report_disable]: Sets the monitoring configuration.

The monitoring subcommand accepts the following optional flags:

--email EMAIL

Comma separated list (no spaces) of email addresses where the cluster will send monitoring information.

--clear_email

Disable emails by clearing email configuration. (default: False)

--heartbeat_interval HEARTBEAT_INTERVAL

Heartbeat email generation interval in seconds. Should be greater than 0.

--heartbeat_disable

Disable heartbeat email generation. (default: False)

--report_interval REPORT_INTERVAL

Cluster report email generation interval in seconds.

Should be greater than 0.

--report_disable

Disable cluster report email generation.

The default setting is False.
tscli monitoring show-config: Shows the monitoring configuration.

nas

tscli nas [-h] {ls,mount-cifs,mount-nfs,unmount}

This subcommand has the following options:

tscli nas ls [-h]: List mounts managed by NAS mounter service.
tscli nas mount-cifs [-h] --server SERVER [--path_on_server PATH_ON_SERVER] --mount_point MOUNT_POINT--username USERNAME --password PASSWORD [--uid UID] [--gid GID] [--options OPTIONS]: Mounts a CIFS device on all nodes.

Accepts the following optional flags:

--server SERVER

IP address or DNS name of CIFS service.

For example, 10.20.30.40.

--path_on_server PATH_ON_SERVER

Filesystem path on the CIFS source server to mount NAS.

For example, /a.

The default setting is / (forward slash).

--mount_point MOUNT_POINT

Directory on all cluster nodes where to mount the NFS filesystem on the target.

If this directory does not exist, the command creates it. If this directory already exists, the command uses it for mounting.

For example, /mnt/external.

--username USERNAME

Username to connect to the CIFS filesystem

--password PASSWORD

CIFS password for --username

--uid UID

The UID that owns all files or directories on the mounted filesystem when the server does not provide ownership information.

See man mount.cifs for more details.

The default setting is 1001.

--gid GID

The GID that owns all files or directories on the mounted filesystem when the server does not provide ownership information.

See man mount.cifs for more details.

The default is 1001.

--options OPTIONS

Other command-line options to forward to the mount.cifs command.

The default setting is noexec.
tscli nas mount-nfs [-h] --server SERVER [--protocol PROTO --path_on_server PATH_ON_SERVER] --mount_point MOUNT_POINT [--options OPTIONS]: Mounts a NFS device on all nodes.

Accepts the following optional flags:

--server SERVER

IP address or DNS name of NFS service. For example, 10.20.30.40.

--path_on_server PATH_ON_SERVER

Filesystem path on the NFS source server.

For example, /a/b/c/d.

The default setting is /.

--mount_point MOUNT_POINT

Directory on all cluster nodes of the target system.

If this directory does not exist, the command creates it. If this directory already exists, the command uses it for mounting.

For example, /mnt/external.

--options OPTIONS

Command-line options to mount.

The default setting is noexec.

--protocol PROTO

One of nfs or nfs4.

The default is nfs.
tscli nas unmount [-h] --dir DIR: Unmounts all devices from the specified directory, DIR.

This command returns an error if nothing is currently mounted on this directory through tscli nas mount.

node

tscli node [-h] {check,ls,reinstall-os,resume-reinstall-os,status}

This subcommand has the following options:

tscli node check [-h] [--select {reinstall-preflight}] [--secondary SECONDARY]: Run checks per node.

Accepts the following flags:

--select {reinstall-preflight}

Select the type of node check

The default setting is reinstall-preflight.

--secondary SECONDARY

Secondary drive for reinstall-preflight.

The default setting is sdd.
tscli node ls [-h] [--type {all,healthy,not-healthy}]: Filter by node state.

The default setting is all.
tscli node reinstall-os [-h] [--secondary SECONDARY] [--cluster]: Reinstall OS on a node.

Accepts the following flags:

--secondary SECONDARY

Secondary drive for reinstall.

The default setting is sdd.

--cluster

The node part of a cluster.

The default setting is False.
tscli node resume-reinstall-os: Resume in-progress reinstall

onboarding

tscli onboarding [-h] {configure,purge-configuration}

Onboarding helps application administrators to bulk update user information. In particular, it configures various in-app email options.

This subcommand has the following options:

tscli onboarding --help: Prints help for the onboarding configuration
tscli onboarding configure: Configures the onboarding through series of steps.

Asks the user to provide information necessary for onboarding-related functionality, such as the following:

Company name

Product name

Should welcome emails be enabled?

Send welcome emails to new users

Support email

Custom message to include in emails

URL of the ThoughtSpot instance

URL of the ThoughtSpot documentation
tscli onboarding purge-configuration: This command removes all onboarding configuration.

patch

tscli patch [-h] {apply,ls,resume-apply,resume-rollback,rollback}

This subcommand has the following options:

tscli patch apply [-h] [release]: Apply the patch on an existing cluster.

Accepts the following flag:

release

The relative path to the patch tar ball.
tscli patch ls [-h] [--applied] [--rolled_back] [--service SERVICE] [--md5 MD5] [--history]: Lists the patches currently applied.

Accepts the following flags:

--applied

Show only the patches applied since last full release.

The default setting is False.

--rolled_back

Show only the patches rolled back since last full release.

The default setting is False.

--service SERVICE

Show patches filtered by service.

The default setting is None.

--md5 MD5

Shows the details of the patch specified.

The default setting is None.

--history

Shows the history of all patch apply/rollback release.

The default setting is False.
tscli patch resume-apply [-h]: Resume patch apply
tscli patch resume-rollback [-h]: Resume patch roll-backup
tscli patch rollback [-h]: Rollback the patch from an existing cluster

rpackage

tscli rpackage [-h] {add,delete,list}

Manages R packages available to SpotIQ.

This subcommand has the following options:

tscli rpackage add [-h] [--repo REPO] [--timeout TIMEOUT] [--dest_dir DEST_DIR] [--nodes NODES] package_name

Command to add an R package, package_name, to the cluster.

Accepts the following flags:

--repo REPO

Specify the url of a specific repository to download packages.

-timeout REPO

Timeout waiting for the R Package to be installed (default: 60)

--dest_dir REPO

Directory where output of this command will be placed

--nodes NODES

Space-separated list of IPs for nodes where to run the command.

The default setting is all.

tscli rpackage add [-h] [--timeout TIMEOUT] [--dest_dir DEST_DIR] [--nodes NODES] package_name

Command to delete an installed R package from the cluster.

Accepts the following flags:

--timeout REPO

Timeout waiting before removing the R package.

The default is 60

--dest_dir REPO

Directory where to save the output of this command.

--nodes NODES

Space-separated list of node IPs where to run the command.

The default setting is all.

tscli rpackage list [-h] [--detailed]

List all R packages installed on the cluster.

saml

tscli saml [-h] {configure,purge-configuration}

This subcommand has the following options:

tscli saml configure [-h]: Configures SAML.
tscli saml purge-configuration: Purges any existing SAML configuration.

To see a list of prerequisites, refer to Configure SAML.

scheduled-pinboards

tscli scheduled-pinboards [-h] {disable,enable}

This subcommand has the following options:

tscli scheduled-pinboards disable [-h]: Disable scheduled pinboards for this cluster.
tscli scheduled-pinboards enable [-h]: Enables scheduled pinboards, which is disabled in prod clusters by default.

Note: When you enable scheduled pinboards, you should also configure a list of intended email domains. Contact ThoughtSpot Support for help on how to configure this list.

smtp

tscli smtp [-h] {remove-mailfromname,remove-mailname,remove-relayhost,remove-saslcredentials,reset-canonical-mapping,set-canonical-mapping,set-mailfromname,set-mailname,set-relayhost,set-saslcredentials,show-canonical-mapping,show-mailfromname,show-mailname,show-relayhost}

This subcommand has the following options:

tscli smtp remove-mailfromname: Removes current cluster mail from name.
tscli smtp remove-mailname: Removes current cluster mail name.
tscli smtp remove-relayhost: Removes current cluster relay host.
tscli smtp remove-saslcredentials: Clears SASL credentials and disables SMTP AUTH.
tscli smtp reset-canonical-mapping: Deletes the current postmap mapping.
tscli smtp set-canonical-mapping [-h] new_key new_value: Sets a new Postmap mapping.
tscli smtp set-mailfromname mailfromname: Sets the name and an email address from where email alerts are sent for the cluster.
tscli smtp set-mailname mailname: Sets the mailname and a domain from where email alerts are sent for the cluster.
tscli smtp set-relayhost [-h] [--force FORCE] relayhost: Sets the Relay Host for SMTP (email) sent from the cluster.

Accepts the following flag:

--force FORCE

Set even if relay host is not accessible.

The default setting is False.

ThoughtSpot uses port 25 to connect to the relay host. If port 25 is blocked in your environment, contact ThoughtSpot Support to use a custom port.
tscli smtp set-saslcredentials: Sets SASL credentials and enables SMTP AUTH
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 for SMTP (email) sent from the cluster.

If there a relay host is not configured, the command returns NOT FOUND.

snapshot

tscli snapshot [-h] {backup,create,delete,ls,pin,restore,unpin,update-ttl}

To learn more about snapshots and backups, see the Understand the backup strategies documentation.

This subcommand has the following options:

tscli snapshot backup [-h] [--mode {full,light,dataless}] [--type {full,incremental}] [--base BASE] [--storage_type {local,nas}] [--remote] name out: Pull snapshot out as a backup.

Accepts the following flags:

--mode {full,light,dataless}

Mode of backups. (default: `full`)

name

Name of snapshot to pull out as a backup. To list all snapshots, run `tscli snapshot ls`.

out

Directory where backup will be written, must not already exist.

--type {full,incremental}

Type of backup.

Incremental backup is not implemented.

The default setting is full.

--base BASE

Based snapshot name for incremental backup.

Incremental backup not implemented yet.

storage_type {local,nas}

Storage type of output directory. (default: `local`)

--remote

Take backup through Orion master. (default: `True`)
tscli snapshot create [-h] name reason ttl: Creates a new snapshot with the specified name and reason.

This command does not accept . (periods). It does accept - (dashes or hyphens).

The ttl parameter is the number of days after which this snapshot is automatically deleted. A value of -1 disables automatic deletion.
tscli snapshot pin [-h] name: Pins a snapshot so it cannot be deleted or garbage collected.
tscli snapshot delete [-h] name: Deletes the named snapshot.
tscli snapshot ls [-h]: Lists available snapshots.
tscli snapshot restore [-h] [--allow_release_change] [--only_service_state] name: Restores cluster to an existing snapshot.

Accepts the following flags:

--allow_release_change

Allow restoration to a snapshot at a different release. (default: `False`)

--only_service_state

Restore only service state. (default: `False`)
tscli snapshot unpin [-h] name: Unpin a snapshot so it can be deleted or garbage-collected
tscli snapshot update-ttl [-h] [--disable DISABLE] name ttl: Updates manual snapshot garbage collection policy.

Accepts the following flags:

name

Specifies which snapshot to update.

ttl

Extends the manual snapshot

ttl

This is the "time-to-live" value.

Use a positive value to increase ttl. Use negative values to decrease it.

--disable DISABLE

Disable manual snapshot garbage collection.

Setting this value to `True` will override any `ttl` value. (default: False)

snapshot-policy

tscli snapshot-policy [-h] {disable,enable,show,update}

This subcommand has the following options:

tscli snapshot-policy disable [-h]: Disable snapshot policy.
tscli snapshot-policy enable -h: Enable specified snapshot policy.
tscli snapshot-policy show [-h]: Show snapshot policy.
tscli snapshot-policy update [-h] [--config CONFIG]: Update periodic snapshot config. This takes the following parameter

--config CONFIG

Text format of periodic backup policy config.

ssl

tscli ssl [-h] {add-cert,clear-min-tls-version,off,on,rm-cert,set-min-tls-version,status,tls-status}

This subcommand manages the SSL configuration.

To use SSL, the following ports must be open:

This subcommand has the following options:

tscli ssl add-cert [-h] key certificate: Adds an SSL certificate, key pair.
tscli ssl clear-min-tls-version [-h]: Clears any customizations for the minimum TLS version to support.
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 [-h]: 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 set-min-tls-version [-h] {1.0,1.1,1.2}: Sets the minimum supported TLS version. Sets the minimum SSL version to be supported by the ThoughtSpot application. Please ensure that client browsers are enabled for this version or newer.
tscli ssl status: Shows whether SSL authentication is enabled or disabled.
tscli ssl tls-status [-h]: Prints the status of TLS support.

sssd

tscli sssd {enable, disable, set-sudo-group, clear-sudo-group}

This subcommand uses system security services daemon (SSSD), and has the following options:

tscli sssd enable --user USER --domain DOMAIN: Enables system Active Directory (AD) user access on a single node. You will be prompted for password credentials. The user must have permission to join a computer or VM to the domain.
tscli sssd disable
tscli sssd set-sudo-group ACTIVE_DIRECTORY_GROUP_NAME: Allows sudo permissions for AD group.
tscli sssd clear-sudo-group ACTIVE_DIRECTORY_GROUP_NAME: Clears any set AD sudo group.

For more about setting up Active Directory access, see Enable Active Directory based access.

storage

tscli storage [-h] {gc,df}

This subcommand has the following options:

tscli storage gc [-h] [--log_age LOG_AGE] [--force] [--localhost_only]: Garbage collect unused storage.
Before issuing this command, you must stop the cluster using =tscli cluster stop.

After garbage collection finishes, you can restart the cluster with tscli cluster start.

This command frees space in the following directories:

/tmp /usr/local/scaligent/logs/ /export/logs/orion /export/logs/oreo /export/logs/hadoop /export/logs/zookeeper cores

The storage subcommand accepts these optional flags:

--log_age LOG_AGE

Deletes logs older than these many hours. Use a non-zero value, becuase zero deletes all temporary files, including the ones that are closed temporarily, while they are passed from one component to the next.

The default setting is 4.

--force

Forces deletion of all logs and temporary files regardless of age. This must only be run on a stopped cluster.

The default setting is False.

--localhost_only

If used, only the logs on the localhost will be removed. If not specified, the command acts on the entire cluster.
tscli storage df [--mode disk|hdfs]: Checks the disk usage on the relevant mounts. Returns output similar to the Linux system command df -h directory.

support

tscli support [-h]
   {bundle, restart-remote, rm-admin-email, rm-admin-phone, rm-feedback-email,
    set-admin-email, set-admin-phone, set-debug-ui-password, set-feedback-email,
    set-remote, show-admin-email, show-admin-phone, show-feedback-email,
    show-remote, start-remote, stop-remote}

This subcommand has the following options:

tscli support bundle [-h] [--include INCLUDE] [--exclude EXCLUDE] [--list_selectors] [--since SINCE] [--from FROM] [--to TO] [--out OUT] [--nodes NODES]: --include INCLUDE

Comma-separated list of selectors to include. Each entry is either a "selector" or a glob for matching files. To see the list of valid selectors, run this command with --list_selectors. You may also specify all to get all selectors and logs, and basic to get only the basic selectors.

Selectors can be used for logs collection: all, orion, system, ts, or the name of a service.

Anything that starting with / (forward slash) is assumed to be a glob pattern, and it is interpreted through find(1). Other entries are ignored.

TIP: Use single quotes around the param value to prevent undesired glob expansion. Use all to collect all selectors and all logs.

The default setting is all_but_logs.

--exclude EXCLUDE

Comma-separated list of selectors to exclude. Applies to the list selected by --include. Params are interpreted in the same manner as in --include.

Use the special keyword logs to exclude logs collection altogether.

There is no default setting.

--list_selectors

List the selectors available for --include and --exclude, and then exit.

The default setting is False.

--since SINCE

Grabs logs from this time window in the past. Should be a human-readable duration string, such as 4h (4 hours), 30m (30 minutes), 1d (1 day).

There is no default setting.

--from FROM

Timestamp when collection begins. Must be of the form: yyyymmdd-HH:MM.

There is no default setting.

--to TO

Timestamp when collection ends. Must be of the form: yyyymmdd-HH:MM.

There is no default setting.

--out OUT

Tarball path for dumping the support bundle.

The default setting is /tmp/support_bundle.tar.gz.

--nodes NODES

Comma separated list of nodes from where to collect logs. Skip this to use all nodes.

There is no default setting.
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-feedback-email: Removes the email address for product feedback. 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 rm-feedback-email: Removes the email for sending feedback out of the system. To set a blank email address, issue the command tscli support set-feedback-email.
tscli support set-admin-email email: Sets the email address for contacting the customer administrator. To display a blank email address, issue the command tscli support set-admin-email.
tscli support set-feedback-email email: Sets the email address for sending feedback. To display a blank email address, issue the command tscli support set-feedback-email.
tscli support set-admin-phone phone_number: Sets the phone number for contacting the customer administrator. Specify a phone number using any value, such as +1 800-508-7008 Ext. 1. To display a blank phone number, issue the command tscli support set-admin-phone.
tscli support set-remote [-h] [--addr ADDR] [--user USER]: Configures the cluster for remote support through SSH tunneling, where ADDR is the address of support, such as tunnel.thoughtspot.com, and USER is the support username.
tscli support show-admin-email: Shows the email address for customer administrator, if set
tscli support show-feedback-email: Shows the email address for product feedback, if set
tscli support show-admin-phone: Shows the phone number for customer administrator, if set
tscli support show-remote: Shows the status and configuration of remote support
tscli support start-remote: Starts remote support
tscli support stop-remote: Stops remote support

tokenauthentication

tscli cli tokenauthentication [-h] {disable,enable}

This subcommand has the following options:

tscli cli tokenauthentication enable: Generates a token
tscli cli tokenauthentication disable: Purges token login configuration