Tableau Server

https://help.tableau.com/current/server/en-us/
Admin
Tableau Server is an enterprise analytics platform that enables organizations to deploy, manage, and...
Tokens:429,060
Snippets:7,148
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Content Migration Tool via Command Line

Source: https://help.tableau.com/current/server/en-us/cmt-install.htm

Example command to install the tool silently without restarting the system.

```bash
Tabcmt-64bit-2022-3-0.exe /quiet /norestart
```

--------------------------------

### Windows Silent Installation Example

Source: https://help.tableau.com/current/server/en-us/rmt-admin-agent-install-cli.htm

Example command for performing a silent installation on Windows while specifying a custom installation directory.

```bash
<Setup file> /silent InstallFolder="D:\Tableau\Tableau Resource Monitoring Tool\agent"
```

--------------------------------

### Initialize and Start Tableau Server

Source: https://help.tableau.com/current/server/en-us/server_external_repo_new_install.htm

Finalize the installation by initializing the server with the specified timeout.

```bash
tsm initialize --start-server --request-timeout 1800
```

--------------------------------

### Run Tableau Server Installer

Source: https://help.tableau.com/current/server/en-us/server_external_filestore_storage_new_install.htm

Command to execute the Tableau Server setup program silently with EULA acceptance.

```bash
tableau-setup-tsm-<branch>.<build>-x64.exe/SILENT/ACCEPTEULA
```

--------------------------------

### Install Initial Tableau Server Node

Source: https://help.tableau.com/current/server/en-us/automated_install_windows.htm

Execute the installation script using required configuration, secrets, and registration files.

```bash
SilentInstaller.py install --secretsFile secrets.json --configFile myconfig.json --registrationFile registration.json TableauServer-64bit-<version>.exe
```

```bash
SilentInstaller.py --bootstrapFile <bootstrap file path>
```

--------------------------------

### Download views using tabcmd get

Source: https://help.tableau.com/current/server/en-us/tabcmd_cmd.htm

Examples of downloading views in various formats like PNG, PDF, and CSV, including options for custom filenames, image sizing, and cache refreshing.

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

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

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

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

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

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

--------------------------------

### Example import job directory path

Source: https://help.tableau.com/current/server/en-us/cli_sites_tsm.htm

Example of the directory structure required for the --import-job-dir option.

```text
C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\siteimports\working\import_ff00_20180102022014457
```

--------------------------------

### Example krb5.conf file

Source: https://help.tableau.com/current/server/en-us/kerberos_delegation_jdbc.htm

A sample configuration file for MIT Kerberos settings.

```ini
[libdefaults]
forwardable = true
default_realm = EXAMPLE.COM
default_tkt_enctypes = rc4-hmac
default_tgs_enctypes = rc4-hmac

[realms]
EXAMPLE.COM = {
kdc = kdc.example.com
admin_server = kdc.example.com
}

[domain_realm]
.example.com = EXAMPLE.COM
example.com = EXAMPLE.COM
```

--------------------------------

### Install Tableau Server via Command Line

Source: https://help.tableau.com/current/server/en-us/setup.htm

Run the installer with silent mode, EULA acceptance, and Server ATR activation enabled.

```bash
TableauServer-64bit-<version>.exe /silent ACCEPTEULA=1 ACTIVATIONSERVICE="1"
```

--------------------------------

### Perform a silent installation with legacy activation

Source: https://help.tableau.com/current/server/en-us/silent_installer_flags.htm

Example command to install Tableau Server in silent mode while explicitly opting out of the ATR licensing service.

```bash
TableauServer-64bit-<version>.exe /silent ACCEPTEULA=1 ACTIVATIONSERVICE="0"
```

--------------------------------

### Configure Windows Installer Options

Source: https://help.tableau.com/current/server/en-us/license_lblm.htm

Use these command-line arguments during the Tableau Windows installation to manage license checks and user registration.

```bash
tableau-setup-std-tableau-2024 SYNCHRONOUSLICENSECHECK="true" SILENTLYREGISTERUSER="true" ATRREQUESTEDDURATIONSECONDS=14400
```

```bash
tableauDesktop-64bit-2024-2-0.exe /quiet /norestart ACCEPTEULA=1 ATRREQUESTEDDURATIONSECONDS=14400 ACTIVATIONSERVER=http://<tableau_server_url>  SYNCHRONOUSLICENSECHECK="true" SILENTLYREGISTERUSER="true"
```

--------------------------------

### tsm login server address example

Source: https://help.tableau.com/current/server/en-us/cli_login.htm

Example of the required URL format for the --server option.

```bash
https://<tsm_hostname>:8850
```

--------------------------------

### Download workbooks using tabcmd get

Source: https://help.tableau.com/current/server/en-us/tabcmd_cmd.htm

Example of downloading a workbook to a specific local file path.

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

--------------------------------

### Locate Apache Configuration Directory

Source: https://help.tableau.com/current/server/en-us/ssl_cert_create.htm

Example path to the Apache configuration folder within a standard Tableau Server installation.

```text
C:\Program Files\Tableau\Tableau Server\packages\apache.<version_code>\conf
```

--------------------------------

### Start RMT Server

Source: https://help.tableau.com/current/server/en-us/rmt-external-messagequeue.htm

Command to start the RMT Server service.

```bash
rmtadmin start
```

--------------------------------

### Install Tableau Server on additional nodes

Source: https://help.tableau.com/current/server/en-us/distrib_ha_install_3node.htm

Command to run the Tableau Server installer on new nodes using the bootstrap file.

```bash
TableauServer-64bit-<version>.exe /silent ACCEPTEULA=1 EMBEDDEDCREDENTIAL=1 BOOTSTRAPFILE="path\bootstrapfile"
```

--------------------------------

### Install pamtester

Source: https://help.tableau.com/current/server/en-us/rmt-admin-authentication-PAM.htm

Commands to install the pamtester utility required for non-interactive PAM authentication.

```bash
sudo apt install pamtester
```

```bash
sudo yum install pamtester
```

--------------------------------

### Run SilentInstaller.py Help Commands

Source: https://help.tableau.com/current/server/en-us/automated_install_windows.htm

Use these commands to view available options and default values for the installation script.

```bash
SilentInstaller.py -h
```

```bash
SilentInstaller.py install –h
```

--------------------------------

### Create a site with tabcmd

