Using the Tableau Content Migration Tool Console Runner

The Tableau Content Migration Tool includes a command line utility for running migrations, tabcmt-runner.exe, located in the installation folder. The default installation folder is %PROGRAMFILES%\Tableau\Tableau Content Migration Tool (32-bit Windows) or %PROGRAMFILES(x86)%\Tableau\Tableau Content Migration Tool (64-bit Windows).

Note: The tabcmt-runner.exe utility is not the same as the tabcmt.cmd command line utility which is used to configure the Content Migration Tool graphical application. For more information about tabcmt.cmd, see Using the Tableau Content Migration Tool Command Line Interface.

Usage:

  • tabcmt-runner [options] <plan_file.tcmx>
  • tabcmt-runner license --remove
  • tabcmt-runner license <new license key>
  • tabcmt-runner license <license file path> [--passphrase=<license file passphrase>]
  • tabcmt-runner encryption --reset
  • tabcmt-runner encryption <new_key>
  • tabcmt-runner improvement [on|off]
  • tabcmt-runner --help
  • tabcmt-runner --version

Options:

  • --version
  • --help
  • --quiet
  • --info
  • --logfile=VALUE
  • --src-user=VALUE
  • --src-password=VALUE
  • --dest-user=VALUE
  • dest-password=VALUE
  • --https=VALUE

Run Plan

Executes a migration plan immediately.

tabcmt-runner [options] <plan file>

Available options:

  • --logfile=<file name> sets the file name to log output to
  • --https=<secure|legacy> sets the HTTPS mode
  • --quiet disables logging to stdout
  • --src-user=<username> sets the username of the source Tableau Server connection
  • --src-password=<password> sets the password of the source Tableau Server connection
  • --dest-user=<username> sets the username of the destination Tableau Server connection
  • --dest-password=<password> sets the password of the destination Tableau Server connection

Exit codes:

  • 0 indicates that the migration was successful.
  • 1 indicates that the migration was successful but warning messages were logged.
  • 2 indicates that the migration failed. Specific errors will be included in the log output.

Show Plan Summary

Shows a summary of the migration plan and then exits.

tabcmt-runner --info <plan file>

help

Shows usage information for the command line utility.

tabcmt-runner --help

version

Shows the current application version information.

tabcmt-runner --version

encryption

Reset the encryption key, or specify a new one. You must specify the encryption key before using the tabcmt-runner utility, even if you already done so from the Content Migration Tool UI.

tabcmt-runner encryption <new_key> | --reset

improvement

Enables or disables collection of anonymous usage information by the application. This information is completely anonymous and is sent periodically to Tableau to help us improve Content Migration Tool.

Examples

Show whether the improvement program is enabled or disabled:

tabcmt-runner improvement

Enable or disable the improvement program:

tabcmt-runner improvement <on|off>

license

Note: This command is only applicable for legacy licenses.

Manages a legacy application license for the current user. When using a legacy key, to use the tabcmt-runner utility you must activate the license using this command, even if you already activated it from the Content Migration Tool UI.

Examples

Show the current license information:

tabcmt-runner license

Set/activate a serial key or offline license key:

tabcmt-runner license <key>

Remove/deactivate the current license:

tabcmt-runner license --remove

Set/activate using a license file:

tabcmt-runner license <file path> [--passphrase=<password>]

Who can do this

To use the console runner, you must have all the following:

  • Administrator permissions on the Content Migration Tool machine.
  • Tableau Server user account with an Explorer role or higher.
  • View and Download Workbook/Save a Copy permissions on the source site.
  • Publishing rights for the destination site.
Thanks for your feedback!