tsm Command Line Reference
Tableau Server on Windows now includes Tableau Services Manager (TSM), which replaces the Configuration Utility and the tabadmin command line tool. If you need help for an earlier version of Tableau Server, see the Tableau Help page.
The topics in this section include reference content for Tableau Services Manager (TSM) command line interface (CLI) to support Tableau Server.
TSM is used to manage installation and configuration of Tableau Server. To learn more about TSM, see Tableau Services Manager Overview.
You can automate the installation and configuration tasks supported by the TSM CLI using the TSM API. To learn more about the prerelease (Alpha) TSM API, see Tableau Services Manager API.
Note: TSM is a batch file. To run tsm commands in another batch file, use the
call command. For example "
call tsm maintenance ziplogs". Doing this will return control to the batch file. You also need to authenticate to TSM before issuing any commands. For more information, see tsm login.
Using the tsm CLI
To run tsm commands, you need to open a command prompt.
Open a command prompt as administrator on the initial node (the node where TSM is installed).
Run the command you want. For example, to see the version of TSM and Tableau Server:
Viewing help content in the shell
To view minimal help content from a command line, use the
tsm help category.
tsm help [category] [command]
Help for all tsm commands
tsm help <category>
Show help for a specific command category. For example,
tsm help authentication.
tsm help <category> <command>
Show help for a specific command. For example,
tsm help authentication open-id.
tsm help command
List all top-level commands or categories.