Was this page helpful?
Yes No

tabcmd Commands

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

addusers group-name

Adds users to the specified group.

Example

tabcmd addusers "Development" --users "users.csv"
Option (short) Option (long) Argument Description
 
--users
filename.csv Add the users in the given file to the specified group. The file should be a simple list with one user name per line. User names are not case sensitive. The users should already be created on Tableau Server. See also CSV Import File Guidelines.
 
--[no-]complete
  When set to complete this option requires that all rows be valid for any change to succeed. If not specified, --complete is used.

creategroup group-name

Creates a group. Use addusers (for local groups) and syncgroup (for Active Directory groups) commands to add users after the group has been created.

Example

tabcmd creategroup "Development"

createproject project-name

Creates a project.

Example

tabcmd createproject -n "Quarterly_Reports" -d "Workbooks showing quarterly sales reports."
Option (short) Option (long) Argument Description
-n --name name Specify the name of the project that you want to create.
-d --description description Specify a description for the project.

Top

createsite site-name

Creates a site.

Examples

Create a site named West Coast Sales. A site ID of WestCoastSales will be automatically created, the site will have no storage quota limit, and site administrators will be able to add and remove users:

tabcmd createsite "West Coast Sales"

Create a site named West Coast Sales with a site ID of wsales:

tabcmd createsite "West Coast Sales" -r "wcoast"

Prevent site administrators from adding users to the site:

tabcmd createsite "West Coast Sales" --no-site-mode

Set a storage quota, in MB:

tabcmd createsite "West Coast Sales" --storage-quota 100
Option (short) Option (long) Argument Description
-r --url site ID Used in URLs to specify the site. Different from the site name.
  --user-quota number of users Maximum number of users that can be added to the site.
  --[no-]site-mode   Allow or deny site administrators the ability to add users to or remove users from the site.
  --storage-quota number of MB In MB, the amount of workbooks, extracts, and data sources that can be stored on the site.

Top

createsiteusers filename.csv

Adds users to a site, based on information supplied in a comma-separated values (CSV) file. If the user is not already created on the server, the command creates the user before adding that user to the site.

The CSV file must contain one or more user names and can also include (for each user) a password, full name, role, administrator level, publisher (yes/no), and email address. For information about the format of the CSV file, see CSV Import File Guidelines. As an alternative to including role, administrator level, and publisher permissions in the CSV file, you can pass role information to the command using the --role option.

By default, users are added to the site that you are logged in to. To add users to a different site, include the global --site option and specify that site. (You must have permissions to create users on the site you specify.)

If the server contains multiple sites, you cannot assign the ServerAdministrator role to a user by using the createsiteusers command. (Use createusers instead.) If you specify the ServerAdministrator role for the role option, the command returns an error. If the CSV file includes System as value for administrator, the value is ignored and the user is assigned the Unlicensed role. However, if the server contains only one site (the default site), you can assign the ServerAdministrator role or specify system for the administrator value; in that case, the createsiteusers command works like the createusers command.

By default, this command creates users using a synchronous operation (it waits for all operations to complete before proceeding). You can use the --no-wait option to specify an asynchronous operation.

Local authentication

If the server is configured to use local authentication, the information in the CSV file is used to create users.

Active Directory authentication

