You can use the
tsm configuration commands to get, set, and update configuration key values.
"Unknown key" responses
Certain configuration keys will return an "Unknown key" response when you attempt to get their current value, or set a new value. If this happens, verify that you have the key spelled correctly, including proper capitalisation. To change the value, use the
--force-keys option on the
tsm configuration set command. For a list of configuration keys you can change, see tsm configuration set Options.
"Null" value responses
Certain configuration keys have a specific default value but will return a "Null" response when you attempt to get their current value. These keys use a default that is derived from the Tableau Server code. If a key is listed as having a specific default in tsm configuration set Options and the
tsm configuration get command returns "Null" for the current value, the default value is determined by code running Tableau Server. You can set the key value using
tsm configuration set, but this is not necessary unless you want to change the value.
tsm configuration get
View the current server configuration and topology.
tsm configuration get --key <config.key> [global options]
Get the current value of the specified configuration key.
tsm configuration list-dynamic-keys
View all the configuration keys that can be configured dynamically (without restarting Tableau Server).
tsm configuration list-dynamic-keys [global options]
tsm configuration set
Set or import server configuration or topology.
Quotes around the
<config.key> and the
<config_value> are optional unless there are spaces, in which case you must use quotes around the key or value.
Note: After setting a configuration key value you must apply the pending configuration changes using
tsm pending-changes apply. Until you do, the new value will not be used by Tableau or show up in the results of a
tsm configuration get command. You can view pending changes using
tsm pending-changes list. For more information, see tsm pending-changes.
tsm configuration set --key <config.key> --value <config_value> [global options]
Required. Beginning in the March maintenance releases (versions 2021.2.10, 2021.3.9, 2021.4.5), if you do not include this option, you will be prompted for the value.
Reset the configuration value to its default.
Force a key to be added to configuration even if it did not previously exist.
Show the command help.
-p, --password <password>
Required, along with
--usernameif no session is active.
Specify the password for the user specified in
If the password includes spaces or special characters, enclose it in quotes:
--password 'my password'
-s, --server https://<hostname>:8850
Use the specified address for Tableau Services Manager. The URL must start with
https, include port 8850, and use the server name not the IP address. For example
https://<tsm_hostname>:8850. If no server is specified,
https://<localhost | dnsname>:8850is assumed.
Use this flag to trust the self-signed certificate on the TSM controller. For more information about certificate trust and CLI connections, see Connecting TSM clients.
-u, --username <user>
Required if no session is active, along with
Specify a user account. If you do not include this option, the command is run using credentials you signed in with.