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

tabadmin Commands

Note: You should only run tabadmin on the primary Tableau Server node, not on worker nodes.

Here are the commands that can be used with the tabadmin command line tool:

 

activate

Activates or returns a Tableau Server license online or offline.

 

Examples

Activate a license offline:

tabadmin activate --tlf <file.tlf>

Return a license offline:

tabadmin activate --tlr <file.tlr>

Activate a license online:

tabadmin activate --activate  --key <license>

Return a license online:

tabadmin activate --return --key <license>
Option (short) Option (long) Argument Description
  --tlf FILE For offline activation. If you are offline during Setup, you are prompted to save a .tlq file, which you submit to Tableau. Tableau sends you a .tlf file. You use this .tlf file to activate Tableau Server.
  --tlr FILE For offline return (deactivation). The file you use as the argument is the .tlr file that you receive from Tableau.
  --key PRODUCTKEY For online activation or return (deactivation) from the command line.
  --trial   For a trial license.
  --activate   Activate the specified license. Use with --tlf, --asr, --key or --trial.
  --return   Deactivate the specified license. Use with --tlr or --key.

See Also

Activate Tableau Server Offline

 

 

administrator

Grants or removes the system administrator capability to the named user. This command does not apply to site administrators.

Examples

Remove the system administrator capability from user hwilson:

tabadmin administrator hwilson false

Give the system administrator capability to user jsmith:

tabadmin administrator jsmith true

 

 

assetkeys

Creates a new key to encrypt sensitive information, such as credentials for external databases, stored within the Tableau repository, which is a PostgreSQL database that Tableau Server uses internally. The key you create with this command can contain either a passphrase that you specify or one that's randomly generated.

Keys are generated with AES symmetric encryption. AES uses a block length of 128 bits. Tableau Server uses a 256-bit key length.

Note: Tableau Server must be running when you issue this command.

If you specify your key's passphrase, it's a best practice for it to be at least eight characters long. You should also take character sets into consideration. A strong passphrase should contain characters from at least three of the following character sets:

  • Lowercase a-z

  • Uppercase A-Z

  • Digits 0-9

  • Non-alphabetic characters

The new key is encrypted and stored in the following key file: asset_keys.yml (ProgramData\Tableau\Tableau Server\data\tabsvc\config). If the key file is lost or corrupted, you can use the assetkeys --validate command to recreate it.

If you use the assetkeys command then later create and restore a backup file (.tsbak), you will need to run the tabadmin assetkeys --validate command after restoring the backup file. By design, backup files do not contain custom encryption keys—even though some data may be encrypted with them. This protects the encrypted values in case the backup file falls into the wrong hands. When you run tabadmin assetkeys --validate after a backup restore, you are prompted to enter the key's passphrase.

If you run unattended restoration from back up, then use the following procedure to restore without entering a passphrase during the validate operation.

  1. Before you restore, make a copy of asset_keys.yml. Save the file outside of the Tableau Server installation path (\Program Files\Tableau Server\).
  2. Restore the backup. If the asset_keys.yml file was in the \config directory (\Program Files\Tableau\Tableau Server\10.3\config), then it is removed during the restore process.
  3. After the restore process is complete, replace the asset_keys.yml file in the \config directory.
  4. Run tabadmin assetkeys --validate.

Validation will succeed because the original asset_keys.yml file is in the \config directory. Embedded passwords will function normally.

Examples

Have Tableau Server generate a key and passphrase for you:

tabadmin assetkeys --auto_create

Generate a key using a passphrase that you specify. You are prompted to enter a passphrase, which will not be displayed as you type:

tabadmin assetkeys --create 

Use the contents of a file as the passphrase:

tabadmin assetkeys --create_from_file C:\test\key\password.txt

Confirm that the key file asset_keys.yml in ProgramData\Tableau\Tableau Server\data\tabsvc\config is valid and consistent with the metadata in the Tableau Repository:

tabadmin assetkeys --validate

Recreate the file asset_keys.yml which is now corrupted or missing from ProgramData\Tableau\Tableau Server\data\tabsvc\config:

tabadmin assetkeys --validate 

You will be prompted for the passphrase.

Option (short) Option (long) Argument Description
  --auto_create [length] Generates a random passphrase to generate the key. Takes an optional argument for the length of the passphrase. You should record the passphrase and keep it in a safe place, as it will be required by --validate if assetkeys.yml is lost or corrupted.
  --create   Generates a key using the passphrase you provide. You are prompted for the passphrase and it will not display as you type it. Your passphrase should be at least 10 characters long and not based on words found in the dictionary.
  --create_from_file FILE Generates a key using the contents of a file that you provide as the passphrase.
  --validate   Confirms that all asset keys being used internally by Tableau Server are up-to-date. If you lose the asset_keys.yml file (for example, due to file corruption), you can use the --validate option to recreate it. You are prompted for and must enter the passphrase that was used to generate the current asset keys in order to successfully recreate the key file.

See Also

Security

 

 

autostart

Specifies whether Tableau Server starts at system start-up time. By default, Tableau Server starts when the computer on which it's installed starts. If autostart is set to off, the tabsvc service will not start (other processes will start) and you will need to explicitly start Tableau Server either using tabadmin start or the Start menu.

