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