Source: https://help.tableau.com/current/server/en-us/tabcmd_cmd.htm

Examples of creating a site with different configurations such as custom site IDs, storage quotas, and user management restrictions.

```bash
tabcmd createsite "West Coast Sales"
```

```bash
tabcmd createsite "West Coast Sales" -r "wsales"
```

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

```bash
tabcmd createsite "West Coast Sales" --storage-quota 100
```

--------------------------------

### Example Path with Version Code

Source: https://help.tableau.com/current/server/en-us/version_server_view.htm

Demonstrates the directory structure for scripts, which requires the long version code in the path.

```text
C:\Program Files\Tableau\Tableau Server\packages\scripts.<version_code>\
```

```text
C:\Program Files\Tableau\Tableau Server\packages\scripts.20182.18.1214.0751
```

--------------------------------

### Configuration File Directory Path

Source: https://help.tableau.com/current/server/en-us/logs_loc.htm

Example path for the backgrounder service configuration files.

```text
C:\ProgramData\Tableau\Tableau Server\data\tabsvc\config\backgrounder
```

--------------------------------

### Install tabcmd via command prompt

Source: https://help.tableau.com/current/server/en-us/tabcmd.htm

Use these commands to install tabcmd silently from an administrator command prompt. Ensure the installer file name matches your downloaded version.

```bash
tableau-setup-tabcmd-tableau-<version_code>-x64.exe /quiet ACCEPTEULA=1
```

```bash
tableau-setup-tabcmd-tableau-<version_code>-x64.exe /quiet ACCEPTEULA=1 INSTALLDIR="<path\to\install\directory>"
```

```bash
tableau-setup-tabcmd-tableau-<version_code>-x64.exe /quiet ACCEPTEULA=1 INSTALLDIR="C:\tabcmd"
```

--------------------------------

### Install RMT Server via Command Line

Source: https://help.tableau.com/current/server/en-us/rmt-admin-master-install-cli.htm

Executes the RMT Server installer in silent mode with the EULA accepted.

```bash
Tabrmt-Master-64bit-<version>.exe /silent ACCEPTEULA=1
```

--------------------------------

### Customize Installation Values

Source: https://help.tableau.com/current/server/en-us/server-helm-deploy.htm

Copy and edit the default values file for custom configuration.

```bash
cp ./helm/tableau-server/values.yaml   
./helm/tableau-server/my-values.yaml  
# Edit ./helm/tableau-server/my-values.yaml with your configuration
```

--------------------------------

### View Installation Directory Structure

Source: https://help.tableau.com/current/server/en-us/rmt-admin-upgrade-reference.htm

Reference for the standard file system layout on Linux and Windows platforms.

```text
/opt/tableau/tabrmt/                         # Install root
+-- master/                                  # Master application binaries
+-- agent/                                   # Agent application binaries
+-- prerequisites/                           # Bundled dependencies
/var/opt/tableau/tabrmt/                     # Data root
+-- master/config/                           # config.json, setup.json
+-- master/logs/                             # Application logs
+-- data/postgresql15/                       # PostgreSQL data files
+-- data/rabbitmq313/                        # RabbitMQ data/mnesia
+-- data/ssl/                               # TLS certificates
/etc/opt/tableau/tabrmt/
+-- master/environment.bash                  # Master environment variables
+-- agent/environment.bash                   # Agent environment variables
```

```text
C:\Program Files\Tableau\Tableau Resource Monitoring Tool\     # Install root
C:\ProgramData\Tableau\Tableau Resource Monitoring Tool\       # Data root
```

--------------------------------

### Navigate to RMT Server Installation Directory

Source: https://help.tableau.com/current/server/en-us/rmt-external-messagequeue.htm

Commands to navigate to the RMT Server installation directory on Windows and Linux.

```bash
cd 'c:\Program Files\Tableau\Tableau Resource Monitoring Tool\master\'
```

```bash
sudo  /var/opt/tableau/tabrmt/master
```

--------------------------------

### Install with Custom Values

Source: https://help.tableau.com/current/server/en-us/server-helm-deploy.htm

Deploy the Helm chart using a custom values file.

```bash
helm install tableau-server ./helm/tableau-server -f ./helm/tableau-server/my-values.yaml
```

--------------------------------

### Install Agent to Custom Location

Source: https://help.tableau.com/current/server/en-us/rmt-admin-agent-install-cli.htm

Specify a custom installation directory using the InstallFolder parameter during silent installation.

```bash
Tabrmt-Agent-64bit-<version>.exe/silent ACCEPTEULA=1 RUN_AS_USER_CUSTOM=1 RUN_AS_USERNAME=<username> RUN_AS_PASSWORD=<password> InstallFolder="D:\Tableau Resource Monitoring Tool\agent"
```

--------------------------------

### Example backgrounder log directories

Source: https://help.tableau.com/current/server/en-us/logs_loc.htm

Multiple instances of a service on a single node result in separate directories for each instance.

```text
backgrounder_0.<version>.<build>
backgrounder_1.<version>.<build>
```

--------------------------------

### Configure userClassNames for configKey

Source: https://help.tableau.com/current/server/en-us/ldap_config.htm

Example format for providing a comma-separated list of user class names when using configKey.

```text
"userclass1,userclass2"
```

--------------------------------

### DATEPARSE Year Formatting Examples

Source: https://help.tableau.com/current/server/en-us/dates_custom_date_formats.htm

Examples demonstrating how to use the 'y' pattern for year parsing in .hyper extracts.

```text
DATEPARSE('y','-10')
```

```text
DATEPARSE('y','-0')
```

--------------------------------

### Install RMT Server on Ubuntu

Source: https://help.tableau.com/current/server/en-us/rmt-admin-master-install-cli.htm

Use the apt package manager to install the RMT Server DEB package.

```bash
sudo apt install ./ <path/to/rmtserverinstaller>/Tabrmt-Master-amd64-<version>.deb
```

--------------------------------

### Set Activation Server via Installer or Registry

Source: https://help.tableau.com/current/server/en-us/license_lblm.htm

Configure the activation server URL for Tableau Desktop using installer flags or registry modifications.

```bash
tableauDesktop-64bit-2021-4-0.exe /quiet /norestart ACCEPTEULA=1  ACTIVATIONSERVER=http://<tableau_server_url>
```

