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 and API token, or a combination of an endpoint, username, and password.

An endPoint has the following format:

https://<controlmEndPointHost>:8443/automation-api

Environments are saved in the env.json file, which is located under the .ctm folder, on the home user that has read/write permissions only for the logged in user. Sensitive information, such as passwords and tokens, is encrypted in the env.json file.

For example, the following command adds an environment named devEnvironment In this command, you include a valid token, as described in Authentication Service.

ctm environment add devEnvironment "https://<controlmEndPointHost>:8443/automation-api" "<token>"

In the following alternative example for creation of the same environment, username and password are specified (instead of an API token).

> ctm environment add devEnvironment "https://<controlmEndPointHost>:8443/automation-api" "<ControlmUser>" "<ControlmPassword>"
 
info:    Environment 'devEnvironment' was created
info:    devEnvironment:
{"endPoint":"https://<controlmEndPointHost>:8443/automation-api","user":"<ControlmUser>"}

The following API commands enable you to manage environments:

• environment show

• environment add

• environment workbench::add

• environment set

• environment delete

• environment update

• environment copy

• environment load

• environment configure

environment show

The environment show command enables you to return a list of all defined environments.

ctm environment show

environment add

The environment add command enables you to add a new environment for a Control-M instance.

ctm environment add <env> <endPoint> <user> [<password>]

or

ctm environment add <env> <endPoint> <token>

The following table describes the environment add command parameters.

environment workbench::add

The environment workbench::add command enables you to add an environment for the installed Control-M Workbench.

ctm environment workbench::add [<endPoint>]

Where [<endPoint>] is the 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

The environment set command enables you to set the default environment for interactive work. All commands are sent to this environment unless a different environment is defined using the -e option.

ctm environment set <env>

Where <env> is the environment name.

environment delete

The environment delete command enables you to delete an environment.

ctm environment delete <env>

Where <env> is the environment name.

environment update

The environment update command enables you to update an environment property.

ctm environment update <env> <name> <value>

The following table describes the environment update command parameters.

environment copy

The environment copy command enables you to duplicate an environment.

ctm environment <env> <newEnv>

Where <env> is the name of the original environment and <newEnv> is the name of the new environment.

environment load

The environment load command enables you to load one or more predefined environments using the env.json file.

ctm environment load <enviromentsFile>

Where <enviromentsFile> is the env.json file, which is located under the .ctm folder, on the home user that has read/write permissions only for the logged in user.

Do not encrypt sensitive information, such as passwords and tokens, in the env.json file. This sensitive information is encrypted automatically when the file is loaded.

environment configure

The environment configure command enables you to set parameters for all environments.

ctm environment configure <setting name> [setting value]

Where <setting name> is the name of the parameter and [setting value] is the value for the parameter.

The following table describes possible environment configure parameters: