tsm configuration

You can use the tsm configuration commands to get, set, and update configuration values.

For specific configuration keys you can set, see tsm configuration set Options.

tsm configuration get

View the current server configuration and topology.

Synopsis

tsm configuration get --key <config.key> [global options]

Option

-k, --key

Required.

Get the current value of the specified configuration key.

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.

Synopsis

tsm configuration set --key <config.key> --value <config_value> [global options]

Options

-k,--key <config.key>

Required.

Configuration key.

-v,--value <config_value>

Required.

Configuration value.

-d

Optional.

Reset the configuration value to its default.

-frc, --force-keys

Optional.

Force a key to be added to configuration even if it did not previously exist.

Global options

-h, --help

Optional.

Show the command help.

-p, --password <password>

Required, along with -u or --username if no session is active.

Specify the password for the user specified in -u or --username.

If the password includes spaces or special characters, enclose it in quotes:

--password "my password"

-s, --server <url_to_tsm>

Optional.

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://mytableauhost:8850. If no server is specified, https://<localhost | dnsname>:8850 is assumed.

--trust-admin-controller-cert

Optional.

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 -p or --password.

Specify a user account. If you do not include this option, the command is run using credentials you signed in with.

Thanks for your feedback! There was an error submitting your feedback. Try again or send us a message.