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