--- schema_version: "1" id: 68cccb94b93ca7a1c83209313c4d752f5d49df8e02778355f4e6f5c5a875f516 title: Automate Licensing Tasks collection: tableau version: next locale: en-gb portal_url: https://docs.salesforce.com/tableau/next/en-gb/server/license_automating.md canonical_url: https://help.tableau.com/v0.0/server/en-gb/license_automating.htm source_site: help.tableau.com content_type: documentation content_hash: 4e1cd19291b3becf79bc2e5bd779259a479ef315baa4df9147fd673d71583f66 description: Automate Tableau Server licensing tasks using command line tools and scripts. --- [Skip to main content](#main-content) # Automate Licensing Tasks Several command line options allow you to perform common licensing tasks for Tableau Server using automated scripts. If you want to perform these licensing tasks for Tableau Desktop using automated scripts, see [Deploy Tableau Desktop](https://help.tableau.com/current/desktopdeploy/en-gb/desktop_deploy_automate.htm) in the Desktop Deployment Guide. ## Command Line Tool Options and Better Script Automation You can use a utility called `tabinstallck.exe` to script the activation, refresh and deactivation of server product keys. `tabinstallck.exe` is installed in the Tableau Server \\bin directory on the initial node. By default, this is: `C:\Program Files\Tableau\Tableau Server\packages\bin.` You can also use `tsm licenses` to perform licensing tasks such as activating or deactivating a Tableau Server product key on- or off-line, and getting associated files for offline activation or deactivation. However, Tableau Server must already be deployed and configured. You can automate these licensing tasks using the [Tableau Services Manager API](http://onlinehelp.tableau.com/v0.0/api/tsm_api/en-gb/index.htm). In addition, `tabinstallck.exe` provides a way to script the licensing step for a new Tableau Server installation that is not completely configured. To use `tabinstallck.exe`, you need to run the commands or script as an administrator on the primary Tableau Server node. **Note**: `tabinstallck.exe` does not support offline activation and deactivation. To learn more, see [Activate Tableau Server Offline](https://help.tableau.com/v0.0/server/en-gb/activate_off.htm). ## Product key operations with forward proxy servers 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](https://help.tableau.com/v0.0/server/en-gb/activate_proxy.htm), before attempting to activate, refresh or deactivate product keys. ## Activate Activate a Tableau Server licence using the `-activate` option: start/wait tabinstallck.exe -activate ## Refresh Refresh a Tableau Server licence using the `-refresh` option: start/wait tabinstallck.exe -refresh ## Deactivate Deactivate a Tableau Server licence using the `-return` option: start/wait tabinstallck.exe -return ## Example An example of a script to activate Tableau Server might look like this: @echo off start/wait tabinstallck.exe -activate if %errorlevel% EQU 0 (ECHO SUCCESS) ELSE (ECHO FAILED) ## Error Handling When you use `tabinstallck.exe` to automate Tableau Server licensing tasks, status information is returned as an exit code in the ERRORLEVEL environment variable. If activation was successful, the exit code is `0` (zero). The table below lists exit codes from the activation process and what they mean. You can also find error information in the `tabinstallck.log` file. This log file is located in the Tableau Server \\logs folder, by default: `C:\ProgramData\Tableau\Tableau Server\data\tabsvc\logs\` The ProgramData folder is hidden by default. This example script shows how to activate Tableau Server and check for specific errors, such as an invalid product key (536871018) and general licensing issues (536871012). @echo off start/wait tabinstallck.exe -activate __ if %errorlevel% EQU 536871018 (ECHO TABLEAU\_ERROR\_LICENSING\_INVALID\_KEY) if %errorlevel% EQU 536871012 (ECHO TABLEAU\_ERROR\_LICENCING\_GENERAL) if %errorlevel% EQU 0 (ECHO SUCCESS)
Exit CodeMessageValue
536871012TABLEAU_ERROR_LICENSING_GENERALAn unknown error occurred during the licensing operation.
536871013TABLEAU_ERROR_LICENSING_INTERNALThe product is unable to start due to an internal licensing error.
536871014TABLEAU_ERROR_LICENSING_SETUPThe product is unable to start due to an internal licensing error.
536871015TABLEAU_ERROR_LICENSING_CONNECTAn error occurred contacting the Tableau licence server.
536871017TABLEAU_ERROR_LICENSING_ACTIVATION_ASRAn error occurred while activating the ASR.
536871016TABLEAU_ERROR_LICENSING_ACTIVATION_GENERALActivation failed, please try again.
536871018TABLEAU_ERROR_LICENSING_ACTIVATION_INVALID_KEYInvalid product key.
536871019TABLEAU_ERROR_LICENSING_ACTIVATION_OFFLINEUnable to complete offline activation.
536871020TABLEAU_ERROR_LICENSING_ACTIVATION_INVALID_MODELAn error was returned from the licence server. Check the Tableau log file for more information.
536871021TABLEAU_ERROR_LICENSING_ACTIVATION_MAX_REHOSTSFailed to deactivate the licence because you have reached the limit of deactivations for this licence.
536871033TABLEAU_ERROR_LICENSING_ACTIVATION_MAX_EXTRA_ACTIVATIONSFailed to activate the licence because you have reached the limit of activations for this licence.
536871022TABLEAU_ERROR_LICENSING_UNLICENSED_GENERALAn unknown error occurred during the unlicensing operation. Check your product key or contact support.
536871023TABLEAU_ERROR_LICENSING_UNLICENSED_NONE_FOUNDNo licences found.
536871024TABLEAU_ERROR_LICENSING_UNLICENSED_EXPIREDOnly expired product keys were found.
536871025TABLEAU_ERROR_LICENSING_UNLICENSED_EXPIRED_TRIALYour trial for this version has ended.
536871026TABLEAU_ERROR_LICENSING_UNLICENSED_EXPIRED_SUBSCRIPTIONThe product key is expired.
536871027TABLEAU_ERROR_LICENSING_UNLICENSED_EXPIRED_MAINTENANCEMaintenance has expired.
536871028TABLEAU_ERROR_LICENSING_RESYNC_GENERALYour product keys could not be synchronised.
536871029TABLEAU_ERROR_LICENSING_REGISTRATION_GENERALAn error occurred during product registration.
536871030TABLEAU_ERROR_LICENSING_SERVICE_INSTALLAn unknown error occurred during licensing operations.
536871031TABLEAU_ERROR_LICENSING_SERVICE_UNINSTALLAn unknown error occurred during licensing operations.
536871032TABLEAU_ERROR_LICENSING_SERVICE_NOT_PRESENTThe FLEXnet licensing service is not present on the system.