net-snmp - npm Package Compare versions

Comparing version 2.1.0 to 2.1.1

package.json

 {
   "name": "net-snmp",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "JavaScript implementation of the Simple Network Management Protocol (SNMP)",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -32,4 +32,2 @@
         }
-
-        // If done, close the session
         session.close ();
@@ -46,2 +44,35 @@ });
 
+# Functionality
+
+RFC 3413 describes five types of SNMP applications:
+
+ 1. Command Generator Applications — which initiate read or write requests
+ 2. Command Responder Applications — which respond to received read or write requests
+ 3. Notification Originator Applications — which generate notifications (traps or informs)
+ 4. Notification Receiver Applications — which receive notifications (traps or informs)
+ 5. Proxy Forwarder Applications — which forward SNMP messages
+
+This library provides an API for (1) and (3) in the section
+[Using This Module: Command & Notification Generator](#using-this-module:-command-&-notification-generator),
+and an API for (4) in the section [Using This Module: Notification Receiver](#using-this-module:-notification-receiver).
+It does not provide support for (2) — traditionally known as "SNMP agents" — nor for (5).
+
+Features:
+ * Support for all SNMP versions: SNMPv1, SNMPv2c and SNMPv3
+ * SNMPv3 message authentication using MD5 and SHA, and DES encryption
+ * Community-based and user-based authorization
+ * SNMP initiator for these protocol operations: Get, GetNext, GetBulk, Set, Trap, Inform
+ * Convenience methods for MIB "walking", subtree collection, table and table column collection
+ * SNMP receiver for traps and informs
+
+Not implemented, but on the roadmap:
+ * SNMP agent (Command Responder Application)
+ * AgentX ([RFC 2741][AgentX])
+
+Not implemented, but further down the priority list:
+ * MIB parsing
+ * Proxy Forwarder Application
+
+[AgentX]: https://tools.ietf.org/html/rfc2741 "AgentX"
+
 # Standards Compliance
@@ -369,3 +400,4 @@
 
-RFC 3413 describes "Command Generator" and "Notification Originator" types of SNMP applications.  This library provides a `Session` class to provide support for building these two types of application.
+This library provides a `Session` class to provide support for building
+"Command Generator" and "Notification Originator" SNMP applications.
 
@@ -1230,3 +1262,4 @@ All SNMP requests are made using an instance of the `Session` class.  This
 RFC 3413 classifies a "Notification Receiver" SNMP application that receives
-"Notification-Class" PDUs.  This library is able to receive these types of PDU:
+"Notification-Class" PDUs. Notifications include both SNMP traps and informs.
+This library is able to receive all types of notification PDU:
 
@@ -1553,2 +1586,6 @@ * `Trap-PDU` (original v1 trap PDUs, which are now considered obselete)
 
+## Version 2.1.1 - 17/01/2020
+
+ * Add CONTRIBUTING.md guidelines
+
 # License
@@ -1555,0 +1592,0 @@

No alert changes

Improved metrics

Total package byte prevSize

1016654

increased by0.59%

Number of package files

36

increased by2.86%

Number of lines in readme file

1611

increased by2.35%

No dependency changes