node-red-nodes/io/snmp
bimalyn-IBM a3211a5e80 Update documentation for snmp nodes (#301)
* I've modified the snmp libraries so that the server and the community can be defined by the msg.
Error will be thrown if you try to override what was defined in the node.
Verified that the contents of msg is no longer clobbered.

Signed-off-by: Bryan Malyn <bimalyn@us.ibm.com>

* Replaced tabs with 4 spaces.
Signed-off-by: Bryan Malyn <bimalyn@us.ibm.com>

* fix extra spacing

Signed-off-by: Bryan Malyn <bimalyn@us.ibm.com>

* Standardise node.error to include msg so that errors can caught

Signed-off-by: Bryan Malyn <bimalyn@us.ibm.com>

* Update documentation for snmp nodes

fixed documentation as noted, removed conflict and iff from documention
remove node.warns if host or community are set in both the node config and msg

Signed-off-by: Bryan Malyn <bimalyn@us.ibm.com>
2017-04-22 15:53:04 +01:00
..
LICENSE Update licenses and packages for all nodes 2016-11-06 20:26:19 +00:00
README.md Update documentation for snmp nodes (#301) 2017-04-22 15:53:04 +01:00
package.json bump snap package to release PR 2017-04-15 12:14:34 +01:00
snmp.html Update documentation for snmp nodes (#301) 2017-04-22 15:53:04 +01:00
snmp.js Update documentation for snmp nodes (#301) 2017-04-22 15:53:04 +01:00

README.md

node-red-node-snmp

A pair of Node-RED nodes that fetch either individual oids, or a table oid from a SNMP enabled host.

Install

Run the following command in your Node-RED user directory - typically ~/.node-red

npm install node-red-node-snmp

Usage

snmp

SNMP oids fetcher. Can fetch a single or comma separated list of oids. Triggered by any input.

msg.host may contain the host.

msg.community may contain the community.

msg.oid may contain a comma separated list of oids to search for. (no spaces)

The host configured in the edit config will override msg.host. Leave blank if you want to use msg.host to provide input.

The community configured in the edit config will override msg.community. Leave blank if you want to use msg.community to provide input.

The oids configured in the edit config will override msg.oid. Leave blank if you want to use msg.oid to provide input.

Outputs msg.payload containing a table of objects, and the requested msg.oid. Values depends on the oids being requested.

snmp-table

Simple SNMP table oid fetcher. Triggered by any input.

msg.host may contain the host.

msg.community may contain the community.

msg.oid may contain the oid of a single table to search for.

The host configured in the edit config will override msg.host. Leave blank if you want to use msg.host to provide input.

The community configured in the edit config will override msg.community. Leave blank if you want to use msg.community to provide input.

The oid configured in the edit config will override msg.oid. Leave blank if you want to use msg.oid to provide input.

Outputs msg.payload containing the table of objects, and the requested msg.oid. Values depends on the oids being requested.

snmp-subtree

Simple SNMP oid subtree fetcher. Triggered by any input.

msg.host may contain the host.

msg.community may contain the community.

msg.oid may contain the oid of a single table to search for.

The host configured in the edit config will override msg.host. Leave blank if you want to use msg.host to provide input.

The community configured in the edit config will override msg.community. Leave blank if you want to use msg.community to provide input.

The oid configured in the edit config will override msg.oid. Leave blank if you want to use msg.oid to provide input.

Outputs msg.payload containing the table of objects, and the requested msg.oid. Values depends on the oids being requested.

snmp-walker

Simple SNMP oid walker fetcher. Triggered by any input.

msg.host may contain the host.

msg.community may contain the community.

msg.oid may contain the oid of a single table to search for.

The host configured in the edit config will override msg.host. Leave blank if you want to use msg.host to provide input.

The community configured in the edit config will override msg.community. Leave blank if you want to use msg.community to provide input.

The oid configured in the edit config will override msg.oid. Leave blank if you want to use msg.oid to provide input.

Outputs msg.payload containing the table of objects, and the requested msg.oid. Values depends on the oids being requested.