Upgrade from Tableau Server 2018.1.x or Earlier in a Non-Default Location (Windows)

Using this topic to upgrade Tableau Server on Windows

This topic applies to upgrades of Tableau Server on Windows with these specific characteristics:

  • You are currently running Tableau Server 2018.1.x or earlier
  • Tableau Server is installed to a non-default location
  • You are upgrading to version 2019.4.0 through 2019.4.4
    or
    You are upgrading to version 2020.1.0 through 2020.1.1

If your deployment does not meet these criteria, see Upgrade Tableau Server Overview to determine the correct instructions for your upgrade.

Upgrading to Server with Tableau Services Manager (TSM)

Beginning with version 2018.2, Tableau Server on Windows now uses 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 details about 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 10.5 and 2018.1. For instructions on how to determine your version of Tableau Server, see View Server Version.

Before you upgrade

Upgrading a server-based product requires planning and preparation. Upgrading Tableau Server from version 2018.1 or earlier to version 2019.4 or later is no different. Before you upgrade your production environment, make sure you have read through and completed the following sections: Upgrading (Tableau Blueprint)(Link opens in a new window), Preparing for Upgrade, and Verify Tableau Server Upgrade.

As a best practice, you should always make a backup of your Tableau Server data before upgrading, and save this backup in a safe place that is not part of your Tableau installation. This backup preserves your Tableau data if something unexpected happens during the upgrade, or if you need to go back to your previous version of Tableau Server. For more information, see Back up Tableau Server data.

Key Upgrade Aspects

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

  • Local security policy—Verify that your local security policy will allow "log on as a service" and "log on locally" permissions for the Run As service account. For details, see Verify the Local Security Policy.

  • Run As—Read and understand these Run As service account requirements: Required Run As Service Account Settings.

  • Windows Accounts and Permissions—Read and understand these Windows account requirements: Windows Accounts and Permissions.

  • Ports—Before upgrading, read and understand the requirements for ports: Tableau Services Manager Ports.

  • Licenses

    • 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 Server Upgrade - Verify Licensing Status.

    • 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. For more information about refreshing your product key in a version earlier than 2018.2.0, see Refresh Maintenance Date for the Product Key(Link opens in a new window). 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 upgrades from 2018.1 or earlier to 2018.2 or later.

  • 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 Preparing for Upgrade.

    Backups from versions of Tableau Server older than version 9.x cannot be used with version 2018.2.x or later. If you are running an older version of Server, you may need to do an intermediate upgrade to version 9.x through 10.x before upgrading to version 2018.2 or later.

  • 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. The script is installed in the \scripts.<version_code> folder of the new version you just installed. By default: C:\Program Files\Tableau\Tableau Server\packages\scripts.<version_code>\

    Tableau Server must be stopped to complete the upgrade. If Tableau Server is not stopped when you run the script, the script will let you know, and will offer to stop the server. You can also choose to stop the server before running the script using the tsm stop command.

  • Antivirus software—Antivirus software that scans directories used by Tableau Server can interfere with installation and ongoing use of Tableau Server. In some cases, this can result in installation failures, problems starting Tableau Server, or impacts to performance. If you plan to run antivirus software on the computer running Tableau Server, follow the recommendations in the Knowledge Base(Link opens in a new window).

Multi-node upgrades:

  • Multi-node terminology—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.

  • 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.0, there is no automatic upgrade of any additional nodes.

  • Single installer—Use the same Setup program on all nodes. Starting with 2018.2.0 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 on the initial node in the cluster.

    Tableau Server must be stopped to complete the upgrade. If Tableau Server is not stopped when you run the script, the script will let you know, and will offer to stop the server. You can also choose to stop the server before running the script using the tsm stop command.

 

Run As User Format

Confirm your Run As user format includes the domain

Tableau Server installations default to using the local Network Service account (NT Authority\Network Service) for the Run As user. If you are using this default account you can skip this section. If you changed the default account, or if you are not certain whether you are using a custom Run As user, follow the steps below.