After changing the autostart value, you need to run a tabadmin config command to update configuration files on all Tableau Server nodes.

tabadmin autostart [on | off]

Example

Display Tableau Server's auto-start status:

tabadmin autostart

Start Tableau Server when the operating system starts:

tabadmin autostart on

Do not start Tableau Server when the operating system starts:

tabadmin autostart off

 

 

backup

Creates a backup of the data managed by Tableau Server. This data includes Tableau's own PostgreSQL database, which contains workbook and user metadata, data extract (.tde) files, and configuration data. If you have imported web data connectors using the import_webdataconnector command, the backup process saves copies of the connectors as well. You do not need to stop Tableau Server before you create a backup file.

By default, the backup file is saved in the Tableau Server \bin directory, where you run the tabadmin backup command. You can specify a particular location by including a full path with the backup file name. You can also use the --userdir option to put the backup file into a known location.

Note: The command adds the .tsbak extension to the file name that you specify unless the name already contains that extension.

Examples

Create a backup file in the current directory named tabserv.tsbak:

tabadmin backup tabserv.tsbak

Create a backup file in the C:\backups\tableau folder named tabserv.tsbak:

tabadmin backup C:\backups\tableau\tabserv.tsbak

Append the current date to the backup file name and put temporary files created during the backup process in C:\mytemp\tableau. The backup file tabserv.tsbak is created in the directory where you are running the command from:

tabadmin backup tabserv.tsbak -d -t C:\mytemp\tableau
Option (short) Option (long) Argument Description
-d --date   Appends the current date to the backup file name. Date is based on Coordinated Universal Time (UTC).
-u --userdir   Places the backup file in the ProgramData\Tableau\Tableau Server folder.
-t --tempdir PATH Specifies the location for temporary files created during the backup or when verifying database integrity. If the path includes a space, use quotes around the full path.
-v --verify   Verifies the integrity of the database. Available beginning with version 9.3.
  --skip-http-truncate   Creates a backup without cleaning entries from the http_requests table in the PostgreSQL database. By default doing a backup will remove all but the most recent 7 days of data in the http_requests table. Use this option to create a backup without cleaning the http_requests table. Available beginning with version 10.3.

Note: Tableau recommends that as a best practice you include cleaning the http_requests table as part of your regular database maintenance. For more information, see cleanup and Remove Unneeded Files.

  --no-config   Creates a backup file without configuration data. The secrets storage configuration bundle is not included in the backup file.

See Also

Back Up Tableau Server Data

 

 

cleanup

Reduces the disk space consumed by Tableau Server. Running tabadmin cleanup removes log files, temporary files, and rows older than seven days from the http_requests table of the Tableau Server PostgreSQL database. If Tableau Server is installed on multiple computers in a cluster, the command can also reset the information maintained by the coordination server that is used to synchronize between nodes and to manage failover.

The effect of the cleanup command depends on whether the server is running or stopped. For more information, see Remove Unneeded Files.

Examples

Remove log files, temporary files, and HTTP request entries in the PostreSQL database:

tabadmin cleanup

Remove log files and temporary files (leave HTTP request entries in the database untouched):

tabadmin cleanup --restart
Option (short) Option (long) Argument Description
-r --restart   Stops Tableau Server, runs the cleanup command, and starts the server again.
  --reset-coordination   In addition to performing a normal cleanup, removes log files, transaction logs, and snapshots that are maintained by the Tableau Server coordination service (zookeeper) when Tableau Server is running on multiple computers in a cluster. Note that using this option completely resets the coordination service, meaning all state maintained by the coordination service is removed. This option also does the equivalent of a tabadmin configure command. For guidelines about when to reset the coordination service, see Troubleshoot Server Processes.

See Also

Remove Unneeded Files

 

 

clearcache

Clears the information being cached by the Cache Server process (redis-server.exe). The cache stores information used to render views in order to help speed rendering. Clearing the cache is useful if metadata about views or data sources that might be cached has changed, and those changes should take effect before the resource is removed from the cache in the normal course of server processing. For example, clearing the cache can be useful if you change permissions on a workbook or view and it's important that the changed permissions take effect immediately.

You must stop the server before you run this command.

Examples

tabadmin clearcache

See Also

Tableau Server Processes

 

 

configure

Updates Tableau Server's configuration by forcing an update to all the files in ProgramData\Tableau\Tableau Server\data\tabsvc\<area>. This update includes refreshing the master service configuration file, workgroup.yml (ProgramData\Tableau\Tableau Server\data\tabsvc\config). When you make a configuration change, it's a best practice to run tabadmin configure (or tabadmin config) to ensure that all files affecting the server’s configuration are completely updated.

If you are running Tableau Server in a distributed environment and if you have imported web data connectors using the import_webdataconnector command or deleted them using the delete_webdataconnector command, the configure command makes sure that any web data connectors are correctly distributed (imported or deleted) in all nodes where the gateway process is running.

Examples

tabadmin configure
tabadmin config

See Also

Reconfigure the Server

set

tabadmin set options

 

 

customize

Customizes the server name that's displayed in tooltips and messages, and the logos that are used by Tableau Server. Note that even if you use this command, the bottom of every server page lists Tableau's copyright information.

