1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
|
from sys import version_info
from pysnmp.entity import config
from pysnmp.entity.rfc3413 import cmdgen
from pysnmp.smi.rfc1902 import *
from pysnmp.hlapi.auth import *
from pysnmp.hlapi.context import *
from pysnmp.hlapi.lcd import *
from pysnmp.hlapi.varbinds import *
from pysnmp.hlapi.asyncore.transport import *
from pysnmp.proto import rfc1905, errind
from pyasn1.type import univ, base
__all__ = ['AsyncCommandGenerator']
class AsyncCommandGenerator:
"""Creates asyncore-based SNMP Command Generator object.
This is a high-level wrapper around pure Command Generator
impementation that aims at simplyfing
:py:class:`pysnmp.entity.engine.SnmpEngine`'s Local Configuration
Datastore (:RFC:`2271#section-3.4.2`) management. Typically,
users instantiate `AsyncCommandGenerator` and call its
commmand-specific methods passing them canned Security,
Transport and SNMP Context parameters along with
:py:class:`~pysnmp.smi.rfc1902.ObjectType` object carrying
MIB variables to include with SNMP request. `AsyncCommandGenerator`
will manage LCD by applying user-supplied configuratoin parameters
and running requested operation.
See :RFC:`3413#section-3.1` for more information on SNMP
Command Generator purpose, design and supported operations.
"""
vbProcessor = CommandGeneratorVarBinds()
lcd = CommandGeneratorLcdConfigurator()
def getCmd(self, snmpEngine, authData, transportTarget, contextData,
varBinds, cbInfo, lookupMib=True):
"""Performs SNMP GET query.
Based on passed parameters, prepares SNMP GET packet
(:RFC:`1905#section-4.2.1`) and schedules its transmission by
I/O framework at a later point of time.
Parameters
----------
snmpEngine : :py:class:`~pysnmp.entity.engine.SnmpEngine`
Class instance representing SNMP engine.
authData : :py:class:`~pysnmp.entity.rfc3413.oneliner.auth.CommunityData` or :py:class:`~pysnmp.entity.rfc3413.oneliner.auth.UsmUserData`
Class instance representing SNMP credentials.
transportTarget : :py:class:`~pysnmp.entity.rfc3413.oneliner.target.UdpTransportTarget` or :py:class:`~pysnmp.entity.rfc3413.oneliner.target.Udp6TransportTarget`
Class instance representing transport type along with SNMP peer
address.
contextData : :py:class:`~pysnmp.entity.rfc3413.oneliner.ctx.ContextData`
Class instance representing SNMP ContextEngineId and ContextName
values.
varBinds : tuple
A sequence of :py:class:`~pysnmp.smi.rfc1902.ObjectType` class
instances representing MIB variables to place into SNMP request.
cbInfo : tuple
* `cbFun` - user-supplied callable that is invoked to pass
SNMP response data or error to user at a later point of time.
* `cbCtx` - user-supplied object passing additional parameters
to/from `cbFun`. Default is `None`.
Other Parameters
----------------
lookupMib : bool
`lookupMib` - load MIB and resolve response MIB variables at
the cost of slightly reduced performance. Default is `True`.
Notes
-----
User-supplied `cbFun` callable must have the following call
signature:
* snmpEngine (:py:class:`~pysnmp.entity.engine.SnmpEngine`):
Class instance representing SNMP engine.
* sendRequestHandle (int): Unique request identifier. Can be used
for matching multiple ongoing requests with received responses.
* errorIndication (str): True value indicates SNMP engine error.
* errorStatus (str): True value indicates SNMP PDU error.
* errorIndex (int): Non-zero value refers to `varBinds[errorIndex-1]`
* varBinds (tuple): A sequence of
:py:class:`~pysnmp.smi.rfc1902.ObjectType` class instances
representing MIB variables returned in SNMP response in exactly
the same order as `varBinds` in request.
* `cbCtx` : Original user-supplied object.
Returns
-------
sendRequestHandle : int
Unique request identifier. Can be used for matching received
responses with ongoing requests.
Raises
------
PySnmpError
Or its derivative indicating that an error occurred while
performing SNMP operation.
Examples
--------
>>> from pysnmp.entity.rfc3413.oneliner.cmdgen import *
>>> def cbFun(snmpEngine, sendRequestHandle, errorIndication, errorStatus, errorIndex, varBinds, cbCtx):
... print(errorIndication, errorStatus, errorIndex, varBinds)
>>>
>>> snmpEngine = SnmpEngine()
>>> g = AsyncCommandGenerator()
>>> g.getCmd(snmpEngine,
... CommunityData('public'),
... UdpTransportTarget(('demo.snmplabs.com', 161)),
... ContextData(),
... ObjectType(ObjectIdentity('SNMPv2-MIB', 'sysDescr', 0)),
... (cbFun, None))
>>> snmpEngine.transportDispatcher.runDispatcher()
(None, 0, 0, [ObjectType(ObjectIdentity(ObjectName('1.3.6.1.2.1.1.1.0')), DisplayString('SunOS zeus.snmplabs.com 4.1.3_U1 1 sun4m'))])
>>>
"""
def __cbFun(snmpEngine, sendRequestHandle,
errorIndication, errorStatus, errorIndex,
varBinds, cbCtx):
lookupMib, cbFun, cbCtx = cbCtx
return cbFun(
snmpEngine,
sendRequestHandle,
errorIndication,
errorStatus,
errorIndex,
self.vbProcessor.unmakeVarBinds(
snmpEngine, varBinds, lookupMib
),
cbCtx
)
(cbFun, cbCtx) = cbInfo
addrName, paramsName = self.lcd.configure(
snmpEngine, authData, transportTarget
)
return cmdgen.GetCommandGenerator().sendVarBinds(
snmpEngine,
addrName,
contextData.contextEngineId,
contextData.contextName,
self.vbProcessor.makeVarBinds(snmpEngine, varBinds),
__cbFun,
(lookupMib, cbFun, cbCtx)
)
def setCmd(self, snmpEngine, authData, transportTarget, contextData,
varBinds, cbInfo, lookupMib=True):
"""Performs SNMP SET query.
Based on passed parameters, prepares SNMP SET packet
(:RFC:`1905#section-4.2.5`) and schedules its transmission by
I/O framework at a later point of time.
Parameters
----------
snmpEngine : :py:class:`~pysnmp.entity.engine.SnmpEngine`
Class instance representing SNMP engine.
authData : :py:class:`~pysnmp.entity.rfc3413.oneliner.auth.CommunityData` or :py:class:`~pysnmp.entity.rfc3413.oneliner.auth.UsmUserData`
Class instance representing SNMP credentials.
transportTarget : :py:class:`~pysnmp.entity.rfc3413.oneliner.target.UdpTransportTarget` or :py:class:`~pysnmp.entity.rfc3413.oneliner.target.Udp6TransportTarget`
Class instance representing transport type along with SNMP peer
address.
contextData : :py:class:`~pysnmp.entity.rfc3413.oneliner.ctx.ContextData`
Class instance representing SNMP ContextEngineId and ContextName
values.
varBinds : tuple
A sequence of :py:class:`~pysnmp.smi.rfc1902.ObjectType` class
instances representing MIB variables to place into SNMP request.
cbInfo : tuple
* `cbFun` - user-supplied callable that is invoked to pass
SNMP response data or error to user at a later point of time.
* `cbCtx` - user-supplied object passing additional parameters
to/from `cbFun`. Default is `None`.
Other Parameters
----------------
lookupMib : bool
`lookupMib` - load MIB and resolve response MIB variables at
the cost of slightly reduced performance. Default is `True`.
Notes
-----
User-supplied `cbFun` callable must have the following call
signature:
* snmpEngine (:py:class:`~pysnmp.entity.engine.SnmpEngine`):
Class instance representing SNMP engine.
* sendRequestHandle (int): Unique request identifier. Can be used
for matching multiple ongoing requests with received responses.
* errorIndication (str): True value indicates SNMP engine error.
* errorStatus (str): True value indicates SNMP PDU error.
* errorIndex (int): Non-zero value refers to `varBinds[errorIndex-1]`
* varBinds (tuple): A sequence of
:py:class:`~pysnmp.smi.rfc1902.ObjectType` class instances
representing MIB variables returned in SNMP response in exactly
the same order as `varBinds` in request.
* `cbCtx` : Original user-supplied object.
Returns
-------
sendRequestHandle : int
Unique request identifier. Can be used for matching received
responses with ongoing requests.
Raises
------
PySnmpError
Or its derivative indicating that an error occurred while
performing SNMP operation.
Examples
--------
>>> from pysnmp.entity.rfc3413.oneliner.cmdgen import *
>>> def cbFun(snmpEngine, sendRequestHandle, errorIndication, errorStatus, errorIndex, varBinds, cbCtx):
... print(errorIndication, errorStatus, errorIndex, varBinds)
>>>
>>> snmpEngine = SnmpEngine()
>>> g = AsyncCommandGenerator()
>>> g.setCmd(snmpEngine,
... CommunityData('public'),
... UdpTransportTarget(('demo.snmplabs.com', 161)),
... ContextData(),
... ObjectType(ObjectIdentity('SNMPv2-MIB', 'sysContact', 0), 'info@snmplabs.com'),
... (cbFun, None))
>>> snmpEngine.transportDispatcher.runDispatcher()
(None, 0, 0, [ObjectType(ObjectIdentity(ObjectName('1.3.6.1.2.1.1.4.0')), DisplayString('info@snmplabs.com'))])
>>>
"""
def __cbFun(snmpEngine, sendRequestHandle,
errorIndication, errorStatus, errorIndex,
varBinds, cbCtx):
lookupMib, cbFun, cbCtx = cbCtx
return cbFun(
snmpEngine,
sendRequestHandle,
errorIndication,
errorStatus,
errorIndex,
self.vbProcessor.unmakeVarBinds(
snmpEngine, varBinds, lookupMib
),
cbCtx
)
(cbFun, cbCtx) = cbInfo
addrName, paramsName = self.lcd.configure(
snmpEngine, authData, transportTarget
)
return cmdgen.SetCommandGenerator().sendVarBinds(
snmpEngine,
addrName,
contextData.contextEngineId,
contextData.contextName,
self.vbProcessor.makeVarBinds(snmpEngine, varBinds),
__cbFun,
(lookupMib, cbFun, cbCtx)
)
def nextCmd(self, snmpEngine, authData, transportTarget, contextData,
varBinds, cbInfo, lookupMib=True):
"""Performs SNMP GETNEXT query.
Based on passed parameters, prepares SNMP GETNEXT packet
(:RFC:`1905#section-4.2.2`) and schedules its transmission by
I/O framework at a later point of time.
Parameters
----------
snmpEngine : :py:class:`~pysnmp.entity.engine.SnmpEngine`
Class instance representing SNMP engine.
authData : :py:class:`~pysnmp.entity.rfc3413.oneliner.auth.CommunityData` or :py:class:`~pysnmp.entity.rfc3413.oneliner.auth.UsmUserData`
Class instance representing SNMP credentials.
transportTarget : :py:class:`~pysnmp.entity.rfc3413.oneliner.target.UdpTransportTarget` or :py:class:`~pysnmp.entity.rfc3413.oneliner.target.Udp6TransportTarget`
Class instance representing transport type along with SNMP peer
address.
contextData : :py:class:`~pysnmp.entity.rfc3413.oneliner.ctx.ContextData`
Class instance representing SNMP ContextEngineId and ContextName
values.
varBinds : tuple
A sequence of :py:class:`~pysnmp.smi.rfc1902.ObjectType` class
instances representing MIB variables to place into SNMP request.
cbInfo : tuple
* `cbFun` - user-supplied callable that is invoked to pass
SNMP response data or error to user at a later point of time.
* `cbCtx` - user-supplied object passing additional parameters
to/from `cbFun`. Default is `None`.
Other Parameters
----------------
lookupMib : bool
`lookupMib` - load MIB and resolve response MIB variables at
the cost of slightly reduced performance. Default is `True`.
Notes
-----
User-supplied `cbFun` callable must have the following call
signature:
* snmpEngine (:py:class:`~pysnmp.entity.engine.SnmpEngine`):
Class instance representing SNMP engine.
* sendRequestHandle (int): Unique request identifier. Can be used
for matching multiple ongoing requests with received responses.
* errorIndication (str): True value indicates SNMP engine error.
* errorStatus (str): True value indicates SNMP PDU error.
* errorIndex (int): Non-zero value refers to `varBinds[errorIndex-1]`
* varBinds (tuple): A sequence of sequences (e.g. 2-D array) of
:py:class:`~pysnmp.smi.rfc1902.ObjectType` class instances
representing a table of MIB variables returned in SNMP response.
Inner sequences represent table rows and ordered exactly the same
as `varBinds` in request. Response to GETNEXT always contain a
single row.
* `cbCtx` : Original user-supplied object.
Returns
-------
sendRequestHandle : int
Unique request identifier. Can be used for matching received
responses with ongoing requests.
Raises
------
PySnmpError
Or its derivative indicating that an error occurred while
performing SNMP operation.
Examples
--------
>>> from pysnmp.entity.rfc3413.oneliner.cmdgen import *
>>> def cbFun(snmpEngine, sendRequestHandle, errorIndication, errorStatus, errorIndex, varBinds, cbCtx):
... print(errorIndication, errorStatus, errorIndex, varBinds)
>>>
>>> snmpEngine = SnmpEngine()
>>> g = AsyncCommandGenerator()
>>> g.nextCmd(snmpEngine,
... CommunityData('public'),
... UdpTransportTarget(('demo.snmplabs.com', 161)),
... ContextData(),
... ObjectType(ObjectIdentity('SNMPv2-MIB', 'system')),
... (cbFun, None))
>>> snmpEngine.transportDispatcher.runDispatcher()
(None, 0, 0, [ [ObjectType(ObjectIdentity(ObjectName('1.3.6.1.2.1.1.1.0')), DisplayString('SunOS zeus.snmplabs.com 4.1.3_U1 1 sun4m'))] ])
>>>
"""
def __cbFun(snmpEngine, sendRequestHandle,
errorIndication, errorStatus, errorIndex,
varBindTable, cbCtx):
lookupMib, cbFun, cbCtx = cbCtx
return cbFun(
snmpEngine,
sendRequestHandle,
errorIndication,
errorStatus,
errorIndex,
[ self.vbProcessor.unmakeVarBinds(snmpEngine, varBindTableRow, lookupMib) for varBindTableRow in varBindTable ],
cbCtx
)
(cbFun, cbCtx) = cbInfo
addrName, paramsName = self.lcd.configure(
snmpEngine, authData, transportTarget
)
return cmdgen.NextCommandGenerator().sendVarBinds(
snmpEngine,
addrName,
contextData.contextEngineId, contextData.contextName,
self.vbProcessor.makeVarBinds(snmpEngine, varBinds),
__cbFun,
(lookupMib, cbFun, cbCtx)
)
def bulkCmd(self, snmpEngine, authData, transportTarget, contextData,
nonRepeaters, maxRepetitions, varBinds, cbInfo,
lookupMib=True):
"""Performs SNMP GETBULK query.
Based on passed parameters, prepares SNMP GETBULK packet
(:RFC:`1905#section-4.2.3`) and schedules its transmission by
I/O framework at a later point of time.
Parameters
----------
snmpEngine : :py:class:`~pysnmp.entity.engine.SnmpEngine`
Class instance representing SNMP engine.
authData : :py:class:`~pysnmp.entity.rfc3413.oneliner.auth.CommunityData` or :py:class:`~pysnmp.entity.rfc3413.oneliner.auth.UsmUserData`
Class instance representing SNMP credentials.
transportTarget : :py:class:`~pysnmp.entity.rfc3413.oneliner.target.UdpTransportTarget` or :py:class:`~pysnmp.entity.rfc3413.oneliner.target.Udp6TransportTarget`
Class instance representing transport type along with SNMP peer
address.
contextData : :py:class:`~pysnmp.entity.rfc3413.oneliner.ctx.ContextData`
Class instance representing SNMP ContextEngineId and ContextName
values.
nonRepeaters : int
One MIB variable is requested in response for the first
`nonRepeaters` MIB variables in request.
maxRepetitions : int
`maxRepetitions` MIB variables are requested in response for each
of the remaining MIB variables in the request (e.g. excluding
`nonRepeaters`). Remote SNMP engine may choose lesser value than
requested.
varBinds : tuple
A sequence of :py:class:`~pysnmp.smi.rfc1902.ObjectType` class
instances representing MIB variables to place into SNMP request.
cbInfo : tuple
* `cbFun` - user-supplied callable that is invoked to pass
SNMP response data or error to user at a later point of time.
* `cbCtx` - user-supplied object passing additional parameters
to/from `cbFun`. Default is `None`.
Other Parameters
----------------
lookupMib : bool
`lookupMib` - load MIB and resolve response MIB variables at
the cost of slightly reduced performance. Default is `True`.
Notes
-----
User-supplied `cbFun` callable must have the following call
signature:
* snmpEngine (:py:class:`~pysnmp.entity.engine.SnmpEngine`):
Class instance representing SNMP engine.
* sendRequestHandle (int): Unique request identifier. Can be used
for matching multiple ongoing requests with received responses.
* errorIndication (str): True value indicates SNMP engine error.
* errorStatus (str): True value indicates SNMP PDU error.
* errorIndex (int): Non-zero value refers to `varBinds[errorIndex-1]`
* varBinds (tuple): A sequence of sequences (e.g. 2-D array) of
:py:class:`~pysnmp.smi.rfc1902.ObjectType` class instances
representing a table of MIB variables returned in SNMP response.
Inner sequences represent table rows and ordered exactly the same
as `varBinds` in request. Number of rows might be less or equal
to `maxRepetitions` value in request.
* `cbCtx` : Original user-supplied object.
Returns
-------
sendRequestHandle : int
Unique request identifier. Can be used for matching received
responses with ongoing requests.
Raises
------
PySnmpError
Or its derivative indicating that an error occurred while
performing SNMP operation.
Examples
--------
>>> from pysnmp.entity.rfc3413.oneliner.cmdgen import *
>>> def cbFun(snmpEngine, sendRequestHandle, errorIndication, errorStatus, errorIndex, varBinds, cbCtx):
... print(errorIndication, errorStatus, errorIndex, varBinds)
>>>
>>> snmpEngine = SnmpEngine()
>>> g = AsyncCommandGenerator()
>>> g.bulkCmd(snmpEngine,
... CommunityData('public'),
... UdpTransportTarget(('demo.snmplabs.com', 161)),
... ContextData(),
... 0, 2,
... ObjectType(ObjectIdentity('SNMPv2-MIB', 'system')),
... (cbFun, None))
>>> snmpEngine.transportDispatcher.runDispatcher()
(None, 0, 0, [ [ObjectType(ObjectIdentity(ObjectName('1.3.6.1.2.1.1.1.0')), DisplayString('SunOS zeus.snmplabs.com 4.1.3_U1 1 sun4m')), ObjectType(ObjectIdentity(ObjectName('1.3.6.1.2.1.1.2.0')), ObjectIdentifier('1.3.6.1.4.1.424242.1.1')] ])
>>>
"""
def __cbFun(snmpEngine, sendRequestHandle,
errorIndication, errorStatus, errorIndex,
varBindTable, cbCtx):
lookupMib, cbFun, cbCtx = cbCtx
return cbFun(
snmpEngine,
sendRequestHandle,
errorIndication,
errorStatus,
errorIndex,
[ self.vbProcessor.unmakeVarBinds(snmpEngine, varBindTableRow, lookupMib) for varBindTableRow in varBindTable ],
cbCtx
)
(cbFun, cbCtx) = cbInfo
addrName, paramsName = self.lcd.configure(
snmpEngine, authData, transportTarget
)
return cmdgen.BulkCommandGenerator().sendVarBinds(
snmpEngine,
addrName,
contextData.contextEngineId,
contextData.contextName,
nonRepeaters, maxRepetitions,
self.vbProcessor.makeVarBinds(snmpEngine, varBinds),
__cbFun,
(lookupMib, cbFun, cbCtx)
)
|
