Downloading and configuring the tctl utility

As a tenant administrator, use the tctl utility to manage tenants and services by using the command line interface. With this utility, you can manage tenants and services, and create template JSONs.

Important

If you want to onboard additional tenants, contact BMC Support.

You can download the tctl utility from the electronic product distribution (EPD) website.

The utility is compatible with the following operating systems:

  • Windows
  • Linux
  • Mac

Best practice
If you configure the command line utility on a Linux computer and export its DISPLAY to another computer, BMC recommends that both computers be located in the same data center or network.


To run the tctl utility

Important

If you are using a self-signed or custom CA certificate, while logging in to the tctl utility, make sure that the certificate authority is added to your browser security settings.

  1. Copy the utility to any folder on the operating system that you are using.
  2. From the directory where the tctl utility binary file is located, open the config file.
    The following image shows the contents of the config file:
    tctl_config_file.png

  3. Add values to the parameters in the config file.
    Refer to the following table to understand how to add the values:

  4. Run the utility.
  5. Log in to BMC Helix Single Sign-on for authentication. Perform the following steps:

    1. From the directory where the config file is located, run the following command:

      tctl login
    2. On the BMC Helix Single Sign-on authentication page, enter the user name and password to authenticate.
      The user name is admin and the default password is bmcAdm1n1#.
      The user is a local user in the tmsrealm realm and is different from the BMC Helix Single Sign-on admin user. 
    3. Click Log in.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*