Image files you use for logos can be in GIF, JPEG, or PNG format.

Examples

Name

Change the product name used in tooltips from "Tableau Server" to "My Company":

tabadmin customize name "My Company"

Reset the product name to the default:

tabadmin customize name -d

Header logo

Customize the main server header logo. The image can be up to 160 by 160 pixels, but not smaller than 32 by 32 pixels. For best results use an image that's 125 by 35 pixels. If the image is larger than 160 by 160 pixels, it is clipped.

tabadmin customize header_logo "C:\My Pictures\example.png"

Reset the header logo to the default:

tabadmin customize header_logo -d

Sign-in logo

Customize the sign-in page logo. The image can be up to 3000 by 3000 pixels.

tabadmin customize sign_in_logo "C:\My Pictures\example.png"

Reset the sign-in logo to the default:

tabadmin customize sign_in_logo -d

Logo

Set the main server header and the sign-in page logo to the same image. The image can be up to 160 by 160 pixels, but not smaller than 32 by 32 pixels. If the image is larger than 160 by 160 pixels, it is clipped.

tabadmin customize logo "C:\My Pictures\example.png"

Reset the logo to the default:

tabadmin customize logo -d

Option (short) Option (long) Argument Description
-d --default nameheader_logosign_in_logologo Resets the name or logo to its default value.
  name NAME Sets the name to the value in the argument. The default is "Tableau Server".
  logo FILE Sets both the header logo and the sign-in page logo to the image referenced in the file path. If the image is larger than 160 by 160 pixels, it is clipped. If the path includes a space, use quotes around the full path.
  header_logo FILE Sets the logo to the image referenced in the file path. For best results use an image that's 125 by 35 pixels. If the image is larger than 160 by 160 pixels, it is clipped. If the path includes a space, use quotes around the full path.
  sign_in_logo FILE Sets the logo to the image referenced in the file path. The image can be up to 3000 by 3000 pixels. If the path includes a space, use quotes around the full path.

See Also

Change the Name or Logo

 

 

dbpass

Enables external access to Tableau's PostgreSQL database (the repository). After you use the dbpass command to allow access to the database, you can connect to and query it using Tableau Desktop to create your own administrative views.

tabadmin dbpass [--disable] [--username <username>] [password]

Note: The --username option is valid starting with Tableau Server 8.2.5. In earlier versions dbpass only enabled the "tableau" user and you could not specify the user. 8.2.5 added a second user called "readonly" and introduced the ability to specify the user you are enabling access for.

Examples

Enable access for the tableau user and set the password to p@ssword:

tabadmin dbpass p@ssword

Enable access for the readonly user and set the password to p@ssword:

tabadmin dbpass --username readonly p@ssword

Disable external access for the default (tableau) user:

tabadmin dbpass --disable

or

tabadmin dbpass --disable --username tableau

Disable external access for the readonly user:

tabadmin dbpass --disable --username readonly
Option (long) Argument Description
--disable   Disable external access to Tableau's PostgreSQL database for the default remote user (tableau) or, starting in 8.2.5, if a user name is specified, disable remote access for that user.
--username tableau or readonly Change the password for the specified user, or, if used with the --disable option, disable access for the specified user. Options for users are tableau and readonly. This option is valid in Tableau Server 8.2.5 or higher.
  password provided by user Enable remote access to Tableau's PostgreSQL database for the default remote user (tableau) or, starting in 8.2.5, if a user name is specified, enable access for that user with the given password.

See Also

Collect Data with the Tableau Server Repository

 

decommission

Prepares Tableau Server File Store nodes for removal from the distributed installation. This command puts the specified nodes into read-only mode so new content cannot be added to the File Store, and makes sure that all content on the node also exists on another File Store node. This command can be run while Tableau Server is running.

Note: Remove a decommissioned File Store node before restarting Tableau Server. Restarting automatically re-activates any decommissioned File Store nodes.

tabadmin decommission <node1 node2 ...>

Examples

Decommission worker2:

tabadmin decommission worker2

Decommission two nodes by IP address:

tabadmin decommission 10.32.139.30 10.32.139.22
Option (long) Argument Description
  <node1 node 2 node 3...> List of File Store nodes (servers) to decommission. Separate multiple nodes with a space.

See Also

Distributed Environments

Maintain a Distributed Environment

 

 

delete_webdataconnector

Removes the specified web data connector from the server, or removes all web data connectors. If the web data connector is installed on a cluster, this command removes the specified connector or all connectors from all computers in the cluster.

Note: If the server is running in a distributed environment and the delete process is partially successful, users can still access the connector. For more information, see Web Data Connectors in Tableau Server.

Examples

tabadmin delete_webdataconnector connector1.html

tabadmin delete_webdataconnector --all

Option (short) Option (long) Argument Description
  --all   Removes all web data connectors from Tableau Server. When you use this option, you do not specify a connector name.

If the server is configured as a cluster, the command removes all connectors from all the nodes where they are installed.

See Also

import_webdataconnector

list_webdataconnectors

Web Data Connectors in Tableau Server

Tableau webdataconnector page on GitHub

 

exportsite

