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
|
Library reference
=================
.. toctree::
:maxdepth: 2
Dealing with many SNMP features may quickly overwhelm developers who aim at a
quick and trivial task, PySNMP employs a layered architecture approach
where the topmost programming API tries to be as simple as possible
to allow immediate solutions for most common use cases.
It will let you perform SNMP GET/SET/WALK and TRAP/INFORM operations by
pasting code snippets from PySNMP documentation and example scripts
right into your Python interactive session.
Synchronous SNMP
----------------
Most simple and strightforward way to use PySNMP is by employing its
Synchronous, blocking API. It's also the default API offered by
users on *pysnmp.hlapi* sub-package import.
Command Generator
.. toctree::
:maxdepth: 2
/docs/hlapi/asyncore/manager/cmdgen/getcmd
/docs/hlapi/asyncore/manager/cmdgen/setcmd
/docs/hlapi/asyncore/manager/cmdgen/nextcmd
/docs/hlapi/asyncore/manager/cmdgen/bulkcmd
Notification Originator
.. toctree::
:maxdepth: 2
/docs/hlapi/asyncore/agent/ntforg/notification
Transport configuration
.. toctree::
:maxdepth: 2
/docs/hlapi/asyncore/transport-configuration
Most of SNMP operations involve packet exchange over network. PySNMP
is shipped with a set of bindings to popular asynchronous Python I/O
frameworks that let you run PySNMP in parallel with other tasks your
application may perform.
Asynchronous: asyncore
----------------------
The :mod:`asyncore` module is in Python standard library since ancient
times. Main loop is built around :mod:`select` dispatcher, user
code is invoked through callback callables.
.. toctree::
:maxdepth: 2
/docs/hlapi/asyncore/manager/cmdgen/async-command-generator
/docs/hlapi/asyncore/agent/ntforg/async-notification-originator
.. _asyncio:
Asynchronous: asyncio
---------------------
The :mod:`asyncio` module first appeared in standard library since
Python 3.3 (in provisional basis). Its main design feature is that
it makes asynchronous code looking like synchronous one. That greately
simplifies development and maintanence.
Command Generator
.. toctree::
:maxdepth: 2
/docs/hlapi/asyncio/manager/cmdgen/getcmd
/docs/hlapi/asyncio/manager/cmdgen/setcmd
/docs/hlapi/asyncio/manager/cmdgen/nextcmd
/docs/hlapi/asyncio/manager/cmdgen/bulkcmd
Notification Originator
.. toctree::
:maxdepth: 2
/docs/hlapi/asyncio/agent/ntforg/notification
Transport configuration
.. toctree::
:maxdepth: 2
/docs/hlapi/asyncio/transport-configuration
.. _trollius:
Asynchronous: trollius
----------------------
An almost compatible alternative to :ref:`asyncio` for pre-3.3 Python
is `Trollius <http://trollius.readthedocs.org>`_ module. PySNMP's
`asyncio` bindings automatically work with Trolleus.
Please refer to :doc:`Trollius examples </examples/contents>` for
more information.
.. _twisted:
Asynchronous: Twisted
---------------------
`Twisted <http://twistedmatrix.org>`_ is one of the earliest and hugely
popular asynchronous I/O framework. It introduced a concept of
:class:`~twisted.internet.defer.Deferred` for representing work-in-progress
that is not blocking the rest of I/O operations. PySNMP provides Twisted
bindings.
Command Generator
.. toctree::
:maxdepth: 2
/docs/hlapi/twisted/manager/cmdgen/getcmd
/docs/hlapi/twisted/manager/cmdgen/setcmd
/docs/hlapi/twisted/manager/cmdgen/nextcmd
/docs/hlapi/twisted/manager/cmdgen/bulkcmd
Notification Originator
.. toctree::
:maxdepth: 2
/docs/hlapi/twisted/agent/ntforg/notification
Transport configuration
.. toctree::
:maxdepth: 2
/docs/hlapi/twisted/transport-configuration
SNMP Engine
-----------
SNMP Engine is a central, stateful object used by all SNMP v3
substsems. Calls to high-level Applications API also consume SNMP
Engine object on input.
.. toctree::
:maxdepth: 2
.. autoclass:: pysnmp.hlapi.SnmpEngine(snmpEngineID=None)
Security Parameters
-------------------
Calls to high-level Applications API consume Security Parameters
configuration object on input. The shortcut classes described in
this section convey configuration information to SNMP engine's
Local Configuration Datastore (:RFC:`2271#section-3.4.2`).
Once committed to LCD, SNMP engine saves its configuration for
the lifetime of SNMP engine object.
Community-based
+++++++++++++++
Security Parameters object is Security Model specific. The
:py:class:`~pysnmp.hlapi.CommunityData`
class is used for configuring Community-Based Security Model of SNMPv1/SNMPv2c.
.. toctree::
:maxdepth: 2
.. autoclass:: pysnmp.hlapi.CommunityData(communityIndex, communityName=None, mpModel=1, contextEngineId=None, contextName='', tag='')
User-based
++++++++++
The :py:class:`~pysnmp.hlapi.UsmUserData` class provides SNMPv3 User-Based
Security Model configuration for SNMP v3 systems.
.. autoclass:: pysnmp.hlapi.UsmUserData(userName, authKey=None, privKey=None, authProtocol=usmNoAuthProtocol, privProtocol=usmNoPrivProtocol, securityEngineId=None)
Identification of Authentication and Privacy Protocols is done
via constant OIDs:
.. autodata:: pysnmp.hlapi.usmNoAuthProtocol
.. autodata:: pysnmp.hlapi.usmHMACMD5AuthProtocol
.. autodata:: pysnmp.hlapi.usmHMACSHAAuthProtocol
.. autodata:: pysnmp.hlapi.usmNoPrivProtocol
.. autodata:: pysnmp.hlapi.usmDESPrivProtocol
.. autodata:: pysnmp.hlapi.usm3DESEDEPrivProtocol
.. autodata:: pysnmp.hlapi.usmAesCfb128Protocol
.. autodata:: pysnmp.hlapi.usmAesCfb192Protocol
.. autodata:: pysnmp.hlapi.usmAesCfb256Protocol
Transport configuration is I/O framework specific and is described in
respective sections.
SNMP Context
------------
SNMP engine may serve several instances of the same MIB within
possibly multiple SNMP entities. SNMP context is a method to
unambiguously identify a collection of MIB variables behind
SNMP engine. See :RFC:`3411#section-3.3.1` for details.
.. note::
SNMP context is only defined within SNMPv3 framework. For SNMPv1/v2c
architecture integration :RFC:`2576#section-5.1` introduces
interoperability aid which is available through
:py:class:`~pysnmp.hlapi.CommunityData`.
.. toctree::
:maxdepth: 2
.. autoclass:: pysnmp.hlapi.ContextData
.. _mib-services:
MIB services
------------
.. _mib-variables:
MIB Variables
+++++++++++++
SNMP MIB variable is identified by an OBJECT IDENTIFIER (OID) and is
accompanied by a value belonging to one of SNMP types (:RFC:`1902#section-2`).
This pair is collectively called a variable-binding in SNMP parlance.
The :py:mod:`~pysnmp.smi.rfc1902` module implements :RFC:`1902#section-2`
MACRO definiitons.
.. toctree::
:maxdepth: 2
.. autoclass:: pysnmp.smi.rfc1902.ObjectIdentity
:members:
.. autoclass:: pysnmp.smi.rfc1902.ObjectType
:members:
.. _notification-types:
MIB notification types
++++++++++++++++++++++
SNMP Notifications are enumerated and imply including certain
set of MIB variables.
Notification Originator applications refer to MIBs for MIB notifications
through *NOTIFICATION-TYPE* ASN.1 macro. It conveys a set of MIB variables to
be gathered and reported in SNMP Notification. The
:py:mod:`~pysnmp.smi.rfc1902` module implements :RFC:`1902#section-2`
macro definiitons.
.. toctree::
:maxdepth: 2
.. autoclass:: pysnmp.smi.rfc1902.NotificationType
:members:
.. _snmp-types:
SNMP base types
---------------
SNMP represents real-world objects it serves along with their
states in form of values. Those values each belong to one
of SNMP types (:RFC:`1902#section-2`) which, in turn, are based
on `ASN.1 <https://en.wikipedia.org/wiki/Abstract_Syntax_Notation_One>`_
data description language. PySNMP types are derived from
`Python ASN.1 types <http://pyasn1.sf.net>`_ implementation.
.. toctree::
:maxdepth: 2
.. _integer32:
Integer32 type
++++++++++++++
.. autoclass:: pysnmp.proto.rfc1902.Integer32(initializer)
:members:
.. _integer:
Integer type
++++++++++++
.. autoclass:: pysnmp.proto.rfc1902.Integer(initializer)
:members:
.. _octetstring:
OctetString type
++++++++++++++++
.. autoclass:: pysnmp.proto.rfc1902.OctetString(strValue=None, hexValue=None)
:members:
.. _ipaddress:
IpAddress type
++++++++++++++
.. autoclass:: pysnmp.proto.rfc1902.IpAddress(strValue=None, hexValue=None)
ObjectIdentifier type
+++++++++++++++++++++
.. autoclass:: pysnmp.proto.rfc1902.ObjectIdentifier(initializer)
Counter32 type
++++++++++++++
.. autoclass:: pysnmp.proto.rfc1902.Counter32(initializer)
Gauge32 type
++++++++++++
.. autoclass:: pysnmp.proto.rfc1902.Gauge32(initializer)
Unsigned32 type
+++++++++++++++
.. autoclass:: pysnmp.proto.rfc1902.Unsigned32(initializer)
TimeTicks type
++++++++++++++
.. autoclass:: pysnmp.proto.rfc1902.TimeTicks(initializer)
Opaque type
+++++++++++
.. autoclass:: pysnmp.proto.rfc1902.Opaque(initializer)
Counter64 type
++++++++++++++
.. autoclass:: pysnmp.proto.rfc1902.Counter64(initializer)
Bits type
+++++++++
.. autoclass:: pysnmp.proto.rfc1902.Bits(initializer)
:members:
|
