Remove a Node

If your Tableau Server installation includes a node you no longer need, you can remove it to simplify your installation, and to free up the hardware resources on that node.

You cannot remove a node if:

  • It is running the only instance of the Repository. You need to move the Repository to another node before removing the original node. See Move the Repository Process.

  • It is running the only instance of the File Store. You need to move the File Store to another node before removing the original node. See Move the File Store Process.

  • It is running an instance of the Coordination Service. You need to redeploy a new Coordination Service ensemble that does not include the node before removing the node. See Deploy a Coordination Service Ensemble .

Important: Do not use the tableau-server-obliterate script to remove a node. First remove the node using the TSM UI or the tsm topology remove-nodes command. This leaves the rest of the cluster in a good state. Later, if you want to re-add the node to the cluster, run the tableau-server-obliterate script on the node to completely remove Tableau. After removing Tableau from the node, restart the computer and then re-add the node using the normal steps for adding and configuring a node. For details on running the script, see Remove Tableau Server from Your Computer.

  1. Open TSM in a browser:

    https://<tsm-computer-name>:8850

    For more information, see Sign in to Tableau Services Manager Web UI.

  2. Click the Configuration tab and, under the node you want to remove, click Remove Node:

    If a configuration limitation does not allow you to remove the node (if, for example, it includes a File Store that must first be decommissioned), a message will display letting you know this.

    Note: If you just added the node, and have not configured it, you must first apply pending changes before you can remove the node.

  3. Click Pending Changes at the top right, and Apply Changes and Restart.

Use the tsm topology remove-nodes command to remove a node from a cluster.

To remove a node from a cluster it must have been configured with a process at some point in the past. If you added a node using the CLI and want to remove it but have not configured any processes, you must add a process on it, run the tsm pending-changes apply command, and then remove the node. For example, you might add one instance of Cluster Controller to the node: tsm topology set-process -n <nodeID> -pr clustercontroller -c 1.

If you are removing a node you added using the Web UI, the Cluster Controller process is automatically added so you do not need to add it before removing the node.

Note: You need to take special steps if the node you are removing hosts the File Store or the Repository processes. You must have at least one instance of each of the processes in your Tableau Server installation, and you must add the second instance and allow it to synchronize with the first before you remove the process on the original node. For more information see Move the Repository Process and Move the File Store Process.

If the node you are removing is hosting the File Store or the repository, move those processes to another node before removing the node. For more information, see Move the File Store Process and Move the Repository Process.

  1. On the initial node, open a command prompt as administrator.

  2. Find the node ID for the node you are changing:

    tsm topology list-nodes -v

  3. Remove a node using the remove-nodes command.

    For example, to remove node2 from an existing cluster:

    tsm topology remove-nodes --node-names "node2"

  4. Apply the changes:

    tsm pending-changes apply

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