docs/release-notes/projects/snmp.rst

   1 ============
   2 SNMP Plug-in
   3 ============
   4
   5 Major Features
   6 ==============
   7
   8 odl-snmp-plugin
   9 ---------------
  10
  11 * **Feature URL:**  https://git.opendaylight.org/gerrit/gitweb?p=snmp.git;a=blob;f=features/features-snmp/src/main/features/features.xml;hb=stable/carbon
  12 * **Feature Description:**  Provides NB API to SB SNMP interface
  13 * **Top Level:** Yes
  14 * **User Facing:** Yes
  15 * **Experimental:** Yes
  16 * **CSIT Test:**
  17
  18   * https://jenkins.opendaylight.org/releng/view/snmp/job/snmp-csit-1node-basic-all-nitrogen/
  19
  20 Documentation
  21 =============
  22
  23 * **Getting Started:**
  24
  25   * `SNMP Plugin:Getting Started
  26     <https://wiki.opendaylight.org/view/SNMP_Plugin:Getting_Started>`_
  27
  28 * **User Guide:**
  29
  30   * :ref:`snmp-user-guide`
  31
  32 * **SNMP Simulator:**
  33
  34   * `SNMP simulator guide <https://wiki.opendaylight.org/view/SNMP_Plugin:SNMP_Simulator>`_
  35
  36 Security Considerations
  37 =======================
  38
  39 * Do you have any external interfaces other than RESTCONF?
  40
  41   Yes, this plugin provides SNMP endpoints for talking to southbound devices.
  42
  43 * Other security issues?
  44
  45   Securing communication to devices (or not) over SNMP is outside the scope of\
  46   this project and left to users.
  47
  48 Quality Assurance
  49 =================
  50
  51 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=69960>`_ (3.5% code coverage)
  52 * Link to CSIT Jobs:
  53
  54   * https://jenkins.opendaylight.org/releng/view/snmp/job/snmp-csit-1node-basic-all-nitrogen/
  55
  56 * Other manual testing and QA information: None
  57
  58 Migration
  59 ---------
  60
  61 * Is it possible to migrate from the previous release? If so, how?
  62
  63   It is possible to seamlessly migrate consumers to this iteration of the plug-in as there has been no functional
  64   change to features. Migration of state data is not defined.
  65
  66 Compatibility
  67 -------------
  68
  69 Compatible with the previous release, no functional change to features
  70
  71 Bugs Fixed
  72 ----------
  73
  74 * List of bugs fixed since the previous release
  75
  76   None - no functional change to features
  77
  78 Known Issues
  79 ------------
  80
  81 * List key known issues with workarounds
  82
  83   No known issues
  84
  85 * `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?component=General&list_id=29216&product=snmp>`_
  86
  87
  88
  89 End-of-life
  90 ===========
  91
  92 * List of features/APIs which are EOLed, deprecated, and/or removed in this release
  93
  94   None
  95
  96 Standards
  97 =========
  98
  99 * List of standards implemented and to what extent
 100
 101   * `SNMP <https://www.ietf.org/rfc/rfc1157.txt/>`_
 102
 103
 104 Release Mechanics
 105 =================
 106
 107 * `Link to release plan <https://wiki.opendaylight.org/view/SNMP_Plugin:Nitrogen_Release_Plan>`_
 108 * Describe any major shifts in release schedule from the release plan
 109
 110   None