This module implements version 1 and 2c of the Simple Network Management Protocol (SNMP).
This module is installed using node package manager (npm):
npm install net-snmp
It is loaded using the require() function:
var snmp = require ("net-snmp");
Sessions to remote hosts can then be created and used to perform SNMP requests and send SNMP traps or informs:
var session = snmp.createSession ("127.0.0.1", "public");
var oids = ["1.3.6.1.2.1.1.5.0", "1.3.6.1.2.1.1.6.0"];
session.get (oids, function (error, varbinds) {
if (error) {
console.error (error);
} else {
for (var i = 0; i < varbinds.length; i++)
if (snmp.isVarbindError (varbinds[i])
console.error (snmp.varbindError (varbinds[i])
else
console.log (varbinds[i].oid + " = " + varbinds[i].value);
}
});
session.trap (snmp.TrapType.LinkDown, function (error) {
if (error)
console.error (error);
});
This module aims to be fully compliant with the following RFCs:
However, this module does not implement, or export any method that might help to implement, the SNMP version 2c report request type.
The following sections describe constants exported and used by this module.
These constants are used to specify which of the two versions supported by this module should be used.
This object contains constants for all valid values the error-status field in
response PDUs can hold. If when parsing a PDU the error-index field contains
a value not defined in this object the constant snmp.ErrorStatus.GeneralError
will be used instead of the value in the error-status field. The following
constants are defined in this object:
NoErrorTooBigNoSuchNameBadValueReadOnlyGeneralErrorNoAccessWrongTypeWrongLengthWrongEncodingWrongValueNoCreationInconsistentValueResourceUnavailableCommitFailedUndoFailedAuthorizationErrorNotWritableInconsistentNameThis object contains constants used to specify syntax for varbind objects, e.g.:
var varbind = {
oid: "1.3.6.1.2.1.1.4.0",
type: snmp.ObjectType.OctetString,
value: "user.name@domain.name"
};
The following constants are defined in this object:
BooleanIntegerOctetStringNullOIDIpAddressCounterGaugeTimeTicksOpaqueInteger32Counter32Gauge32Unsigned32Counter64NoSuchObjectNoSuchInstanceEndOfMibViewThis object contains constants used to specify a type of SNMP trap. These
constants are passed to the trap() and inform() methods exposed by the
Session class. The following constants are defined in this object:
ColdStartWarmStartLinkDownLinkUpAuthenticationFailureEgpNeighborLossEnterpriseSpecificSome parts of this module accept simple OID strings, e.g.:
var oid = "1.3.6.1.2.1.1.5.0";
Other parts take an OID string, it's type and value. This is collectively referred to as a varbind, and is specified as an object, e.g.:
var varbind = {
oid: "1.3.6.1.2.1.1.5.0",
type: snmp.ObjectType.OctetString,
value: new Buffer ("host1")
};
The type parameter is one of the constants defined in the snmp.ObjectType
object.
The JavaScript true and false keywords are used for the values of varbinds
with type Boolean.
All integer based types are specified as expected (this includes Integer,
Counter, Gauge, TimeTicks, Integer32, Counter32, Gauge32, and
Unsigned32), e.g. -128 or 100.
Since JavaScript does not offer full 64 bit integer support objects with type
Counter64 cannot be supported in the same way as other integer types,
instead Node.js Buffer objects are used. Users are responsible for
producing (i.e. for set() requests) and consuming (i.e. the varbinds passed
to callback functions) Buffer objects. That is, this module does not work
with 64 bit integers, it simply treats them as opaque Buffer objects.
Dotted decimal strings are used for the values of varbinds with type OID,
e.g. 1.3.6.1.2.1.1.5.0.
Dotted quad formatted strings are used for the values of varbinds with type
IpAddress, e.g. 192.168.1.1.
Node.js Buffer objects are used for the values of varbinds with
type Opaque and OctetString. For varbinds with type OctetString this
module will accept JavaScript strings, but will always give back Buffer
objects.
The NoSuchObject, NoSuchInstance and EndOfMibView types are used to
indicate an error condition. Currently there is no reason for users of this
module to to build varbinds using these types.
Most of the request methods exposed by this module require a mandatory callback function. This function is called once a request has been processed. This could be because an error occurred when processing the request, a trap has been dispatched or a successful response was received.
The first parameter to every callback is an error object. In the case no error occurred this parameter will be "null" indicating no error, e.g.:
function responseCb (error, varbinds) {
if (error) {
console.error (error);
} else {
// no error, do something with varbinds
}
}
When defined, the error parameter is always an instance of the Error class,
or a sub-class described in one of the sub-sections contained in this section.
The semantics of error handling is slightly different between SNMP version 1 and 2c. In SNMP version 1 if an error occurs when calculating the value for one OID the request as a whole will fail, i.e. no OIDs will have a value.
This failure manifests itself within the error-status and error-index fields
of the response. When the error-status field in the response is non-zero,
i.e. not snmp.ErrorStatus.NoError the callback will be called with error
defined detailing the error.
Requests made with SNMP version 1 can simply assume all OIDs have a value when
no error object is passed to the callback, i.e.:
var oids = ["1.3.6.1.2.1.1.5.0", "1.3.6.1.2.1.1.6.0"];
session.get (oids, function (error, varbinds) {
if (error) {
console.error (error.toString ());
} else {
var sysName = varbinds[0].value; // this WILL have a value
}
});
In SNMP version 2c instead of using the error-status and error-index fields of
the response to signal an error, the value for the varbind placed in the
response for an OID will have an object syntax describing an error. The
error-status and error-index fields of the response will indicate the request
was successul, i.e. snmp.ErrorStatus.NoError.
This changes the way in which error checking is performed in the callback.
When using SNMP version 2c each varbind must be checked to see if its value
was computed and returned successfully:
var oids = ["1.3.6.1.2.1.1.5.0", "1.3.6.1.2.1.1.6.0"];
session.get (oids, function (error, varbinds) {
if (error) {
console.error (error.toString ());
} else {
if (varbinds[0].type != snmp.ErrorStatus.NoSuchObject
&& varbinds[0].type != snmp.ErrorStatus.NoSuchInstance
&& varbinds[0].type != snmp.ErrorStatus.EndOfMibView) {
var sysName = varbinds[0].value;
} else {
console.error (snmp.ObjectType[varbinds[0].type] + ": "
+ varbinds[0].oid);
}
}
});
This module exports two functions and promotes a specifc pattern to make error
checking a little simpler. Firstly, regardless of version in use varbinds can
always be checked. This results in a generic callback that can be used for
both versions.
The isVarbindError() function can be used to determine if a varbind has an
error condition. This function takes a single varbind parameter and returns
true if the varbind has an error condition, otherwise false. The exported
varbindError() function can then be used to obtain the error string
describing the error, which will include the OID for the varbind:
session.get (oids, function (error, varbinds) {
if (error) {
console.error (error.toString ());
} else {
if (snmp.isVarbindError (varbinds[0])) {
console.error (snmp.varbindError (varbinds[0]));
} else {
var sysName = varbinds[0].value;
}
}
});
If the varbindError function is called with a varbind for which
isVarbindError would return false, the string NotAnError will be returned
appended with the related OID.
The sections following defines the error classes used by this module.
This error indicates a remote host failed to process a request. The exposed
message attribute will contain a detailed error message. This error also
exposes a status attribute which contains the error-index value from a
response. This will be one of the constants defined in the
snmp.ErrorStatus object.
This error indicates a failure to render a request message before it could be
sent. The error can also indicate that a parameter provided was invalid.
The exposed message attribute will contain a detailed error message.
This error states that no response was received for a particular request. The
exposed message attribute will contain the value Request timed out.
This error indicates a failure to parse a response message. The exposed
message attribute will contain a detailed error message.
All SNMP requests are made using an instance of the Session class. This
module exports the createSession() function which is used to create
instances of the Session class.
The createSession() function instantiates and returns an instance of the
Session class:
// Default options
var options = {
port: 161,
retries: 1,
timeout: 5000,
transport: "udp4",
trapPort: 162,
version: snmp.Version1
};
var session = snmp.createSession ("127.0.0.1", "public", options);
The optional target parameter defaults to 127.0.0.1. The optional
community parameter defaults to public. The optional options parameter
is an object, and can contain the following items:
port - UDP port to send requests too, defaults to 161retries - Number of times to re-send a request, defaults to 1timeout - Number of milliseconds to wait for a response before re-trying
or failing, defaults to 5000transport - Specify the transport to use, can be either udp4 or udp6,
defaults to udp4trapPort - UDP port to send traps and informs too, defaults to 162version - Either snmp.Version1 or snmp.Version2c, defaults to
snmp.Version1The get() method fetches the value for one or more OIDs.
The oids parameter is an array of OID strings. The callback function is
called once the request is complete. The following arguments will be passed
to the callback function:
error - Instance of the Error class or a sub-class, or null if no
error occurredvarbinds - Array of varbinds, will not be provided if an error occurredThe varbind in position N in the varbinds array will correspond to the OID
in position N in the oids array in the request.
Each varbind must be checked for an error condition using the
snmp.isVarbindError() function when using SNMP version 2c.
The following example fetches values for the sysName (1.3.6.1.2.1.1.5.0) and
sysLocation (1.3.6.1.2.1.1.6.0) OIDs:
var oids = ["1.3.6.1.2.1.1.5.0", "1.3.6.1.2.1.1.6.0"];
session.get (oids, function (error, varbinds) {
if (error) {
console.error (error.toString ());
} else {
for (var i = 0; i < varbinds.length; i++) {
// for version 1 we can assume all OIDs were successful
console.log (varbinds[i].oid + "|" + varbinds[i].value);
// for version 2c we must check each OID for an error condition
if (snmp.isVarbindError (varbinds[i]))
console.error (snmp.varbindError (varbinds[i]));
else
console.log (varbinds[i].oid + "|" + varbinds[i].value);
}
}
});
The getBulk() method fetches the value for the OIDs lexicographically
following one or more OIDs in the MIB tree.
The oids parameter is an array of OID strings. The optional nonRepeaters
parameter specifies the number of OIDs in the oids parameter for which only
1 varbind should be returned, and defaults to 0. For each remaining OID
in the oids parameter the optional maxRepetitions parameter specifies how
many OIDs lexicographically following an OID for which varbinds should be
fetched, and defaults to 20.
The callback function is called once the request is complete. The following
arguments will be passed to the callback function:
error - Instance of the Error class or a sub-class, or null if no
error occurredvarbinds - Array of varbinds, will not be provided if an error occurredThe varbind in position N in the varbinds array will correspond to the OID
in position N in the oids array in the request.
For for the first nonRepeaters items in varbinds each item will be a
single varbind. For all remaining items in varbinds each item will be an
array of varbinds - this makes it easy to tie response varbinds with requested
OIDs since response varbinds are grouped and placed in the same position in
varbinds.
Each varbind must be checked for an error condition using the
snmp.isVarbindError() function when using SNMP version 2c.
The following example fetches values for the OIDs following the sysContact
(1.3.6.1.2.1.1.4.0) and sysName (1.3.6.1.2.1.1.5.0) OIDs, and up to the
first 20 OIDs in the ifDescr (1.3.6.1.2.1.2.2.1.2) and ifType
(1.3.6.1.2.1.2.2.1.3) columns from the ifTable (1.3.6.1.2.1.2.2) table:
var oids = [
"1.3.6.1.2.1.1.4.0",
"1.3.6.1.2.1.1.5.0",
"1.3.6.1.2.1.2.2.1.2",
"1.3.6.1.2.1.2.2.1.3"
];
var nonRepeaters = 2;
session.getNext (oids, nonRepeaters, function (error, varbinds) {
if (error) {
console.error (error.toString ());
} else {
// step through the non-repeaters which are single varbinds
for (var i = 0; i < nonRepeaters; i++) {
if (i >= varbinds.length)
break;
if (snmp.isVarbindError (varbinds[i]))
console.error (snmp.varbindError (varbinds[i]));
else
console.log (varbinds[i].oid + "|" + varbinds[i].value);
}
// then step through the repeaters which are varbind arrays
for (var i = nonRepeaters; i < varbinds.length; i++) {
for (var j = 0; j < varbinds[i].length; j++) {
if (snmp.isVarbindError (varbinds[i][j]))
console.error (snmp.varbindError (varbinds[i][j]));
else
console.log (varbinds[i][j].oid + "|"
+ varbinds[i][j].value);
}
}
});
The getNext() method fetches the value for the OIDs lexicographically
following one or more OIDs in the MIB tree.
The oids parameter is an array of OID strings. The callback function is
called once the request is complete. The following arguments will be passed
to the callback function:
error - Instance of the Error class or a sub-class, or null if no
error occurredvarbinds - Array of varbinds, will not be provided if an error occurredThe varbind in position N in the varbinds array will correspond to the OID
in position N in the oids array in the request.
Each varbind must be checked for an error condition using the
snmp.isVarbindError() function when using SNMP version 2c.
The following example fetches values for the next OIDs following the
sysObjectID (1.3.6.1.2.1.1.1.0) and sysName (1.3.6.1.2.1.1.4.0) OIDs:
var oids = [
"1.3.6.1.2.1.1.1.0",
"1.3.6.1.2.1.1.4.0"
];
session.getNext (oids, function (error, varbinds) {
if (error) {
console.error (error.toString ());
} else {
for (var i = 0; i < varbinds.length; i++) {
// for version 1 we can assume all OIDs were successful
console.log (varbinds[i].oid + "|" + varbinds[i].value);
// for version 2c we must check each OID for an error condition
if (snmp.isVarbindError (varbinds[i]))
console.error (snmp.varbindError (varbinds[i]));
else
console.log (varbinds[i].oid + "|" + varbinds[i].value);
}
}
});
The inform() method sends a SNMP inform.
The typeOrOid parameter can be one of two types; one of the constants
defined in the snmp.TrapType object (excluding the
snmp.TrapType.EnterpriseSpecific constant), or an OID string.
The first varbind to be placed in the request message will be for the
sysUptime.0 OID (1.3.6.1.6.3.1.1.4.1.0). The value for this varbind will
be the value returned by the process.uptime () function multiplied by 100.
This will be followed by a second varbind for the snmpTrapOID.0 OID
(1.3.6.1.6.3.1.1.4.1.0). The value for this will depend on the typeOrOid
parameter. If a constant is specified the trap OID for the constant will be
used as supplied for the varbinds value, otherwise the OID string specified
will be used as is for the value of the varbind.
The optional varbinds parameter is an array of varbinds to include in the
inform request, and defaults to the empty array [].
The callback function is called once the trap has been sent, or an error
occurred. The following arguments will be passed to the callback function:
error - Instance of the Error class or a sub-class, or null if no
error occurredvarbinds - Array of varbinds, will not be provided if an error occurredThe varbind in position N in the varbinds array will correspond to the
varbind in position N in the varbinds array in the request. The remote host
should echo back varbinds and their values as specified in the request, and
the varbinds array will contain each varbind as sent back by the remote host.
Normally there is no reason to use the contents of the varbinds parameter
since the varbinds are as they were sent in the request.
The following example sends a generic cold-start inform to a remote host, it does not include any varbinds:
session.inform (snmp.TrapType.ColdStart, function (error) {
if (error)
console.error (error);
});
The following example sends an enterprise specific inform to a remote host, and includes two enterprise specific varbinds:
var informOid = "1.3.6.1.4.1.2000.1";
var varbinds = [
{
oid: "1.3.6.1.4.1.2000.2",
type: snmp.Type.OctetString,
value: "Periodic hardware self-check"
},
{
oid: "1.3.6.1.4.1.2000.3",
type: snmp.Type.OctetString,
value: "hardware-ok"
}
];
session.inform (informOid, varbinds, function (error) {
if (error)
console.error (error);
});
The set() method sets the value of one or more OIDs.
The varbinds parameter is an array of varbind objects. The callback
function is called once the request is complete. The following arguments will
be passed to the callback function:
error - Instance of the Error class or a sub-class, or null if no
error occurredvarbinds - Array of varbinds, will not be provided if an error occurredThe varbind in position N in the varbinds array will correspond to the
varbind in position N in the varbinds array in the request. The remote host
should echo back varbinds and their values as specified in the request unless
an error occurred. The varbinds array will contain each varbind as sent
back by the remote host.
Each varbind must be checked for an error condition using the
snmp.isVarbindError() function when using SNMP version 2c.
The following example sets the value of the sysName (1.3.6.1.2.1.1.4.0) and
sysLocation (1.3.6.1.2.1.1.6.0) OIDs:
var varbinds = [
{
oid: "1.3.6.1.2.1.1.5.0",
type: snmp.ObjectType.OctetString,
value: "host1"
}, {
oid: "1.3.6.1.2.1.1.6.0",
type: snmp.ObjectType.OctetString,
value: "somewhere"
}
];
session.set (varbinds, function (error, varbinds) {
if (error) {
console.error (error.toString ());
} else {
for (var i = 0; i < varbinds.length; i++) {
// for version 1 we can assume all OIDs were successful
console.log (varbinds[i].oid + "|" + varbinds[i].value);
// for version 2c we must check each OID for an error condition
if (snmp.isVarbindError (varbinds[i]))
console.error (snmp.varbindError (varbinds[i]));
else
console.log (varbinds[i].oid + "|" + varbinds[i].value);
}
}
});
The subtree() method fetches the value for all OIDs lexicographically
following a specified OID in the MIB tree which have the specified OID as
there base. For example, the OIDs sysName (1.3.6.1.2.1.1.5.0) and
sysLocation (1.3.6.1.2.1.1.6.0) both have the same base system
(1.3.6.1.2.1.1) OID.
For SNMP version 1 repeated get() calls are made until the one of the
returned OIDs does not use the specified OID as its base. For SNMP version
2c repeated getBulk() calls are made until the one of the returned OIDs
does no used the specified OID as its base.
The oid parameter is an OID string. The optional maxRepetitions parameter
is passed to getBulk() requests when SNMP version 2c is being used.
This method will not call a single callback once all OID values are fetched.
Instead the feedCallback function will be called each time a response is
received from the remote host. The following arguments will be passed to the
feedCallback function:
varbinds - Array of varbinds, and will contain at least one varbindEach varbind must be checked for an error condition using the
snmp.isVarbindError() function when using SNMP version 2c.
Once at least one of the returned OIDs does not use the specified OID as its
base, or an error has occurred, the doneCallback function will be called.
The following arguments will be passed to the doneCallback function:
error - Instance of the Error class or a sub-class, or null if no
error occurredOnce the doneCallback function has been called the request is complete and
the requestCallback function will no longer be called.
If the feedCallback function returns a true value when called no more
get() or getBulk() method calls will be made and the doneCallback will
be called.
The following example fetches all OIDS under the system (1.3.6.1.2.1.1) OID:
var oid = "1.3.6.1.2.1.1";
function doneCb (error) {
if (error)
console.error (error.toString ());
}
function feedCb (varbinds) {
for (var i = 0; i < varbinds.length; i++) {
if (snmp.isVarbindError (varbinds[i]))
console.error (snmp.varbindError (varbinds[i]));
else
console.log (varbinds[i].oid + "|" + varbinds[i].value);
}
}
var maxRepetitions = 20;
// The maxRepetitions argument is optional, and will be ignored unless using
// SNMP verison 2c
session.subtree (oid, maxRepetitions, feedCb, doneCb);
The table() method fetches the value for all OIDs lexicographically
following a specified OID in the MIB tree which have the specified OID as
there base, much like the subtree() method.
This method is designed to fetch conceptial tables, for example the ifTable
(1.3.6.1.2.1.2.2) table. The values for returned varbinds will be structured
into objects to represent conceptual rows. Each row is then placed into an
object with the rows index being the key, e.g.:
var table = {
// Rows keyed by ifIndex (1 and 2 are shown)
1: {
// ifDescr (column 2) and ifType (columnd 3) are shown
2: "interface-1",
3: 6,
...
},
2: {
2: "interface-2",
3: 6,
...
},
...
}
Internally this method calls the subtree() method to obtain the subtree of
the specified table.
The oid parameter is an OID string. If an OID string is passed which does
not represent a table the resulting object produced to hold table data will be
empty, i.e. it will contain no indexes and rows. The optional
maxRepetitions parameter is passed to the subtree() request.
The callback function will be called once the entire table has been fetched.
The following arguments will be passed to the callback function:
error - Instance of the Error class or a sub-class, or null if no
error occurredvarbinds - Object containing object references representing conceptual
rows keyed by index (e.g. for the ifTable table rows are keyed by ifIndex),
each row object will contain values keyed by column number, will not be
provided if an error occurredIf an error occurs with any varbind returned by subtree() no table will be
passed to the callback function. The reason for failure, and the related
OID string (as returned from a call to the snmp.varbindError() function),
will be passed to the callback function in the error argument as an
instance of the RequestFailedError class.
The following example fetches the ifTable (1.3.6.1.2.1.2.2) table:
var oid = "1.3.6.1.2.1.2.2";
function sortInt (a, b) {
if (a > b)
return 1;
else if (b > a)
return -1;
else
return 0;
}
function responseCb (error, table) {
if (error) {
console.error (error.toString ());
} else {
// This code is purely used to print rows out in index order,
// ifIndex's are integers so we'll sort them numerically using
// the sortInt() function above
var indexes = [];
for (index in table)
indexes.push (parseInt (index));
indexes.sort (sortInt);
// Use the sorted indexes we've calculated to walk through each
// row in order
for (var i = 0; i < indexes.length; i++) {
// Like indexes we sort by column, so use the same trick here,
// some rows may not have the same columns as other rows, so
// we calculate this per row
var columns = [];
for (column in table[indexes[i]])
columns.push (parseInt (column));
columns.sort (sortInt);
// Print index, then each column indented under the index
console.log ("row for index = " + indexes[i]);
for (var j = 0; j < columns.length; j++) {
console.log (" column " + columns[j] + " = "
+ table[indexes[i]][columns[j]]);
}
}
}
}
var maxRepetitions = 20;
// The maxRepetitions argument is optional, and will be ignored unless using
// SNMP verison 2c
session.table (oid, maxRepetitions, responseCb);
The trap() method sends a SNMP trap.
The typeOrOid parameter can be one of two types; one of the constants
defined in the snmp.TrapType object (excluding the
snmp.TrapType.EnterpriseSpecific constant), or an OID string.
For SNMP version 1 when a constant is specified the following fields are set in the trap:
1.3.6.1.4.1When an OID string is specified the following fields are set in the trap:
snmp.TrapType.EnterpriseSpecificIn both cases the time-stamp field in the trap PDU is set to the value
returned by the process.uptime () function multiplied by 100.
SNMP version 2c messages are quite different in comparison with version 1.
The version 2c trap has a much simpler format, simply a sequence of varbinds.
The first varbind to be placed in the trap message will be for the
sysUptime.0 OID (1.3.6.1.6.3.1.1.4.1.0). The value for this varbind will
be the value returned by the process.uptime () function multiplied by 100.
This will be followed by a second varbind for the snmpTrapOID.0 OID
(1.3.6.1.6.3.1.1.4.1.0). The value for this will depend on the typeOrOid
parameter. If a constant is specified the trap OID for the constant
will be used as supplied for the varbinds value, otherwise the OID string
specified will be used as is for the value of the varbind.
The optional varbinds parameter is an array of varbinds to include in the
trap, and defaults to the empty array [].
The optional agentAddr parameter is the IP address used to populate the
agent-addr field for SNMP version 1 type traps, and defaults to 127.0.0.1.
When using SNMP version 2c the agentAddr parameter is ignored if specified
since version 2c trap messages do not have an agent-addr field.
The callback function is called once the trap has been sent, or an error
occurred. The following arguments will be passed to the callback function:
error - Instance of the Error class or a sub-class, or null if no
error occurredThe following example sends an enterprise specific trap to a remote host using
a SNMP version 1 trap, and includes the sysName (1.3.6.1.2.1.1.5.0) varbind
in the trap. Before the trap is sent the agentAddr field is calculated using
DNS to resolve the hostname of the local host:
var enterpriseOid = "1.3.6.1.4.1.2000.1"; // made up, but it may be valid
var varbinds = [
{
oid: "1.3.6.1.2.1.1.5.0",
type: snmp.Type.OctetString,
value: "host1"
}
];
dns.lookup (os.hostname (), function (error, agentAddress) {
if (error) {
console.error (error);
} else {
session.trap (enterpriseOid, varbinds, agentAddress,
function (error) {
if (error)
console.error (error);
});
}
});
The following example sends a generic link-down trap to a remote host using a
SNMP version 1 trap, it does not include any varbinds or specify the
agentAddr parameter:
session.trap (snmp.TrapType.LinkDown, function (error) {
if (error)
console.error (error);
});
The following example sends an enterprise specific trap to a remote host using a SNMP version 2c trap, and includes two enterprise specific varbinds:
var trapOid = "1.3.6.1.4.1.2000.1";
var varbinds = [
{
oid: "1.3.6.1.4.1.2000.2",
type: snmp.Type.OctetString,
value: "Hardware health status changed"
},
{
oid: "1.3.6.1.4.1.2000.3",
type: snmp.Type.OctetString,
value: "status-error"
}
];
// version 2c should have been specified when creating the session
session.trap (trapOid, varbinds, function (error) {
if (error)
console.error (error);
});
The walk() method fetches the value for all OIDs lexicographically following
a specified OID in the MIB tree.
For SNMP version 1 repeated get() calls are made until the end of the MIB
tree is reached. For SNMP version 2c repeated getBulk() calls are made
until the end of the MIB tree is reached.
The oid parameter is an OID string. The optional maxRepetitions parameter
is passed to getBulk() requests when SNMP version 2c is being used.
This method will not call a single callback once all OID values are fetched.
Instead the feedCallback function will be called each time a response is
received from the remote host. The following arguments will be passed to the
feedCallback function:
varbinds - Array of varbinds, and will contain at least one varbindEach varbind must be checked for an error condition using the
snmp.isVarbindError() function when using SNMP version 2c.
Once the end of the MIB tree has been reached, or an error has occurred, the
doneCallback function will be called. The following arguments will be
passed to the doneCallback function:
error - Instance of the Error class or a sub-class, or null if no
error occurredOnce the doneCallback function has been called the request is complete and
the requestCallback function will no longer be called.
If the feedCallback function returns a true value when called no more
get() or getBulk() method calls will be made and the doneCallback will
be called.
The following example walks to the end of the MIB tree starting from the
ifTable (1.3.6.1.2.1.2.2) OID:
var oid = "1.3.6.1.2.1.2.2";
function doneCb (error) {
if (error)
console.error (error.toString ());
}
function feedCb (varbinds) {
for (var i = 0; i < varbinds.length; i++) {
if (snmp.isVarbindError (varbinds[i]))
console.error (snmp.varbindError (varbinds[i]));
else
console.log (varbinds[i].oid + "|" + varbinds[i].value);
}
}
var maxRepetitions = 20;
// The maxRepetitions argument is optional, and will be ignored unless using
// SNMP verison 2c
session.walk (oid, maxRepetitions, feedCb, doneCb);
Example programs are included under the modules example directory.
None, yet!
Bug reports should be sent to stephen.vickers.sv@gmail.com.
require() call to include this modulesubtree(), table() and walk() methodstransport option to the createSession() function)snmp-table program had snmp-subtree in its usage messagesnmp-tail program to constantly poll for an OIDs valuewalk() and subtree()
methods by returning trueIn no particular order:
table() methodSuggestions and requirements should be sent to stephen.vickers.sv@gmail.com.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses.
Stephen Vickers stephen.vickers.sv@gmail.com
FAQs
JavaScript implementation of the Simple Network Management Protocol (SNMP)
The npm package net-snmp receives a total of 5,887 weekly downloads. As such, net-snmp popularity was classified as popular.
We found that net-snmp demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
TC39 met in Seattle and advanced 9 JavaScript proposals, including three to Stage 4, introducing new features and enhancements for a future ECMAScript release.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.