Provision service

For Helix Control-M to run and monitor jobs on your application host, you must have an Agent installed. The Provision service allows you access to the full cycle of Agent setup when provisioning a new Agent. In addition, you can use the Provision service to deploy application plug-ins or integration plug-ins to the Agent during provisioning. A group of images is provided in the repository, including two types of images — Agent images (for the various operating systems), and plug-in images (for various Control-M plug-ins).

The following commands are available for Agent provisioning:

• Image: Prepares the file system installation of the Agent
  
• Setup: Registers an Agent and connects it with a Control-M environment
  
• Install: Runs all phases of image installation (including both image and setup)
  

Separating the Image and Setup phases can help in a situation in which installing and setting up agents dynamically is required by your architecture. In this scenario, you can prepare your image (whether it is a VM image, a Docker image, AWS AMI, etc.) with the Agent inside it. Then when required, use the setup command to dynamically perform a Control-M/Agent setup and register it to the Control-M/Server.

For a more static architecture, where there is no distinction between building an image and instantiation, you can use the provision install command, which allows you to install in a single step.

To provision a plug-in, run just the image command.

To prepare for provisioning, you must obtain the installation packages (for the Agent, application plug-ins, or integration plug-ins) that are referenced within the images.

Additional commands are available for removing an image and for uninstalling a Control-M/Agent from the application host.

provision images

Get a list of the images that are available on the server for a specific OS. Returns a list of image names.

CLI Syntax

ctm provision images <os> [-s version=all|latest|<numeric_string>]

Where:

Here is an example of a request for a list of the latest available images and a typical response:

> ctm provision images Linux 
[
   "AWS_plugin.Linux",
   "Agent_Amazon.Linux",
   "Agent_CentOs.Linux",
   "Agent_Oracle.Linux",
   "Agent_RedHat.Linux",
   "Agent_Suse.Linux",
   "Agent_Ubuntu.Linux",
   "Application_Integrator_plugin.Linux",
   "Azure_plugin.Linux",
   "Databases_plugin.Linux",
   "Hadoop_plugin.Linux",
   "Informatica_plugin.Linux",
   "MFT_plugin.Linux",
   "SAP_plugin.Linux"
]

REST API Syntax

Example using  curl:

os=Linux
curl -H "x-api-key: $token" $endpoint/provision/images/$os?version=9.0.20.080

provision image

Downloads an image and installs it into the current user account.

For a plug-in, use just this command.

For an agent, after running this command you must still register the agent on the server using the setup command.

Note: This functionality is supported only through the CLI, and cannot be called through a REST API command.

CLI Syntax

ctm provision image <image>

Where:

To verify that plug-in provisioning was successful, ensure that the relevant product code was added to the installed-versions.txt file located in the Agent home directory:

provision saas:agent::setup  

Registers an agent and connects it with a Control-M environment.

Note: This functionality is supported only through the CLI, and cannot be called through a REST API command.

CLI Syntax

ctm provision saas:agent::setup <agentTag> [name]

Where:

To verify that the agent was registered successfully, ensure that the relevant product code, DRKAI.9.0.20.080, was added to the installed-versions.txt file located in the Agent home directory.

provision saas::install

Performs all phases of image installation. For an agent, this includes both image and setup.

Note: This functionality is supported only through the CLI, and cannot be called through a REST API command.

CLI Syntax

ctm provision saas::install <image> <agentTag> [name]

Where:

To verify that an agent was installed successfully, ensure that the relevant product code, DRKAI.9.0.20.080, was added to the installed-versions.txt file located in the Agent home directory.

provision agent::update

Downloads and installs the latest version of Control-M/Agent and any installed plug-ins to the agent machine that runs the command.

Note: 

• This functionality is supported only through the CLI, and cannot be called through a REST API command. 
• To run this command, the current version of Control-M/Agent must be 9.0.20.280 or higher.
• If Control-M MFT or Control-M for SAP is installed on the Agent, you must stop the Agent before running this API command and start it afterwards. To avoid Agent downtime, you can create a host group and include multiple Agents with the same plug-in within the host group. After you shut down one Agent, jobs are routed to another Agent in the host group.

CLI Syntax

ctm provision agent::update [instanceName]

To skip confirmation messages during installation, add  -y  after the command.

provision image::remove

Uninstalls an image from this user account without unregistering it in Control-M.

Note: This functionality is supported only through the CLI, and cannot be called through a REST API command.

CLI Syntax

ctm provision image::remove

provision agent::uninstall

Uninstalls an image from this user account and unregisters it from the server.

Note: This functionality is supported only through the CLI, and cannot be called through a REST API command.

CLI Syntax

ctm provision agent::uninstall

_{Back to top}