Use Case

This integration allows collecting alarms from Foglight to create events in OBM through OA. The template name is Foglight Alarm to OBM Event (OA).

Requirements

Integration Requirements


FoglightOperations Agent
Authentication
  • Username and Password
  • API Token
  • N/A
Permissions
  • Groups
    • Foglight Operators
    • Foglight Users
  • Roles
    • API Access
    • Console User
    • Operator
  • N/A
Environment

Network Requirements


Direction (Port)
Communication
  • ZigiOps → Foglight (8080)
  • ZigiOps → Operations Agent (30005)

Actions

New Alarms

This action sends HTTP requests at a scheduled interval to collect new alarms from Foglight to create events in OBM.

Cleared Alarms

This action sends HTTP requests at a scheduled interval to detect cleared alarms from Foglight to send normal events to OBM to close the corresponding events.

Data Mapping

Below is the default data mapping for this integration template.

Source EntityTarget Entity AttributeTarget Entity Attribute Details
Alarms







Category

Foglight

(a static value that the integration sends for the "Category" attribute of the OBM event)

Close Key

{id}

(the "ID" of the Foglight alarm)

Correlation Key

{id}:{severity}

(a combination from the "ID" and the "Severity" of the Foghtlight alarm)

Description

{message}

(the "Message" of the Foglight alarm)

Node

{topologyobjectid/name}

(the "Name" of the Topology Object of the Foglight alarm)

Related CI

{topologyobjectid/name}|{foglight/source/url_hostname}

(a combination from the "Name" of the Foglight Topology Object of the Foghtlight alarm)

Severity

The ZigiOps checks the available values in the following order:

  1. Minor
    (the value that the integration sends if the "Severity" of the alarm is "2")
  2. Major
    (the value that the integration sends if the "Severity" of the alarm is "3")
  3. Critical
    (the value that the integration sends if the "Severity" of the alarm is "4")
  4. Normal
    (the value that the integration sends if the alarm is cleared in Foglight)
Source CI

{z_self/hostname}

(the hostname of the ZigiOps server)

Subcategory

Alarm

(a static value that the ZigiOps sends for the "Subcategory" field of the OBM event)

Timestamp

{createdtime}

(the time when the Foglight violation has been opened)

Title

{rulename}({topologyobjectid/name})

(a combination of the "Rule Name" and the "Name" of the Topology Object of the Foglight alarm)

Recommendations

This section provides information about the recommended considerations, which you should consider before enabling the integration.

Correlation

OBM handles the correlation based on the "Correlation Key" and "Close Key" attributes that the integration supplies with each event.

Mapping

The predefined templates comply with the specifics of the integrated systems. It is recommended to confirm if your integrated systems have any required fields, which must be reported so that you can map them accordingly. Note that if a required field is not mapped, the action might fail. In this case, you could review the troubleshooting page for more information about the action's execution history.