---
schema_version: "1"
id: 9ca243fcbece4c0d7a6234a8afaddc10d79c7460ae66fd3cc997f52a1c91932c
title: tsm configuration
collection: tableau
version: next
locale: en-gb
portal_url: https://docs.salesforce.com/tableau/next/en-gb/server/cli_configuration_tsm.md
canonical_url: https://help.tableau.com/v0.0/server/en-gb/cli_configuration_tsm.htm
source_site: help.tableau.com
content_type: documentation
content_hash: b617936d47821fd810019b6c9a3f8720415e45b0305281b19e84188eb4b9359a
description: Reference for tsm configuration commands to get, set, and update Tableau Server configuration keys.
---
[Skip to main content](#main-content)

# tsm configuration

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](https://help.tableau.com/v0.0/server/en-gb/cli_configuration-set_tsm.htm).

## "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](https://help.tableau.com/v0.0/server/en-gb/cli_configuration-set_tsm.htm) 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](#TSMGet)
- [tsm configuration list-dynamic-keys](#TSMListDynamicKeys)
- [tsm configuration set](#TSMSet)

## 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 list-dynamic-keys

View all the configuration keys that can be configured dynamically (without restarting Tableau Server).

### Synopsis

`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](https://help.tableau.com/v0.0/server/en-gb/cli_pending-changes.htm#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](https://help.tableau.com/v0.0/server/en-gb/cli_pending-changes.htm).

### 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. 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.

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 https://<hostname>:8850

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://<tsm_hostname>: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](https://help.tableau.com/v0.0/server/en-gb/tsm_overview.htm#Connecti).

\-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.