Exports a Tableau Server site, including its users, workbooks, projects, extracts, and data connections, and places it in a file with a .zip file extension. You can then use the exported site file to provision a new site by using the importsite and importsite_verified commands.

You don't need to stop Tableau Server before you use the exportsite command. Tableau Server will lock the site being exported during the export process.

Notes: When you import a site that you exported earlier, each user and schedule that is being imported must match an existing user and schedule. For suggestions about how to manage the export and import process to match users and schedules, see Tips for importing to a target with fewer users or schedules than the source site.

If your source site has workbooks that use published data sources, the target site name must match the source site name. The data connections for the workbooks will continue to refer to the source site name and can't be updated on the new site.

Examples

tabadmin exportsite <site ID> --file <PATH>

or

tabadmin exportsite <site ID> --file <FILE>

Export the site whose site ID is finance to a file named finance_export.zip and place it in Program Files\Tableau\Tableau Server\10.3\bin:

tabadmin exportsite finance --file finance_export

Export the Default site. The site ID for the Default site is "" (double quotes, no space).

tabadmin exportsite "" --file finance_export

If you are using Windows PowerShell to run the command, enclose the double quotes for the Default site within single quotes ('""'). For example: tabadmin exportsite '""' --file finance_export

Export the Default site to a file named finance_export.zip and place it in C:\temp\exported sites instead of in the Tableau Server bin directory. Because the path contains a space, it's contained by quotes:

tabadmin exportsite "" --file "C:\temp\exported sites\finance_export"

Export the site whose site ID is finance, name the export site file financesite.zip, place the file in C:\sites\exported, and write temporary run-time files to C:\temp_files:

tabadmin exportsite finance --file C:\sites\exported\financesite --tempdir C:\temp_files

Option (short) Option (long) Argument Description
  --file

FILE or

PATH

The name or name and location (path) of the exported site file to be created. If you don't specify a path, Tableau Server's bin directory is the assumed location (Program Files\Tableau\Tableau Server\10.3\bin). If you specify a path and the path includes a space, use quotes around the full path.
  --tempdir   The location of temporary files created during export. Use this option if you don't have write access to the Tableau Server installation directory. This option does not determine where the export site file is created.

See Also

Export or Import a Site

 

 

failoverprimary

Identifies a second installation of the primary Tableau Server as the backup primary, or if the primary has failed, identify the backup primary as the new primary and the former primary as the new backup.

Note: If you run this command without providing an option, the current computer is assumed to be the primary and no backup primary is identified.

Example

tabadmin failoverprimary --primary "<computer name(s) or IPv4 address(es)>"

The following command specifies the primary Tableau Server computer (10.32.139.22) and the backup primary (10.32.139.50):

tabadmin failoverprimary --primary "10.32.139.22,10.32.139.50"

Option (short) Option (long) Argument Description
  --primary Computer name(s) or IPv4 address(es) The Tableau Server machine that's acting as the cluster's primary.

See Also

High Availability

Configure for Failover and Multiple Gateways

Use a Backup Primary

 

 

failoverrepository

Manually identifies a second, passive installation of the PostGRES repository as the active repository.

If Tableau Server is configured for high availability, failover of the repository is automatic. Use the failoverrepository command to manually fail over the repository (for example, if Tableau Server is configured for manual repository failover using the tabadmin set clustercontroller.pgsql.failover false command).

Tableau Server must be running when you run the failoverrepository command.

tabadmin failoverrepository --target <computer name or IPv4 address> | --preferred

Example

tabadmin failoverrepository --target worker_server2

Note: This command is persistent. The failover repository remains the active repository until you issue the command again. If you have a preferred active repository configured, use the --preferred option to switch back to that repository.

Option (short) Option (long) Argument Description
  --target Computer name or IPv4 address The Tableau Server repository node to failover to.
  --preferred   Failover to the repository node that is specified as the preferred active repository.

See Also

High Availability

Configure for Failover and Multiple Gateways

Use a Backup Primary

 

 

get

Get the value of a Tableau Server configuration option.

Example

tabadmin get [option-name]

Get the backgrounder query limit:

tabadmin get backgrounder.querylimit

 

 

get_openid_redirect_url

If Tableau Server is configured to use OpenID Connect for authentication, gets the URL that is used to redirect users from the identity provider (IdP) to Tableau Server after a successful sign-in.

Example

tabadmin get_openid_redirect_url

See Also

OpenID Connect

Configure Tableau Server for OpenID Connect

 

 

importsite

Imports a site into Tableau Server. The importsite command is the first of two commands you use to import a site into Tableau Server. To run this command, you need the following:

  • An exported site file. Tableau Server administrators create this file using the exportsite command. If you have a site on Tableau Online and you want to import it into your own on-premises installation of Tableau Server, request an exported site file from Tableau Customer Support.

  • The site ID for the target site. The target site is the Tableau Server site into which you want to import. The target site must already exist when you run the importsite command; you can't create it as part of the command. The site ID for Tableau Server's default site is "" (double quotes, no space).

    The contents of the site that you import will replace (not amend) the contents of the target site. For example, if your target site has a workbook named MyDashboard.twbx and the site you are importing does not have this workbook, the import process will remove MyDashboard.twbx from the target site.

