1. Home
  2. Previous Releases
  3. Latest Release
  4. Guides
  5. Concepts
  6. Tools
    1. Alert Editor
    2. Alias Sync Tool
    3. Analyzer
    4. Apache Parquet Merge Tool
    5. Avro Extractor Tool
    6. Business Schema Designer
    7. Business Schema Manager
    8. Cluster Management Console
    9. CMC Logs Manager
    10. CMC Monitoring
    11. CMC Patch Manager
    12. CMC Scheduler
    13. CMC Tenant Manager
    14. Command Line Interface
    15. Content Manager
    16. Dashboard Filters Manager
    17. Dashboard Manager
    18. Data Agent
    19. Data APIs for External Notebooks
    20. Data Lineage Viewer v2
    21. Data Manager
    22. Formula Builder
    23. Inspector Tool
    24. Join Editor
    25. Load Job Details Viewer
    26. Load Plan DAG Viewer
    27. Model Update Viewer
    28. Notebook Editor
    29. Profile Manager
    30. Public API
    31. Query Plan Viewer
    32. Scheduler
    33. Schema Designer
    34. Schema Diagram Viewer
    35. Schema Manager
    36. Schema Wizard
    37. Security Manager
    38. Table Editor
    39. Tenant Management Tool
      1. Export and Import Objects
      2. Export a Tenant
      3. Import a Tenant
      4. Migrate Scheduled Jobs for DST
      5. Backup and Restore
    40. Upload Service Command Line Interface (CLI)
    41. Versioning Migration Tool
  7. References
  8. Integrations
  9. Data applications
  10. Releases
  11. Incorta Premium

Tools → Tenant Management Tool

About the Tenant Management Tool

The Tenant Management Tool (TMT) is a command line tool for managing and configuring one or more tenants in a given Incorta cluster. The tool is a JAR file, tmt.jar, and a shell script file, tmt.sh.

A System Administrator with root access to the host running the Cluster Management Console (CMC) is able to run the Tenant Management Tool. The default location is:

<CMC_INSTALLATION_PATH>/IncortaAnalytics/cmc/tmt

When using either tmt.jar or tmt.sh, you must specify the Cluster name or a Cluster JDBC database connection string. Here are the available commands and input parameters for the TMT:

Usage

java -jar tmt.jar [Options]
./tmt.sh [Options]

Options

You must include cluster name or JDBC connection string in the tmt command, else the command will result in an error.

Cluster name

-clnm,--cluster-name <cluster name >

JDBC connection string to cluster metadata database

-cjdbc,--config-jdbc <driver class name> <connection string> <user> <pass>

Change tenant path

-p,--change-path <tenant> <new path>

Change the default log path

-logpath,--log-path <path>

Copy tenant data files, used with create/import/export

-cf,--copy-data-files <data files directory>

Create a new Tenant

-c,--create <tenant name>

Create system tenant

-cst,--create-system-tenant

Disable tenant with given name

-d,--disable <tenant>

Enable tenant with given name

-e,--enable <tenant>

Exports all favorite dashboards for all users in the specified tenant.

-ef,--export-all-favorite-dashboards <tenant>

Export tenant to specified output path

-ex,--export <tenant> <output path>

Force actions without requiring interactive confirmation.

-f,--force

Import all favorite dashboards in the given file for a specific tenant.

-if,--import-all-favorite-dashboards <tenant> <partial-tenant-export-file>

Import tenant from external package

-i,--import <tenant package>

List all available tenants

-l,--list <filters [e - display enabled tenants only, d - display disabled tenants only, p - print tenant path in case tmt is not running from the command line] >

List tenant configs

 -lc,--list-configs <tenant>

Override tenant name, used with create/import/export

-on,--override-name <new name>

Override tenant path, used with create/import/export

-op,--override-path <new path>

Override tenant properties with another properties file, used with create/import/export

-opf,--override-properties

Pauses scheduled jobs (data loads/alerts/send dashboards), used with import tenant

-psj,--pause-scheduled-jobs <no>


-h,--help


-v,--version

Remove property

-rp,--remove-property <tenant> <property-name>

Remove tenant with given name

-r,--remove <tenant>

Rename tenant

-re,--rename <tenant> <new name>
Important

Do not use the old tenant name to create a new tenant or import a tenant with the same name of the old tenant.

Run in interactive mode

-ii,--interactive

Tenant Super User mail with import

-sm,--super-email <new super mail>

Tenant Super User name with import

-su,--super-user <new super user>

Tenant Super User password with import

-sp,--super-password <new super passsword>

Update a tenant configuration property

-u,--update-property <tenant> <property-name> <value>

Upgrade the metadata schema for all tenants

-umd,--upgrade-metadata

Use sample data, used with create

-s,--sample