Skip to main content

Using custom plugins with CMA

Centreon Monitoring Agent can execute custom plugins. Use this feature if your monitoring needs are specific and not covered by native Centreon controls and plugins. Supported languages are: PowerShell, Perl, Python, Bash.

To get started, create your plugin: for example, you can use our developer guide. Executing custom plugins requires declaring their commands in a dedicated file on the host. These commands will be used as macro values in the corresponding service.

Actions on the host​

  1. Copy the plugin to the host, in the directory of your choice.

  2. Create the commands file. Supported formats are .txt or .ini. Example content:

    [custom_checks]
    check_echo = /usr/bin/echo "$ARG1$ $ARG2$"
    custom_check_2 = /path/to/custom_check_2 -c /arg=$ARG1$
    ...

  3. Declare the path to the file in the agent configuration, using the custom_check_file parameter.

    • Linux: centagent.json
    {
      ...
      "custom_check_file":"/path/to/commandsfile.ini",
      ...
    }
    • Windows: via the installer/silent mode (/CUSTOMCHECK) or directly in the registry (by adding a custom_check_file registry key).

Actions in Centreon​

On your central server, if not already done, create the host corresponding to the resource to be monitored.

Create a service based on the proposed service template or create a dedicated service template. In that case, the template must inherit (directly or via its parent) from the OS-Linux-Custom-Script-Centreon-Monitoring-Agent or OS-Windows-Custom-Script-Centreon-Monitoring-Agent templates, and be configured with passive checks enabled and active checks disabled.

  1. Fill in the macros:

    • $_SERVICECUSTOMCHECK$: the name of the command declared on the host (e.g.: check_echo)
    • $_SERVICEARG1$: value that will be passed to $ARG1$ in the declared command

    It is possible to pass up to 8 values ($_SERVICEARG1$ to $_SERVICEARG8$).

  2. Deploy the configuration.