Configure a connector instance

Configure a connector instance to schedule the frequency of event collection.

Before you begin

Before starting this procedure:
  • Locate or define a connector definition.
  • Create the credentials to connect to the event source.
  • If the connector instance is to be used for the collection of Operational Metrics, the ITOA Metric Management plugin must be activated.

Role required: evt_mgmt_admin

About this task

You can use a connector instance to control the location and manner in which events arrive from external sources. You can optionally select to collect Operational Metrics information from the external sources that you are connecting to. The Operational Metrics feature is for the analysis of trends, threshold definitions, and anomaly detection. You can run a test to confirm that connector instance parameters let the MID Server receive events from a supported external event source to the Event [em_event] table. The test also confirms:

  • The MID Server is running.
  • The host is running on the IP address that is in the Host IP field.
  • Both the MID Server and the host are running in the same domain.
  • The connector instance value fields are valid.
  • A connection can be made to SCOM, using API, to retrieve events.

Procedure

  1. Navigate to Event Management > Event Connectors (Pull) > Connector Instances.
  2. Click New.
  3. Fill in the fields, as appropriate.
    Table 1. Connector Instance Form
    Field Description
    Name A unique name for the connector instance record, such as the name of event source host.
    Description Any optional information that the administrator wants to use to identify this record.
    Connector definition The vendor and protocol used to gather events from the external event source. Select the connector definition that matches the source of external events. The options available in the base system are:
    • HPOM
    • Hyperic
    • IBM Netcool
    • NagiosXI
    • OMi
    • SCOM
    • SolarWinds
    • vRealize
    • Zabbix
    Host IP The IP address of the event source host. The system uses this IP address to select the appropriate MID Server for communicating with the event source host.
    Credential The record from the Credentials [discovery_credentials] table containing valid credentials to the event source host.
    Event collection last run time The date and time of the most recent event import. The value of this field is automatically populated.
    Last event collection status The status of the last import. The value of this field is automatically populated.
    • None - A valid connection has not yet been established.
    • Success - A successful connection was established.
    • Error - A connection was established. However the external event source was not updated.
    Event collection schedule (seconds) The frequency in seconds that the system checks for new events from the external event source. This value cannot be lower than the minimum schedule property, which by default is 120 seconds.
    Last error message Last error message received by the connector. If the test connector fails, an error message appears in this field.
    Active This option appears only after the form has been saved.

    Do not select this check box until after you test the connection between the MID Server and the connector.

    Select this check box to enable pulling events from this external event source.

    Bi-directional Select to invoke the bi-directional option. This option is available only when the specified connector definition has been configured with bi-directional values. When selected, this option enables the bi-directional exchange of values to-and-from the external event source. The Last bi-directional status option appears only when this option is selected.

    This option appears only if the connector definition that is selected is SCOM.

    Last bi-directional status The value of this field is automatically populated. The status values are:
    • None - A valid connection has not yet been established.
    • Success - A successful connection was established.
    • Error - A connection was established. However the external event source was not updated.

    This option appears only if the connector definition that is selected is SCOM.

    Metrics collection Select to enable the collection of Operational Metrics.
    Note: The metrics connector supports working against the SCOM database (MSSQL) that is configured to work with SSL.

    This option appears only if the connector definition that is selected is SCOM.

    Last metrics collection status Status of the Operational Metrics collection activity. The value of this field is automatically populated.

    This option appears only if the connector definition that is selected is SCOM and when the Metrics collection option is selected.

    Metrics collection schedule (seconds) The time, in seconds, to repeat the Operational Metrics collection scheduled job.

    This option appears only if the connector definition that is selected is SCOM and when the Metrics collection option is selected.

    Metrics database host Enter either the IP address or the host name of the metrics database host.

    This option appears only if the connector definition that is selected is SCOM.

    Connect using a named instance Select to specify the MSSQL named instance to connect to.

    This option appears only if the connector definition that is selected is SCOM.

    Metrics database named instance The name of the metrics database instance.

    This option appears only if the connector definition that is selected is SCOM.

    Metrics database port The port used by the metric database. The connection is made using JDBC. The base system value is 1,433.

    This option appears only if the connector definition that is selected is SCOM.

    Database login with Windows authentication Perform database login with the credentials of the log-on user that is defined on the MID Server service.

    This option appears only if the connector definition that is selected is SCOM.

    Metrics collection running When selected, indicates that the Operational Metrics collection is running.

    This option appears only if the connector definition that is selected is SCOM.

    Metrics database credential Credentials for the metric database.

    This option appears only if the connector definition that is selected is SCOM.

    Connector Instance Values The related list containing connection parameters for the event source host. The list of parameters depends on the selected connector definition.
    MID Servers for Connectors The name of theMID Server to process events from the event server.
  4. Right-click the form header and select Save.
  5. Click Test connector to verify that the MID Server can communicate with the external server host.
  6. If the test fails, follow the instructions on the page to correct the problem and then run another test. The description of the reason for failure is shown in the MID Server log, according to the type of error, such as, Events, Metrics, or Bi-Directional.
  7. After a successful test, select the Active check box and then click Update.
  8. Confirm that Event Management processes events using this connector instance by manually creating an event.