Tableau Server on Windows Help

Use the tsm pending-changes commands to apply, discard, or view pending configuration and topology changes to Tableau Server.

Passwords and secrets that you enter during TSM configuration are encrypted after you save them. Secrets remain encrypted until, during, and after you apply pending changes. For more information about secret storage, see Manage Server Secrets.

tsm pending-changes apply

Use the tsm pending-changes apply command to apply pending configuration and topology changes to Tableau Server.

If the pending changes require a server restart, the pending-changes apply command will display a prompt to let you know a restart will occur. This prompt displays even if the server is stopped, but in that case there is no restart. You can suppress the prompt using the --ignore-prompt option, but this does not change the restart behavior. If the changes do not require a restart, the changes are applied without a prompt.

Synopsis

tsm pending-changes apply [global options]

Options

-iw, --ignore-warnings

Optional.

Ignore warning level constraints.

--ignore-prompt

Optional.

Suppress the prompt for restart. This only suppresses the prompt. The restart behavior is unchanged.

--request-timeout <timeout in seconds>

Optional.

Wait the specified amount of time for the command to finish. Default value is 1800 (30 minutes).

tsm pending-changes discard

Use the tsm pending-changes discard command to discard pending configuration and topology changes to Tableau Server.

Synopsis

tsm pending-changes discard [options] [global options]

Options

--config-only

Optional.

Discard only pending configuration changes.

--topology-only

Optional.

Discard only pending topology changes.

tsm pending-changes list

Lists pending configuration and topology changes to Tableau Server. Any changes that do not require a server restart will be listed as not requiring a restart. If none of the pending changes require a restart, a message displays saying the changes do not require a server restart. If any change in the list requires a restart, the entire list of pending changes will result in a restart. For more information on dynamic configuration or topology changes, see Tableau Server Dynamic Topology Changes.

Synopsis

tsm pending-changes list [options] [global options]

Options

--config-only

Optional.

List only pending configuration changes.

--topology-only

Optional.

List only pending topology changes.

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.

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