```bash
reg.exe add HKEY_LOCAL_MACHINE\SOFTWARE\Tableau\Tableau 2024.2\Settings /f /v WorkGroupServer /d https://<tableau_server_url>
```

--------------------------------

### Run Agent Installer

Source: https://help.tableau.com/current/server/en-us/rmt-admin-agent-install-cli.htm

Execute the installer in silent mode. Ensure the Run As User account matches the Tableau Server account.

```bash
Tabrmt-Agent-64bit-<version>.exe /silent ACCEPTEULA=1 RUN_AS_USER_CUSTOM=1 RUN_AS_USERNAME=<username> RUN_AS_PASSWORD=<password>
```

--------------------------------

### Specify Nested Project Path

Source: https://help.tableau.com/current/server/en-us/tabcmd_cmd.htm

Example syntax for publishing to a nested project structure.

```bash
--parent-project-path "Main" -r "Nested"
```

--------------------------------

### Configure LBLM during Tableau Desktop/Prep Installation

Source: https://help.tableau.com/current/server/en-us/license_lblm.htm

Run the installer executable with specific switches to set duration or disable LBLM during deployment.

```bash
tableauDesktop-64bit-2024-2-0.exe /quiet /norestart ACCEPTEULA=1 ATRREQUESTEDDURATIONSECONDS=43200
```

```bash
tableauDesktop-64bit-2024-2-0.exe /quiet /norestart ACCEPTEULA=1 LBLM=disabled
```

```bash
tableauPrepBuilder-64bit-2024-2-0.exe /quiet /norestart ACCEPTEULA=1 LBLM=disabled
```

--------------------------------

### Install or Upgrade with Secrets

Source: https://help.tableau.com/current/server/en-us/server-helm-deploy.htm

Executes a Helm upgrade or install command using multiple values files.

```bash
helm upgrade --install tableau-server ./helm/tableau-server \
  -n default \
  -f ./helm/tableau-server/values-multinode.yaml \
  -f ./helm/tableau-server/secrets.yaml
```

--------------------------------

### Install tabcmd on Ubuntu

Source: https://help.tableau.com/current/server/en-us/tabcmd.htm

Use the apt-get package manager to install the tabcmd DEB package on Ubuntu systems.

```bash
sudo apt-get install ./tableau-tabcmd-<version>_all.deb
```

--------------------------------

### Configure groupClassNames for configKey

Source: https://help.tableau.com/current/server/en-us/ldap_config.htm

Example format for providing a comma-separated list of group class names when using configKey.

```text
"basegroup,othergroup"
```

--------------------------------

### Configure RMT Server for external repository

Source: https://help.tableau.com/current/server/en-us/rmt-external-repo.htm

Navigate to the installation directory and execute the master-setup command to point the RMT server to the external database.

```bash
cd 'c:\Program Files\Tableau\Tableau Resource Monitoring Tool\master\'
```

```bash
./rmtadmin master-setup --db-config=external --db-server=<aws_rds_servername> --db-database=<aws_rds_database_name> --db-port=5432 --db-admin-username=postgres --db-admin-password=<postgres_user_password>
```

--------------------------------

### Install Helm Chart

Source: https://help.tableau.com/current/server/en-us/server-helm-deploy.htm

Deploy the Tableau Server Helm chart using the specified namespace and configuration file.

```bash
helm install tableau-server ./helm/tableau-server \
  -n tableau \
  -f ./helm/tableau-server/values-multinode.yaml
```

--------------------------------

### Create environment and download bootstrap file

Source: https://help.tableau.com/current/server/en-us/rmt-external-repo.htm

Commands to initialize the monitoring environment and generate the bootstrap file required for agent registration.

```bash
rmtadmin create-env --name=<myenvironment> --api-username=<TableauServer API user name> --api-password=<password for the Tableau Server API user account>
```

```bash
rmtadmin bootstrap-file --env=<myenvironment> --filename=<The absolute or relative path including the file name>
```

--------------------------------

### Define Secrets File

Source: https://help.tableau.com/current/server/en-us/server-helm-deploy.htm

Example of a dedicated secrets file to be passed during Helm installation.

```yaml
secrets:  
  licenseKey: "YOUR-LICENSE-KEY"  
  tsmRemotePassword: "YOUR-TSM-PASSWORD"  
  tableauUsername: "YOUR-ADMIN-USER"  
  tableauPassword: "YOUR-ADMIN-PASSWORD"
```

--------------------------------

### Restore Backup and Start Server

Source: https://help.tableau.com/current/server/en-us/identity_migration_troubleshoot.htm

Restores the backup file and restarts the server to initiate the identity migration process.

```bash
tsm maintenance restore --file <file_name>
tsm start
```

--------------------------------

### Configure userClassNames

Source: https://help.tableau.com/current/server/en-us/entity_identity_store.htm

Example format for providing multiple LDAP user class names as a list of strings.

```json
["userclass1",userclass2"]
```

--------------------------------

### Initialize RMT Server

Source: https://help.tableau.com/current/server/en-us/rmt-admin-master-install-cli.htm

Run the initialization script to accept the EULA and set up the server.

```bash
sudo /opt/tableau/tabrmt/master/install-scripts/initialize-rmt-master --accepteula
```

--------------------------------

### Define efs-bootstrap StorageClass

Source: https://help.tableau.com/current/server/en-us/server-helm-prerequisites.htm

Example manifest for creating the efs-bootstrap StorageClass.

```yaml
apiVersion: storage.k8s.io/v1  
kind: StorageClass
metadata:  
  name: efs-bootstrap  
provisioner: efs.csi.aws.com  
reclaimPolicy: Retain  
volumeBindingMode: Immediate  
allowVolumeExpansion: true
```

--------------------------------

### Identity Pool CSV Import Examples

Source: https://help.tableau.com/current/server/en-us/csvguidelines.htm

Examples of CSV files formatted for identity pool assignments, including adding users to pools and managing identifiers.

```text
henryw,henrypassword,Henry Wilson,Viewer,None,yes,hwilson@myco.com,General Contractors,hwilson  
freds,fredpassword,Fred Suzuki,Creator,None,no,fsuzuki@myco.com,General Contractors,fsuzuki
```

```text
henryw,henrypassword,Henry Wilson,Viewer,None,yes,hwilson@myco.com,General Contractors 2,hwilson  
freds,fredpassword,Fred Suzuki,Creator,None,no,fsuzuki@myco.com,General Contractors 2,fsuzuki
```

