tsm topology

You can use the tsm topology commands to prepare File Store nodes for safe removal or to put them back into read-write mode. You can also initiate a repository failover, get a list of nodes or ports, get the bootstrap configuration file required to add additional nodes to your cluster, and remove nodes.

tsm topology cleanup-coordination-service

Use the tsm topology cleanup-coordination-service command to remove the non-production Tableau Server Coordination Service ensemble after you deploy a new ensemble. This command removes the old Coordination Service instances on all nodes in the non-production Coordination Service ensemble and is required after you deploy a new Coordination Service ensemble. To learn more about Coordination Service ensembles, see Deploy a Coordination Service Ensemble .

Synopsis

tsm topology cleanup-coordination-service [option] [global options]

Option

--request-timeout <timeout in seconds>

Optional.

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

tsm topology deploy-coordination-service

You can use the tsm topology deploy-coordination-service command to deploy the Tableau Server Coordination Service. This command deploys a Coordination Service ensemble, which is a set of Coordination Service instances that run on specified nodes in your server cluster. To learn more about Coordination Service ensembles, including how many nodes in your cluster should have a Coordination Service instance, see Deploy a Coordination Service Ensemble .

Synopsis

tsm topology deploy-coordination-service --nodes <nodeID,nodeID,...> [option] [global-options]

Options

-n, --nodes <nodeID,nodeID,...>

Required.

Node IDs of nodes to include in the new Coordination Service ensemble, separated by commas. You can specify 1, 3, or 5 Coordination Service nodes, depending on the total number of nodes in your cluster. For more information, see The Coordination Service Quorum.

--request-timeout <timeout in seconds>

Optional.

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

tsm topology failover-repository

You can use the tsm topology failover-repository to manually initiate a repository failover from the current active repository to the second, passive repository.

The tsm topology failover-repository command is persistent. The failover repository remains the active repository until you issue the command again, or, if Tableau Server is configured for it, until automatic failover occurs. If you have a preferred active repository configured, use the --preferred option to switch back to that repository. For more information about configuring a preferred active repository, see Tableau Server Repository. If Tableau Server is configured for high availability, failover of the repository is automatic when necessary. Use the failover-repository command to manually fail over the repository.

Synopsis

tsm topology failover-repository --preferred | --target <node_name> [global options]

Options

-r, --preferred

Required if -t or --target is not used.

Use the configured preferred node as the target for repository failover.

--request-timeout <timeout in seconds>

Optional.

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

-t, --target <node_name>

Required if -r or --preferred is not used.

The fully qualified name of the target node onto which failover will occur.

tsm topology filestore decommission

You must use the tsm topology filestore decommission command to prepare a file store node or nodes for safe removal. This command puts the specified nodes into read-only mode and ensures there is no unique content on the specified nodes.

If decommissioning results in a single file store node, you must use the --override option or the decommission will fail.

Synopsis

tsm topology filestore decommission --nodes <nodeID,nodeID,...> [options] [global options]

Options

-n, --nodes <nodeID,nodeID,...>

Required.

List of one or more nodes to decommission, specified by node ID and separated by commas.

--delete-filestore

Optional.

Forces the removal of the file store, even if it has not been decommissioned. You should only use this option if the node the file store is on is in a error state and decommissioning cannot be done. Any unique files on the node will be permanently deleted.

-o, --override

Optional.

Overrides warnings or failures that would normally occur if removing the target File Store node would reduce the number of remaining file store nodes to one.

--request-timeout <timeout in seconds>

Optional.

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

tsm topology filestore recommission

Use the tsm topology filestore recommission command to revert any decommissioned nodes back to read-write mode.

Synopsis

tsm topology filestore recommission --nodes <nodeID,nodeID,...> [global options]

Options

-n, --nodes <nodeID,nodeID,...>

Required.

List of one or more nodes to recommission, specified by node ID and separated by commas.

tsm topology nodes get-bootstrap-file

You can use the tsm topology nodes get-bootstrap-file command to get the bootstrap file that is required to add a new node to the cluster.

Important: The bootstrap file contains a copy of the master keystore file used for encrypting the configuration secrets. We strongly recommend that you take additional measures to secure the bootstrap file using mechanisms as described in Securing secrets for import and export operations.