If the server is configured to use Active Directory authentication, user information is imported from Active Directory to the server. In that case, any password and friendly name information in the CSV file is ignored. Further, if a user is specified in the CSV file but there is no corresponding user in Active Directory, the user is not added to Tableau Server. For Active Directory users, the user name is not guaranteed to be unique across domains, therefore you must include the domain as part of the user name (for example, example\Adam or adam@example.com.

While these can be sent either as domain/usernameor username@domain.com, we recommend using the domain/username format. See User Management in Active Directory Deployments for more information.

Example

tabcmd createsiteusers "users.csv" --role "Interactor"
Option (short) Option (long) Argument Description
  --admin-type Site or None (Deprecated. Use the --role option instead.) Assigns or removes the site administrator right for any user who does not already have an administrator setting in the CSV file. The default is None for new users and unchanged for existing users. If the server contains multiple sites; system administrators cannot be created or demoted using createsiteusers. (Use createusers instead.)
  --complete   Requires that all rows be valid for any change to succeed. This is the default setting.
  --license Interactor, Viewer, or Unlicensed (Deprecated. Use the --role option instead.) Specifies the license level for any user who does not already have a license level setting in the CSV file. The default is Unlicensed for new users and unchanged for existing users.

Note: License levels were used in earlier versions of Tableau. They were replaced by site roles starting in Tableau Server 9.0.

  --no-complete   Specifies that the command should make changes on the server even if not all rows contain valid information. Rows that contain invalid information are skipped.
  --no-publisher   (Deprecated. Use the --role option instead.) Disallows publishing rights for any users who do not already have a publisher setting in the CSV file. This is a default value for new users.
  --nowait   Do not wait for asynchronous jobs to complete.
  --publisher   (Deprecated. Use the --role option instead.) Assigns publishing rights for any user who does not already have a publisher setting in the CSV file. The default is no publishing rights (equivalent to --no-publish) for new users and unchanged for existing users.
-r --role ServerAdministrator, SiteAdministrator, Publisher, Interactor, ViewerWithPublish, Viewer, UnlicensedWithPublish, or Unlicensed Specifies a site role for any user who does not already have a role specified in the CSV file. The default is Unlicensed for new users and unchanged for existing users.

If you have a user-based server installation, and if the command creates a new user but you have already reached the limit on the number of licenses for your users, the user is added as an unlicensed user.

Note: On Tableau Server on-premises, you cannot assign the ServerAdministrator role if the server has more than one site. In that case, use the createuser command.

Note: If you specify a role option, you cannot also include license, publisher, no-publisher, or administrator options.

  --silent-progress   Do not display progress messages for the command.

Top

createusers filename.csv

Create users in Tableau Server, based on information supplied in a comma-separated values (CSV) file.

The CSV file must contain one or more user names and can also include (for each user) a password, full name, role, administrator level, publisher (yes/no), and email address. For information about the format of the CSV file, see CSV Import File Guidelines. As an alternative to including role, administrator level, and publisher permissions in the CSV file, you can pass role information to the command using the --role option.

If the server has only one site (the default site), the user is created and added to the site. If the server has multiple sites, the user is created but is not added to any site. To add users to a site, use createsiteusers.

If you have a user-based server installation, and if the command creates a new user but you have already reached the limit on the number of licenses for your users, the user is added as an unlicensed user.

Local authentication

If the server is configured to use local authentication, the information in the CSV file is used to create users.

Active Directory authentication

If the server is configured to use Active Directory authentication, user information is imported from Active Directory to the server. In that case, any password and friendly name information in the CSV file is ignored. Further, if a user is specified in the CSV file but there is no corresponding user in Active Directory, the user is not added to Tableau Server. For Active Directory users, the user name is not guaranteed to be unique across domains, therefore you must include the domain as part of the user name (for example, example\Adam or adam@example.com.

While these can be sent either as domain/usernameor username@domain.com, we recommend using the domain/username format. See User Management in Active Directory Deployments for more information.

Example

tabcmd createusers "users.csv" --role "ServerAdministrator"
tabcmd createusers "users.csv"
Option (short) Option (long) Argument Description
  --admin-type Site or None (Deprecated. Use the --role option instead.) Assigns or removes the site administrator right for any user who does not already have an administrator setting in the CSV file. The default is None for new users and unchanged for existing users.
  --complete   Requires that all rows be valid for any change to succeed. This is the default setting.
  --license Interactor, Viewer, or Unlicensed (Deprecated. Use the --role option instead.) Specifies the license level for any user who does not already have a license level setting in the CSV file. The default is Unlicensed for new users and unchanged for existing users.

Note: License levels were used in earlier versions of Tableau Server, but have been replaced by site roles starting with Tableau Server 9.0.

  --no-complete   Specifies that the command should make changes on the server even if not all rows contain valid information. Rows that contain invalid information are skipped.
  --no-publisher   (Deprecated. Use the --role option instead.) Disallows publishing rights for any users who do not already have a publisher setting in the CSV file. This is a default value for new users.
  --nowait   Do not wait for asynchronous jobs to complete.
  --publisher   (Deprecated. Use the --role option instead.) Assigns publishing rights for any user who does not already have a publisher setting in the CSV file. The default is no publishing rights (equivalent to --no-publish) for new users and unchanged for existing users.
-r --role ServerAdministrator, SiteAdministrator, Publisher, Interactor, ViewerWithPublish, Viewer, UnlicensedWithPublish, or Unlicensed Specifies a role for any user who does not already have a role specified in the CSV file. The default is Unlicensed for new users and unchanged for existing users.

On a multi-site server, the command does not assign the user to a site. Therefore, the only roles that the command will assign are ServerAdministrator and Unlicensed. In that case, if you specify a different role (like Publisher or Viewer), the command assigns the Unlicensed role.

On a single-site server, the user is created and added to the default site using the role that you specify.

If you have a user-based server installation, and if the command creates a new user but you have already reached the limit on the number of licenses for your users, the user is added as an unlicensed user.

Note: If you specify a role option, you cannot also include license, publisher, no-publisher, or administrator options.

  --silent-progress   Do not display progress messages for the command.

Top

delete workbook-name or datasource-name

Deletes the specified workbook or data source from the server.

This command takes the name of the workbook or data source as it is on the server, not the file name when it was published.

Example

tabcmd delete "Sales_Analysis"
Option (short) Option (long) Argument Description
-r --project Project name The name of the project containing the workbook or data source you want to delete. If not specified, the “Default” project is assumed.
  --workbook Workbook name The name of the workbook you want to delete.
  --datasource Data source name The name of the data source you want to delete.

Top

deletegroup group-name

Deletes the specified group from the server.

Example

tabcmd deletegroup "Development"

deleteproject project-name

Deletes the specified project from the server.

Example

tabcmd deleteproject "Designs"

deletesite site-name

Deletes the specified site from the server.

Example

tabcmd deletesite "Development"

Top

deletesiteusers filename.csv

Removes users from from the site that you are logged in to. The users to be removed are specified in a file that contains a simple list of one user name per line. (No additional information is required beyond the user name.)

By default, if the server has only one site, or if the user belongs to only one site, the user is also removed from the server. On a Tableau Server Enterprise installation, if the server contains multiple sites, users who are assigned the role of Server Administrator are removed from the site but are not removed from the server.

If the user owns content, the user's role is change to Unlicensed, but the user is not removed from the server or the site. The content is still owned by that user. To remove the user completely, you must change the owner of the content and then try removing the user again.

If the user was imported from Active Directory, the user is removed from the site and possibly from the server. However, the user is not deleted from Active Directory.

Example

tabcmd deletesiteusers "users.csv"

Top

deleteusers filename.csv

Deletes the users listed in the specified comma-separated values (CSV) file.

The CSV file should contain a simple list of one user name per line.

Example

tabcmd deleteusers "users.csv"
Option (short)Option (long)ArgumentDescription
 --[no-]complete When set to --complete this option requires that all rows be valid for any change to succeed. If not specified, --complete is used.

editdomain

Changes the nickname or full domain name of an Active Directory domain on the server. A domain “nickname” is the Windows NetBIOS domain name.

You can modify the nickname for any domain the server is using. In general, you can modify the full domain name for any domain except the one that you used to sign in. However, if the user name that you are currently signed in with exists in both the current domain and the new domain, you can modify the full name for the current domain.

Review User Management in Active Directory Deployments to understand how multiple domains, domain name mapping, and user names interact with Tableau Server.

To see a list of domains, use listdomains.

Examples

tabcmd editdomain --id 2 --nickname "new-nickname"
tabcmd editdomain --id 3 --name "new-name"

Option (long) Argument Description
--id Domain ID The ID of domain to change. To get a list of domain IDs, use use listdomains.
--name Domain name The new name for the domain.
--nickname Domain nickname The new nickname for the domain.

Top

editsite site-name

Changes the name of a site or its web folder name. You can also use this command to allow or deny site administrators the ability to add and remove users. If site administrators have user management rights, you can specify how many users they can add to a site.

Examples

tabcmd editsite wc_sales --site-name "West Coast Sales"

tabcmd editsite wc_sales --site-id "wsales"

tabcmd editsite wsales --status ACTIVE

tabcmd editsite wsales --user-quota 50

Option (long) Argument Description
--site-name Name to change the site to The name of the site that's dislayed.
--site-id The site ID to change the site to Used in the URL to uniquely identify the site.
--user-quota Number of users Maximum number of users who can be members of the site.
--[no-]site-mode   Allow or prevent site administrators from adding users to the site.
--status ACTIVE or SUSPENDED Activate or suspend a site.
--storage-quota Number of MB In MB, the amount of workbooks, extracts, and data sources that can be stored on the site.

Top

export

Exports a view or workbook from Tableau Server and saves it to a file. This command can also export just the data used for a view.

Note the following when you use this command:

  • Permissions: To export, you must have the Export Image permission. By default, this permission is Allowed or Inherited for all roles, although permissions can be set per workbook or view.

  • Exporting data: To export just the data for a view, use the --csv option. This exports the summary data used in a view to a .csv file.

  • Specifying the view, workbook, or data to export: You specify this using the "workbook/view" string as it appears in the URL for the workbook or view, not using its “friendly name,” and excluding the :iid=<n> session ID at the end of the URL. For example, to export the Tableau sample view Investment Growth from the Finance workbook, you would use the string Finance/InvestmentGrowth, not Finance/Investment Growth, or Finance/InvestmentGrowth?:iid=1. Use -t <site_id> if the server is running multiple sites and the view or workbook is on a site other than Default.

    To export a workbook, you still include a valid view in the string you use. Using the above example, to export the Finance workbook, you would use the string Finance/InvestmentGrowth. Finally, to export a workbook, it must have been published with Show Sheets as Tabs selected in the Tableau Desktop Publish dialog box.

  • The saved file's format: Your format options depend on what's being exported. A workbook can only be exported as a PDF using the --fullpdf argument. A view can be exported as a PDF (--pdf) or a PNG (--png).

  • The saved file's name and location (optional): If you don't provide a name, it will be derived from the view or workbook name. If you don't provide a location, the file will be saved to your current working directory. Otherwise, you can specify a full path or one that's relative to your current working directory.

    Note: You must include a file name extension such as .csv or .pdf. The command does not automatically add an extension to the file name that you provide.

  • Dashboard web page objects not included in PDF exports: A dashboard can optionally include a web page object. If you are performing an export to PDF of a dashboard that includes a web page object, the web page object won't be included in the PDF.

  • Non-ASCII characters and PDF exports: If you are exporting a view or workbook with a name that includes a character outside the ASCII character set, you need to URL encode (or percent-encode) the character.

    For example if your command includes the city Zürich, you need to URL encode it as Z%C3%BCrich:

    tabcmd export "/Cities/Sheet1?locationCity=Z%C3%BCrich" -fullpdf

Clearing the Cache to Use Real-Time Data

You can optionally add the URL parameter ?:refresh=yes to force a fresh data query instead of pulling the results from the cache. If you are using tabcmd with your own scripting and the refresh URL parameter is being used a great deal, this can have a negative impact on performance. It's recommended that you use refresh only when real-time data is required—for example, on a single dashboard instead of on an entire workbook.

Examples

Views

tabcmd export "Q1Sales/Sales_Report" --csv -f "Weekly-Report.csv"

tabcmd export -t Sales "Sales/Sales_Analysis" --pdf -f "C:\Tableau_Workbooks\Weekly-Reports.pdf"

tabcmd export "Finance/InvestmentGrowth" --png

tabcmd export "Finance/InvestmentGrowth?:refresh=yes" --png

Workbooks

tabcmd export "Q1Sales/Sales_Report" --fullpdf

tabcmd export "Sales/Sales_Analysis" --fullpdf --pagesize tabloid -f "C:\Tableau_Workbooks\Weekly-Reports.pdf"

Option (short) Option (long) Argument Description
-f --filename The name and extension to use for the saved file Saves the file with the given filename.
  --csv   View only. Export the view's data (summary data) in CSV format.
  --pdf   View only. Export as a PDF.
  --png   View only. Export as an image in PNG format.
  --fullpdf   Workbook only. Export as a PDF. The workbook must have been published with Show Sheets as Tabs enabled.
  --pagelayout landscape, portrait Sets the page orientation of the exported PDF. If not specified, its Tableau Desktop setting will be used.
  --pagesize unspecified, letter, legal, note folio, tabloid, ledger, statement, executive, a3, a4, a5, b4, b5, quarto Sets the page size of the exported PDF. Default is letter.
  --width Number of pixels Sets the width. Default is 800 px.
  --height Number of pixels Sets the height.Default is 600 px.

Top

get url

Gets the resource from Tableau Server that's represented by the specified (partial) URL. The result is returned as a file.

Note the following when you use this command:

  • Permissions: To get a file, you must have the Download/Web Save As permission. By default, this permission is allowed or inherited for all roles, although permissions can be set per workbook or view.

  • File extension: The URL must include a file extension, for example, "/views/Finance/InvestmentGrowth.csv". The extension (.csv) determines what's returned. A view can be returned in PDF, PNG, CSV (summary data only), or XML (information only) format. A Tableau workbook is returned as a TWB if it connects to a published data source or uses a live connection, or a TWBX if it connects to a data extract.

    To figure out the correct extension, you can use a web browser to navigate to the item on Tableau Server and add the file extension to the end of the URL.

    When you type the URL for the GET request, exclude the session ID (:iid=<n>) that appears at the end of the file name. For example, use "/views/Finance/InvestmentGrowth.pdf" instead of "/views/Finance/InvestmentGrowth?:iid=3.pdf".

    Note: If you are downloading a view to a PDF or PNG file, and if you include a --filename parameter that includes the .pdf or .png extension, you do not have to include a .pdf or .png extension in the URL.

  • The saved file's name and location (optional): The name you use for --filename should include the file extension. If you don't provide a name and file extension, both will be derived from the URL string. If you don't provide a location, the file is saved to your current working directory. Otherwise, you can specify a full path or one that's relative to your current working directory.

  • PNG size (optional): If the saved file is a PNG, you can specify the size, in pixels, in the URL.

Clearing the cache to use real-time data

You can optionally add the URL parameter ?:refresh=yes to force a fresh data query instead of pulling the results from the cache. If you are using tabcmd with your own scripting, using the refresh parameter a great deal can have a negative impact on performance. It's recommended that you use refresh only when real-time data is required—for example, on a single dashboard instead of on an entire workbook.

Examples

Views

tabcmd get "/views/Sales_Analysis/Sales_Report.png" --filename "Weekly-Report.png"

tabcmd get "/views/Finance/InvestmentGrowth.pdf" -f "Q1Growth.pdf"

tabcmd get "/views/Finance/InvestmentGrowth" -f "Q1Growth.pdf"

tabcmd get "/views/Finance/InvestmentGrowth.csv" 

tabcmd get "/views/Finance/InvestmentGrowth.png?:size=640,480" -f growth.png

tabcmd get "/views/Finance/InvestmentGrowth.png?:refresh=yes" -f growth.png

Workbooks

tabcmd get "/workbooks/Sales_Analysis.twb" -f "C:\Tableau_Workbooks\Weekly-Reports.twb" 
tabcmd get "/workbooks/Sales.xml"

Top

initialuser

Create the initial administrative user on a server that does not have an initial administrative user defined.

Note: The tabcmd initialuser command does not require authentication to Tableau Server, but you must run the command on the primary server node.

Examples

tabcmd initialuser --username "admin" --password "P@ssword!"
tabcmd initialuser --username "admin" --password "P@ssword!" --friendly "Tableau Admin"
Option (short) Option (long) Argument Description
-f --friendly Display name for the user Creates the initial administrative user with the display name.

Top

listdomains

Displays a list of the Active Domain domains that are in use on the server, along with their nicknames and IDs. If the server is configured to use local authentication, the command returns only the domain name local.

Example

tabcmd listdomains

listsites

Returns a list of sites to which the logged in user belongs.

Example

tabcmd listsites --username adam --password mypassword

Top

login

Logs in a Tableau Server user.

Use the --server, --site, --username, --password global options to create a session.

Note: When you use the tabcmd login command, you cannot use SAML single sign-on (SSO), even if the server is configured to use SAML. To log in, you must pass the user name and password of a user who has been created on the server. You will have the permissions of the Tableau Server user that you're signed in as. For more information, see Set Users’ Site Roles and Content Access and Ownership.

If you want to log in using the same information you've already used to create a session, just specify the --password option. The server and user name stored in the cookie will be used.

If the server is using a port other than 80 (the default), you will need to specify the port.

You need the --site (-t) option only if the server is running multiple sites and you are logging in to a site other than the Default site. If you do not provide a password you will be prompted for one. If the --no-prompt option is specified and no password is provided the command will fail.

Once you log in, the session will continue until it expires on the server or the logout command is run.

Example

Logs you in to the Tableau Server running on your local machine:

tabcmd login -s http://localhost -u jsmith -p p@ssw0rd!

Logs you in to the Sales site on sales-server:

tabcmd login -s http://sales-server -t Sales -u administrator -p p@ssw0rd!
tabcmd login -s http://sales-server:8000 -t Sales -u administrator -p p@ssw0rd!

Logs you in to the Sales site on sales-server using SSL but does not validate the server's SSL certificate:

tabcmd login --no-certcheck -s https://sales-server -t Sales -u administrator -p p@ssw0rd!

Establishes a forward proxy and port for localhost:

tabcmd login --proxy myfwdproxyserver:8888 -s http://localhost -u jsmith -p p@ssW0rd!

Logs you in to the reverse proxy using SSL:

tabcmd login -s https://myreverseproxy -u jsmith -p p@ssW0rd!

Option (short) Option (long) Argument Description
-s --server server URL

If you are running the command from an on-premises Tableau Server computer, you can use http://localhost. Otherwise, specify the computer's URL, such as http://bigbox.myco.com or http://bigbox.

For Tableau Online specify the URLhttps://online.tableau.com.

-t --site site ID

Include this option if the server has multiple sites, and you are logging in to a site other than the Default site.

The site ID is used in the URL to uniquely identify the site. For example, a site named West Coast Sales might have a site ID of west-coast-sales.

-u --username user name The user name of the user logging in. For Tableau Online, the user name is the user's email address.
-p --password password Password for the user specified for --username. If you do not provide a password you will be prompted for one.
  --password-file filename.txt Allows the password to be stored in the given file rather than the command line, for increased security.
-x --proxy Host:Port Use to specify the HTTP proxy server and port for the tabcmd request.
  --no-prompt   Do not prompt for a password. If no password is specified, the login command will fail.
  --no-proxy   Do not use an HTTP proxy server.
  --cookie   Saves the session ID on login. Subsequent commands will not require a login. This value is the default for the command.
  --no-cookie   Do not save the session ID information after a successful login. Subsequent commands will require a login.
  --timeout SECONDS Number of seconds The number of seconds the server should wait before processing the login command. Default: 30 seconds.

Top

logout

Logs out of the server.

Example

tabcmd logout

publish filename.twb(x), filename.tds(x), or filename.tde

Publishes the specified workbook (.twb(x)), data source (.tds(x)), or data extract (.tde) to Tableau Server.

If you are publishing a workbook, by default, all sheets in the workbook are published without database user names or passwords.

The permissions initially assigned to the workbook or data source are copied from the project that the file is published to. Permissions for the published resource can be changed after the file has been published. 

If the workbook contains user filters, one of the thumbnail options must be specified.

Example

tabcmd publish "analysis.twbx" -n "Sales_Analysis"
--db-username "jsmith" --db-password "p@ssw0rd"
tabcmd publish "analysis_sfdc.tde" -n "Sales Analysis" 
--oauth-username "username" --save-oauth

If the file is not in the same directory as tabcmd, include the full path to the file.

Example

tabcmd publish "C:\Tableau Workbooks\analysis.twbx" -n "Sales_Analysis" --db-username "jsmith" --db-password "p@ssw0rd"
tabcmd publish "C:\Tableau Workbooks\analysis_sfdc.tde" -n "Sales Analysis" --oauth-username "username" --save-oauth
Option (short) Option (long) Argument Description
-n --name Name of the workbook or data source on the server If omitted, the workbook, data source, or data extract will be named after filename.
-o --overwrite   Overwrites the workbook, data source, or data extract if it already exists on the server.
-r --project Name of a project Publishes the workbook, data source, or data extract into the specified project. Publishes to the “Default” project if not specified.
  --db-username  

Use this option to publish a database user name with the workbook, data source, or data extract.

  --db-password   Use this option to publish a database password with the workbook, data source, or data extract.
  --save-db-password   Stores the provided database password on the server.
  --oauth-username Email address of the user account Connects the user through a preconfigured OAuth connection, if the user already has a saved access token for the cloud data source specified in --name. Access tokens are managed in user preferences.

For existing OAuth connections to the data source, use this option instead of --db-username and --db-password.

  –-save-oauth   Saves the credential specified by --oauth-username as an embedded credential with the published workbook or data source.

Subsequently, when the publisher or server administrator signs in to the server and edits the connection for that workbook or data source, the connection settings will show this OAuth credential as embedded in the content.

If you want to schedule extract refreshes after publishing, you must include this option with --oauth-username. This is analogous to using --save-db-password with a traditional database connection.

  --thumbnail-username   If the workbook contains user filters, the thumbnails will be generated based on what the specified user can see. Cannot be specified when --thumbnail-group option is set.
  --thumbnail-group   If the workbook contains user filters the thumbnails will be generated based on what the specified group can see. Cannot be specified when --thumbnail-username option is set.
  --tabbed   When a workbook with tabbed views is published, each sheet becomes a tab that viewers can use to navigate through the workbook. Note that this setting will override any sheet-level security.
  --append   Append the extract file to the existing data source.
  --replace   Use the extract file to replace the existing data source.
  --disable-uploader   Disable the incremental file uploader.
  --restart   Restart the file upload.

Top

refreshextracts workbook-name or datasource-name

Performs a full or incremental refresh of extracts belonging to the specified workbook or data source.

This command takes the name of the workbook or data source as it appears on the server, not the file name when it was published. Only an administrator or the owner of the workbook or data source is allowed to perform this operation.

Examples

tabcmd refreshextracts --datasource sales_ds
tabcmd refreshextracts --workbook "My Workbook"
tabcmd refreshextracts --url SalesAnalysis
Option (short) Option (long) Argument Description
  --incremental   Runs the incremental refresh operation.
  --synchronous   Adds the full refresh operation to the queue used by the Backgrounder process, to be run as soon as a Backgrounder process is available. If a Backgrounder process is available, the operation is run immediately. The refresh operation appears on the Background Tasks report.

During a synchronous refresh, tabcmd maintains a live connection to the server while the refresh operation is underway, polling every second until the background job is done.

  --workbook Name of a workbook The name of the workbook containing extracts to refresh. If the workbook has spaces in its name, enclose it in quotes.
  --datasource Name of a data source The name of the data source containing extracts to refresh.
  --project Name of a project Use with --workbook or --datasource to identify a workbook or data source in a project other than Default. If not specified, the Default project is assumed.
  --url URL name of a workbook The name of the workbook as it appears in the URL. A workbook published as “Sales Analysis” has a URL name of “SalesAnalysis”.

Top

removeusers group-name

Removes users from the specified group.

Example

tabcmd removeusers "Development" --users "users.csv"
Option (short) Option (long) Argument Description
  --users filename.csv Remove the users in the given file from the specified group. The file should be a simple list with one user name per line.
  --[no-]complete   Requires that all rows be valid for any change to succeed. If not specified --complete is used.

runschedule schedule-name

Runs the specified schedule.

This command takes the name of the schedule as it is on the server.

For Tableau Online, the command can be run within the scope of a single site, using site administrator permissions.

Example

tabcmd runschedule "5AM Sales Refresh"

Top

set setting

Enables the specified setting on the server. Details about each setting can be seen on the Maintenance page on the server.

Use an exclamation mark in front of the setting name to disable the setting. You can enable or disable the following settings:

  • allow_scheduling

  • embedded_credentials

  • remember_passwords_forever

Example

tabcmd set embedded_credentials

syncgroup group-name

Synchronizes a Tableau Server group with an Active Directory group. If the Tableau Server group does not already exist, it is created and synchronized with the specified Active Directory group.

If the group name itself includes an "@" (other than as the domain separator) you need to refer to the symbol using the hex format "\0x40".

Example

tabcmd syncgroup "Development"
tabcmd syncgroup "Dev\0x40Fremont"

Note: If you synchronize a group that you are a member of, changes that you make using this command do not apply to your user. For example, if you use this command to remove the administrator right from users in a group that you are a member of, you are still an administrator when the command finishes.

Option (short) Option (long) Argument Description
  --administrator System, Site, or None

(Deprecated. Some operations may no longer work. Use the --role option instead.)

Assigns or removes the administrator right for users in the group. The None option removes the administrator right from all users in the group (except you, if you are a member of the group that you are synchronizing). If you do not include this option, users who are added to the group after you run the command are not assigned the administrator right.

  --license Interactor, Viewer, or Unlicensed

(Deprecated. Some operations may no longer work. Use the --role option instead.)

Specifies the license level for users in the group.

Note: License levels were used in earlier versions of Tableau Server, but have been replaced by site roles starting in Tableau Server 9.0.

  --no-publisher  

(Deprecated. Some operations may no longer work. Use the --role option instead.)

Disallows publishing rights for users in the group.

  --overwritesiterole   Allows a user’s site role to be overwritten with a less privileged one when using ‑‑role. By default, a user site role can be promoted when using ‑‑role, but cannot be demoted. Because the ‑‑overwritesiterole option will demote user site roles, use it with caution.
  --publisher  

(Deprecated. Some operations may no longer work. Use the --role option instead.)

Assigns publishing rights to users in the group.

-r --role ServerAdministrator, SiteAdministrator, Publisher, Interactor, ViewerWithPublish, Viewer, UnlicensedWithPublish, or Unlicensed Specifies a role for users in the group. The default is Unlicensed.

Note: If you specify a role option, you cannot also include license, publisher, no-publisher, or administrator options.

  --silent-progress   Do not display progress messages for the command.

version

Displays the version information for the current installation of the tabcmd utility.

Example

tabcmd version

Top