Migrate from Tabadmin to the TSM CLI

The Tableau Services Manager (TSM) command-line interface (CLI) replaces the tabadmin CLI in Tableau Server on Linux, and in Tableau Server on Windows version 2018.2. This page maps tabadmin commands to TSM commands to help you to migrate to the TSM CLI.

To learn more about the TSM CLI, see tsm Command Line Reference.

Tabadmin commands with a corresponding TSM CLI command

The following table shows which tabadmin commands correspond to commands available in the TSM CLI.

Command DescriptionTabadmin Command(s)Comparable TSM CLI Command
Activate a licencetabadmin activate --activatetsm licenses activate
Deactivate licencestabadmin activate --returntsm licenses deactivate
Create a backup of the data managed by Tableau Servertabadmin backuptsm maintenance backup

A backup created using TSM does not include any server configuration data. There is no option to include server configuration data.

Clear the server cachetabadmin clearcache tsm maintenance cleanup -r
Clean up temporary files and old log filestabadmin cleanuptsm maintenance cleanup
Note: This command was added in version 10.5.1
Update the server configuration with any changes you've madetabadmin configuretsm pending-changes apply
Customise the server name and logostabadmin customizetsm customize
Enable access to the repositorytabadmin dbpasstsm data-access repository-access enable
Disable access to the repositorytabadmin dbpass --disabletsm data-access repository-access disable
Set a file store instance to read-only modetabadmin decommissiontsm topology filestore decommission
Delete one or more Web Data Connectors (WDCs) from Tableau Servertabadmin delete_webdataconnectortsm data-access web-data-connectors delete

To learn more, see Web Data Connectors in Tableau Server.

Add a Web Data Connector (WDC) to Tableau Servertabadmin import_webdataconnector

and

tabadmin whitelist_webdataconnector

tsm data-access web-data-connectors add

Note: TSM does not support importing WDCs, instead it lets you add WDCs to an allowlist. To learn more, see Web Data Connectors in Tableau Server.

List Web Data Connectors (WDCs) used by Tableau Servertabadmin list_webdataconnectorstsm data-access web-data-connectors list

To learn more, see Web Data Connectors in Tableau Server.

Export a site from Tableau Servertabadmin exportsitetsm sites export
Initiate a repository failovertabadmin failoverrepositorytsm topology failover-repository
Get a configuration optiontabadmin gettsm configuration get
Get the OpenID redirect URLtabadmin get_openid_redirect_urltsm authentication openid get-redirect-url
Import site .csv files into Tableau Servertabadmin importsitetsm sites import
Import a site into Tableau Server using .csv filestabadmin importsite_verifiedtsm sites import-verified
Display licence information for Tableau Servertabadmin licensestsm licenses list

Note: For more information about the output of this command, see View Server Licences.

Move a file store from read-only mode to an active read/write statetabadmin recommissiontsm topology filestore recommission
Regenerate internal security tokenstabadmin regenerate_internal_tokenstsm security regenerate-internal-tokens
Register Tableau Servertabadmin registertsm register
Rebuild the search index for Tableau Servertabadmin reindextsm maintenance reindex-search
Reset the Tableau Server administrator accounttabadmin resettsm reset

Note: Added in version 2018.1.

Stop and restart all Tableau Server processestabadmin restarttsm restart
Restore from a Tableau Server backup filetabadmin restoretsm maintenance restore

The restore command does not restore any server configuration data. This is true whether you are using a backup created with TSM or a backup created with tabadmin.

Set a configuration optiontabadmin settsm configuration set
Activate or suspend a sitetabadmin sitestatetsm sites unlock
Start all Tableau Server processestabadmin starttsm start
Get the status of Tableau Server and server processestabadmin statustsm status
Stop all Tableau Server processestabadmin stoptsm stop
Create an archive (.zip) file with Tableau Server log filestabadmin ziplogstsm maintenance ziplogs

The default behaviour of the ziplogs command has changed: with tsm, the command collects up to the last two days of log files by default. The tabadmin ziplogs command collected up to seven days of log files. For more information, see tsm maintenance ziplogs.

Tabadmin commands with no corresponding TSM CLI command

The following table lists the tabadmin commands for which a comparable TSM CLI command is not available.

Command DescriptionTabadmin CommandNotes
Add or remove a user from the system administrator grouptabadmin administratorYou can use the Tableau Server REST API Add User to Group and Remove User from Group methods to add or remove a user from the system administrator group.
Create a new key to encrypt sensitive information stored in the repositorytabadmin assetkeysUse the tsm security regenerate-internal-tokens command to create or regenerate secrets and master keys.
Specify whether Tableau Server starts at system start-up timetabadmin autostartTableau Server returns to the state it was in prior to a system restart. If it was running, it will restart. If it was stopped it will be stopped after the system starts.
Identify a second server node for backuptabadmin failoverprimaryTSM does not have primary nodes, so a TSM equivalent to this command is not needed.
Manage credentials for delegated data access on Tableau Servertabadmin manage_global_credentialsWe recommend that you use Kerberos delegation to Apache Impala for global credential management. To learn more, see Kerberos and Enable Kerberos Delegation for Hive/Impala(Link opens in a new window) in the Tableau Community.
Reset the password for a Tableau Server accounttabadmin passwdIf your server uses local authentication, you can use the Tableau Server REST API Update User method to reset the password for a user account.
Reset binding between Tableau Server user ID and Open ID Connect identity providertabadmin reset_openid_sub
Determine whether your environment meets the minimum requirements to run Tableau Servertabadmin validate
Verify that a backup of the Tableau Server repository will restore successfullytabadmin verify_databaseThe tsm maintenance backup command automatically verifies that a backup will restore correctly unless you use the --skip-verification parameter.
Prepare VizQL processes for fast load times after a Tableau Server restarttabadmin warmupThe tabadmin warmup command is no longer necessary, as Tableau Server is now optimised to automatically provide fast load times after a server restart.