---
schema_version: "1"
id: e592b0ace86749928e1e55aa015eb48928fffc030e45b92a92b53b6c39cb0d91
title: Using the Tableau Content Migration Tool Console Runner
collection: tableau
version: next
locale: en-us
portal_url: https://docs.salesforce.com/tableau/next/en-us/server-linux/cmt-deployment_console_runner.md
canonical_url: https://help.tableau.com/v0.0/server-linux/en-us/cmt-deployment_console_runner.htm
source_site: help.tableau.com
content_type: documentation
content_hash: 6b52781032086e61e306a18107e1b75b94570575a578866b429a83528ac8ca2b
description: Reference for the Content Migration Tool tabcmt-runner.exe console runner for running migrations.
---
[Skip to main content](#main-content)

# 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`.

**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](https://help.tableau.com/v0.0/server-linux/en-us/cmt-command_line.htm).

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
- tabcmt-runner script-warning \[on|off\]

Options:

- \--version
- \--help
- \--quiet
- \--info
- \--logfile=VALUE
- \--src-user=VALUE
- \--src-password=VALUE
- \--dest-user=VALUE
- \--dest-password=VALUE
- \--https=VALUE
- \--allow-scripts

## 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 connection
- `--src-password=<password>` sets the password of the source connection
- `--dest-user=<username>` sets the username of the destination connection
- `--dest-password=<password>` sets the password of the destination 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

Default value: `on`

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

Deprecated in July 2022.

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>\]

### script-warning

Default value: `on`

Shows a warning message when running a migration plan that includes migration scripts.

**Note:** This command updates your selection on the Settings page. For more information, see [Tableau Content Migration Tool Settings](https://help.tableau.com/v0.0/server-linux/en-us/cmt-settings.htm).

#### Examples

Show if script warning is turned on or off.

tabcmd-runner script-warning

Turn script warning on or off

tabcmd-runner script-warning <on|off>

If turned on, you must include the option `--allow-scripts` to execute migration plans.

tabcmd-runner --allow-scripts <plan file>

## Who can do this

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

- Administrator permissions on the Content Migration Tool machine.
- Tableau site 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.

## Other articles in this section