Was this page helpful?
Yes No
Tableau Help > Tableau Server for Windows Help > 

tabcmd

You can use the tabcmd command-line utility to create scripts to automate administrative 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 primary server node, you need to download the installer from the Tableau website. For more information, see Install tabcmd below.

The tabcmd installer is included on the primary node with Tableau Server versions earlier than 10.1. If you have Tableau Server 10.0.x or earlier, you can find TabcmdInstaller.exe in <server install location>\<version>\extras. For example: D:\Tableau\Tableau Server\10.0\extras\TabcmdInstaller.exe..

Install tabcmd

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.

  1. Go to the Tableau Server Releases page (do this even if you use Tableau Online).

  2. 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.

    Select the server version you use (latest release for Tableau Online)

    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.

  3. Scroll to the Download Files section under the resolved issues, and select the tabcmd download link that is compatible with the computer from which you’ll run the commands.

    Select the tabcmd installer for the computer you'll use it on (32- or 64-bit)

  4. Save the file and 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.

How to use tabcmd

The basic steps for using tabcmd are as follows:

  1. Open the Command Prompt as an administrator.

  2. Change to the directory where tabcmd is installed.

    If you are using tabcmd on the Tableau Server primary node, change to the Tableau Server bin folder. For example:

    cd C:\Program Files\Tableau\Tableau Server\10.4\bin

    If you installed tabcmd on a computer other than the primary node, change to the directory where you installed tabcmd.

  3. 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. If you are using tabcmd to perform more than one task, you must run tasks one after another (serially), rather than in parallel.

Commands (such as login) and the options (such as -s, -u, etc.) are not case sensitive, but the values you provide (such as User@Example.com) are case sensitive.

Examples

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 login here:

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 wsales):

tabcmd delete "Sales_Workbook" -s http://tabserver.mycompany.com -t wsales -u admin -p mypassword 

The options -s, -t, -u, and -p are among the tabcmd global variables, which can be used with any command.

For more information, see tabcmd Commands.

Status messages and logs

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.