Skip to main content

Tabadmin commands with a corresponding TSM CLI command

The following table shows which tabadmin commands correspond to commands available in the TSM CLI.

Command DescriptionTabadmin Command(s)Comparable TSM CLI Command
Activate a licensetabadmin activate --activatetsm licenses activate
Deactivate licensestabadmin activate --returntsm licenses deactivate
Activate a trial licensetabadmin activate --trialtsm licenses activate --trial
Create a backup of the data managed by Tableau Server
tabadmin backup
tsm maintenance backup
A backup created using TSM does not include any server configuration data. There is no option to include server configuration data.
Clear the server cachetabadmin clearcachetsm maintenance cleanup -r
Clean up temporary files and old log filestabadmin cleanuptsm maintenance cleanup
Update the server configuration with any changes you've madetabadmin configuretsm pending-changes apply
Customize the server name and logostabadmin customizetsm customize
Enable access to the repositorytabadmin dbpasstsm data-access repository-access enable
Disable access to the repositorytabadmin dbpass --disabletsm data-access repository-access disable
Set a file store instance to read-only modetabadmin decommissiontsm topology filestore decommission
Delete one or more Web Data Connectors (WDCs) from Tableau Server
tabadmin delete_webdataconnector
tsm data-access web-data-connectors delete
Add a Web Data Connector (WDC) to Tableau Server
tabadmin import_webdataconnectortsm data-access web-data-connectors add
andNote: TSM does not support importing WDCs, instead it lets you add WDCs to a safe list (or "whitelist"). To learn more, see Web Data Connectors in Tableau Server.
tabadmin whitelist_webdataconnector
List Web Data Connectors (WDCs) used by Tableau Server
tabadmin list_webdataconnectors
tsm data-access web-data-connectors list
To learn more, see Web Data Connectors in Tableau Server.
Export a site from Tableau Servertabadmin exportsitetsm sites export
Initiate a repository failovertabadmin failoverrepositorytsm topology failover-repository
Get a configuration optiontabadmin gettsm configuration get
Get the OpenID redirect URLtabadmin get_openid_redirect_urltsm authentication openid get-redirect-url
Import site .csv files into Tableau Servertabadmin importsitetsm sites import
Import a site into Tableau Server using .csv filestabadmin importsite_verifiedtsm sites import-verified
Display license information for Tableau Server
tabadmin licenses
tsm licenses list
Note: For more information about the output of this command, see View Server Licenses.
Move a file store from read-only mode to an active read/write statetabadmin recommissiontsm topology filestore recommission
Regenerate internal security tokenstabadmin regenerate_internal_tokenstsm security regenerate-internal-tokens
Register Tableau Servertabadmin registertsm register
Rebuild the search index for Tableau Servertabadmin reindextsm maintenance reindex-search
Reset the Tableau Server administrator accounttabadmin resettsm reset
Stop and restart all Tableau Server processestabadmin restarttsm restart
Restore from a Tableau Server backup file
tabadmin restore
tsm maintenance restore
The restore command does not restore any server configuration data. This is true whether you are using a backup created with TSM or a backup created with tabadmin.
Set a configuration optiontabadmin settsm configuration set
Activate or suspend a sitetabadmin sitestatetsm sites unlock
Start all Tableau Server processestabadmin starttsm start
Get the status of Tableau Server and server processestabadmin statustsm status
Stop all Tableau Server processestabadmin stoptsm stop
Create an archive (.zip) file with Tableau Server log filestabadmin ziplogstsm maintenance ziplogs
Tabadmin commands with no corresponding TSM CLI command
The following table lists the tabadmin commands for which a comparable TSM CLI command is not available.
Command DescriptionTabadmin CommandNotes
Add or remove a user from the system administrator grouptabadmin administratorYou can use the Tableau Server REST API Add User to Group and Remove User from Group methods to add or remove a user from the system administrator group.
Create a new key to encrypt sensitive information stored in the repositorytabadmin assetkeysUse the tsm security regenerate-internal-tokens command to create or regenerate secrets and master keys.
Specify whether Tableau Server starts at system start-up timetabadmin autostartTableau Server returns to the state it was in prior to a system restart. If it was running, it will restart. If it was stopped it will be stopped after the system starts.
Identify a second server node for backuptabadmin failoverprimaryTSM does not have primary nodes, so a TSM equivalent to this command is not needed.
Manage credentials for delegated data access on Tableau Servertabadmin manage_global_credentialsWe recommend that you use Kerberos delegation to Apache Impala for global credential management. To learn more, see Kerberos and Enable Kerberos Delegation for Hive/Impala in the Tableau Community.
Reset the password for a Tableau Server accounttabadmin passwdIf your server uses local authentication, you can use the Tableau Server REST API Update User method to reset the password for a user account.
Reset binding between Tableau Server user ID and Open ID Connect identity providertabadmin reset_openid_sub
Determine whether your environment meets the minimum requirements to run Tableau Servertabadmin validate
Verify that a backup of the Tableau Server repository will restore successfullytabadmin verify_databaseThe tsm maintenance backup command automatically verifies that a backup will restore correctly unless you use the --skip-verification parameter.
Prepare VizQL processes for fast load times after a Tableau Server restarttabadmin warmupThe tabadmin warmup command is no longer necessary, as Tableau Server is now optimized to automatically provide fast load times after a server restart.


