SNMP2VES Manager¶

SNMP Manager library follows VES Event Listener 7.1

FM VES Message¶

Datatype: commonEventHeader

Field	Mandatory	Default value	Configurable	Runtime	Notes
domain	yes	fault	no	no	none
eventId	yes	SNMP Trap RequestID	yes	yes	Uses default defined value if TRAP OID not configured
eventName	yes	SNMP Fault	yes	yes	Uses default defined value if TRAP OID not configured
priority	yes	HIGH	no	no	none
reportingEntityName	yes	NF-OAM-ADOPTER	yes	yes	set value if provided by notification trap and oid-reporting-entity-name configured.
startEpochMicrosec	yes	System time at the moment of notification generation	yes	yes	set value if provided by notification trap and oid-start-epoch-microsec configured.
lastEpochMicrosec	yes	System time at the moment of notification generation	yes	yes	set value if provided by notification trap and oid-last-epoch-microsec configured.
sequence	yes	0	yes	yes	set value if provided by notification trap and oid-event-sequence configured.
sourceName	yes	Host Address of SNMP Agent sending the trap notification	yes	yes	set value if provided by notification trap and oid-source-name configured.
version	yes	4.1	yes	no	Library only enforces mandatory fields for 4.1 version
vesEventListenerVersion	yes	7.1	none	no	Library only enforces mandatory fields for 7.1 version
eventType	no	none	no	no	none
nfcNamingCode	no	none	no	no	none
nfNamingCode	no	none	no	no	none
nfVendorName	no	NF-OAM-ADOPTER-VENDOR	yes	no	none
reportingEntityId	no	none	no	yes	set value if provided by notification trap and oid-reporting-entity-id configured.
internalHeader Fields	no	none	no	no	none
sourceId	no	none	none	no	none
timeZoneOffset	no	none	no	no	none

Datatype: faultFields

Field	Mandatory	Default value	Configurable	Runtime	Notes
alarmCondition	yes	SNMP Fault	yes	yes	set value if provided by notification trap and trap configured.
eventSeverity	yes	CRITICAL	yes	yes	set value if provided by notification trap and event-severity configured.
eventSourceType	yes	SNMP Agent	yes	no	none
faultFieldsVersion	yes	4.0	no	no	none
specificProblem	yes	SNMP Fault	no	yes	set value if provided by notification trap and oid-specific-problem-desc configured.
vfStatus	yes	ACTIVE	no	no	none
eventCategory	no	none	no	yes	set value if provided by notification trap and event-category configured.
alarmAdditional Information	no	no	no	yes	Map of OID with values
alarmInterfaceA	no	none	no	yes	set value if provided by notification trap and oid-alarm-interface-name configured.

Mapping Configuration¶

Configuration file fm-ves-message-mapping.yaml contains all definitions required to define the mapping from trap provided information to VES Message format

trap mapping example

reporting-entity-name: "NF-OAM-ADOPTER"
reporting-entity-id: "NF-OAM-ADOPTER"
nf-vendor-name: "SOME-VENDOR"
traps:
  - oid: "default"
    name: "SNMP_Fault"
    event-severity: "CRITICAL"
    event-source-type: "Unknown"
  - oid: "1.3.6.1.4.1.1007.0.0.1.0.1"
    name: "PortDOWN"
    event-severity: "MAJOR"
    event-category: "link"
    event-source-type: "port"
    oid-event-id: "1.3.6.1.4.1.1007.2.6.9.0"
    oid-event-sequence: "0"
    oid-reporting-entity-id: "1.3.6.1.4.1.1007.0.0.1.0.6"
    oid-source-name: "1.3.6.1.4.1.1007.0.0.1.0.2"
    oid-specific-problem-desc: "1.3.6.1.4.1.1007.0.0.1.0.3"
    oid-alarm-interface-name: "1.3.6.1.4.1.1007.0.0.1.0.7"
    oid-start-epoch-microsec: "1.3.6.1.4.1.1007.0.0.1.0.4"
    oid-last-epoch-microsec: "1.3.6.1.4.1.1007.0.0.1.0.5"
  - oid: "1.3.6.1.4.1.1007.0.0.1.0.1"
    name: "PortUP"
    event-severity: "NORMAL"
    event-category: "link"
    event-source-type: "port"
    oid-event-id: "1.3.6.1.4.1.1007.2.6.10.0"
    oid-event-sequence: "0"
    oid-reporting-entity-id: "1.3.6.1.4.1.1007.0.0.1.0.6"
    oid-source-name: "1.3.6.1.4.1.1007.0.0.1.0.2"
    oid-specific-problem-desc: "1.3.6.1.4.1.1007.0.0.1.0.3"
    oid-alarm-interface-name: "1.3.6.1.4.1.1007.0.0.1.0.7"
    oid-start-epoch-microsec: "1.3.6.1.4.1.1007.0.0.1.0.4"
    oid-last-epoch-microsec: "1.3.6.1.4.1.1007.0.0.1.0.5"

