1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
9 SNMP Manager library follows `VES Event Listener 7.1 <https://docs.onap.org/projects/onap-vnfrqts-requirements/en/latest/Chapter8/ves7_1spec.html#>`_
14 **Datatype: commonEventHeader**
36 - Uses default defined value if TRAP OID not configured
42 - Uses default defined value if TRAP OID not configured
49 * - reportingEntityName
54 - set value if provided by notification trap and oid-reporting-entity-name configured.
55 * - startEpochMicrosec
57 - System time at the moment of notification generation
60 - set value if provided by notification trap and oid-start-epoch-microsec configured.
63 - System time at the moment of notification generation
66 - set value if provided by notification trap and oid-last-epoch-microsec configured.
72 - set value if provided by notification trap and oid-event-sequence configured.
75 - Host Address of SNMP Agent sending the trap notification
78 - set value if provided by notification trap and oid-source-name configured.
84 - Library only enforces mandatory fields for 4.1 version
85 * - vesEventListenerVersion
90 - Library only enforces mandatory fields for 7.1 version
111 - NF-OAM-ADOPTER-VENDOR
115 * - reportingEntityId
120 - set value if provided by notification trap and oid-reporting-entity-id configured.
121 * - internalHeader Fields
140 **Datatype: faultFields**
156 - set value if provided by notification trap and trap configured.
162 - set value if provided by notification trap and event-severity configured.
169 * - faultFieldsVersion
180 - set value if provided by notification trap and oid-specific-problem-desc configured.
192 - set value if provided by notification trap and event-category configured.
193 * - alarmAdditional Information
198 - Map of OID with values
204 - set value if provided by notification trap and oid-alarm-interface-name configured.
206 Mapping Configuration
207 ---------------------
209 Configuration file **fm-ves-message-mapping.yaml** contains all definitions required to define the mapping
210 from trap provided information to VES Message format
212 **trap mapping example**
214 .. literalinclude:: fm-ves-message-mapping.yaml
219 - **reporting-entity-name** Reporting entity name assigned to the event
220 - **reporting-entity-id** Reporting entity id assigned to the event
221 - **nf-vendor-name** Vendor name assigned to the event
224 - **oid** *OID* trap identifier
225 - **name** Name of the trap
226 - **event-severity** Severity assigned to the event
227 - **event-category** Category assigned to the event
228 - **event-source-type** Source type assigned to the event
229 - **oid-event-id** *OID* containing the event entity id e.g. port interface
230 - **oid-event-sequence** Event sequence 0 on a raise and 1 on a clear
231 - **oid-reporting-entity-id** *OID* containing the reporting entity id
232 - **oid-source-name** *OID* containing the source name
233 - **oid-specific-problem-desc** *OID* containing the trap problem description
234 - **oid-start-epoch-microsec** *OID* containing the alarm start epoch
235 - **oid-last-epoch-microsec** *OID* containing the alarm last epoch
236 - **oid-alarm-interface-name** *OID* containing the interface name
238 **Output example for port down trap**
240 .. literalinclude:: PortDOWN.json
243 **Output example for any undefined trap**
245 Undefined trap will use the mapping defined for default.
247 .. literalinclude:: unknown-trap.json