update link to upper-constraints.txt
[dcaegen2.git] / docs / sections / services / mapper / SampleSnmpTrapConversion.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2018 Tech Mahindra Ltd.
4
5 Sample Snmp trap Conversion:
6 ============================
7
8 Following is the **Sample SNMP Trap** that will be received by the Universal VES Adapter from the Snmp Trap Collector :
9
10 .. code-block:: json
11
12     {
13    "cambria.partition":"10.53.172.132",
14    "trap category":"ONAP-COLLECTOR-SNMPTRAP",
15    "community len":0,
16    "protocol version":"v2c",
17    "varbinds":[
18       {
19          "varbind_value":"CLEARED and CRITICAL severities have the same name",
20          "varbind_oid":"1.3.6.1.4.1.19444.12.2.0.2.0",
21          "varbind_type":"OctetString"
22       },
23       {
24          "varbind_value":"1.3",
25          "varbind_oid":"1.3.6.1.4.1.19444.12.2.0.3.0",
26          "varbind_type":"ObjectIdentifier"
27       },
28       {
29          "varbind_value":"1.3",
30          "varbind_oid":"1.3.6.1.4.1.19444.12.2.0.4.0",
31          "varbind_type":"ObjectIdentifier"
32       },
33       {
34          "varbind_value":"CLEARED",
35          "varbind_oid":"1.3.6.1.4.1.19444.12.2.0.5.0",
36          "varbind_type":"OctetString"
37       },
38       {
39          "varbind_value":"Queue manager: Process failure cleared",
40          "varbind_oid":"1.3.6.1.4.1.19444.12.2.0.6.0",
41          "varbind_type":"OctetString"
42       },
43       {
44          "varbind_value":"The queue manager process has been restored to normal operation",
45          "varbind_oid":"1.3.6.1.4.1.19444.12.2.0.7.0",
46          "varbind_type":"OctetString"
47       },
48       {
49          "varbind_value":"The queue manager process has been restored to normal operation. The previously issued alarm has been cleared",
50          "varbind_oid":"1.3.6.1.4.1.19444.12.2.0.8.0",
51          "varbind_type":"OctetString"
52       },
53       {
54          "varbind_value":"Changes to shared config will be synchronized across the cluster",
55          "varbind_oid":"1.3.6.1.4.1.19444.12.2.0.9.0",
56          "varbind_type":"OctetString"
57       },
58       {
59          "varbind_value":"No action",
60          "varbind_oid":"1.3.6.1.4.1.19444.12.2.0.10.0",
61          "varbind_type":"OctetString"
62       },
63       {
64          "varbind_value":"sprout-1.example.com",
65          "varbind_oid":"1.3.6.1.4.1.19444.12.2.0.12.0",
66          "varbind_type":"OctetString"
67       }
68    ],
69    "notify OID":"1.3.6.1.6.3.1.1.5.3",
70    "community":"",
71    "uuid":"1fad4802-a6d0-11e8-a349-0242ac110002",
72    "epoch_serno":15350273450000,
73    "agent name":"10.53.172.132",
74    "sysUptime":"0",
75    "time received":1.535027345042007E9,
76    "agent address":"10.53.172.132",
77    "notify OID len":10
78  }
79
80
81 Following is the converted VES Format of the above SNMP Sample Trap by using the default SNMP Trap Mapping File:
82
83 .. code-block:: json
84
85  {
86    "event":{
87       "commonEventHeader":{
88          "startEpochMicrosec":1.5350269902625413E9,
89          "eventId":"XXXX",
90          "sequence":0,
91          "domain":"fault",
92          "lastEpochMicrosec":1.5350269902625413E9,
93          "eventName":"fault__ONAP-COLLECTOR-SNMPTRAP",
94          "sourceName":"10.53.172.132",
95          "priority":"Medium",
96          "version":3,
97          "reportingEntityName":"VesAdapter"
98       },
99       "faultFields":{
100          "eventSeverity":"MINOR",
101          "alarmCondition":"ONAP-COLLECTOR-SNMPTRAP",
102          "faultFieldsVersion":2,
103          "specificProblem":"SNMP Fault",
104          "alarmAdditionalInformation":[
105             {
106                "name":"1.3.6.1.4.1.19444.12.2.0.2.0",
107                "value":"CLEARED and CRITICAL severities have the same name"
108             },
109             {
110                "name":"1.3.6.1.4.1.19444.12.2.0.3.0",
111                "value":"1.3"
112             },
113             {
114                "name":"1.3.6.1.4.1.19444.12.2.0.4.0",
115                "value":"1.3"
116             },
117             {
118                "name":"1.3.6.1.4.1.19444.12.2.0.5.0",
119                "value":"CLEARED"
120             },
121             {
122                "name":"1.3.6.1.4.1.19444.12.2.0.6.0",
123                "value":"Queue manager: Process failure cleared"
124             },
125             {
126                "name":"1.3.6.1.4.1.19444.12.2.0.7.0",
127                "value":"The queue manager process has been restored to normal operation"
128             },
129             {
130                "name":"1.3.6.1.4.1.19444.12.2.0.8.0",
131                "value":"The queue manager process has been restored to normal operation. The previously issued alarm has been cleared"
132             },
133             {
134                "name":"1.3.6.1.4.1.19444.12.2.0.9.0",
135                "value":"Changes to shared config will be synchronized across the cluster"
136             },
137             {
138                "name":"1.3.6.1.4.1.19444.12.2.0.10.0",
139                "value":"No action"
140             },
141             {
142                "name":"1.3.6.1.4.1.19444.12.2.0.12.0",
143                "value":"sprout-1.example.com"
144             }
145          ],
146          "eventSourceType":"SNMP Agent",
147          "vfStatus":"Active"
148       }
149    }
150  }