Labels:

Comments

Post a Comment

Popular Posts

Add Space between bars in Tableau chart

Add Space between bars in Tableau chart Scenario: Tableau defaults to no spacing between the panes in a view. How do I get some spacing between groups of bars in my charts? It can be achieved through the steps below: Add subtotals (Analysis->Totals->Add All Subtotals) Right click on the measure pill on the Rows shelf and change the default SUM() aggregations to MIN() To edit the color legend – double click on the Total color, this takes you to a color dialog, select the WHITE color, click OK Right click on the word Total in the X axis and select Format In the Format window, click the Header tab and blank out the Total label field The added space looks like below:
1 comment
Read more

Adding “Apply” Button to A Filter Menu In Tableau

Adding An “Apply” Changes Button To A Filter Menu In Tableau Sometimes when a user is changing the options they want on a filter in Tableau, the chart updates as they change each option. This might not be the best user experience if they are changing many options and don’t want the dashboard to redraw the view until they have completed their selection. It is very simple to fix this – Tableau includes an “apply” changes option, which when enabled, means the dashboard won’t redraw to reflect the new filter choices until the user presses the “apply” button. Simply click the drop down arrow on the filter menu > go to “customize”, then click “show apply button”.  
1 comment
Read more

Error "Cannot mix aggregate and non-aggregate arguments with this function"

Error "Cannot mix aggregate and non-aggregate arguments with this function" When Creating a Calculated Field When creating a calculation, the following error might occur:  "Cannot mix aggregate and non-aggregate arguments with this function." The issue can be resolved through one of the below options: Modify the calculation so that all fields are either aggregate or non-aggregate. Each option can result in different values (please reference the additional information section for specific examples). Option 1 (Aggregate Then Divide) Wrap all fields in an aggregation. Sample: [Profit] / SUM ([Sales]) -> SUM ([Profit]) / SUM ([Sales]) Option 2 ( Divide Then Aggregate) Remove aggregations from all of the fields. Sample: [Profit] / SUM ([Sales]) ->[Profit] / [Sales]   Option 3 ( Condition Then Aggregate) Move the aggregation so all fields are aggregated. For example, the calculation: IF [Row ID] = 1 THEN SUM( [Sales] ) END  could...
Post a Comment
Read more

Tableau Bar Chart Rounded corners

Tableau Bar Chart Rounded corners Follow the steps in the video below to create rounded corners for the bar chart:
Post a Comment
Read more