```text
janes,janepassword,Jane Smith,Viewer,None,yes,jsmith@myco.com,General Contractors,jwang  
laurar,laurapassword,Laura Rodriguez,Creator,None,no,lrodriguez@myco.com,General Contractors,jrodriguez
```

--------------------------------

### Server Lifecycle Commands

Source: https://help.tableau.com/current/server/en-us/logs_debug_level.htm

Commands to stop, start, and apply pending configuration changes to the server.

```bash
tsm stop
```

```bash
tsm pending-changes apply
```

```bash
tsm start
```

--------------------------------

### Registration file format

Source: https://help.tableau.com/current/server/en-us/activate.htm

Example of the required JSON structure for the registration file.

```json
{
    "first_name" : "Andrew",
    "last_name" : "Smith",
    "phone" : "311-555-2368",
    "email" : "andrew.smith@mycompany.com",
    "company" : "My Company",
    "industry" : "Finance",
    "company_employees" : "500",			
    "department" : "Engineering",
    "title" : "Senior Manager",
    "city" : "Kirkland",
    "state" : "WA",
    "zip" : "98034",
    "country" : "United States",
    "opt_in" : "false",
    "eula" : "accept"
}
```

--------------------------------

### Standard CSV User Import Example

Source: https://help.tableau.com/current/server/en-us/csvguidelines.htm

A sample CSV file structure for importing multiple users with standard attributes.

```text
henryw,henrypassword,Henry Wilson,Creator,None,yes,henryw@example.com  
freds,fredpassword,Fred Suzuki,Viewer,None,no,freds@example.com  
alanw,alanpassword,Alan Wang,Explorer,Site,yes,alanw@example.com  
michellek,michellepassword,Michelle Kim,Creator,System,yes,michellek@example.com
```

--------------------------------

### JSON configuration file structure

Source: https://help.tableau.com/current/server/en-us/config_file_example.htm

Example of a JSON file defining gateway settings, identity store, and gateway timeout keys.

```json
{
   "configEntities": {
      "gatewaySettings": {
         "_type": "gatewaySettingsType",
         "port": 80,
         "publicHost": "localhost",
         "publicPort": 80
      },
      "identityStore": {
         "_type": "identityStoreType",
         "type": "local",
         "domain": "example.lan",
         "nickname": "EXAMPLE"
      }
    },
     "configKeys": {
        "gateway.timeout": "900"
     }
}
```

--------------------------------

### Manage RMT Services and Backup Database

Source: https://help.tableau.com/current/server/en-us/rmt-external-repo.htm

Stop and start RMT services, then use pg_dump to create a backup of the local repository.

```bash
rmtadmin stop
```

```bash
rmtadmin start -db
```

```bash
cd 'C:\Program Files\Tableau\Tableau Resource Monitoring Tool\prerequisites\postgresql<version number>\bin'
```

```bash
pg_dump -f your_file_name.dump -F d -j 10 -Z 5 -d tabrmt -h localhost -p 5555 -U postgres
```

--------------------------------

### TSM Status Output Example

Source: https://help.tableau.com/current/server/en-us/server_process_container.htm

Example output from the tsm status -v command showing the hierarchy of microservice containers and their constituent microservices.

```text
node1: TABLEAUSVR01
Status: RUNNING
'Tableau Server Gateway 0' is running.
'Tableau Server Application Server 0' is running.
'Tableau Server Interactive Microservice Container 0' is running.
    'MessageBus Microservice 0' is running.
    'Relationship Query Microservice 0' is running.
'Tableau Server VizQL Server 0' is running.
'Tableau Server VizQL Server 1' is running.
'Tableau Server VizQL Server 2' is running.
'Tableau Server VizQL Server 3' is running.
'Tableau Server Cache Server 0' is running.
'Tableau Server Cache Server 1' is running.
'Tableau Server Coordination Service 0' is running.
'Tableau Server Cluster Controller 0' is running.
'Tableau Server Search And Browse 0' is running.
'Tableau Server Backgrounder 0' is running.
'Tableau Server Backgrounder 1' is running.
'Tableau Server Non-Interactive Microservice Container 0' is running.
     'Relationship Ingestor Microservice 0' is running.
     'External Content Provider Microservice 0' is running.
     'Flow Provider Microservice 0' is running.
     'Content Provider Microservice 0' is running.
'Tableau Server Data Server 0' is running.
'Tableau Server Data Server 1' is running.
'Tableau Server Data Engine 0' is running.
'Tableau Server File Store 0' is running.
'Tableau Server Repository 0' is running (Active Repository).
'Tableau Server Tableau Prep Conductor 0' is running.
'Tableau Server Elastic Server 0' is running.
'Tableau Server Ask Data 0' is running.
'Tableau Server Administration Agent 0' is running.
'Tableau Server Administration Controller 0' is running.
'Tableau Server Service Manager 0' is running.
'Tableau Server License Manager 0' is running.
'Tableau Server Client File Service 0' is running.
'Tableau Server Database Maintenance 0' is stopped.
'Tableau Server Backup/Restore 0' is stopped.
'Tableau Server Site Import/Export 0' is stopped.
'Tableau Server SAML Service 0' is stopped.
c:\Program Files\Tableau\Tableau Server\packages\scripts.near.18.1216.1859>
```

--------------------------------

### Activate and List Licenses

Source: https://help.tableau.com/current/server/en-us/distrib_ha_init_node_fail.htm

Activate the product key and verify the license status.

```bash
tsm licenses activate -k <product-key>
```

```bash
tsm licenses list
```

--------------------------------

### Install RMT Server to Custom Directory

Source: https://help.tableau.com/current/server/en-us/rmt-admin-master-install-cli.htm

Specifies a custom installation path for the RMT Server during silent installation.

```bash
Tabrmt-Master-64bit-<version>.exe /silent ACCEPTEULA=1 InstallFolder="D:\Tableau Resource Monitoring Tool\master"
```

--------------------------------

### Create a project with tabcmd

Source: https://help.tableau.com/current/server/en-us/tabcmd_cmd.htm

Creates a new project with a specified name and description.

```bash
tabcmd createproject -n "Quarterly_Reports" -d "Workbooks showing quarterly sales reports."
```

--------------------------------

### Start Administration Controller Service

