Managing tenants with tctl commands

As an administrator, use the tctl commands to perform manage tenants.

Tenants can be licensed or for trial. The free trial for tenants remains active for 14 days. During the trial, you get unrestricted access to all capabilities that are available with the

BMC Helix IT Operations Management integrated products and common services.

To onboard a tenant

Use one of the following commands:

tctl create tenant -f <tenant json file>
For this command, provide the complete path to the JSON file.
tctl create tenant -v <json payload with escaped quotes>
For this command, use the JSON directly by escaping the double quotes.

To resume the tenant onboarding flow

To troubleshoot infrastructure or environment failures that result in aborting the onboarding flow, you can resume the tenant onboarding after the infrastructure issue is fixed.

You must know the tenant ID of this tenant. Run the following command:

tctl resume tenant <tenantid>

To update a tenant

Use one of the following commands:

tctl update tenant <tenant id> -f <tenant json file>
For this command, provide the complete path to the JSON file.
tctl update tenant <tenant id> -v <tenant json content> #quotes in json content should be escaped (\")
For this command, use the JSON directly by escaping the double quotes.

To get a list of all tenants

Use the following commands:

Get the list of all tenants on a stack:
tctl get tenant
Get details of a tenant in the tabular format based on its tenant ID:
tctl get tenant <tenant id>

To run tenant jobs

Use the following command to run the ITSM_USER_SYNC and ITSM_IMS_WEB_HOOK jobs:

tctl run job <tenantid> -l <label> -f true