Was this page helpful?
Yes No

tabcmd

Tableau provides the tabcmd command-line utility which you can use to automate site administration tasks on your Tableau Online site. For example, creating or deleting users, projects, and groups.

In this article

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. Open a web browser and 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.

  3. 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.”

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

  4. Save the installer to the tabcmd computer, or a location accessible from that computer .

  5. Complete the installation steps as appropriate for the operating system of the tabcmd computer:

    • Windows

    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.

    • Linux

    1. Log on as a user with sudo access to the tabcmd computer.

    2. Navigate to the directory where you copied the .rpm or .deb package 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

How to use tabcmd

The basic steps for using tabcmd are as follows:

  1. Open the Command Prompt as an administrator.

  2. On a Windows computer, change to the directory where tabcmd is installed.

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

    C:\Program Files\Tableau\Tableau Server\packages\bin.<version>

    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.

  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.

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

tabcmd login -s https://online.tableau.com -t mysite -u authority@email.com -p password

Here’s how to start a session and delete a workbook with one command—note that you do not need login here:

tabcmd delete "Sales_Workbook" -s https://online.tableau.com -t campaign -u admin@email.com -p password

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.