Source: https://help.tableau.com/current/server/en-us/server_process_tsm-admin-controller.htm

Manually start the TSM Administration Controller service if it fails to start automatically.

```batch
sc start tabadmincontroller_0
```

--------------------------------

### Example XML Status Report

Source: https://help.tableau.com/current/server/en-us/service_status_xml.htm

A sample output showing the structure of the system information XML returned by the server.

```xml
<systeminfo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <machines>
    <machine name="my_tableau_server">
    <repository worker="my_tableau_server:8060" status="Active" preferred="false"/>
    <dataengine worker="my_tableau_server:27042" status="Active"/>
    <applicationserver worker="my_tableau_server:8600" status="Active"/>
    <apiserver worker="my_tableau_server:8000" status="Active"/>
    <vizqlserver worker="my_tableau_server:9100" status="Active"/>
    <dataserver worker="my_tableau_server:9700" status="Active"/>
    <backgrounder worker="my_tableau_server:8250" status="Active"/>
    <gateway worker="my_tableau_server:80" status="Active"/>
    <searchandbrowse worker="my_tableau_server:11000" status="Active"/>
    <cacheserver worker="my_tableau_server:6379" status="Active"/>
    <filestore worker="my_tableau_server:9345" status="Active" pendingTransfers="0" failedTransfers="0" syncTimestamp="2015-02-27T20:30:48.564Z"/>
    <clustercontroller worker="my_tableau_server:12012" status="Active"/>
    <coordination worker="my_tableau_server:12000" status="Active"/>
    </machine>
  </machines>
  <service status="Active"/>
</systeminfo>
```

--------------------------------

### Start a tabcmd session

Source: https://help.tableau.com/current/server/en-us/tabcmd.htm

Establishes an authenticated session with the specified Tableau Server.

```bash
tabcmd login -s http://tabserver.mycompany.com -u admin -p mypassword
```

--------------------------------

### Get Bootstrap File

Source: https://help.tableau.com/current/server/en-us/backup_restore.htm

Generates a bootstrap file for cluster node configuration.

```bash
tsm topology nodes get-bootstrap-file --file <path\file>.json
```

--------------------------------

### Constructing Direct View URLs

Source: https://help.tableau.com/current/server/en-us/trusted_auth_webURL.htm

Examples of URL structures for accessing views directly, including support for multi-site server configurations.

```text
http://<server_name>/trusted/<unique_ticket>/views/<workbook_name>/<view_name>
```

```text
http://<server_name/trusted/<unique_ticket>/t/Sales/views/<workbook_name>/<view_name>
```

--------------------------------

### Create Environment and Bootstrap File

Source: https://help.tableau.com/current/server/en-us/rmt-external-messagequeue.htm

Commands to initialize a new environment and generate the bootstrap file required for agent registration.

```bash
rmtadmin create-env --name=<myenvironment> --api-username=<TableauServer API user name> --api-password=<password for the Tableau Server API user account>
```

```bash
rmtadmin bootstrap-file --env=<myenvironment> --filename<The absolute or relative path including the file name>
```

--------------------------------

### Specify Custom Installation Directory

Source: https://help.tableau.com/current/server/en-us/silent_installer_flags.htm

Override the default installation path for Tableau Server.

```bash
<Setup file> /silent INSTALLDIR="D:\Tableau\Tableau Server" 					
```

--------------------------------

### Start RMT database service

Source: https://help.tableau.com/current/server/en-us/rmt-troubleshoot-messaging-table-disk-usage-warning.htm

Starts only the database service for the Resource Monitoring Tool.

```bash
rmtadmin start --db
```

--------------------------------

### Configure groupClassNames

Source: https://help.tableau.com/current/server/en-us/entity_identity_store.htm

Example format for providing multiple LDAP group class names as a list of strings.

```json
["basegroup","othergroup"]
```

--------------------------------

### Default installation path

Source: https://help.tableau.com/current/server/en-us/server-upgrade-baseline-singlenode-setup.htm

The default directory path for Tableau Server scripts and packages.

```text
C:\Program Files\Tableau\Tableau Server\packages\scripts.<version_code>\
```

```text
C:\Program Files\Tableau\Tableau Server\packages\
```

--------------------------------

### Silent Installation with Custom Directory

Source: https://help.tableau.com/current/server/en-us/server_tsig_install_switches.htm

Performs a silent installation of the Independent Gateway to a non-default directory.

```text
<Setup file> /silent INSTALLDIR="D:\Tableau\Tableau Server\independentgateway"
```

--------------------------------

### Navigate to RMT Installation Directory

Source: https://help.tableau.com/current/server/en-us/rmt-external-repo.htm

Changes the current directory to the RMT master installation folder.

```bash
cd 'c:\Program Files\Tableau\Tableau Resource Monitoring Tool\master\'
```

--------------------------------

### Login to Tableau Server

Source: https://help.tableau.com/current/server/en-us/tabcmd_cmd.htm

Examples of authenticating a user session with different server configurations and options.

```bash
tabcmd login -s http://localhost -u jsmith -p password
```

```bash
tabcmd login -s http://sales-server -t Sales -u administrator -p password
```

```bash
tabcmd login -s http://sales-server:8000 -t Sales -u administrator -p password
```

```bash
tabcmd login --no-certcheck -s https://sales-server -t Sales -u administrator -p password
```

```bash
tabcmd login --proxy myfwdproxyserver:8888 -s http://localhost -u jsmith -p password
```

```bash
tabcmd login -s https://myreverseproxy -u jsmith -p password
```

--------------------------------

### tabcmd version

Source: https://help.tableau.com/current/server/en-us/tabcmd_cmd.htm

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

```APIDOC
## tabcmd version

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

### Usage
`tabcmd version`
```

--------------------------------

### tabcmd get

Source: https://help.tableau.com/current/server/en-us/tabcmd_cmd.htm

Retrieves a resource from Tableau Server based on a partial URL.

```APIDOC
## tabcmd get

### Description
Gets a resource (workbook or view) from Tableau Server and saves it as a file. Requires Download/Web Save As permissions.

### Parameters
#### Path Parameters
- **url** (string) - Required - The partial URL of the resource (e.g., "/views/Workbook/View.png" or "/workbooks/Workbook.twb").

#### Options
- **--filename** (string) - Optional - The name and path for the saved file. If omitted, the name is derived from the URL.
- **?:refresh=yes** (query parameter) - Optional - Forces a fresh data query instead of using the cache.
- **?:size=width,height** (query parameter) - Optional - Specifies the pixel dimensions for PNG exports.
```

