Tableau Server on Windows Help

You can use the tsm licenses commands to manage server licence tasks like activating or deactivating a Tableau Server product key on or offline, and getting associated files for offline activation or deactivation.

tsm licences activate

Activates a Tableau Server product key.

If the computer where you are running Tableau Server has been configured to connect to the internet through a forward proxy, follow the procedure in the topic, Configure Product Key Operations with Forward Proxy, before running this command.

Synopsis

tsm licenses activate --license-key <product-key> [global options]

Options

-f, --license-file <file.tlf>

Required if doing offline activation.

Specifies the licence file (<file>.tlf) used for offline activation.

-k, --licence-key <product-key>

Required if activating a valid product key.

Specifies the product key to use for online activation.

-t, --trial

Note: This option is only available in versions earlier than 2023.3.0. For trial licensing with later versions, contact your account representative.

Required if activating a trial licence.

Activate a trial licence.

tsm licences atr-configuration get

View the Server authentication-to-run (ATR) duration. The ATR duration is the length of time that Tableau Server is authorised to run before the licence must be renewed.

Synopsis

tsm licenses atr-configuration get --duration [global options]

Options

--duration

Displays the current authentication-to-run (ATR) in seconds. For example, 432000 (5 days).

tsm licences atr-configuration set

Set the Server authentication-to-run (ATR) duration. The ATR duration is the length of time that Tableau Server is authorised to run before the licence must be renewed.

Synopsis

tsm licenses atr-configuration set --duration <duration_in_seconds> [global options]

Options

--duration <duration_in_seconds>

Sets the authorisation-to-run (ATR) duration (in seconds). For example, 432000 (5 days).

tsm licences deactivate

Deactivates a Tableau Server product key either online or offline.

If the computer where you are running Tableau Server has been configured to connect to the internet through a forward proxy, follow the procedure in the topic, Configure Product Key Operations with Forward Proxy, before running this command.

Synopsis

tsm licenses deactivate --license-key <product-key> [global options]

Options

-f, --license-file <return_file.tlr>

Required if doing offline deactivation.

Specifies the licence file (<file>.tlf) used for offline deactivation.

-k, --licence-key <product-key>

Required if deactivating a product key.

Specifies the product key to use for online deactivation.

tsm licences get-offline-activation-file

Generate an offline activate file to use for activating Tableau Server offline. To learn more, see Activate Tableau Server Offline.

Note: You can only activate one product key at a time unless you're using Server ATR. With Server ATR, you can provide a comma-delimited list of product keys in the offline activation file to simultaneously activate multiple product keys.

Synopsis

tsm licenses get-offline-activation-file --license-key <product-key> --output-dir <path> [global options]

Options

-k, --licence-key <product-key>

Required.

Specifies the product key to use for offline activation.

-o, --output-dir <path>

Required.

The location where the offline activation file should be saved. This location must exist.

tsm licences get-offline-deactivation-file

Generate an offline deactivation file to use for deactivating Tableau Server offline. To learn more, see Deactivate Tableau Server Offline.

Synopsis

tsm licenses get-offline-deactivation-file --license-key <product-key> --output-dir <path> [global options]

Options

-k, --licence-key <product-key>

Required.

Specifies the product key to use for offline deactivation.

-o, --output-dir <path>

Required.

The existing location where the offline deactivation file should be saved.

tsm licences list

Lists licences that are activated on the Tableau Server deployment.

For example, a server with five Creator licences, five Explorer licenses, 100 Viewer licences and Data Management would provide command output similar to the following:

The following fields are returned:

• KEY: A globally unique 16-character string that identifies the licence.
• TYPE: Describes the type of licence
  • Term: Term licences map to a subscription schedule and must be renewed. The expiration date is listed under the LIC EXP field.
  • Perpetual: Perpetual licences are purchased once and do not need to be renewed but must be refreshed to update the MAINT EXP or maintenance expiration date.
  • Cores: Core licences are licences that map to the number of cores on the computers running specific Tableau Server services. Core licensing allows for a guest user access to views on the server or embedded on other web servers. Core licences also allow for unlimited Explorer and Viewer users.
• CREATOR: The number of Creator licences issued to the Tableau Server deployment.
• EXPLORER: The number of Explorer licences issued to the Tableau Server deployment.
• VIEWER: The number of Viewer licences issued to the Tableau Server deployment.
• DATA MANAGEMENT:Tableau Server is licensed with Data Management (True/False). See About Data Management.
• GUEST ACCESS: Tableau Server is licensed for a Guest User. See Guest User. The ability to leverage a Guest User requires Core licensing. See TYPE field.
• LIC EXP: The date that the licence expires and Tableau Server will stop working. Term licences expire. See TYPE field. Visit the Tableau Customer Portal(Link opens in a new window) to refresh licences.
• MAINT EXP: Applies only to legacy perpetual licences (TYPE = Perpetual). For Term licences, this field will output N/A. MAINT EXP displays the date that the maintenance contract for the Tableau Server deployment expires. To update the licence maintenance key see Refresh Expiration Date and Attributes for the Product Key. Visit the Tableau Customer Portal(Link opens in a new window) to view maintenance purchase history and to purchase additional maintenance.
• UPDATABLE: Specifies whether the licence is an updatable subscription licence (True/False).
• LBLM: Specifies if login-based licence management (LBLM) is enabled for the Tableau Server deployment (True/False). When enabled, LBLM allows users to log into Tableau Server to licence their instance of Tableau Desktop or Prep, rather than entering a product key. For more information about LBLM, see Login-based Licence Management.
• SERVER MANAGEMENT: Tableau Server is licensed for Advanced Management (formerly Server Management Add-on) (True/False). For more information about Advanced Management, see About Tableau Advanced Management on Tableau Server.

Synopsis

tsm licenses list [global options]

tsm licences refresh

Update the maintenance expiration date of all product keys on Tableau Server.

If the computer where you are running Tableau Server has been configured to connect to the internet through a forward proxy, follow the procedure in the topic, Configure Product Key Operations with Forward Proxy, before running this command.

Synopsis

tsm licenses refresh [global options]

Global options

-h, --help

Optional.

Show the command help.

-p, --password <password>

Required, along with -u or --username if no session is active.

Specify the password for the user specified in -u or --username.

If the password includes spaces or special characters, enclose it in quotes:

--password "my password"

-s, --server https://<hostname>:8850

Optional.

Use the specified address for Tableau Services Manager. The URL must start with https, include port 8850, and use the server name not the IP address. For example https://<tsm_hostname>:8850. If no server is specified, https://<localhost | dnsname>:8850 is assumed.

--trust-admin-controller-cert

Optional.

Use this flag to trust the self-signed certificate on the TSM controller. For more information about certificate trust and CLI connections, see Connecting TSM clients.

-u, --username <user>

Required if no session is active, along with -p or --password.

Specify a user account. If you do not include this option, the command is run using credentials you signed in with.