When you run the importsite command, the command creates a temporary directory containing mapping files in comma-separated-value (CSV) format that define how the exported site's assets (users, workbooks, projects, extracts, and data sources) will be mapped when the site has been imported. It is important that you verify these details. Use a text editor or Microsoft Excel to open the mapping files and make any changes. Any entries with ??? (question marks) represent mappings that couldn't be handled and must be edited. After you verify the mappings, finish the import process using the importsite_verified command.

Note: When you import a site that you exported earlier, each user and schedule that is being imported must match an existing user and schedule. For suggestions about how to manage the export and import process to match users and schedules, see Tips for importing to a target with fewer users or schedules than the source site.

Examples

tabadmin importsite <site ID> --file <PATH>

or

tabadmin importsite <site ID> --file <FILE>

Import the file sales_site.zip located in C:\tableau\exported to a site whose site ID is wsales:

tabadmin importsite wsales --file C:\tableau\exported\sales_site.zip

Import the file sales_site.zip, which is located in located in C:\Program Files\Tableau\Tableau Server\10.3\bin, to the Default site. The site ID for the Default site is "" (double quotes, no space).

tabadmin importsite "" --file sales_site.zip

The mapping files for you to verify are placed in ProgramData\Tableau\Tableau Server\data\tabsvc\temp\import_<site ID>_<datetime>\mappings. To specify a different directory, use the --tempdir option.

Place the files to be verified in C:\temp\site_to_import:

Skip the verification step (not recommended):

tabadmin importsite wsales --file "C:\tableau\exported\sales_site.zip" -no-verify

Option (short) Option (long) Argument Description
  --file PATH The name and location of the exported site file you are importing. If you don't specify a path, Tableau Server's bin directory is the assumed location (Program Files\Tableau\Tableau Server\10.3\bin).
  --no-verify  

Skips the verification step and imports the exported site file directly to its new location in your Tableau Server installation. If you choose this option, you do not need to use the importsite_verified command.

Note: Importing a site without verifying the mappings is not recommended.

  --tempdir PATH The directory where you will verify that the site files have the correct mappings. If you don't specify this option, files are placed in a directory under ProgramData\Tableau\Tableau Server\data\tabsvc\temp.

See Also

Export or Import a Site

 

 

importsite_verified

Performs the second part of an import process for a site on Tableau Server. Before you can use importsite_verified, you must first use importsite.

The importsite_verified command reads from a directory containing CSV files that you have verified, and imports a new site into Tableau Server based on how the site's assets are mapped in the CSV files. The site that receives the import (the target site) must already exist on Tableau Server.

During the import process, Tableau Server locks the site receiving the import.

Examples

tabadmin importsite_verified <target site ID> --importjobdir <PATH>

Import files from the directory C:\temp\site_to_import to the site whose site ID is esale:

Option (short) Option (long) Argument Description
  --importjobdir PATH The directory containing CSV files whose mappings you have verified.

See Also

Export or Import a Site

 

 

import_webdataconnector

Installs a web data connector on the server. Users who create workbooks can then reference the web data connector as a data source.

Note: Starting with version 10.0 of Tableau Server, the recommended way to make web data connectors available on Tableau Server is to add them to a safe list. For more information, see whitelist_webdataconnector.

Important: Before you import a web data connector, make sure that the JavaScript code in the connector does not implement any functionality that should not be on your server.

When the import_webdataconnector command finishes importing the connector, the command displays the server URL of the connector. When users want to reference the web data connector as a data source, they need to know this URL. (You can also view the URLs of connectors on your server by using the list_webdataconnectors command.)

If the web data connector includes references to an external file, such as to a .css file or .js file, you must make sure that the external file is available from the server, either over the web or as a local file. If the connector references a local file, the local file must be in the same folder as the connector's .html file relative paths to subdirectories are not supported for imported web connectors. (Make sure that the <link> or <script> element in the connector correctly references the file as a peer of the connector file.) If the external file is local, you must use the import_webdataconnector command to import the external file separately.

If the server includes multiple computers in a cluster, the web data connector is imported to each computer where a gateway process is running.

Examples

tabadmin import_webdataconnector connector1.html

tabadmin import_webdataconnector c:\webdataconnectors\connector1.html --overwrite

tabadmin import_webdataconnector \\myshare\webdataconnectors\connector2.html --overwrite

tabadmin import_webdataconnector connector1.css

Note:The connector name can contain only these characters: a-zA-Z0-9()~.-_.

Option (short) Option (long) Argument Description
  --overwrite   Overwrites any existing file on the server that has the same name as the file that you are importing.

See Also

delete_webdataconnector

list_webdataconnectors

Web Data Connectors in Tableau Server

 

 

licenses

Displays license information for Tableau Server.

Examples

tabadmin licenses
tabadmin licenses -p

Option (short) Option (long) Argument Description
-p --processor_cores   Display the physical core count for the current machine.

 

 

list_webdataconnectors

Displays the names or URLs of web data connectors that are installed on the server.

Examples

List the names of the web data connectors.

tabadmin list_webdataconnectors

List the URLs of the web data connectors.

tabadmin list_webdataconnectors --urls

Option (short) Option (long) Argument Description
  --urls   Specifies that the command should list URLs instead of names.

See Also

import_webdataconnector

delete_webdataconnector