Synopsis

tsm topology nodes get-bootstrap-file --file <path\file>.json [global options]

Options

-f,--file <file>

Required.

Full path and file name where the configuration file will be saved. If a duplicate file exists it will be overwritten.

 

tsm topology list-nodes

Display the nodes in the cluster and (optionally) the services on each node.

Synopsis

tsm topology list-nodes [options] [global options]

Options

-v, --verbose

Optional.

Shows each node ID, the node role (for more information, see set-node-role below), the node address, and the processes on each node.

 

tsm topology set-node-role

Set the Backgrounder node roles. This determines the type of tasks that Backgrounder will perform on the nodes. The following node roles are useful if you have a Tableau Prep Conductor license for your Tableau Server Deployment. For more information, see Tableau Prep Conductor.

Synopsis

tsm topology set-node-role [options] [global options]

Options

-n, --nodes <nodeID,nodeID,...>

Required.

List of one or more nodes to set node roles for, specified by node ID and separated by commas.

-r --role <all-jobs,flows,no-flows>

Required

Sets the role for the nodes specified. The valid values for this option are:

  • all-jobs: backgrounder will perform all types of jobs.
  • flows :backgrounder will perform flow run jobs.
  • no-flows: backgrounder will not perform flow run jobs.

tsm topology list-ports

Display the ports in the cluster.

Synopsis

tsm topology list-ports [options] [global options]

Options

--node-name <nodeID>

Optional.

Specify the node to list ports for.

--service-name

Optional.

Specify the service to list ports for.

 

tsm topology remove-nodes

Remove nodes from the cluster. Some scenarios require that you move or redeploy processes before removing nodes. See Remove a Node. If you remove a node and want to re-add it to the cluster, you need to first run the obliterate script to clean Tableau off it, then reinstall the node using the normal process for adding a new node. For more information, see Remove Tableau Server from Your Computer and Install and Configure Additional Nodes.

Note: To remove a node from a cluster it must have been configured with a process at some point in the past. If you are removing a node on which you've not configured any processes, then you must add a process on it, run tsm pending-changes apply, and then remove the node.

Synopsis

tsm topology remove-nodes --nodes <nodeID,nodeID,...> [global options]

Options

-n, --nodes <nodeID,nodeID,...>

Required.

Specify the node or nodes to remove. If specifying multiple nodes, separate node IDs with a comma.

 

tsm topology set-ports

Set the ports for a service instance.

Synopsis

tsm topology set-ports --node-name <nodeID> --port-name <port_name> --port-value <port_value> [options] [global options]

Options

-i, --instance <instance_id>

Optional.

Specifies the instance id of the service. Defaults to 0 (zero) if not specified.

-n, --node-name <nodeID>

Required.

Specifies the node ID of the node.

-pn, --port-name <port_name>

Required.

The name of the port to be set, in this format: service_name:port_type. If no port type is specified, the primary port is assumed. For port name syntax, see Dynamically mapped ports.

-pv, --port-value <port_value>

Required.

The port to set.

-r, --restart

Optional.

Suppress the prompt for restart and restart Tableau Server when necessary.

 

tsm topology set-process

Set the number of instances of a process on a node. If a node already has the specified process, the number is updated to match the specified count.

You can only set one process at a time. If you specify more than one process, any process after the first one will be silently ignored.

Note: For a complete list of process names, see Tableau Server Processes.

Synopsis

tsm topology set-process --count <process_count> --node <nodeID> --process <process_name> [global options]

Options

-c, --count <process_count>

Required.

The process count (number of instances) to set.

-n, --node <nodeID>

Required.

Specifies the node ID of the node on which to set the process.

-pr, --process <process_name>

Required.

The name of the process to be set.

 

tsm topology toggle-coordination-service

You can use the tsm topology toggle-coordination-service command to switch between coordination service ensembles. To learn more about Coordination Service ensembles, see Deploy a Coordination Service Ensemble .

Synopsis

tsm topology toggle-coordination-service [option] [global options]

Option

--request-timeout <timeout in seconds>

Optional.

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

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.