Skip to content

Commit c77f13a

Browse files
Steve-MclSteve-Mcl
authored
Merge pull request #904 from Steve-Mcl/snmpv3_Add_smc
Add SNMPv3 to node-red-node-snmp
2 parents c833709 + 484c4f9 commit c77f13a

4 files changed

Lines changed: 826 additions & 228 deletions

File tree

‎io/snmp/README.md‎

Lines changed: 78 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
node-red-node-snmp
22
==================
33

4-
A pair of <a href="http://nodered.org" target="_new">Node-RED</a> nodes that
5-
fetch either individual oids, or a table oid from a SNMP enabled host.
4+
A set of <a href="http://nodered.org" target="_new">Node-RED</a> nodes that
5+
fetch values from SNMP enabled hosts. Supports v1, v2c and v3.
6+
* SNMP get - Simple SNMP oid or oid list fetcher
7+
* SNMP set - Simple snmp Set node.
8+
* SNMP subtree - Simple sub tree fetcher
9+
* SNMP table - Simple SNMP oid table fetcher
10+
* SNMP walker - Simple SNMP oid walker fetcher
611

712
Install
813
-------
@@ -18,16 +23,28 @@ Usage
1823

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

21-
`msg.host` may contain the host.
26+
`msg.host` may contain the host including the port.
2227

23-
`msg.community` may contain the community.
28+
`msg.community` may contain the community. (v1 and v2c only)
29+
30+
`msg.username` may contain the username. (v3 only)
31+
32+
`msg.authkey` may contain the digest security key. (v3 only)
33+
34+
`msg.privkey` may contain the encryption security key. (v3 only)
2435

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

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

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

42+
The username configured in the edit config will override `msg.username`. Leave blank if you want to use `msg.username` to provide input.
43+
44+
The digest security key configured in the edit config will override `msg.authkey`. Leave blank if you want to use `msg.authkey` to provide input.
45+
46+
The encryption security key configured in the edit config will override `msg.privkey`. Leave blank if you want to use `msg.privkey` to provide input.
47+
3148
The oids configured in the edit config will override `msg.oid`. Leave blank if you
3249
want to use `msg.oid` to provide input.
3350

@@ -38,9 +55,15 @@ Values depends on the oids being requested.
3855

3956
SNMP sets the value of one or more OIDs.
4057

41-
`msg.host` may contain the host.
58+
`msg.host` may contain the host including the port.
59+
60+
`msg.community` may contain the community. (v1 and v2c only)
61+
62+
`msg.username` may contain the username. (v3 only)
4263

43-
`msg.community` may contain the community.
64+
`msg.authkey` may contain the digest security key. (v3 only)
65+
66+
`msg.privkey` may contain the encryption security key. (v3 only)
4467

