Was this page helpful?
Yes No

tsm licenses

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

tsm licenses activate

Activates a Tableau Server product key.

Synopsis

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

Options

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

Required if doing offline activation.

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

-k, --license-key <product-key>

Required if activating a valid product key.

Specifies the product key to use for online activation.

-t, --trial

Required if activating a trial license.

Activate a trial license.

tsm licenses deactivate

Deactivates a Tableau Server product key either online or offline.

Synopsis

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

Options

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

Required if doing offline deactivation.

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

-k, --license-key <product-key>

Required if deactivating a product key.

Specifies the product key to use for online deactivation.

tsm licenses get-offline-activation-file

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

Synopsis

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

Options

-k, --license-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 licenses 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, --license-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 licenses list

List licenses on Tableau Server. The output reflects whether Tableau Server uses a user-based license, a core-based license, or a combination of the two. This command provides product keys, license expiration dates, maintenance expiration dates, and quotas for each type of user-based license. To learn more, see View Server Licenses.

Synopsis

tsm licenses list [global options]

 

tsm licenses 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 <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 <server address>

Optional.

Use the specified address for Tableau Services Manager. 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.