Was this page helpful?
Yes No
Tableau Help > Tableau Server on Windows Help > 

Tableau Server on Windows now includes Tableau Services Manager (TSM), which replaces the Configuration Utility and the command line tool. If you need help for an earlier version of Tableau Server, see the Tableau Help page.

Upgrade from Tableau Server 2018.1 or earlier to Tableau Server with TSM

Beginning with version 2018.2, Tableau Server on Windows is available with Tableau Services Manager (TSM). TSM is the web-based server configuration and management utility that replaces the Server Configuration utility and the tabadmin command line utility. The Tableau Server upgrade process has changed with the introduction of TSM. For information on how upgrade has changed, see Upgrade process changes.

When you upgrade from a pre-TSM version of Tableau Server (2018.1 or earlier) to a version running with TSM, you need to go through some special upgrade steps. These are required only for the pre-TSM to TSM upgrade. Pre-TSM versions of Tableau Server on Windows are versions older than 2018.2. Examples of pre-TSM versions are 9.3, 10.5, and 2018.1.

Note: With TSM, we've changed the language we use to describe the Tableau Server nodes in a distributed installation. Prior to the release of TSM we referred to the first node as the "primary" node, and any additional nodes as "worker" nodes. With TSM the nodes are more closely peers, so we refer to the first node as the "initial" node, and other nodes as "additional" nodes.

Before you upgrade

Upgrading a server-based product requires planning and preparation. Upgrading Tableau Server from version 2018.1 or earlier to version 2018.2 or later is no different. Before you upgrade your production environment, make sure you have read through and completed the following sections: Research the Upgrade, Prepare for the Upgrade, and Test the Upgrade.

As a best practice, you should always make a backup of your Tableau Server data before upgrading. This backup is necessary in the event that something unexpected happens during the upgrade, or if you need to roll back to your previous version of Tableau Server. If you create this backup yourself, you can do it while Tableau Server is running.

Understand the key aspects of upgrading to TSM

Below are key aspects of upgrading Tableau Server from version 2018.1 or earlier to version 2018.2 that you need to be aware of.

All upgrades:

  • Local administrator—Sign in as a local administrator. You need to be signed into the Tableau Server computer as a "local admin" to run the Tableau Server Setup program, and to run scripts related to upgrading. A "local admin" is a user who's a member of the Administrators group in the Local Users and Groups management console in Windows.

  • Licensing

    • Trial product keys—You cannot directly upgrade a server that is running a trial product key from one major version to another (for example, from version 10.5.x to version 2018.x). To upgrade from one major version to another with a trial product key, install the new version of Tableau Server on a separate machine, activate a trial key there, and restore a backup from your existing version. For more information, see Confirm licensing requirements.

    • Expired maintenance—You cannot upgrade a server with a product key whose maintenance has expired or expires on a date earlier than the release date of the version you are upgrading to. If you attempt to upgrade a server in this state, your server will be unlicensed and the upgrade may fail. If your maintenance has expired or is too old, use the Manage Product Keys application to refresh your product key before you uninstall your original version. If refreshing the key does not update maintenance to a valid date, check in the Tableau Customer Portal for a Tableau Server key with current maintenance.

  • Uninstall—Use Windows Control Panel to uninstall your existing pre-TSM version of Tableau Server before upgrading. This special case upgrade is unlike upgrades in earlier versions, which automatically uninstalled the previous version of Tableau Server. When you upgrade from version 2018.1 or earlier to version 2018.2 or later, you must uninstall your earlier version yourself. If you have not uninstalled your earlier version, you will be prompted to do so when you attempt to install your new version. This is specific to the 2018.1 or earlier to 20182 or later upgrades.

  • Backup—Save a backup of your earlier version to a safe place on a different computer. Uninstalling your previous version of Tableau Server will create a backup in the Tableau data directory (by default: C:\ProgramData\Tableau\Tableau Server). We strongly recommend you copy this backup to a computer that is not part of your Tableau Server installation before upgrading. This provides you with an up-to-date version of your data you can use if you need to go back to your earlier version of Tableau Server. For more information on properly preparing for an upgrade, see Prepare for the Upgrade.

  • Firewall management—Firewall management is manual. Unlike earlier versions of Tableau Server, you must manage the local firewall on any computers where you run Tableau Server. For more information, see Local firewall configuration.

  • Upgrade script—After installing the new version, complete the upgrade and switch to the new version by running the upgrade-tsm.cmd script.

Multi-node upgrades:

  • Uninstall—Use Windows Control Panel to uninstall your existing pre-TSM version of Tableau Server from all nodes before upgrading. If you have not uninstalled your earlier version, you will be prompted to do so when you attempt to install your new version.

  • Node installation—Run the Setup program on all nodes in a cluster. Unlike some distributed installation upgrades in versions prior to 2018.2, there is no automatic upgrade of any additional nodes.

  • Single installer—Use the same Setup program on all nodes. Starting with 2018.2 you use the same installer on all nodes, and specify when prompted whether you are upgrading the initial (primary) node, or an additional (worker) node. There is no separate installer for the additional nodes.

  • Upgrade script—After installing the new version on all nodes in your cluster, complete the upgrade and switch to the new version by running the upgrade-tsm.cmd script.