Tableau provides the tabcmd command-line utility which you can use to automate site administration tasks on your Tableau Server site. For example, creating or deleting users, projects, and groups.
Note: The tabcmd utility is included with Tableau Server, however its installer is not included. If you want to run it on a computer other than the initial server node, you need to download the installer from the Tableau website. For more information, see Install tabcmd below.
When Tableau Server or Tableau Online is upgraded to a new version, if an updated version of tabcmd is required, you can download it from the Tableau Releases page on the Tableau website, to avoid issues caused by version incompatibilities. Using an out of date version of tabcmd can cause errors and unpredictable results.
Open a web browser and go to the Tableau Server Releases page (do this even if you use Tableau Online).
For Tableau Online: select the latest release.
For Tableau Server (Windows or Linux): select the release that matches your server version.
If the expanded information shows maintenance releases, select the latest maintenance release or the one that matches your server version.
This takes you to the release notes page, where you can read about security improvements and resolved issues.
Note: If you need the tabcmd installer for a version of Tableau Server prior to 10.1, it comes with your server installation. See the note above.
Scroll to the Download Files section under the resolved issues, select the tabcmd download link that is compatible with the computer on which you’ll run the tabcmd commands.
The remaining steps refer to this computer as “the tabcmd computer.”
Save the installer to the tabcmd computer, or a location accessible from that computer .
Complete the installation steps as appropriate for the operating system of the tabcmd computer:
Run the installer.
We recommend that you install tabcmd to a folder named tabcmd at the root of the C:\ drive (C:\tabcmd), for convenience when using tabcmd, and to accommodate some limitations with the Windows operating system.
Note The tabcmd Setup program does not add the tabcmd directory to the Windows PATH variable. You can add it manually, or you can include the full path to tabcmd each time you call it.
Log on as a user with sudo access to the tabcmd computer.
Navigate to the directory where you copied the
.debpackage that you downloaded.
On RHEL-like distributions, including CentOS, run the following command:
sudo yum install tableau-tabcmd-<version>.noarch.rpm
On Ubuntu, run the following command:
sudo gdebi -n tableau-tabcmd-<version>_all.deb
The basic steps for using tabcmd are as follows:
Open the Command Prompt as an administrator.
On a Windows computer, if you installed tabcmd on a computer other than the initial node, change to the directory where you installed tabcmd.
On a Linux computer, you do not need to change to the install directory.
Run the tabcmd command.
When you use tabcmd, you must establish an authenticated server session. The session identifies the server or Tableau Online site and the user running the session. You can start a session first, and then specify your command next, or you can start a session and execute a command all at once.
Important: If you are using tabcmd to perform more than one task, you must run tasks one after another (serially), rather than at the same time (in parallel).
Commands (such as
login) and the options (such as
-u, etc.) are not case sensitive, but the values you provide (such as
User@Example.com) are case sensitive.
The following command demonstrates starting a session with the Tableau Server named tabserver.mycompany.com:
tabcmd login -s http://tabserver.mycompany.com -u admin -p mypassword
The next example shows a command that deletes a workbook named Sales_Workbook:
tabcmd delete "Sales_Workbook"
Here’s how to accomplish all of the above with one command—note that you do not need
tabcmd delete "Sales_Workbook" -s http://tabserver.mycompany.com -u admin -p mypassword
A Tableau Server can run multiple sites. When a workbook is on the Default site of a multi-site server you don't need to specify Default, the above command is sufficient. However, if the command applies to something on a site other than Default, you need to specify the site ID for that site (see login). Here's the same command for a workbook that's on the West Coast Sales site (site ID
tabcmd delete "Sales_Workbook" -s http://tabserver.mycompany.com -t wsales -u admin -p mypassword
-p are among the tabcmd global variables, which can be used with any command.
For more information, see tabcmd Commands.
When a command is successful, tabcmd returns a status code of zero. A full error message for non-zero status codes is printed to stderr. In addition, informative or progress messages may be printed to stdout.
A full log named tabcmd.log that includes debugging, progress, and error messages is written to C:\Users\<username>\AppData\Local\Tableau.