Control-M Plug-in User Guide


The Control-M plug-in allows you to monitor scheduled jobs that are running on a Control-M server.

This plug-in supports Control-M versions beginning 9.0.18, and is based on Control-M's REST API. For more information on supported Control-M versions, see the Geneos 5.x Compatibility Matrix.

Intended audience

This guide is directed towards Geneos users who want to set up a plug-in to monitor an existing Control-M solution.

As a user, you should be familiar with general administration of the Control-M solution, as well as its terminologies.


You need the following to set up the Control-M plug-in:

Java requirements

Caution: The Java installation and environment configuration is a common source of errors for users setting up Java-based components and plug-ins. It is recommended to read Configure the Java environment to help you understand your Java installation.

Control-M credentials

  • Control-M server host name or IP address
  • Control-M server port
  • Control-M username and password

The Netprobe does not allow plaintext connections to the Control-M server, as it enforces an SSL connection to the Control-M server API.

If you attempt to connect to a non-SSL port, this causes a connection timeout and displays this error message:

Failed to connect to Control-M server: Unrecognised SSL message, plaintext connection?

Set up Control-M monitoring

Setup involves two main tasks:

  1. Create the Control-M sampler.
  2. Associate the Control-M sampler with a managed entity.

Create the Control-M sampler

  1. In the Gateway Setup Editor, create a new sampler by right-clicking the Samplers folder and selecting New Sampler.
  2. Enter a name for this sampler. For example, enter the name "ctrl-m" in the Name field.
  3. Under the Plugin field, click the drop-down list and select control-m.
  4. In the Basic tab below the Plugin field, enter the Control-M server information for the following fields:
    • In the Host field, select either name or ipAddress, then enter the host name or IP address.
    • In the Port field, enter the port number.
    • In the Username field, enter the username.
    • In the Password field, select either stdAES to set your password directly in the sampler, or var to enter the password you set in the managed entity. See Password in Control-M Plug-in Technical Reference.
    • Note: You can toggle between data and var for the host Name, Port, and Username fields. This toggle option allows you to define either a text or numerical value (data) or variable (var) for these fields.

  5. Click Save current document to apply your changes.
  6. Success: The sampler can now be associated with a managed entity. This sampler provides the default JobView dataview, which shows all jobs running in the Control-M server.

The JobView dataview appears by default when you do not specify any Dataviews in the Control-M sampler. You can define your own dataviews based on filters of the Control-M parameters. For more information on creating your own views, see the Job view filters in Control-M Plug-in Technical Reference.

Associate the Control-M sampler with a managed entity

  1. In the Gateway Setup Editor, create a new managed entity by right-clicking the Managed entities folder and selecting New Managed entity.
  2. Enter a name for this managed entity. For example, enter the name "ctrl-m" in the Name field.
  3. In the Options field, select the probe on which you want the sampler to run.
  4. Under the Sampler field, click Add new.
  5. In the text field under Ref, select the sampler you just created from the drop-down list.
  6. Click Save current document to apply your changes.

Success: After you save your changes to the managed entity, the Control-Mdataview appears under the managed entity on the Active Console state tree.

Further reading

After you have set up the Control-M plug-in, you can learn about its filters and custom dataviews in the Control-M Plug-in Technical Reference.