Removing "Abc" Placeholder Text in Tableau Measures column

Removing "Abc" Placeholder Text in Tableau Measures column Quick and easy fix for this issue could be: Use Polygon mark type On the Marks card in the dropdown menu, select Polygon Resize the last column to make it smaller Navigate to Format > Borders In the left-hand Format Border Pane, for Column Divider, For Pane, select None from the dropdown menu Navigate to Format > Shading In the left-hand Format Border Shading, for Row Banding, move the slider to the desired level of row banding
2 comments
Read more

Using Special Characters in Tableau URL Parameters

Using Special Characters in Tableau URL Parameters When we try to use special characters in URL parameters, the URL parameter might not do anything, or an error might occur. The issue can be resolve by:  Use one of the following workarounds: Replace the special character with the URL encoding sequence for backslash (\) (%5c) followed by the URL encoding sequence for the special character. The backslash is needed to escape the special character. For example, the URL encoding sequence for backslash and comma (\,) is %5c%2c.  In the data source, separate comma-delimited field values into separate columns that can be filtered independently. In Tableau Desktop, use a calculated field to replace the special characters, such as commas or spaces, with hyphens (-). Cause The browser cannot parse the special characters used in the URL. Additional Information The error varies depending on the browser and special character being used. Networ...
1 comment
Read more

Cannot mix aggregate and non-aggregate arguments with this function

Cannot mix aggregate and non-aggregate arguments with this function Issue When creating a calculation, one of the following errors might occur:    "Cannot mix aggregate and non-aggregate arguments with this function." (Option 1,2,3 or 4 can be used). " All fields must be aggregate or constant when using table calculation functions or fields from multiple data sources." (Option 1 or 3 can be used). "Argument to sum (an aggregate function) is already an aggregation, and cannot be further aggregated ."  (Option 2, 3 or 4 can be used). Environment Tableau Desktop Resolution Each option can result in different values (please reference the attached workbook in the right-hand pane and additional information section for specific examples). Option 1 (Aggregate All Fields) Wrap all fields in an aggregation. Sample: [Profit] / SUM ([Sales]) -> SUM ([Profit]) / SUM ([Sales])   Option 2 ( De-aggregate All Fields) Remove aggregations from all of ...
Post a Comment
Read more

Set a Date Filter Default to Max Date in Tableau

Set a Date Filter Default to Max Date in Tableau Some of us might have not noticed the setting a   filter to default to the Max date. There is a quick and simple option to achieve this in Tableau filters. Follow the steps below: 1. Create a date filter with the date dimension. 3. Drag the date dimension to filters pane. 4. Edit the date filter to Select from the list and select the max date available. 2.    Now, y ou have the option  'Filter to latest date value when workbook is opened', check this box and click on OK.
1 comment
Read more

Tableau Extract Update Error "Timeout Error: IPC_NamedPipe::Select(WaitForMultipleObjects)

Tableau Extract Update Error "Timeout Error: IPC_NamedPipe::Select(WaitForMultipleObjects) When trying to update the Data Source or w hen attempting to connect to a data source, or create and/or refresh extracts with Tableau Desktop, the following error message occurs:  IPC_NamedPipe::Select(WaitForMultipleObjects): Timeout. Cause Anti-virus software is blocking Tableau processes from running, or the Logs folder contained corrupted information.  Resolution Option 1: If it is easy w ork with IT helpdesk/support to add below Tableau folders and processes to exclusions : Tableau.exe hyperd.exe hyperdstarter.exe *.hyper extension (if AntiVirus has an option for extension exclusions) C:\Users\<username>\Documents\My Tableau Repository C:\Users\<username>\AppData\Local\Temp\TableauTemp C:\Users\<username>\AppData\Local\Tableau C:\Program Files\Tableau Make sure that child folders are included in the exclusions. AntiVirus prog...
Post a Comment
Read more