1
0
mirror of https://github.com/node-red/node-red-nodes.git synced 2023-10-10 13:36:58 +02:00
node-red-nodes/io/snmp/README.md

96 lines
3.2 KiB
Markdown
Raw Normal View History

2015-03-04 20:55:53 +01:00
node-red-node-snmp
==================
A pair of <a href="http://nodered.org" target="_new">Node-RED</a> nodes that
fetch either individual oids, or a table oid from a SNMP enabled host.
Install
-------
2016-03-02 14:26:19 +01:00
Run the following command in your Node-RED user directory - typically `~/.node-red`
2015-03-04 20:55:53 +01:00
npm install node-red-node-snmp
Usage
-----
2016-03-02 14:26:19 +01:00
### snmp
2015-03-04 20:55:53 +01:00
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)
2015-03-04 20:55:53 +01:00
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
2016-03-02 14:26:19 +01:00
want to use `msg.oid` to provide input.
2015-03-04 20:55:53 +01:00
Outputs `msg.payload` containing a table of objects, and the requested `msg.oid`.
Values depends on the oids being requested.
2015-03-04 20:55:53 +01:00
2016-03-02 14:26:19 +01:00
### snmp-table
2015-03-04 20:55:53 +01:00
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.
2015-03-04 20:55:53 +01:00
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
2016-03-02 14:26:19 +01:00
want to use `msg.oid` to provide input.
2015-03-04 20:55:53 +01:00
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.