4568
`msg.varbinds` may contain an array of varbind JSON objects e.g.:
4669
```
@@ -81,6 +104,12 @@ The host configured in the edit config will override `msg.host`. Leave blank if
81104

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

107+
The username configured in the edit config will override `msg.username`. Leave blank if you want to use `msg.username` to provide input.
108+
109+
The digest security key configured in the edit config will override `msg.authkey`. Leave blank if you want to use `msg.authkey` to provide input.
110+
111+
The encryption security key configured in the edit config will override `msg.privkey`. Leave blank if you want to use `msg.privkey` to provide input.
112+
84113
The varbinds configured in the edit config will override `msg.varbinds`. Leave blank if you want to use `msg.varbinds` to provide input.
85114

86115

@@ -89,16 +118,28 @@ The varbinds configured in the edit config will override `msg.varbinds`. Leave b
89118

90119
Simple SNMP table oid fetcher. Triggered by any input.
91120

92-
`msg.host` may contain the host.
121+
`msg.host` may contain the host including the port.
93122

94-
`msg.community` may contain the community.
123+
`msg.community` may contain the community. (v1 and v2c only)
95124

96-
`msg.oid` may contain the oid of a single table to search for.
125+
`msg.username` may contain the username. (v3 only)
126+
127+
`msg.authkey` may contain the digest security key. (v3 only)
128+
129+
`msg.privkey` may contain the encryption security key. (v3 only)
130+
131+
`msg.oid` may contain a comma separated list of oids to search for. (no spaces)
97132

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

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

137+
The username configured in the edit config will override `msg.username`. Leave blank if you want to use `msg.username` to provide input.
138+
139+
The digest security key configured in the edit config will override `msg.authkey`. Leave blank if you want to use `msg.authkey` to provide input.
140+
141+
The encryption security key configured in the edit config will override `msg.privkey`. Leave blank if you want to use `msg.privkey` to provide input.
142+
102143
The oid configured in the edit config will override `msg.oid`. Leave blank if you
103144
want to use `msg.oid` to provide input.
104145

@@ -109,16 +150,28 @@ Values depends on the oids being requested.
109150

110151
Simple SNMP oid subtree fetcher. Triggered by any input. Reads from OID specified and any below it.
111152

112-
`msg.host` may contain the host.
153+
`msg.host` may contain the host including the port.
113154

114-
`msg.community` may contain the community.
155+
`msg.community` may contain the community. (v1 and v2c only)
156+
157+
`msg.username` may contain the username. (v3 only)
158+
159+
`msg.authkey` may contain the digest security key. (v3 only)
160+
161+
`msg.privkey` may contain the encryption security key. (v3 only)
115162

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

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

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

169+
The username configured in the edit config will override `msg.username`. Leave blank if you want to use `msg.username` to provide input.
170+
171+
The digest security key configured in the edit config will override `msg.authkey`. Leave blank if you want to use `msg.authkey` to provide input.
172+
173+
The encryption security key configured in the edit config will override `msg.privkey`. Leave blank if you want to use `msg.privkey` to provide input.
174+
122175
The oid configured in the edit config will override `msg.oid`. Leave blank if you
123176
want to use `msg.oid` to provide input.
124177

@@ -129,16 +182,28 @@ Values depends on the oids being requested.
129182

130183
Simple SNMP oid walker fetcher. Triggered by any input. Reads from OID specified to the end of the table.
131184

132-
`msg.host` may contain the host.
185+
`msg.host` may contain the host including the port.
186+
187+
`msg.community` may contain the community. (v1 and v2c only)
188+
189+
`msg.username` may contain the username. (v3 only)
133190

134-
`msg.community` may contain the community.
191+
`msg.authkey` may contain the digest security key. (v3 only)
192+
193+
`msg.privkey` may contain the encryption security key. (v3 only)
135194

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

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

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

201+
The username configured in the edit config will override `msg.username`. Leave blank if you want to use `msg.username` to provide input.
202+
203+
The digest security key configured in the edit config will override `msg.authkey`. Leave blank if you want to use `msg.authkey` to provide input.
204+
205+
The encryption security key configured in the edit config will override `msg.privkey`. Leave blank if you want to use `msg.privkey` to provide input.
206+
142207
The oid configured in the edit config will override `msg.oid`. Leave blank if you
143208
want to use `msg.oid` to provide input.
144209

‎io/snmp/package.json‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
{
22
"name" : "node-red-node-snmp",
3-
"version" : "0.0.25",
4-
"description" : "A Node-RED node that looks for SNMP oids.",
3+
"version" : "1.0.0",
4+
"description" : "A Node-RED node that gets and sets SNMP oid values. Supports v1, v2c and v3",
55
"dependencies" : {
6-
"net-snmp" : "1.2.4"
6+
"net-snmp" : "^3.6.3"
77
},
88
"repository" : {
99
"type":"git",
1010
"url":"https://github.com/node-red/node-red-nodes.git",
1111
"directory" : "tree/master/io/snmp"
1212
},
1313
"license": "Apache-2.0",
14-
"keywords": [ "node-red", "snmp", "oid" ],
14+
"keywords": [ "node-red", "snmp", "oid", "snmpv3" ],
1515
"node-red" : {
1616
"nodes" : {
1717
"snmp": "snmp.js"
@@ -24,6 +24,8 @@
2424
},
2525
"contributors": [
2626
{ "name": "Mika Karaila" },
27-
{ "name": "Bryan Malyn" }
27+
{ "name": "Bryan Malyn" },
28+
{ "name": "Steve-Mcl" },
29+
{ "name": "Andres" }
2830
]
2931
}

0 commit comments

Comments
 (0)