Fix Sonar complains
[oam/nf-oam-adopter.git] / docs / snmp / index.rst
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.
4
5 SNMP2VES Manager
6 ################
7
8 SNMP Manager library follows `VES Event Listener 7.1 <https://docs.onap.org/projects/onap-vnfrqts-requirements/en/latest/Chapter8/ves7_1spec.html#>`_
9
10 .. toctree::
11    :maxdepth: 3
12    :caption: Contents:
13
14 FM VES Message
15 --------------
16
17 Datatype: commonEventHeader
18 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
19
20 .. list-table::
21    :header-rows: 1
22
23    * - Field
24      - Mandatory
25      - Default value
26      - Configurable
27      - Runtime
28      - Notes
29    * - domain
30      - yes
31      - fault
32      - no
33      - no
34      - none
35    * - eventId
36      - yes
37      - SNMP Trap RequestID
38      - yes
39      - yes
40      - Uses default defined value if TRAP OID not configured
41    * - eventName
42      - yes
43      - SNMP Fault
44      - yes
45      - yes
46      - Uses default defined value if TRAP OID not configured
47    * - priority
48      - yes
49      - HIGH
50      - no
51      - no
52      - none
53    * - reportingEntityName
54      - yes
55      - NF-OAM-ADOPTER
56      - yes
57      - yes
58      - set value if provided by notification trap and oid-reporting-entity-name configured.
59    * - startEpochMicrosec
60      - yes
61      - System time at the moment of notification generation
62      - yes
63      - yes
64      - set value if provided by notification trap and oid-start-epoch-microsec configured.
65    * - lastEpochMicrosec
66      - yes
67      - System time at the moment of notification generation
68      - yes
69      - yes
70      - set value if provided by notification trap and oid-last-epoch-microsec configured.
71    * - sequence
72      - yes
73      - 0
74      - yes
75      - yes
76      - set value if provided by notification trap and oid-event-sequence configured.
77    * - sourceName
78      - yes
79      - Host Address of SNMP Agent sending the trap notification
80      - yes
81      - yes
82      - set value if provided by notification trap and oid-source-name configured.
83    * - version
84      - yes
85      - 4.1
86      - yes
87      - no
88      - Library only enforces mandatory fields for 4.1 version
89    * - vesEventListenerVersion
90      - yes
91      - 7.1
92      - none
93      - no
94      - Library only enforces mandatory fields for 7.1 version
95    * - eventType
96      - no
97      - none
98      - no
99      - no
100      - none
101    * - nfcNamingCode
102      - no
103      - none
104      - no
105      - no
106      - none
107    * - nfNamingCode
108      - no
109      - none
110      - no
111      - no
112      - none
113    * - nfVendorName
114      - no
115      - NF-OAM-ADOPTER-VENDOR
116      - yes
117      - no
118      - none
119    * - reportingEntityId
120      - no
121      - none
122      - no
123      - yes
124      - set value if provided by notification trap and oid-reporting-entity-id configured.
125    * - internalHeader Fields
126      - no
127      - none
128      - no
129      - no
130      - none
131    * - sourceId
132      - no
133      - none
134      - none
135      - no
136      - none
137    * - timeZoneOffset
138      - no
139      - none
140      - no
141      - no
142      - none
143
144 Datatype: faultFields
145 ~~~~~~~~~~~~~~~~~~~~~
146
147 .. list-table::
148    :header-rows: 1
149
150    * - Field
151      - Mandatory
152      - Default value
153      - Configurable
154      - Runtime
155      - Notes
156    * - alarmCondition
157      - yes
158      - SNMP Fault
159      - yes
160      - yes
161      - set value if provided by notification trap and trap configured.
162    * - eventSeverity
163      - yes
164      - CRITICAL
165      - yes
166      - yes
167      - set value if provided by notification trap and event-severity configured.
168    * - eventSourceType
169      - yes
170      - SNMP Agent
171      - yes
172      - no
173      - none
174    * - faultFieldsVersion
175      - yes
176      - 4.0
177      - no
178      - no
179      - none
180    * - specificProblem
181      - yes
182      - SNMP Fault
183      - no
184      - yes
185      - set value if provided by notification trap and oid-specific-problem-desc configured.
186    * - vfStatus
187      - yes
188      - ACTIVE
189      - no
190      - no
191      - none
192    * - eventCategory
193      - no
194      - none
195      - no
196      - yes
197      - set value if provided by notification trap and event-category configured.
198    * - alarmAdditional Information
199      - no
200      - no
201      - no
202      - yes
203      - Map of OID with values
204    * - alarmInterfaceA
205      - no
206      - none
207      - no
208      - yes
209      - set value if provided by notification trap and oid-alarm-interface-name configured.
210
211 Mapping Configuration
212 ---------------------
213
214 Configuration file **fm-ves-message-mapping.yaml** contains all definitions required to define the mapping
215 from trap provided information to VES Message format
216
217 **trap mapping example**
218
219 .. literalinclude:: fm-ves-message-mapping.yaml
220   :language: YAML
221
222 - **global**
223
224      - **reporting-entity-name** Reporting entity name assigned to the event
225      - **reporting-entity-id** Reporting entity id assigned to the event
226      - **nf-vendor-name** Vendor name assigned to the event
227
228 - **traps**
229     - **oid** *OID* trap identifier
230     - **name** Name of the trap
231     - **event-severity** Severity assigned to the event
232     - **event-category**  Category assigned to the event
233     - **event-source-type** Source type assigned to the event
234     - **oid-event-id** *OID* containing the event entity id e.g. port interface
235     - **oid-event-sequence** Event sequence 0 on a raise and 1 on a clear
236     - **oid-reporting-entity-id** *OID* containing the reporting entity id
237     - **oid-source-name** *OID* containing the source name
238     - **oid-specific-problem-desc** *OID* containing the trap problem description
239     - **oid-start-epoch-microsec** *OID* containing the alarm start epoch
240     - **oid-last-epoch-microsec** *OID* containing the alarm last epoch
241     - **oid-alarm-interface-name** *OID* containing the interface name
242
243 **Output example for port down trap**
244
245 .. literalinclude:: PortDOWN.json
246   :language: JSON
247
248 **Output example for any undefined trap**
249
250 Undefined trap will use the mapping defined for default.
251
252 .. literalinclude:: unknown-trap.json
253   :language: JSON