Before upgrading to version 2018.2 or higher, make sure your Run As user is in the correct format. The format should include the domain, like this: <domain>\<runasuser>

  1. Stop the server by selecting All Programs > Tableau Server <version> > Stop Tableau Server on the Windows Start menu.

  2. Select Configure Tableau Server on the Windows Start menu.

  3. If you are using an Active Directory account for the server’s Run As User account, enter its password on the General tab.

  4. Confirm the format of your Run As User account:

    • If the Run As user is "NT AUTHORITY\NetworkService" you are using the default and do not need to make any changes. Cancel out of the configuration utility.

    • If the user name include the domain, you do not need to make any changes. Cancel out of the configuration utility.

    • If the user name does not include the domain, add the domain at the beginning of the user name, and separate the domain from the name using a back slash (\).

      For example, if the Server Run As User is "TableauServer" in the "MYCO" domain, update the User field to this: MYCO\TableauServer.

  5. Click OK.

  6. Restart the server.

Existing Files

Gather existing files

You will need to gather the following files from your existing Tableau Server deployment. Later, at the end of the upgrade process, you will need to upload these files to complete the upgrade.

Some of these files contain secrets that must be protected. Use a secure process to copy, store, and transport these files.

  • Custom logos If you have customized the Tableau Server portal with custom images, then you will need copies of these files for the upgrade.

    For more information, see the Tableau Server 2018.1 online help topic, Change the Name or Logo(Link opens in a new window).

  • SAML files. You will need the SAML certificate, key, and IdP metadata file. The default location for these files is C:\Program Files\Tableau\Tableau Server\SAML.

    For more information, see the Tableau Server 2018.1 online help topic, Configure SAML(Link opens in a new window).

  • Kerberos keytab file. If you've enabled Kerberos SSO for Tableau Server, then you will need the keytab file that was generated as part of that configuration.

    For more information, see the Tableau Server 2018.1 online help topic, Kerberos Configuration Script(Link opens in a new window).

  • SSL

    • CA cert file. If your existing Tableau Server is configured for mutual SSL, you will need to resubmit the CA cert file. The default location for these files is C:\Program Files\Tableau\Tableau Server\SSL.

    • Certificate and key files. You do not need to do anything with these files. These files are automatically upgraded.

  • Open ID file. If your organization uses a static discovery file (instead of an online discovery file), you will need a copy of that file for upgrade.

    For more information, see the Tableau Server 2018.1 online help topic, Configure Tableau Server for Open ID Connect(Link opens in a new window).

Upgrade steps

When you upgrade from a pre-TSM version of Tableau Server on Windows (version 2018.1.x or earlier) to version 2019.4, the steps you follow depend on which version you are upgrading to:

  • Upgrading from 2018.1.x or earlier to 2019.4.0.
  • Upgrading from 2018.1.x or earlier to 2019.4.1 through 2019.4.4 or 2020.1.0 through 2020.1.1

Choose the appropriate section below.

Upgrade single node Tableau Server from pre-TSM to 2019.4.0 (Windows, non-default location only)

Upgrade a single node Tableau Server from version 2018.1.x or earlier to version 2019.4.0 (non-default location only)

Upgrade to 2019.4.0 in stages - If you have Tableau Server version 2018.1.x or earlier installed to a non-default location and are upgrading to version 2019.4.0, you must upgrade in stages, first to a version of Tableau Server on Windows with TSM (version 2018.2.x through 2019.3.x) and then again to version 2019.4.0. We recommend you upgrade to version 2019.3.x, but upgrading to any TSM version prior to 2019.4 will allow you to then successfully upgrade to version 2019.4. In the steps below we assume you are upgrading to 2019.3.

  1. Upgrade to version 2019.3. Follow the steps in the 2019.3 Tableau Server on Windows documentation for upgrading to version 2019.3. Upgrade from Tableau Server 2018.1.x or Earlier (Windows)(Link opens in a new window) (this link opens an instance of the 2019.3 Help with instructions for upgrading to that version).

    After you upgrade to 2019.3, proceed to the next step.

  2. When you have confirmed that Tableau Server is running as expected, and your data is accessible, you can follow the instructions in Upgrading from 2018.2 and Later (Windows) in this Help.

