Chat now with support
Chat with Support

Foglight for Integrations 5.9.6 - User and Reference Guide

Using Foglight for Integrations Reference

Configuring Agent Properties for the SNMP Trap Agent

The SNMP Trap Agents can be configured based on the parameters listed below.

To update agent properties:
1
On the navigation panel, under Dashboards, click Administration > Agents > Agent Properties.
2
On the Namespace > Type column, click IntegrationAgents > TrapAgent.
3
Set any of the following properties:
Trap_Reception_Port — Traps are configured to send to this specific port on the server the agent is deployed.
Undefined_Trap_Creates_Alarm — This is a Boolean value that indicates how to handle unformatted traps. If false, the unformatted trap is logged and discarded. If true, an alarm is sent to the alarm browser. Traps are logged in the agent log. The agent log can be retrieved through the UI using the Agent Status dashboard. The agent can be selected and the Get Log button can be clicked.
Undefined_Trap_Alarm_Duration — When an unformatted trap is sent to the alarm browser, the duration of the trap is noted. When combined with the Clear Integration Alarm Rule, the trap could stay open in the event browser.
Undefined_Trap_Severity — The severity of the alarm for the unformatted trap.
Integration Servlet URL — The URL of the Management Server (FMS) that receives the trap from the agent. Change this from localhost to the name or IP address and port number of the Management Server. For example: http://123.456.78.9:8080/Integration/Write.
Undefined Variable Value — The value for this property is used in the message format when a trap variable that was configured in the message format does not come in on the trap. It is defaulted to Undefined.

For more information about Agent Properties, see the Foglight Administration and Configuration Guide.

Troubleshooting

What happens to traps that I do not have a MIB loaded for?

They are recognized as unformatted traps. There is a configuration option in the Agent Properties dashboard for the SNMPTrapAgentCartridge UI to report these as alarms. They can also be logged.

Where do I configure the duration for unformatted traps?

There is a configuration option in the Agent Properties for the SNMPTrapAgentCartridge UI.

What happens if I load a MIB more than once?

A MIB cannot have items removed from it. Any MIB loaded a second time only adds new symbols or changes some existing symbols.

Can I load a file that contains more than one MIB?

Yes, but only the first MIB definition is recognized. Split the MIIBs into separate files and reload them individually.

How do I configure an SNMP port?

Set the parameters in the Administration > Agents > Agent Properties dashboard.

What port should the Foglight Agent Manager run on?

In order to start a trap receiver agent, the Foglight Agent Manager must be installed. It should be installed as ROOT if you want to run it on the default port of 162. If run as NON-ROOT, you must configure a port higher than 1024 in the agent properties (Administration > Agent > Agent Properties).

Related topics:
•
Loading MIB Definitions
•
Configuring Agent Properties for the SNMP Trap Agent
•
Configuring Alarms from SNMP Trap Definitions

Receiving Acknowledged and Cleared Commands

XML data is used to receive Acknowledge and Clear commands from third-party systems.

Understanding the XML Data

The following XML elements are utilized.

Table 5. XML elements
XML Element
Description

clearAlarms

This is the element that lists the alarms to be cleared (one or more).

id

When beneath the clearAlarms element or the acknowledgeAlarms element, this is the id of the alarm as assigned in Foglight. This id would originally be passed to the external system from Foglight in the outgoing XML. The field in that XML is called <uniqueId>.

acknowledgeAlarms

This is similar to the clearAlarms element but is used to acknowledge alarms.

clearAlarm

This element is used to clear a single alarm. The alarmId is passed using an attribute in the format id=”xxx”.

acknowledgeAlarm

This element is similar to the clearAlarm element, but is used to acknowledge a single alarm.

Sample of XML

<?xml version="1.0" encoding="UTF-8"?>

<alarmActions xmlns="http://www.quest.com/xml/ns/foglight/ integration/alarmActions"

xmlns:xsi="http://www.w3.org/2001/ XMLSchema-instance"

xsi:schemaLocation="http://www.quest.com/xml/ns/foglight/ integration/alarmActions

../src/META-INF/alarm_actions.xsd">

<clearAlarms>

<id>e696b857-11f0-4eb6-b3db-8542dc34f38a</id>

</clearAlarms>

 

<acknowledgeAlarms>

<id>f554t857-11f0-4eb6-b3db-8542dc34f38a</id>

</acknowledgeAlarms>

 

<clearAlarm id="o987y651-11f0-4eb6-b3db-8542dc34f38a"/>

<acknowledgeAlarm id="f987a651-11f0-4eb6-b3db-8542dc34f38a"/>

</alarmActions>

Viewing Alarms

To view alarms, access the Alarms dashboard. For more information about viewing alarms, see the Foglight User Guide

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating