Backup and Restore with External File Store

If your Tableau Server is configured to run File Store externally, the backup and restore process is different than if you were running File Store locally. This topic describes the process of backup and restore when you have Tableau Server configured with External File Store.

Creating a snapshot of the network share

When you have External File Store enabled on your Tableau Server, you cannot use the tsm maintenance backup command to do a backup of the Tableau Server Repository and File Store Data. Instead, use the storage snapshot technology to create a point in time snapshot of your network share. However, before you can create the snapshot backup, you must first prepare Tableau Server for the snapshot backup and on completion resume Tableau Server normal processes.

Use the following steps to create a snapshot backup.

  1. Prepare for snapshot backup: Run the following command to create a repository backup file , and temporarily copy it to the network share. Server continues to operate normally during the backup process. Some internal processes will be paused during this time to ensure a consistent snapshot.

    tsm maintenance snapshot-backup prepare

    You should see a message that says 'Preparation for snapshot backup succeeded' to indicate that the preparation step is done.

    Check to make sure that the repository backup file was created on the network share.

  2. Create a snapshot of the network share: Use the snapshot technology of your network attached storage to create a snapshot of the network share. This snapshot will include both the File Store data and the repository backup file that was created in the previous step.

  3. Complete the backup process: Run the following command to complete the backup process in restart the paused internal processes. This also removes the repository backup file that was copied to your network share.

    Check to make sure that the temporary repository backup file was removed from the network share.

Backup Strategies:

The backup strategy you use depends on your recovery plan. The snapshot backup process may or may not be sufficient as it only creates a backup of the File Store and repository data. There are other configurations and settings that you might need to do a full recovery. Here are some scenarios that illustrate where the snapshot backup may or may not be enough:

  • You maintain a standby Tableau Server to use in case your production Server is down. In this scenario, creating a snapshot backup and restoring it to your standby server on a regular schedule might be sufficient. Your backup schedule should be according to your recovery point objective.

  • You plan to use a new Tableau Server installation in case of a disaster, but don’t necessarily need to use the configurations and settings from your existing Tableau Server installation. In this case, you can install a new Tableau Server, and use the snapshot to restore the data.
  • You don’t have a standby Tableau Server, but want to be able to create a new Tableau Server installation using the configurations and settings from your existing Tableau Server and restore the data. In this scenario, you would need more than the snapshot backup to install a new Tableau Server. To do a full backup including all the configurations and settings, follow these instructions:

    1. Export topology and configuration data. This exports majority of Tableau Server and the topology. For more information, see Perform a Full Backup and Restore of Tableau Server
    2. Create a snapshot of the network share to create a backup of the File Store and Repository data as described earlier in the Creating a snapshot of the network share section of this topic.

    3. Document the settings that are not included in the export. These are settings like system user accounts, coordination serviced deployment configuration, customized settings, and such. For more information, see Perform a Full Backup and Restore of Tableau Server.

Restoring a snapshot backup

The steps described below apply to both stand-alone and Tableau Server cluster.

  1. Stop Tableau Server. At the command prompt, run the following command:

    tsm stop

  2. Restore File Store data. Use the point in time snapshot that you want to recover to, and restore it to your shared file server. Once the restore is complete, Tableau Server is using the restored File Store data.

  3. Restore Repository Data. Use the following restore command to restore the repository data.

    tsm maintenance snapshot-backup restore

  4. Restart Tableau Server. At a command prompt, run the following command:

    tsm start

Who can do this

Tableau Server Administrators can backup and restore Tableau Server. In addition you must have permission to access and perform snapshot backups on the external storage.

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