Upgrade single node Tableau Server from pre-TSM to 2019.4.1 through 2019.4.4 or 2020.1.0 through 2020.1.1 (Windows, non-default location only)

Upgrade a single node Tableau Server from version 2018.1.x or earlier to version 2019.4.1 through 2019.4.4 or 2020.1.0 through 2020.1.1 (non-default location only)

If you have Tableau Server version 2018.1.x or earlier installed to a non-default location and are upgrading to version 2019.4.1 through 2019.4.4 or 2020.1.0 through 2020.1.1, you have two upgrade options:

  • Upgrade in stages—You can first upgrade to a version of Tableau Server on Windows with TSM (version 2018.2.x through 2019.3.x) and then upgrade to version 2019.4.1 or later. We recommend you upgrade to version 2019.3.x, but upgrading to any TSM version prior to 2019.4 will allow you to then successfully upgrade to version 2019.4.1 or later. To do this, follow the steps above: Upgrade single node Tableau Server from pre-TSM to 2019.4.0 (Windows, non-default location only).

  • Upgrade on the command line—You can upgrade directly to version 2019.4.1 through 2019.4.4 or 2020.1.0 through 2020.1.1, you run the Setup program from the command line. The steps below provide detailed instructions.

Upgrade to version 2019.4.1 through 2019.4.4 or 2020.1.0 through 2020.1.1 on the command line

  1. Confirm that your product key and maintenance are valid for the version you are updating to, and that you have refreshed the product key before upgrading. See the Licenses section above for details. If you do not have a valid product key with active maintenance, your upgrade will fail.

  2. Uninstall your existing version.

    After confirming that the Manage Product Keys application is not open, use Windows Control Panel to uninstall Tableau Server. Unlike earlier versions of the Setup program, version 2018.2 and later will not uninstall the previous version.

    Uninstalling will create a backup of your data and stop Tableau. Your data directories are left in place.

    The backup file created by the uninstall is used later, for the upgrade, and is saved as "uninstall-<version>.tsbak" in the Tableau data directory, by default: C:\ProgramData\Tableau\Tableau Server.

    Important: Save a copy of the backup on a different computer. This ensures you have the backup if something goes wrong on the Tableau Server computer. Creating and saving a backup to a non-Tableau location is a best practice step you should always take.

  3. Run the Setup program for your new version 2019.4.1 or later from the command line:

    1. Open a command prompt as an administrator and change to the folder where you downloaded the Setup program for your new version.
    2. Run this command. The DATADIR and INSTALLDIR property names must be typed in uppercase. Do not include the version number in the path.

      TableauServer-64bit-<version>.exe DATADIR="<drive:\path\to\data directory>" INSTALLDIR="<drive:\path\to\install\directory>"

      For example, if your existing installation was to D:\Applications\Tableau Server\2018.1:

      c:\Users\bsmith\Downloads>TableauServer-64bit-2019-4-1.exe DATADIR="D:\Applications\Tableau Server" INSTALLDIR="D:\Applications\Tableau Server"

      This will start the Setup program.

  4. When prompted to "Select a type of install", your install directory should be shown (without the version folder).

    Confirm that Upgrade Tableau Server. If multi-node, upgrade primary node of existing cluster. is selected (this is the default):

    Important: If you do not see Upgrade options for install type, you may not have correctly specified the data and install directories for your previous version. Do not continue the install or your new version will not include your data. Cancel out of the Setup by clicking the "X" in the upper right corner, and locate your backup file created by uninstalling the earlier version. This file is saved in the data directory. Rerun the above command with the corrected paths.

  5. Click Next to continue.

    If you are prompted by Windows Defender Firewall, click Allow access. You may need to do this multiple times for the installation to complete.

  6. When the installation is done, the last page of the Setup program tells you that the upgrade is not yet finished. You need to run an upgrade script to complete the upgrade. You can run the script from the Setup program, or run it yourself from the command line.

  7. Run the upgrade script in one of two ways.

    • 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. If your old installation of Tableau Server used a non-default Run As user, you will also be prompted for the Run As user password.

        The upgrade script will look for the backup file created by the uninstall of the previous version in the Tableau data folder (C:\ProgramData\Tableau\Tableau Server). You can specify a backup file in a different location using a --backup-path option but to do this you need to run the script from the command line.

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

    • On the command line:

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

      2. Navigate to the scripts folder for your new installation.

        By default:

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

      3. Run the upgrade script:

        upgrade-tsm

        The script will assume a location for a backup file from your previous installation, and prompt you for passwords:

        • By default the upgrade script will look for the backup file created by the uninstall of the previous version in the Tableau data folder (C:\ProgramData\Tableau\Tableau Server). You can specify a different location using a --backup-path option. For example:

          upgrade-tsm --backup-path "C:\path\to\backup\file\uninstall-10.5.tsbak"

        • 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 when you run the script using --username and --password options.

        • If your old installation of Tableau Server used a non-default Run As user, you will also be prompted for the Run As user password. You can provide this when you run the script using a --service-runas-password option.

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

  8. When the upgrade is complete, a browser window will open with the TSM sign in page. Sign in to TSM. You will be prompted to activate or register Tableau Server if these steps are needed.

    If the window does not open automatically, open a browser window and go to:

    https://<tsm-computer-name>:8850
  9. Start Tableau Server.

    • In the Web UI:

      • Click Tableau Server is stopped, and Start Tableau Server

    • On the command line:

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

      2. Navigate to the bin directory for your new installation. By default this is:

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

      3. Start Tableau Server:

        tsm start

  10. Upload files. Use the following TSM commands to upload files from your previous Tableau Server. The files must be uploaded with TSM. Do not copy them to destinations in the Tableau Server folder hierarchy. Instead, copy them to a temporary directory (for example, C:\temp) and then run the TSM commands to copy them into the system.

    • Custom logo files. If you have customized the Tableau Server portal with custom images, run the following command:

      tsm customize --header-logo <file> --signin-logo <file> --logo <file>

    • SAML files. Run the following command for SAML SSO:

      tsm authentication saml configure --cert-file <file> --key-file <file> --idp-metadata <file>

      If you are using SAML for datasource delegation, run the following command:

      tsm data-access set-saml-delegation --cert-file <file> --key-file <file>

    • Kerberos. Run the following commands:

      tsm authentication kerberos configure --keytab-file <file>

      tsm authentication kerberos enable

    • Mutual SSL files. Follow the instructions here:

      Configure Mutual SSL Authentication(Link opens in a new window)

    • Open ID file. Run the following command:

      tsm authentication openid configure --metadata-file <file>

    If you run any of the above commands, you also need to apply pending changes:

    tsm pending-changes apply

