--- schema_version: "1" id: 403b2156001fd1963282bcd2a98ad32dfbbcefd04d6a403902c1cc9976c5ba57 title: tsm licences collection: tableau version: current locale: en-gb portal_url: https://docs.salesforce.com/tableau/current/en-gb/server-linux/cli_licenses_tsm.md canonical_url: https://help.tableau.com/current/server-linux/en-gb/cli_licenses_tsm.htm source_site: help.tableau.com content_type: documentation content_hash: 0470277d278ec1dfd19abbd76199a9173f4c7aa113194bdf9375f790553cbbe7 description: Reference for tsm licenses commands to activate, deactivate, and manage Tableau Server product keys. --- [Skip to main content](#main-content) # tsm licences 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](#TSMActivate) - [tsm licences atr-configuration get](#TSMAtr-configuration-get) - [tsm licences atr-configuration set](#TSMAtr-configuration-set) - [tsm licences deactivate](#TSMDeactivate) - [tsm licences get-offline-activation-file](#TSMActivateFile) - [tsm licences get-offline-deactivation-file](#TSMDeactivateFile) - [tsm licences list](#TSMLicenseList) - [tsm licences refresh](#TSMLicenseRefresh) ## tsm licences activate Activates a Tableau Server product key. ### Synopsis `tsm licenses activate --license-key [global options]` ### Options \-f, --license-file Required if doing offline activation. Specifies the licence file (.tlf) used for offline activation. \-k, --licence-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 [global options]` ### Options \--duration 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. ### Synopsis `tsm licenses deactivate --license-key [global options]` ### Options \-f, --license-file Required if doing offline deactivation. Specifies the licence file (.tlf) used for offline deactivation. \-k, --licence-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](https://help.tableau.com/current/server-linux/en-gb/activate_off.htm). **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 --output-dir [global options]` ### Options \-k, --licence-key Required. Specifies the product key to use for offline activation. \-o, --output-dir 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](https://help.tableau.com/current/server-linux/en-gb/deactivate_off.htm). ### Synopsis `tsm licenses get-offline-deactivation-file --license-key --output-dir [global options]` ### Options \-k, --licence-key Required. Specifies the product key to use for offline deactivation. \-o, --output-dir 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: ![List of four Tableau licences and details about their expiry dates.](/tableau/current/en-gb/server-linux/en-gb/Img/license_list.png) 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](https://help.tableau.com/current/server-linux/en-gb/dm_overview.htm). - **GUEST ACCESS**: Tableau Server is licensed for a Guest User. See [Guest User](https://help.tableau.com/current/server-linux/en-gb/users_guest.htm). 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](https://customer.tableausoftware.com/) 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](https://help.tableau.com/current/server-linux/en-gb/license_refresh.htm). Visit the Tableau [Customer Portal](https://customer.tableausoftware.com/) 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 in to Tableau Server to license their instance of Tableau Desktop or Prep, rather than entering a product key. For more information about LBLM, see [Login-based Licence Management](https://help.tableau.com/current/server-linux/en-gb/license_lblm.htm). - **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](https://help.tableau.com/current/server-linux/en-gb/itm_intro.htm). ### Synopsis `tsm licenses list [global options]` ## tsm licences refresh Update the maintenance expiration date of all product keys on Tableau Server. ### Synopsis `tsm licenses refresh [global options]` ## Global options \-h, --help Optional. Show the command help. \-p, --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://: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://:8850`. If no server is specified, `https://: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](https://help.tableau.com/current/server-linux/en-gb/tsm_overview.htm#Connecti). \-u, --username 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.