global
- reporting-entity-name Reporting entity name assigned to the event
- reporting-entity-id Reporting entity id assigned to the event
- nf-vendor-name Vendor name assigned to the event
traps
- oid OID trap identifier
- name Name of the trap
- event-severity Severity assigned to the event
- event-category Category assigned to the event
- event-source-type Source type assigned to the event
- oid-event-id OID containing the event entity id e.g. port interface
- oid-event-sequence Event sequence 0 on a raise and 1 on a clear
- oid-reporting-entity-id OID containing the reporting entity id
- oid-source-name OID containing the source name
- oid-specific-problem-desc OID containing the trap problem description
- oid-start-epoch-microsec OID containing the alarm start epoch
- oid-last-epoch-microsec OID containing the alarm last epoch
- oid-alarm-interface-name OID containing the interface name

Output example for port down trap

{
  "event":{
    "commonEventHeader":{
      "domain":"fault",
      "eventId":"1023555944",
      "eventName":"FAULT_NF-OAM-ADOPTER_PortDOWN",
      "lastEpochMicrosec":1613592976108880,
      "nfVendorName":"SOME-VENDOR",
      "priority":"High",
      "reportingEntityId":"10283",
      "reportingEntityName": "NF-OAM-ADOPTER",
      "sequence":0,
      "sourceName":"OAM-BOX",
      "startEpochMicrosec":1613592976108380,
      "timeZoneOffset":"UTC+02:00",
      "version":"4.0",
      "vesEventListenerVersion":"7.1"
    },
    "faultFields":{
      "alarmAdditionalInformation":{
        "1.3.6.1.4.1.1007.0.0.1.0.7":"A0",
        "1.3.6.1.4.1.1007.0.0.1.0.5":"1613592976108880",
        "1.3.6.1.6.3.1.1.4.1.0":"1.3.6.1.4.1.1007.0.0.1.0.1",
        "1.3.6.1.4.1.1007.0.0.1.0.6":"10283",
        "1.3.6.1.4.1.1007.0.0.1.0.3":"Port DOWN",
        "1.3.6.1.4.1.1007.0.0.1.0.4":"1613592976108380",
        "1.3.6.1.4.1.1007.0.0.1.0.2":"OAM-BOX",
        "1.3.6.1.2.1.1.3.0":"0:00:50.00"
      },
      "alarmCondition":"PortDOWN",
      "alarmInterfaceA":"A0",
      "eventCategory":"link",
      "eventSeverity":"MAJOR",
      "eventSourceType":"port",
      "faultFieldsVersion":"4.0",
      "specificProblem":"Port DOWN",
      "vfStatus":"Active"
    }
  }
}

Output example for any undefined trap

Undefined trap will use the mapping defined for default.

{
  "event": {
    "commonEventHeader": {
      "domain": "fault",
      "eventId": "46102539",
      "eventName":"FAULT_NF-OAM-ADOPTER_SNMP_Fault",
      "lastEpochMicrosec": 1.601542425363E12,
      "nfVendorName": "SOME-VENDOR",
      "priority": "High",
      "reportingEntityName": "NF-OAM-ADOPTER",
      "sequence": 0,
      "sourceName": "127.0.0.1",
      "startEpochMicrosec":1613592976108380,
      "timeZoneOffset":"UTC+02:00",
      "version": "4.0",
      "vesEventListenerVersion": "7.1"
    },
    "faultFields": {
      "alarmAdditionalInformation": {
        "1.3.6.1.6.3.1.1.4.1.0": "1.2.3.4.5",
        "1.2.3.4.5": "some string",
        "1.3.6.1.2.1.1.1.0": "System Description",
        "1.3.6.1.2.1.1.3.0": "0:00:50.00"
      },
      "alarmCondition": "SNMP_Fault",
      "eventSeverity": "CRITICAL",
      "eventSourceType": "Unknown",
      "faultFieldsVersion": "4.0",
      "specificProblem": "SNMP_Fault",
      "vfStatus": "Active"
    }
  }
}