Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Configure event collection from an Icinga2 connector

Configure the Icinga 2 (Icinga) connector instance to receive events while monitoring your network resources.

Before you begin

Role required: evt_mgmt_admin

Supported version: 2.4.1.

Procedure

  1. Navigate to All > Event Management > Integrations > Connector Instances.

  2. Click New.

  3. On the form, fill in the fields.

    FieldDescription
    NameDescriptive and unique name for the Icinga connector.
    DescriptionDescription for the use of the Icinga event collection instance.
    Connector definitionName of the required connector definition. Select Icinga2.
    Host IPIP address where Icinga is installed.
    CredentialPermission to connect to Icinga. Click the search icon in the Credential field. Use Basic Authentication credentials. Either select the required credentials from the list or click New and create the required credentials on the Credentials form. If you create the credentials, save them using a unique and recognizable name, for example, ICINGA2CHCK.
    Event collection last run timeLast run time value. Automatically updated.
    Last event collection statusLast run status. Automatically updated.
    Event collection schedule (seconds)Frequency, in seconds, that the system checks for new events from Icinga. The default value is 120 seconds.
    Last error messageLast error message. Automatically updated.
  4. Right-click the form header and select Save.

    The connector instance values are added to the form and the parameters that are relevant to the connector appear.

Image omitted: icinga2-connector-values.png
Icinga Connector Instance Values
1.  debug: Display debug messages. Default value: false. Specify true to see debug messages.
2.  logPayloadForDebug: Display payload related debug messages. Default value: false. Specify true to see payload related debug messages.
  1. In the Connector Instance Values section, verify and where required, modify the default connector instance values.
FieldDescription
debugDisplay debug messages. Default value: `false`. Specify `true` to see debug messages.
portNumber of the connector port. Default value: `5665`.
protocolType of protocol. Default protocol type: `https`.
alert\_typeProvide the Icinga alert type details. There are 2 types of an alert in Icinga2: SOFT and HARD SOFT: Connector instance will pull a soft alert. HARD: Connector instance will pull a hard alert.
  1. In the MID Servers for Connectors section, specify a MID Server that is up and is valid.

    If no MID Server is specified, an available MID Server that has a matching IP range is used.

    You can configure several MID Servers. If the first is down, the next MID Server is used. If that MID Server is not available, the next is selected, and so on. MID Servers are sorted according to the order that their details were entered into the MID Server for Connectors section.

  2. Right-click the form header and select Save.

  3. Test the connection between the MID Server and the Icinga connector.

    1. Click Test Connector.

      If the test fails, follow the instructions that the error issues to correct the problem and then run another test.

      Note: Use a network tool, such as ping, to verify credential correctness and network connectivity from the MID Server to the external monitoring tool.

    2. After a successful test, select the Active check box.

  4. Click Update.

Parent Topic:Configure a pull connector