SNMP

Events & Alarms

Sending Event and Alarm traps to an SNMP Trap Daemon is an optional feature of the applications running within the n2svcd framework. This feature is disabled by default, but can be enabled by adding the <snmp> element to the n2svcd.xml configuration file directly within the <n2svcd> element:

<?xml version="1.0" encoding="utf-8"?>
<n2svcd>
  <snmp enabled="1" host="localhost"/>

Other settings allow you to adjust the port number. Refer to the n2svcd Configuration section for details.

When enabled by configuration, the n2svcd applications will each send SNMPv2c/v3 traps to the configured address/port using UDP.

MIBs

The N-Squared Trap MIB definitions are available here:

  1. NSQUARED-MIB.txt
  2. NSQUARED-N2SVCD-MIB.txt

They are defined underneath the N-Squared Enterprise number 56540.

Deployment

The recommended deployment for SNMP with n2svcd is the following:

  1. The snmptrapd Linux component is run local to listen on the localhost 127.0.0.1 address.
  2. The n2svcd applications are configured to deliver via UDP to the local snmptrapd instance.
  3. The snmptrapd will aggregate all of the individual traps into a single stream.
  4. The “forward” feature of snmptrapd is used to securely relay these traps to an external sink.

The specific configuration of snmptrapd will depend on the nature of the security required for the off-platform relay. Refer to the snmptrapd documentation.

MIUB Object IDs

The N-Squared enterprise-specific OIDs are:

Event & Alarm

Event Only

Alarm Only

genDateTimeAt

MANDATORY: This will always use the 8-byte GMT encoding.

Seconds are rounded down to the earlier decisecond.

genAppName

MANDATORY: The name of the n2svcd application which was “in control” at generation time.

This is the name as configured in the element in n2svcd.xml.

When an application is repeated, this will include the repeat number, e.g. “Logic:2”.

genSourceClass

MANDATORY: The module class of the software file which generated the trap.

genAffectedLabel

OPTIONAL: A label identifying the affected object/connection/resource.

The affected object may be the source object, but not always.

When present, this is also used to correlate ALARM and CLEAR pairs.

genMsg

The message string.

eventID/alarmID

The Event/Alarm ID is in format XX-YY-NNNNN where XX an YY are two-character alphanumerics which together indicate the originating module, and NNNNN is a unique five-digit number (with possible leading zeros) that uniquely identifies the nature of the event or alarm.

The XX-YY-NNNNN event/alarm ID can be used in the on-line searchable Alarm Guide to find the associated event/alarm description, parameter description, and recommended action information.

eventSeverity

alarmSeverity

Debugging Traces

Debugging traces are never written to SNMP.