--------------------------------

### Run the upgrade script

Source: https://help.tableau.com/current/server/en-us/server-upgrade-baseline-multinode-run-script.htm

Commands to execute the upgrade script and view available options.

```bash
upgrade-tsm
```

```bash
upgrade-tsm -h
```

--------------------------------

### Linux Agent Installation Commands

Source: https://help.tableau.com/current/server/en-us/rmt-admin-agent-install-cli.htm

Commands to install the RMT Agent package on RHEL-based distributions or Ubuntu.

```bash
sudo yum install Tabrmt-Agent-x86_64-<version>.rpm
```

```bash
sudo apt install Tabrmt-Agent-amd64-<version>.deb
```

--------------------------------

### Start RMT Services

Source: https://help.tableau.com/current/server/en-us/rmt-troubleshoot-upgrade.htm

Commands to manually start the RMT master service on Linux and Windows platforms.

```bash
sudo -u tabrmt-master XDG_RUNTIME_DIR=/run/user/$(id -u tabrmt-master) systemctl --user start tabrmt-master
```

```powershell
Start-Service TableauResourceMonitoringTool
```

--------------------------------

### Publish Samples to a Project

Source: https://help.tableau.com/current/server/en-us/tabcmd_cmd.htm

Publishes sample workbooks to the 'Inside Sales' project on the default site.

```bash
tabcmd publishsamples -n "Inside Sales" -t "" -s localhost --username "jsmith" --password "secret-password"
```

--------------------------------

### Create a keytab file using ktab

Source: https://help.tableau.com/current/server/en-us/kerberos_delegation_jdbc.htm

Use the ktab tool from the JDK to generate a keytab file for the Run As service account.

```bash
<JDK_HOME>/bin/ktab -k E:/tmp/tabsrv.keytab -a tabsrv@EXAMPLE.COM
```

--------------------------------

### Configure trusted authentication hosts

Source: https://help.tableau.com/current/server/en-us/cli_authentication_tsm.htm

Examples of specifying trusted web server hosts using IP addresses or hostnames.

```bash
tsm authentication trusted configure -th "192.168.1.101", "192.168.1.102", "192.168.1.103"
```

```bash
tsm authentication trusted configure -th "webserv1", "webserv2", "webserv3"
```

--------------------------------

### Specify nested project paths

Source: https://help.tableau.com/current/server/en-us/tabcmd_cmd.htm

Syntax examples for targeting nested projects using the parent-project-path option.

```bash
--parent-project-path "Main" -r "Nested"
```

```bash
--parent-project-path "Main\Nested\Nested2 -r "Nested3"
```

--------------------------------

### View hardware detection logs

Source: https://help.tableau.com/current/server/en-us/server_hardware_min.htm

Example log entries showing detected system processor count and total system memory.

```text
2020-11-24 17:40:43.842 +0000 main : DEBUG com.tableausoftware.tabadmin.configuration.builder.BootstrapConfigurationBuilder - System processor count = 8
```

```text
2020-11-24 17:40:43.842 +0000 main : DEBUG com.tableausoftware.tabadmin.configuration.builder.BootstrapConfigurationBuilder - System memory = 64383MB
```

--------------------------------

### Display tabcmd version

Source: https://help.tableau.com/current/server/en-us/tabcmd_cmd.htm

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

```bash
tabcmd version
```

--------------------------------

### tabcmd upgradethumbnails

Source: https://help.tableau.com/current/server/en-us/tabcmd_cmd.htm

Starts or stops the Upgrade Thumbnails job on the specified Tableau Server.

```APIDOC
## tabcmd upgradethumbnails

### Description
Starts or stops the Upgrade Thumbnails job on the Tableau Server. If the --stop option is omitted, the job is started; otherwise, the currently running job is terminated.

### Usage
`tabcmd upgradethumbnails --server <serverURL> [--stop]`

### Options
- **--server** (string) - Required - The URL of the Tableau Server.
- **--stop** (flag) - Optional - When specified, stops the in-progress Upgrade Thumbnails job.

### Global Options
- **-u, --user** (string) - Required - The Tableau Server username.
- **-p, --password** (string) - Required - The Tableau Server password.
- **--password-file** (string) - Optional - Path to a text file containing the password.
- **-t, --site** (string) - Optional - The Tableau Server site ID.
- **--timeout** (integer) - Optional - Seconds to wait for the server to complete the command.
```

--------------------------------

### Example Data Directory Configuration

Source: https://help.tableau.com/current/server/en-us/server_tsig_install_switches.htm

Specifies a custom location for TSIG software configuration and data storage.

```text
DATADIR="D:\TableauServerData"
```

--------------------------------

### Example Activity Log Entry

Source: https://help.tableau.com/current/server/en-us/activity_log_audit_permissions.htm

A sample JSON log entry representing a group being granted connection permissions to a data source.

```json
{
	"actorUserId": 39872,
	"actorUserLuid": "4e6b42bf-9040-4e60-b326-1c56a4fb96f8",
	"authorizableType": "DATASOURCE",
	"capabilityId": 32,
	"capabilityValue": "connect",
	"contentId": 2099835,
	"contentName": "Superstore ExtractNeal3",
	"eventTime": "2023-01-31T22:44:23.650058Z",
	"granteeId": 22,
	"granteeLuid": "dae0717a-d524-436d-b469-fadeaa22a5dd",
	"granteeType": "Group",
	"granteeValue": "GROUP_ALLOW",
	"initiatingUserId": 39872,
	"initiatingUserLuid": "4e6b42bf-9040-4e60-b326-1c56a4fb96f8",
	"isError": false,
	"eventCategory": "security",
	"eventType": "set_permissions",
	"eventVersion": "1.0",
	"permissionType": "explicit",
	"siteLuid": "b45e272d-10c7-49d5-9037-e53ce47dbf4e"
}
```

--------------------------------

### Export views using tabcmd

Source: https://help.tableau.com/current/server/en-us/tabcmd_cmd.htm

Examples of exporting views to CSV, PDF, and PNG formats with optional cache refreshing.

```bash
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
```

--------------------------------

### Configure Hardware Incident Triggers

Source: https://help.tableau.com/current/server/en-us/rmt-incidents-hardware.htm

Example JSON configuration for setting a disk space warning threshold for a specific environment.

```json
{
  "environments":  {
    "staging-environment":  {
     "monitoring":  {
        "incidents":  {
          "triggers":  [
            {
              "counter":  "DiskSpaceAvailableKB",
              "severity":  "warning",
              "threshold":  2097152
            }
          ]
        }
      }
    }
  }
}
```

--------------------------------

### Import Server Configuration

Source: https://help.tableau.com/current/server/en-us/cli_settings_tsm.htm

Basic syntax for importing server configuration or topology using a JSON file.

```bash
tsm settings import --import-config-file <path/to/import_file.json> [global options]
```

--------------------------------

### Example Backfill API Response

Source: https://help.tableau.com/current/server/en-us/dm_tools_backfill.htm

A sample JSON response showing the status of various content types and lineage indexing progress.

```json
{
  "contentBackfillTotalDurationSeconds": 362,
  "lineageBackfillTotalDurationSeconds": 14,
  "contentBackfillStatuses": [
    {
	"contentType": "PublishedDatasource",
	"contentId": "sites/1/datasources/-631379806-1912815680",
	"successfullyIngestedCount": 20,
	"failedToIngestCount": 0,
	"durationSeconds": 312,
	"totalCount": 20,
	"checkpointCreatedTime": "2020-07-29T23:50:25.763Z",
	"backfillComplete": true
    },
    {
	"contentType": "Database",
	"contentId": "sites/1/databases/e1331f9d-4d73-ee04-9edf-96fd1c37cb8e",
	"successfullyIngestedCount": 35,
	"failedToIngestCount": 0,
	"durationSeconds": 26,
	"totalCount": 35,
	"checkpointCreatedTime": "2020-04-29T23:50:25.769Z",
	"backfillComplete": true
    },
    {
	"contentType": "DatabaseTable",
	"contentId": "sites/1/tables/d946d084-53a8-09b6-2ad2-93301e6b4b15",
	"successfullyIngestedCount": 64,
	"failedToIngestCount": 0,
	"durationSeconds": 49,
	"totalCount": 64,
	"checkpointCreatedTime": "2020-04-29T23:50:25.774Z",
	"backfillComplete": true
    },
    {
	"contentType": "Metric",
	"contentId": "sites/1/metrics/metric1",
	"successfullyIngestedCount": 2,
	"failedToIngestCount": 0,
	"durationSeconds": 254,
	"totalCount": 2,
	"checkpointCreatedTime": "2020-04-29T23:50:25.779Z",
	"backfillComplete": true
    },
    {
	"contentType": "Workbook",
	"contentId": "sites/1/workbooks/6749399-1501801290",
	"successfullyIngestedCount": 10,
	"failedToIngestCount": 0,
	"durationSeconds": 267,
	"totalCount": 10,
	"checkpointCreatedTime": "2020-04-29T23:50:25.784Z",
	"backfillComplete": true
    },
    {
	"contentType": "Flow",
	"contentId": "sites/1/flows/4",
	"successfullyIngestedCount": 4,
	"failedToIngestCount": 0,
	"durationSeconds": 195,
	"totalCount": 4,
	"checkpointCreatedTime": "2020-04-29T23:50:25.788Z",
	"backfillComplete": true
    }
   ],
  "lineageBackfillStatus": {
	"totalCount": 45,
	"processedCount": 18,
	"lastLineageConnection": "CloudFile downstreamWorkbooks Workbook",
	"backfillComplete": false
    }
}
```

--------------------------------

### Install RMT Server on RHEL/CentOS

Source: https://help.tableau.com/current/server/en-us/rmt-admin-master-install-cli.htm

Use the yum package manager to install the RMT Server RPM package.

```bash
sudo yum install <path/to/rmtserverinstaller>/Tabrmt-Master-x86_64-<version>.rpm
```

--------------------------------

### Manage Upgrade Thumbnails Job

Source: https://help.tableau.com/current/server/en-us/tabcmd_cmd.htm

Commands to start or stop the thumbnail upgrade process on the server.

```bash
tabcmd upgradethumbnails --server <serverURL>
```

```bash
tabcmd upgradethumbnails --server <serverURL> --stop
```

--------------------------------

### Migrate plan file

Source: https://help.tableau.com/current/server/en-us/cmt-command_line.htm

Opens a migration plan file directly to the migrate step in the GUI.

```bash
tabcmt migrate <plan file>
```

--------------------------------

### Install tabcmd on RHEL-like distributions

Source: https://help.tableau.com/current/server/en-us/tabcmd.htm

Use the yum package manager to install the tabcmd RPM package on RHEL-based systems.

```bash
sudo yum install tableau-tabcmd-<version>.noarch.rpm
```

--------------------------------

### Configure New Run As Service Account via CLI

Source: https://help.tableau.com/current/server/en-us/runas_acct.htm

Set the new domain username and password for the Run As service account.

```bash
tsm configuration set -k service.runas.username -v <domain\username>
```

```bash
tsm configuration set -k service.runas.password -v "<password>"
```

--------------------------------

### Identify backup/restore permission errors

Source: https://help.tableau.com/current/server/en-us/trouble_install_upgrade.htm

Example error messages indicating that the Run As user lacks necessary permissions for the backup/restore file location.

```text
The runas user does not have permission to read the backup file: <backup/restore basefilepath>.

Repository restore failed.
An error occurred during installation.
An error occurred while restoring repository.
```

--------------------------------

### Export with URL encoded characters

Source: https://help.tableau.com/current/server/en-us/tabcmd_cmd.htm

Example of URL encoding non-ASCII characters in the export command.

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

--------------------------------

### Example WMI ManagementException Log Entry

Source: https://help.tableau.com/current/server/en-us/rmt-troubleshoot-wmi-query-issues.htm

A sample log entry indicating a ManagementException due to an invalid WMI query.

```json
{  ...  
"Level":  "Error",  ...  
"RenderedMessage":  "Error getting network adapters",  
"Exception":  "System.Management.ManagementException: * Invalid query  *  
       at System.Management.ManagementException.ThrowWithExtendedInfo(ManagementStatus errorCode) ..."  
...  }
```

--------------------------------

### Activate Tableau Server with Product Key

Source: https://help.tableau.com/current/server/en-us/activate.htm

