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

Restore from a Backup

Use the tabadmin restore command to restore your Tableau Server data. You might do this if you had a system failure and need to restore your data, if you need to switch back to a previous version of Tableau Server (for example, if there is a problem with an upgrade), or if you are moving Tableau Server to new hardware.

Before you begin

Only backups created using tabadmin backup, or created by the Tableau Server uninstall process can be used to restore Tableau Server data.

When you use tabadmin to restore your Tableau data, the contents of the PostgreSQL database, data extracts, and configuration files are overwritten with the content in the backup file (.tsbak). If you are running a distributed installation of Tableau Server, perform the restore on the primary node.

We recommend verifying the following before attempting a restore:

  • If you have made permission changes to the install directories, then verify that the Run As User account has access to the Tableau directories. See Verify Folder Permissions.

  • Antivirus software—Antivirus software that performs full drive scans can interfere with Tableau Server. In some cases, interference from antivirus software will prohibit Tableau Server from restoring properly. If you are running antivirus software on the computer running Tableau Server, follow the recommendations in the Knowledge Base.

  • Beginning with version 9.3, a verify_database command allows you to verify that your backup file does not have a hidden problem that will cause the restore to fail. If you have version 9.3 or later, verify the integrity of the backup using the tabadmin verify_databasecommand before you restore the database. For more information, see Verify the Tableau Postgres Database.

Restore Tableau Server from a backup file

  1. On the Tableau Server computer, open a command prompt as administrator.

  2. Go to the Tableau Server \bin folder, located here:

    C:\Program Files\Tableau\Tableau Server\<version>\bin

    Where <version> is your version of Tableau Server.

    For example, go to the Tableau Server 10.3 bin directory by typing the following:

    cd C:\Program Files\Tableau\Tableau Server\10.3\bin

  3. Stop the server:

    tabadmin stop
  4. Restore from a backup file:

    tabadmin restore <filename>

    In the above line, replace <filename> with the name of the backup file you want to restore from.

    Note: When restoring from a backup, Tableau Server prompts for the password of the Run As user account. You can type the password when prompted, or use a .txt file that contains only the password (if you are scripting the restore, for example).

    To restore only the data but no configuration settings (for example, if you are moving Tableau Server to a new computer), include the --no-config option:

    tabadmin restore --no-config <filename>
  5. Restart the server:

    tabadmin start
  6. If you ran the tabadmin assetkeys command at any time before you created the backup file that you're now restoring, run the following command:

    tabadmin assetkeys --validate 

    You'll be prompted to enter the passphrase needed to re-create the custom encryption keys in use in the backup file.

Note: When a restore completes successfully these folders are deleted automatically, but you may find extraneous folders if you have had restore failures. If Tableau Server is running correctly with all expected data, it's safe to remove any tabsvc.bak-* folders from ProgramData\Tableau\Tableau Server\data to free additional disk space. In Tableau Server clusters, tabsvc.bak-* folders are created on each machine running Tableau Server. Only remove the tabsvc.bak-* folders.

Do not remove the tabsvc folder, which is also located under ProgramData\Tableau\Tableau Server\data. It contains necessary Tableau Server data.

Providing the Run As user password in a file

Note:If you choose to store private information like passwords in a file, keep security considerations in mind. As a best practice we recommend you include a step in your process to remove the file after it is used to prevent unauthorized access.

When you restore from a backup, Tableau Server prompts you for the password of the Run As user account. If you are scripting the restore, you can provide the password in a .txt file that contains only the password.

For example, to restore to a new computer, use these commands:

tabadmin restore --no-config <backupfilename.tsbak> --password-file <passwordfile.txt>

tabadmin start

By default, Tableau Server looks in the bin folder for the password file. If you save the file in a different location, include the path for the file. For example:

tabadmin restore --no-config <backupfilename.tsbak> --password-file <c:\<location>\passwordfile.txt>

tabadmin start