Upgrade a multi-node Tableau Server from pre-TSM to 2019.4.1 (Windows, non-default location only)

Upgrade a multi-node Tableau Server from version 2018.1.x or earlier to version 2019.4.1 through 2019.4.4 or 2020.1.0 through 2020.1.1
  1. Confirm that your product key and maintenance are valid for the version you are updating to, and that you have refreshed the product key before upgrading. See the Licenses section above for details. If you do not have a valid product key with active maintenance, your upgrade will fail.

  2. Uninstall your existing version.

    After confirming that the Manage Product Keys application is not open, use Windows Control Panel to uninstall Tableau Server. Unlike earlier versions of the Setup program, version 2018.2 and later will not uninstall the previous version.

    Uninstalling will create a backup of your data and stop Tableau. Your data directories are left in place.

    The backup file created by the uninstall is used later, for the upgrade, and is saved as "uninstall-<version>.tsbak" in the Tableau data directory, by default: C:\ProgramData\Tableau\Tableau Server.

    Important: Save a copy of the backup on a different computer. This ensures you have the backup if something goes wrong on the Tableau Server computer. Creating and saving a backup to a non-Tableau location is a best practice step you should always take.

  3. When Tableau Server is uninstalled on the primary node, use Control Panel to uninstall Tableau on all worker nodes before continuing.

  4. Run the Setup program for your new version 2019.4.1 or later from the command line on your initial (old primary) node:

    1. Open a command prompt as an administrator and change to the folder where you downloaded the Setup program for your new version.
    2. Run this command. The DATADIR and INSTALLDIR property names must be typed in uppercase. Do not include the version number in the path.

      TableauServer-64bit-<version>.exe DATADIR="<drive:\path\to\data directory>" INSTALLDIR="<drive:\path\to\install\directory>"

      For example, if your existing installation was to D:\Applications\Tableau Server\2018.1:

      c:\Users\bsmith\Downloads>TableauServer-64bit-2019-4-1.exe DATADIR="D:\Applications\Tableau Server" INSTALLDIR="D:\Applications\Tableau Server"

      This will start the Setup program.

  5. When prompted to "Select a type of install", your install directory should be shown (without the version folder).

    Confirm that Upgrade Tableau Server. If multi-node, upgrade primary node of existing cluster. is selected (this is the default):

    Important: If you do not see Upgrade options for install type, you may not have correctly specified the data and install directories for your previous version. Do not continue the install or your new version will not include your data. Cancel out of the Setup by clicking the "X" in the upper right corner, and locate your backup file created by uninstalling the earlier version. This file is saved in the data directory. Rerun the above command with the corrected paths.

  6. Click Next to continue.

    If you are prompted by Windows Defender Firewall, click Allow access. You may need to do this multiple times for the installation to complete.

    When the installation is done, the last page of the Setup program tells you that the upgrade is not finished. You need to run an upgrade script to complete the upgrade. Do not run the upgrade script yet. You need to generate a bootstrap file and use this when you install the other nodes.

    Only after you have installed your new version on all nodes will you run the script.

  7. Generate a bootstrap file

    Generate the bootstrap file on the initial node:

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

    2. Navigate to the bin directory for your new installation. By default this is:

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

    3. Generate the bootstrap file:

      tsm topology nodes get-bootstrap-file -f <path\file>.json

    4. Copy the bootstrap file to each additional (worker) node, or to a network location accessible to the nodes.

  8. Copy the bootstrap file to each additional (worker) node, or to a network location accessible to the nodes.

  9. On every additional (worker) node, run Setup from the command line to install the new version of Tableau Server:

    1. Open a command prompt as an administrator and change to the folder where you downloaded the Setup program for your new version.
    2. Run this command. The DATADIR and INSTALLDIR, property names must be typed in uppercase. Do not include the version number in the path.

      TableauServer-64bit-<version>.exe DATADIR="<drive:\path\to\data directory>" INSTALLDIR="<drive:\path\to\install\directory>"

      For example, if your existing installation was to D:\Applications\Tableau Server\2018.1 and your bootstrap file is in your download directory:

      TableauServer-64bit-2019-4-1.exe DATADIR="D:\Applications\Tableau Server" INSTALLDIR="D:\Applications\Tableau Server"

      This will start the Setup program.

  10. When prompted to "Select a type of install", your install directory should be shown (without the version folder).

    Select Upgrade worker node of existing Tableau Server cluster (only applies to multi-node):

    Important: If you do not see Upgrade options for install type, you may not have correctly specified the data and install directories for your previous version. Do not continue the install or your new version will not include your data. Cancel out of the Setup by clicking the "X" in the upper right corner, and locate your backup file created by uninstalling the earlier version. This file is saved in the data directory. Rerun the above command with the corrected paths.

  11. Click Install to continue.

    If you are prompted by Windows Defender Firewall, click Allow access. You may need to do this multiple times for the installation to complete.

  12. When prompted:

    1. Navigate to the location of the bootstrap file you copied.

    2. Enter the username and password for a user who has administrative rights on the computer where the bootstrap file was created (for example, the TSM administrator who created the bootstrap file).

    Click Next to continue.

  13. When the node installation completes, a dialog tells you the upgrade is not yet complete:

    Click OK to close the dialog.

  14. After you install the new version on all nodes, run the upgrade script on the initial node:

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

    2. Navigate to the scripts folder for your new installation.

      By default:

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

    3. Run the upgrade script:

      upgrade-tsm

      The script will assume a location for a backup file from your previous installation, and prompt you for passwords:

      • By default the upgrade script will look for the backup file created by the uninstall of the previous version in the Tableau data folder (C:\ProgramData\Tableau\Tableau Server). You can specify a different location using a --backup-path option. For example:

        upgrade-tsm --backup-path "C:\path\to\backup\file\uninstall-10.5.tsbak"

      • 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 when you run the script using --username and --password options.

      • If your old installation of Tableau Server used a non-default Run As user, you will also be prompted for the Run As user password. You can provide this when you run the script using a --service-runas-password option.

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

  15. When the upgrade is complete, a browser window will open with the TSM sign in page. Sign in to TSM. You will be prompted to activate or register Tableau Server if these steps are needed.

    If the window does not open automatically, open a browser window and go to:

    https://<tsm-computer-name>:8850
  16. If you install a total of three or more nodes, you should also deploy a Coordination Service ensemble. If you do not, you will get a warning message every time you make changes to the server configuration or topology. You can ignore this message, but as a best practice you should deploy a multi-node Coordination Service ensemble.

    When you install Tableau Server, a single instance of the Coordination Service is installed on the initial node. TSM and Tableau Server depend on the Coordination Service to function properly, so to provide redundancy and ensure availability on multi-node installations, configure additional instances of the Coordination Service by deploying a Coordination Service ensemble. Coordination Service ensembles are installed with one, three, or five instances of the Coordination Service. In a three-node installation of Tableau Server, the recommended number of Coordination Service instances is three, one on each node.

    For detailed instructions on deploying a Coordination Service ensemble, see Deploy a Coordination Service Ensemble .

  17. Start Tableau Server.

    • In the Web UI:

      • Click Tableau Server is stopped, and Start Tableau Server

    • On the command line:

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

      2. Navigate to the bin directory for your new installation. By default this is:

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

      3. Start Tableau Server:

        tsm start

  18. Upload files. Use the following TSM commands to upload files from your previous Tableau Server. The files must be uploaded with TSM. Do not copy them to destinations in the Tableau Server folder hierarchy. Instead, copy them to a temporary directory (for example, C:\temp) and then run the TSM commands to copy them into the system.

    • Custom logo files. If you have customized the Tableau Server portal with custom images, run the following command:

      tsm customize --header-logo <file> --signin-logo <file> --logo <file>

    • SAML files. Run the following command for SAML SSO:

      tsm authentication saml configure --cert-file <file> --key-file <file> --idp-metadata <file>

      If you are using SAML for datasource delegation, run the following command:

      tsm data-access set-saml-delegation --cert-file <file> --key-file <file>

    • Kerberos. Run the following commands:

      tsm authentication kerberos configure --keytab-file <file>

      tsm authentication kerberos enable

    • Mutual SSL files. Follow the instructions here:

      Configure Mutual SSL Authentication(Link opens in a new window)

    • Open ID file. Run the following command:

      tsm authentication openid configure --metadata-file <file>

    If you run any of the above commands, you also need to apply pending changes:

    tsm pending-changes apply

 

Thanks for your feedback! There was an error submitting your feedback. Please try again.