Creating tenants in BMC Helix Platform
Before you begin
- Make sure that you have downloaded the tctl utility from BMC Electronic Product Distribution (EPD).
Set up the tctl utility.
See Onboarding and managing tenants and services in BMC Helix IT Operations Management deployment documentation.
To create a tenant
- Log in to the tctl utility.
- From the folder where you downloaded the tctl utlity, edit the config file and add the details according to your environment.
From the directory where the config file is located, run the following command:
tctl login- On theBMC Helix Single Sign-On authentication page, enter the user name and password and authenticate.
The user name is the admin and the default password is bmcAdm1n1#. This user is a local user in the tmsrealm realm, and is different from the BMC Helix Single Sign-On admin user. - Click Log in.
Create the tenant.json file by using the following details as an example. This file is used to create the tenant.
{
"name": "york",
"email": "jsmith@bmc.com",
"first_name": "John",
"last_name": "Smith",
"phone": "1234678",
"environment": "dev",
"domain": "york-private-small.bmc.com",
"description": "York",
"country": "United Kingdom",
"login_id": "hannah_admin",
"type": "LICENSE"
}The following table describes the parameters:
Parameter name
Description
name
Name of the tenant.
email
Email ID of the administrator user of the tenant.
first_name
First name of the administrator user.
last_name
Last name of the administrator user.
phone
Contact number of the administrator user.
environment
Type of the environment.
The value of this parameter depends on the kind of setup that you want to create, such as, dev, qa, or production.
Important:
- Do not use "prod" to indicate the production environment.
- Do not use special characters.
- The value of this parameter is not based on deployment size, such as,
compact, small, medium, or large.
domain
The tenant domain.
Important: Only small case letters, digits, and hyphen are valid values.
description
Description of the tenant.
country
Country where the tenant is located.
login_id
Login ID of the administrator user.
type
Type of the tenant.
Valid values:
- LICENSE
- TRIAL
Run the following command to create a new tenant:
tctl create tenant -f tenant.jsonThe email address specified in the JSON file receives the following emails:
- An email for license activation
- An email for setting the password for the initial user
- Activate the tenant by using link in the email.
- Verify the active services.
To see the list of services that are activated on the new tenant, run the following command:
tctl get tenant-service <tenant_id>Expected output:
To activate a service on the new tenant, run the following command:
tctl activate service <tenant_id> -i <service-id>For example, the following image shows the Discovery service activated for the new tenant:
Where to go from here
Deploy-BMC-Helix-Service-Management-in-a-multitenant-BMC-Helix-Platform-environment