Activate Tableau Server Using the Authorization-To-Run (ATR) Service

You can use the Server authorization-to-run (ATR) service to activate Tableau Server deployed in cloud or virtual environments without running out of license activations. The ATR service achieves this by providing short-term leases of configurable duration (ATR duration) that ties the license to the device until product key expiration date is met. ATR abstracts Tableau licensing from underlying hardware changes, which is common on virtual environments. This option is ideal for cloud-based or virtual environments, but is available to anyone who can activate their copy of Tableau Server online because Tableau Server needs to connect to various internet locations for licensing purposes. For more information, see Communicating with the Internet(Link opens in a new window).

Select this option if:

  • You plan to activate Tableau Server online
  • You plan to install Tableau Server in the cloud
  • You plan to install Tableau Server on a virtual machine or other non-persistent environment

Do not use this option if:

  • You plan to activate Tableau Server offline
  • You plan to install Tableau Server in an air-gapped environment

Selecting ATR for product activation is a permanent choice that cannot be easily undone. To change this later, you must backup, remove, and then reinstall Tableau Server.

Note: When using Server ATR with subscription licenses, you cannot refresh product keys in Tableau Server. To renew a subscription or make licensing changes, you must identify the new product key in the Tableau Customer Portal and activate it.

Select the Server ATR option

You can select the Server authorization-to-run (ATR) option when installing Tableau Services Manager (TSM) using the TSM web interface or the TSM CLI. For more information, see Install TSM(Link opens in a new window).

Set or change the Server ATR duration

When using Server authorization-to-run (ATR) to activate Tableau Server, you can change the ATR duration and use a setting different than the default of 432000 seconds (5 days). The ATR duration is the length of time that Tableau Server is authorized to run and will refresh while Tableau Services Manager (TSM) processes are up, requiring no new activation until the key(s) have reached their expiration date. If you're creating a test server or virtual machine (VM) that will have a short lifespan, you might want to shorten the ATR duration. Similarly, if you have a server that will remain for a long time, you might want to lengthen the ATR duration. The license refresh duration varies from hourly to daily, depending on the ATR duration. You should keep your Tableau Server running for at least 50 percent of the ATR duration. Otherwise if the Tableau Server is left shut down too long, you may need to reapply your license.

To change the ATR duration, you use the tsm licenses atr-configuration set –duration <value_in_seconds> command. For more information, see tsm licenses atr-configuration set(Link opens in a new window).

ATR duration in seconds Minimum Maximum Default
Tableau Server (container) 3600 (1 hour) 2593000 (30 days) 14400 (4 hours)
Tableau Server (non-container) 14400 (4 hours) 7776000 (90 days) 432000 (5 days)

To set ATR duration and manually start the Administration Controller Manager, run the following commands:

  1. On the initial node, open a terminal session, and they use the following commands:

  2. tsm licenses atr-configuration set -–duration <value_in_seconds>

  3. tsm pending-changes apply

  4. sudo su -l tableau

  5. systemctl --user stop tabadmincontroller_0

  6. systemctl --user start tabadmincontroller_0

  7. Verify that the controller is running by using the tsm status -v command. Tableau Server Administration Controller should be listed as "is running". If the Administration Controller Manager is not started, then run:

    systemctl --user restart tabadmincontroller_0

Move a Server ATR license to another Tableau Server

If you want to stop using your license on an existing Tableau Server and use it on a new installation of Tableau Server, you can move your Server ATR license. You might want to move licenses when:

  • Switching between development or pre-production environments.

  • Moving Tableau Server to upgraded hardware.

  • Moving Tableau Server to cloud infrastructure.

  • Using an ephemeral Tableau Server, such as a virtual machine (VM) or container.

How do ATR leases work?

When you sign into Tableau Server and activate it using your product key, your ATR lease remains active as long as the Administration Controller, also called the TSM Controller, and the Activation Service are running. If you stop using Tableau Server, such as when you shut down the computer where Tableau Server is installed, you are automatically logged out and the ATR lease expires. Tableau reclaims the license and frees the capacity for new use after the ATR lease duration has elapsed.

Activate the same license on another Tableau Server

You can have one production and two non-production installations per license. If you have unused activations on a license, you can activate the same license on another Tableau Server. If you’re out of activations, you can still activate the license after its lease expires.

  1. You have an existing Tableau Server that is licensed using Server ATR.

  2. Stop the existing Tableau Server from refreshing its leased activation. You can do this using any of the following methods:

    • Shut down your existing Tableau Server.

    • Uninstall the existing Tableau Server.

    • Disconnect the existing Tableau Server from the Internet by unplugging the ethernet cable or disconnecting wifi.

  3. After the ATR lease expires, you can reuse the license on another Tableau Server.

  4. On the new computer, install Tableau Server.

    When prompted, activate Tableau Server using the same license.

Remove product keys that were activated using Server ATR

You can remove product key(s) that were activated using Server ATR when you want to reclaim license capacity from one Tableau Server installation and use it on another. This procedure removes all product keys activated using Server ATR on the specified Tableau Server. Before you begin, view license details for Server ATR product keys by running the atrdiag -product "Tableau Server"(Link opens in a new window) command.

Note: If your Tableau Server is in a container, use the -container option with each atrdiag command. For example, atrdiag -product "Tableau Server" -container. For more information about Tableau Server in a container, see Tableau Server in a Container(Link opens in a new window).

  1. On the initial node, open a terminal session, and they use the following commands:

  2. Login as user "Tableau":

    sudo su -l tableau

  3. Stop Administration Controller Manager (tabadmincontroller):

    systemctl --user stop tabadmincontroller_0

  4. Use the following atrdiag(Link opens in a new window) command to view activated product keys and locate the UUID.

    atrdiag -product "Tableau Server"

  5. Copy the UUID field from the top of the ATRDIAG output to delete the ATR lease containing all activated product keys.

    Note: You cannot remove an individual product key from an ATR lease.

    atrdiag -deleteATR <UUID> -product "Tableau Server"

  6. Start Administration Controller Manager (tabadmincontroller) if it isn't already running:

    systemctl --user start tabadmincontroller_0

  7. Activate(Link opens in a new window) a new set of product keys.

  8. Restart Tableau Server.

Stop using Server ATR for activation

If you no longer want to use the Server ATR activation method for a specific Tableau Server, you must perform a backup, delete the existing Tableau Server, install a new Tableau Server, and then restore from backup.

  1. Perform a full backup of your Tableau Server. For more information, see Perform a Full Backup and Restore of Tableau Server(Link opens in a new window).

  2. Completely remove Tableau Server using the tableau-server-obliterate script with the -l option. For more information, see Remove Tableau Server from Your Computer(Link opens in a new window).

  3. Install and configure Tableau Server. When installing TSM, on the Product Activation page, clear the Use ATR for product activation check box. For more information, see Install and Configure Tableau Server(Link opens in a new window).

  4. Restore from backup. For more information, see Perform a Full Backup and Restore of Tableau Server(Link opens in a new window).

Thanks for your feedback!