Web Data Connectors in Tableau Server

 

 

manage_global_credentials

Manages credentials for delegated data access on Tableau Server. Use this command to specify the credentials for a proxy user that is used to access a data source that does not support single-sign on via Kerberos.

Examples

tabadmin manage_global_credentials --add --server <server> --user <username> --password <password>

Add credentials for a server named my-server.

tabadmin manage_global_credentials --add --server my-server --user jsmith --password p@ssword

Option (short) Option (long) Argument Description
  --add   Add credentials for the specified server.
  --remove   Remove credentials
  --show   Show current credentials
-s --server server Server for which credentials are being managed
-u --username user User name for connecting to a server
-p --password password Password for connecting to a server
-o --override   Override existing credentials

See Also

Enabling Delegation for Cloudera Impala in the Tableau Community.

 

 

passwd

Resets the password for a Tableau Server account. After typing the command, you are prompted to enter a new password for the user.

You can only use this command if Tableau Server's user authentication is set to Local Authentication. When authentication is set to Active Directory, passwords are handled by Active Directory, not Tableau Server.

Examples

tabadmin passwd <username>

Reset the password for server user jsmith:

tabadmin passwd jsmith

See Also

Configure General Server Options

 

 

recommission

Reverts a decommissioned file store node in read-only mode to an active read/write state. Use spaces to separate multiple nodes.

Examples

tabadmin recommission <computer name(s) or IPv4 address(es)>

Recommission file store node by IP address:

tabadmin recommission 10.32.139.29

See Also

Distributed Environments

Maintain a Distributed Environment

 

 

regenerate_internal_tokens

Creates new security tokens that Tableau Server uses internally. These tokens include the passwords used by Tableau Server to access the repository, and the certificates used to validate internal SSL connections between Tableau Server components and the repository.

Running this command stops Tableau Server, so you will need to restart Tableau Server after you run the command.

Example

tabadmin regenerate_internal_tokens --passwords

tabadmin regenerate_internal_tokens --certs

Option (short) Option (long) Argument Description
  --certs None Regenerates key pair for internal SSL connections.
  --passwords None Regenerates passwords for the Postgres database.
  None None Regenerates key pair for internal SSL connections and passwords for Postgres database. Note: The key pair is regenerated only if internal SSL is configured.
  --roll_key   Updates the secrets for encrypted passwords that are stored in the repository. See Manage Server Secrets.
  --restart None Restart Tableau Server after regenerating tokens.

See Also

Regenerate a Password for the Tableau Server PostgreSQL Database (Repository)

Security

 

register

Register Tableau Server with the user information provided in the specified file. This is used for scripted, automated installations.

Examples

tabadmin register --file tabregister.json
Option (short) Option (long) Argument Description
  --file JSON-format file Register Tableau Server using the information in the specified file.

See Also

Automated Installation or Upgrade of Tableau Server

Registration Input File Options

 

reindex

Rebuilds the search index for Tableau Server. In rare instances, you may need to rebuild the index if searches on the server return incomplete or incorrect results, or if the Search & Browse process is down for an extended period. You can use this command if users cannot sign in to the server because no sites are listed after they enter their credentials.

Note: The recommended way to reindex Search is to run this command while Tableau Server is stopped. Reindexing while the server is running can result in content, including sites and projects, temporarily disappearing.

Examples

tabadmin reindex

Reindex the server

See Also

Rebuild the Search Index

 

 

reset

Resets the Tableau Server administrator account. This command will reset the server so that you will need to set up an administrator account.

Example

tabadmin reset

Option (short) Option (long) Argument Description
  --destroy-sessions None Destroys all existing sessions. All users will be forced to sign in again.
  --silent None Suppresses normal verbose mode. This is useful if you are creating a chain of several automated steps.

See Also

Add an Administrator Account

 

 

reset_openid_sub

Clears the user identifier (sub value) that binds a user identity in Tableau Server to a specific OpenID Connect identity provider (IdP).

If Tableau Server is configured to use OpenID Connect for authentication, the first time a user signs in to Tableau Server using the IdP, Tableau stores the sub value sent by the IdP with the user information in Tableau Server. The sub provides a unique identity for that user with the IdP. If you change IdPs for OpenID Connect, you must remove the sub value for the user. That way, when the user signs in using the new IdP, Tableau can store a new sub value.

Option (short) Option (long) Argument Description
  --username username Removes the sub value for the specified user.
  --all None Removes the sub value for all users.

Example

tabadmin reset_openid_sub --username Alice

This command clears the sub value for the user named Alice.

tabadmin reset_openid_sub --all

This command clears the sub value for all users on the server.

See Also

OpenID Connect

Changing IdPs in Tableau Server for OpenID Connect

 

 

restart

Stops and starts all Tableau Server processes. The restart command also does a configuration so you do not need to do a tabadmin config if you are doing a restart (a config will not do any harm).

Example

tabadmin restart

 

 

restore

Restores a Tableau Server backup file (.tsbak) to a Tableau Server installation. When you restore a .tsbak file, the contents of the Tableau PostgreSQL database, data extracts, and configuration files are overwritten with the content in the backup file. If the backup was made after web data connectors were imported to the server using the import_webdataconnector command, the restore process restores the connectors as well. Using the --no-config option restores everything but the server's configuration.

