1. Home
  2. Other Releases
  3. On-premises 5.2
  4. Guides
  5. Tours
  6. Concepts
  7. 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. Command Line Interface
    10. Content Manager
    11. Dashboard Filters Manager
    12. Data Agent
    13. Data APIs for External Notebooks
    14. Data Manager
    15. Formula Builder
    16. Formula Validation Tool
    17. Inspector Tool
    18. Join Editor
    19. Load Job Viewer
    20. Model Update Viewer
    21. Notebook Editor
    22. Profile Manager
    23. Public API
    24. Query Plan Viewer
    25. Scheduler
    26. Schema Designer
    27. Schema Diagram Viewer
    28. Schema Manager
    29. Schema Wizard
    30. Security Manager
    31. Table Editor
    32. 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
      6. Adjust Offset for Scheduler
    33. Versioning Migration Tool
  8. References
  9. Integrations
  10. Data applications
  11. Releases

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>

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