Environment service
The Environment service enables you to manage environments, including defining and selecting the Control-M environment to use. An environment is a combination of an endPoint, username, and password.
An endPoint looks like the following:
Environments are saved in an env.json file located in the home user with read/write permissions only for the logged in user under .ctm folder.
env.json is encrypted.
For example, to add an environment and name it devEnvironment, use the command below:
info: Environment 'devEnvironment' was created
info: devEnvironment:
{"endPoint":"https://<controlmEndPointHost>:8443/automation-api","user":"<ControlmUser>"}
environment show
Returns a list of all defined environments.
CLI Syntax
environment add
Adds a new environment for a Control-M instance.
CLI Syntax
Where:
Parameter | Description |
|---|---|
<env> | Environment name |
<endPoint> | Control-M REST API endPoint |
<user> | Control-M username Note: If you specify an LDAP user, prefix the username with the domain: <domain>\<user> |
<password> | Control-M password |
environment workbench::add
Adds an environment for the installed Control-M Workbench.
CLI Syntax
Where:
Parameter | Description |
|---|---|
[<endPoint>] | REST API endPoint for the Control-M Workbench. By default, the Workbench endpoint is https://localhost:8443/automation-api, with "workbench" as the user name and password. You can use this parameter if you installed the Workbench on a different host. |
environment set
Sets the default environment for interactive work. All commands are sent to this environment unless a different environment is defined using the -e option.
CLI Syntax
Where:
Parameter | Description |
|---|---|
<env> | Environment name |
environment delete
Deletes an environment.
CLI Syntax
Where:
Parameter | Description |
|---|---|
<env> | Environment name |
environment update
Updates an environment property. The property <name> can be an endPoint, username, or password. If an environment does not exist, it will be created.
CLI Syntax
Where:
Parameter | Description |
|---|---|
<env> | Environment name |
<name> | Can be one of the following:
For more information about these properties, see environment add. |
<value> | Parameter value |
environment copy
Duplicates an environment.
CLI Syntax
Where:
Parameter | Description |
|---|---|
<env> | Environment name |
<newEnv> | Name of the new environment |
environment load
This command allows you to load a predefined env.json to your environment definitions.
The file that you are importing must include passwords that are decoded. When saved to the user's env.json file, the passwords are encrypted.
CLI Syntax
Where:
Parameter | Description |
|---|---|
<enviromentsFile> | An env.json file |
environment configure
This command allows you to set parameters for all environments.
CLI Syntax
Where:
Parameter | Description |
|---|---|
<setting name> | Parameter name |
[setting value] | Parameter value |
Possible parameters:
Parameter | Value | Default | Description |
|---|---|---|---|
rootCertificateRequired | false | true | false | Disable API calls that use a self-signed HTTPS certificate, and allow only certificates that are signed by a trusted Certificate Authority. By default, self-signed certificates are allowed. |