Examples

Restore a file named tabserv.tsbak located in C:\mybackups and then restart the server:

tabadmin restore C:\mybackups\tabserv.tsbak --restart

Restore a file named tabserv.tsbak located in the Tableau Server bin directory and then restart the server:

tabadmin restore tabserv.tsbak --restart

Restore a file named tabserv.tsbak located in C:\mybackups, retaining everything but the server's configuration, but don't restart the server:

tabadmin restore --no-config C:\mybackups\tabserv.tsbak
Option (short) Option (long) Argument Description
  --no-config   Restore the Tableau Server backup file including the data but excluding the server's configuration.
  --parallel-pg-restore   Run the restore process for the PostgreSQL repository as a parallel job.
  --password <password> Restore the Tableau Server backup file using the Run As User password.
  --password-file File Restore the Tableau Server backup file, reading the password from the specified file.
  --restart   Restart the service when the restore process has completed.

See Also

Restore from a Backup

Recover Extracts from a Backup

 

 

set

Allows you to change the value of Tableau Server configuration options.

In some cases, a set command can take multiple values. If so, the values are separated by commas and spaces.

After changing configuration values, you need to run a tabadmin config command to update configuration files on all Tableau Server nodes.

Examples

tabadmin set [option-name] [value]

tabadmin set --stdin [option-name] [value]

If the parameter you're setting begins with a hyphen, enclose the parameter's value in both double- and single-quotes.

tabadmin set [option-name] "'[-value]'"

Set the backgrounder query limit to 2.5 hours (9000 seconds):

tabadmin set backgrounder.querylimit 9000

Disable sorting, based on duration of last run, of extract refresh jobs:

tabadmin set backgrounder.sort_jobs_by_run_time_history_observable_hours "'-1'"

Set the names of two web servers that request trusted tickets from Tableau Server.

tabadmin set wgserver.trusted_hosts myserver1, myserver2

Option (short) Option (long) Argument Description
-d --default   Reset the parameter to its default value.
-s --stdin   Read a parameter value from the standard input stream (STDIN) such as the console. You are prompted for the value.

See Also

tabadmin set options

 

 

sitestate

Activates (unlocks) or suspends a site. You can use this command to activate a site that was locked because of a site import failure. When a site is suspended, the only Tableau Server user who can access it is the system administrator.

Note: To specify the default site, use "" for the site ID.

Examples

tabadmin sitestate <site ID> --status <active|suspended>

Activate a site whose site ID is wsales:

tabadmin sitestate wsales --status active

Activate the Default site. The site ID for the Default site is "" (double quotes, no space).

tabadmin sitestate "" --status active

Option (short) Option (long) Argument Description
  --status

active

or

suspended

Specifies whether to activate or suspend the specified site.

 

 

start

Starts all Tableau Server processes. The start command also does a configuration so you do not need to do a tabadmin config if you are doing a start (a config will not do any harm).

To use tabadmin start:

  1. Open a command prompt as an administrator:

  2. Type the following:

    cd "C:\Program Files\Tableau\Tableau Server\10.3\bin"
  3. Type the following to start the server:

    tabadmin start

Examples

tabadmin start
tabadmin start --wait 1200

Option (short) Option (long) Argument Description
  --wait number of seconds Number of seconds after starting after which Tableau Server is ready to accept client requests. The default is 600 seconds.

 

 

status

Tells you whether or not Tableau Server is running and, if you use the --verbose option, gives you details on individual server process status, including whether a process is running and its process ID. The tabadmin status command obtains its information by connecting to the Windows Service tabsvc.exe, which in turn queries the tabspawn executables for each process. Because of this, it can sometimes display different information for the server processes than the status table on the Maintenance page, which queries the processes directly.

Examples

tabadmin status
tabadmin status --verbose

Option (short) Option (long) Argument Description
-v --verbose   Returns a list of all the Tableau Server processes, their process IDs, and their status.

See Also

Server Settings (General)

Tableau Server Processes

 

 

stop

Stops all Tableau Server processes. To use tabadmin stop:

  1. Open a command prompt as an administrator:

  2. Type the following:

    cd "C:\Program Files\Tableau\Tableau Server\10.3\bin"
  3. Type the following to stop the server:

    tabadmin stop

 

 

validate

Confirms whether your Tableau Server environment meets the minimum requirements for running Tableau Server.

Example

tabadmin validate

Option (short) Option (long) Argument Description
  --skiptempIPv6   Skip validating that temporary IPv6 addresses are disabled.

 

verify_database

Verifies that a backup of the PostgreSQL database that serves as the Tableau Server repository will restore successfully.

Note: The verify_database command is available beginning with Tableau Server version 9.3.

If you specify a backup file (.tsbak) as an option, the command restores the file to a temporary database in order to verify the backup. If you do not specify a backup file, a temporary backup of the running database is created and then restored to a temporary database. If verification fails, errors are displayed on the command line and are also logged in the tabadmin.log log file. Until the errors are addressed, You cannot restore a .tsback file that fails verification. If verification of the database fails, contact Tableau Support for assistance.

