Multi-node Upgrade -- Run Upgrade Script

Upgrading Tableau Server on Windows from version 2018.1 or older requires special steps that are documented separately. For instructions for how to upgrade from a pre-2018.2 version, see Upgrade from Tableau Server 2018.1.x or Earlier (Windows).

This topic is part of the Tableau Server in-place upgrade scenario for upgrading from Tableau Server on Windows 2018.2 or later.

Run Upgrade script

  1. After you have installed the new version on every node in the cluster, run the upgrade script on the initial node. If Tableau Server is running, the script will let you know, and offer to stop it. Tableau Server must be stopped to run the upgrade script.

    If the final Setup screen is still open, you can select Automatically launch the upgrade script and a command window will open to run the script. Alternately, you can run the script directly from a command prompt.

    Note: Beginning in version 2020.4.0, if the upgrade script fails, details about the failure display in the command window and you can rerun the script to try the upgrade again. The script restarts at the point it failed. This saves time and is a good first step if your upgrade fails. For more information, see Upgrade fails on 2020.4.0 or later.

    • To run the upgrade script from the Setup program:

      1. Select Automatically launch the upgrade script and click OK:

      2. A command window will open for the script. Because you are logged in as a user with local administrator rights, the script will run using your credentials. If you are prompted, enter your password.

      Clicking OK will close the Setup program dialog. If you cleared the option to automatically launch the upgrade script, you will need to run the script manually, from the command line.

    • To run the upgrade script from a command prompt:

      1. Open a command prompt as administrator.

        You must open a new command window because the Setup program updates the path for the new installation.

      2. Navigate to the scripts directory for the new version you have just installed.

        By default:

        C:\Program Files\Tableau\Tableau Server\packages\scripts.<version_code>\

      3. Run the upgrade script:

        upgrade-tsm

        Because you are logged in as a user with local administrator rights, the script will run using your credentials. If you are prompted, enter your password. You can specify a different user and password using the --username and --password options.

        To see all options for the upgrade-tsm script, use the -h option:

        upgrade-tsm -h

      The upgrade script will take some time to complete.

  2. When the upgrade script completes, start Tableau Server. You can do this from the TSM web UI or from a command prompt:

    • In TSM, click Tableau Server is stopped, and Start Tableau Server:

    • From a command prompt:

      1. Open a new command prompt as administrator.
      2. Enter this command:

        tsm start

Continue to Verify Tableau Server Upgrade.

Thanks for your feedback!