Use this command to activate a production license using a specific product key.

```bash
tsm licenses activate -k <product key>
```

--------------------------------

### Cluster Node Configuration Examples

Source: https://help.tableau.com/current/server/en-us/server_tsig_install_switches.htm

Examples of valid formats for the TSCLUSTER property, which defines allowed nodes for housekeeping requests.

```text
"ip 192.1.168.0/24"
```

```text
"host ts.example.org"
```

--------------------------------

### Configuration Key Mismatch Error

Source: https://help.tableau.com/current/server/en-us/trouble_install_upgrade.htm

Example of a configuration error message indicating an unknown key in the settings file.

```text
c:\Users\mytableau\Desktop>tsm settings import -f 20183-export.json
Configuration error: At least one configuration value you specified does not match a known configuration key. This applies to the following keys: '[features.TsmConfigFileService]'
Use this parameter to override unknown key error: --force-keys
```

--------------------------------

### Locate Tableau Server installation log file path

Source: https://help.tableau.com/current/server/en-us/server_hardware_min.htm

The path to the log file containing hardware detection details during installation.

```text
<install directory>\ProgramData\Tableau\Tableau Server\logs\app-install.log
```

--------------------------------

### Import Topology and Configuration

Source: https://help.tableau.com/current/server/en-us/backup_restore.htm

Imports the topology and configuration settings from a previously exported JSON file.

```bash
tsm settings import -f <filename>.json
```

--------------------------------

### Hardware detection log entries

Source: https://help.tableau.com/current/server/en-us/server-upgrade-prepare-min-HW-recommendations.htm

Example log entries showing the hardware check process, detected core counts, and specification validation.

```text
2015-04-09 14:22:29.533 -0700_DEBUG_10.36.2.32:<machine name>_:_pid=21488_0x2cd83560__user=__request=__ Running hardware check
```

```text
2015-04-09 14:22:29.713 -0700_DEBUG_10.36.2.32:<machine name>_:_pid=21488_0x2cd83560__user=__request=__ Detected 12 cores and 34281857024 bytes of memory
```

```text
2015-04-09 14:22:29.716 -0700_DEBUG_10.36.2.32:<machine name>_:_pid=21488_0x2cd83560__user=__request=__ Hardware meets recommended specifications. Default values will be used.
```

--------------------------------

### Add Repository Instance

Source: https://help.tableau.com/current/server/en-us/distrib_rep_move.htm

Configures a new repository process on a specific node.

```bash
tsm topology set-process -n <nodeID> -pr pgsql -c 1
```

--------------------------------

### Remove Tableau Server Files

Source: https://help.tableau.com/current/server/en-us/trouble_install_upgrade.htm

Run this script to completely remove all traces of a previous Tableau Server installation before attempting a fresh install.

```cmd
tableau-server-obliterate.cmd
```

--------------------------------

### Perform Silent Installation with Bootstrap File

Source: https://help.tableau.com/current/server/en-us/silent_installer_flags.htm

Use this command to perform a silent installation when adding a node to a cluster using a bootstrap file.

```bash
<Setup file> /silent ACCEPTEULA=1 BOOTSTRAPFILE="C:\Users\tableauadmin\Downloads\bootstrap.json" 
```

```bash
<Setup file> /silent ACCEPTEULA=1 BOOTSTRAPFILE="C:\Users\tableauadmin\Downloads\bootstrap.json" EMBEDDEDCREDENTIAL=1
```

--------------------------------

### Download Bootstrap File

Source: https://help.tableau.com/current/server/en-us/rmt-admin-agent-install-cli.htm

Use this command to download the bootstrap configuration file required for agent registration.

```bash
rmtadmin bootstrap-file --env=<myenvironment> --filename<The absolute or relative path including the file name>
```

--------------------------------

### Configure pg_hba.conf for Remote Access

Source: https://help.tableau.com/current/server/en-us/server_external_repo_configure_standalone.htm

Example entry for the pg_hba.conf file to permit remote connections from a specific network range.

```text
host all all 10.0.0.0/8 md5
```

--------------------------------

### Export workbooks using tabcmd

Source: https://help.tableau.com/current/server/en-us/tabcmd_cmd.htm

Examples of exporting workbooks to PDF format with optional page size settings.

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

--------------------------------

### Tableau Server Job Failure Example

Source: https://help.tableau.com/current/server/en-us/trouble_job_failures.htm

A concrete example of a job failure message indicating a service failed to reach the requested state.

```text
This job failed due to unexpected error: 'ServiceOperationTimeoutException'
One or more services failed to reach their expected state.
node1:
     vizportal_0.2021.4.0.0: Failed to reach requested state. Current state: INSTALL_FAILED
```

--------------------------------

### Navigate to the scripts directory

Source: https://help.tableau.com/current/server/en-us/server-upgrade-baseline-multinode-run-script.htm

The default path for the scripts directory where the upgrade script is located.

```text
C:\Program Files\Tableau\Tableau Server\packages\scripts.<version_code>\
```

--------------------------------

### SAML Assertion Username Attribute Example

Source: https://help.tableau.com/current/server/en-us/saml_requ.htm

Example structure of a SAML assertion containing the required username attribute typed as xs:string.

```xml
<saml:Assertion _assertion-element-attributes_>
  <saml:Issuer>_issuer-information_</saml:Issuer>
  <Signature xmlns="http://www.w3.org/2000/09/xmldsig#">
    ...
  </Signature>
  <saml:Subject>
    ...
  </saml:Subject>
  <saml:Conditions _condition-attributes_ >
    ...
  </saml:Conditions>
  <saml:AuthnStatement _authn-statement-attributes_ >
    ...
  </saml:AuthnStatement>

  <saml:AttributeStatement>
    <saml:Attribute Name="username" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic">
    <saml:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">
          **_user-name_**
    </saml:AttributeValue>
    </saml:Attribute>
  </saml:AttributeStatement>
</saml:Assertion>
```

--------------------------------

### Create an RMT environment

Source: https://help.tableau.com/current/server/en-us/rmt-admin-master-install-cli.htm

Initializes a new environment for the Resource Monitoring Tool using the specified API credentials.

```bash
rmtadmin create-env --name=<myenvironment> --api-username=<TableauServer API user name> --api-password=<password for the Tableau Server API user account>
```
Tokens:
Raw