Note: A running PostgreSQL database can have errors that don't impact use but would cause a failure when you tried to restore a backup. This means that you may be able to continue to use a running database, but you cannot back it up and restore the backup. As a best practice, verify your database before taking a backup (prior to an upgrade, for example).

Example

Verify a backup file in the C:\backups\tableau folder named tabserv.tsbak:

tabadmin verify_database --file C:\backups\tableau\tabserv.tsbak

Option (short) Option (long) Argument Description
-f --file FILE Backup file to verify. If no file is specified, the command verifies the running PostgreSQL database by making a temporary backup of it.
-t --temp PATH Location of the temporary folder to use while doing verification. The default is the Tableau temp folder. Temporary files are removed after verification completes.

See Also

backup

Verify the Tableau Postgres Database

 

warmup

Causes every VizQL server process to load the vizql DLL file, resulting in faster load times when server users first load views. Administrators can run this command, or script it to be run, after a Tableau Server restart.

Example

tabadmin warmup

 

whitelist_webdataconnector

Adds a web data connector to the safe list (whitelist) for an installation of Tableau Server. Users who create workbooks can then reference the web data connector as a data source. Tableau Server only uses the safe list if the tabadmin webdataconnector.whitelist.mode property is set to fixed or mixed.

The safe list includes the URLs of hosted web data connectors that you have vetted and that you want to allow Tableau Server users to connect to. For more information, see Web Data Connectors in Tableau Server.

Important: Before you add a web data connector to the safe list, check the functionality of the connector. For more information, see Testing and Vetting Web Data Connectors.

The URLs for connectors in the safe list are case sensitive. When a connector is on the safe list, data sources and workbooks that are associated with the connector can be refreshed on Tableau Server. After you make changes to the safe list, you must restart Tableau Server for the changes to take effect.

For each connector that you add to the safe list, you must also create a secondary safe list specific to that connector. This secondary safe list determines which domains the connector can send requests to and receive requests from. This helps ensure that connectors do not send information to untrusted domains.

Option (short) Option (long) Argument Description
-a --add Connector URL Add the URL of a hosted web data connector to the safe list.
-d --delete Connector URL Remove the URL of a web data connector from the safe list.
-l --list  

List all of the connector URLs on the safe list.

-r --reset  

Clear the safe list.

-s --add_secondary_whitelist Connector URL and comma separated list of URLs the connector can make requests to

Add a list of domains that a particular connector can make requests to. The first argument is a connector that has already been added to the safe list. The second argument is a comma separated list of domains or resources. You can include regular expressions in the list of domains. If you do not specify a secondary safe list for a connector, then that connector cannot connect to any domains.

-p --print_secondary_whitelist Connector URL

Print the secondary safe list for a given connector URL.

-w --reset_secondary_whitelist Connector URL

Clear the secondary safe list for a given connector URL.

Note: If you use Windows PowerShell to run these commands, you might need to include quotes around the argument. For example, when you add a secondary safe list with regular expressions, you need to include quotes.

Examples

tabadmin whitelist_webdataconnector -a https://example.com/myconnector.html
tabadmin whitelist_webdataconnector -a http://example.com:8080/myconnector.html
tabadmin whitelist_webdataconnector -d https://example.com/myconnector.html
tabadmin whitelist_webdataconnector -s https://example.com/myconnector.html https://myFirstAPI.com/getData,http://mySecondAPI.com:80/(.*),data:image/(.*)
tabadmin whitelist_webdataconnector -p https://example.com/myconnector.html
tabadmin whitelist_webdataconnector -w https://example.com/myconnector.html

See Also

Web Data Connectors in Tableau Server

Tableau webdataconnector page on GitHub

ziplogs

Creates an archive (.zip) containing Tableau Server log files, without removing the log files themselves. If you are running a Tableau Server cluster, log files from worker servers are included in the archive that's created. You can specify the file name and location. If you don't provide a file name, the archive is called logs.zip . If you don't include a path, the file is saved in the \bin directory. Saving an archive file to a UNC path is not supported.

Examples

Create an archive in the Tableau Server bin directory named logs.zip:

tabadmin ziplogs

Create an archive in the Tableau Server bin directory named mylogs.zip:

tabadmin ziplogs mylogs.zip

Create an archive in the Tableau Server bin directory named mylogs.zip that includes logs dated January 31, 2014 up to the present, excluding earlier logs:

tabadmin ziplogs -d 01/31/2014 mylogs.zip

Option (short) Option (long) Argument Description
-n --with-netstat-info   Include information about the server environment in the .zip file.
-p --with-postgresql-data   Include data from Tableau Server's PostgreSQL database. If Tableau Server is stopped, make a copy of the pgsql\data folder. If Tableau Server is running, get the data as binary dump files.
-l --with-latest-dump   Limit the included log files to only the most recent ones to help reduce file size. By default, the 10 most recent log files are included.
-f --force   Overwrites the existing log file of the same name.
-d --minimumdate [mm/dd/yyyy] Log files with this date, up to the present, are included in the .zip file. Logs dated earlier are excluded from the file. If not specified, up to seven days worth of data is included.
-a --all   Include all log files in the .zip file. Data from Tableau Server's PostgreSQL database is still excluded.

See Also

Work with Log Files

Archive Logs on Command Line (tabadmin)