You are viewing content for 5.0 | 4.9 | 4.8 | 4.7 | 4.6 | 4.5 | 4.4 | 4.3 | Previous 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]

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

© Incorta, Inc. All Rights Reserved.