diff options
| author | Ilya Etingof <etingof@gmail.com> | 2018-08-12 17:22:58 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-08-12 17:22:58 +0200 |
| commit | ac0b956d006a4b7b32780e852740b56ecd826c7e (patch) | |
| tree | 4576911add0e18525991109acdb2a91bc4b2fde8 /docs | |
| parent | 488ec26798a4493ee0fc45e730f88f1365f56df7 (diff) | |
| download | pysnmp-git-ac0b956d006a4b7b32780e852740b56ecd826c7e.tar.gz | |
Add `hlapi.v1arch` API (#186)
* Add `hlapi.v1arch` API
Introduce new sub-package `pysnmp.hlapi.v1arch` which
wraps otherwise very detailed packet-level SNMP
messaging into a handful of convenience functions.
As a side effect, the `pysnmp.hlapi.*` sub-packages
moved under `pysnmp.hlapi.v3arch` though `pysnmp.hlapi`
still exposes `pysnmp.hlappi.v3arch.*` symbols to
retain some degree of backward compatibility.
The signature of the hlapi `.sendNotification()` call
has changed to accept `*varBinds` instead of a sequence
of `varBinds`. The rationale is to unify this method
call with similar methods of CommandGenerator.
* Add v1arch docs and reshuffle hlapi docs
Diffstat (limited to 'docs')
127 files changed, 2101 insertions, 1059 deletions
diff --git a/docs/source/docs/api-reference.rst b/docs/source/docs/api-reference.rst index 8ff7d958..cb7c6d3f 100644 --- a/docs/source/docs/api-reference.rst +++ b/docs/source/docs/api-reference.rst @@ -3,44 +3,40 @@ Library reference ================= .. toctree:: - :maxdepth: 2 + :maxdepth: 3 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. 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. -Synchronous SNMP ----------------- +High-level, v3arch, sync +------------------------ -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. +The synchronous `hlapi.v3arch` API is the easiest to use and probably +the richest in features. However `hlapi.v1arch` API may be faster. Command Generator .. toctree:: :maxdepth: 2 - /docs/hlapi/asyncore/sync/manager/cmdgen/getcmd - /docs/hlapi/asyncore/sync/manager/cmdgen/setcmd - /docs/hlapi/asyncore/sync/manager/cmdgen/nextcmd - /docs/hlapi/asyncore/sync/manager/cmdgen/bulkcmd + /docs/hlapi/v3arch/asyncore/sync/manager/cmdgen/getcmd + /docs/hlapi/v3arch/asyncore/sync/manager/cmdgen/setcmd + /docs/hlapi/v3arch/asyncore/sync/manager/cmdgen/nextcmd + /docs/hlapi/v3arch/asyncore/sync/manager/cmdgen/bulkcmd Notification Originator .. toctree:: :maxdepth: 2 - /docs/hlapi/asyncore/sync/agent/ntforg/notification + /docs/hlapi/v3arch/asyncore/sync/agent/ntforg/notification Transport configuration +++++++++++++++++++++++ @@ -59,8 +55,8 @@ saves its configuration for the lifetime of SNMP engine object. .. autoclass:: pysnmp.hlapi.Udp6TransportTarget :members: setLocalAddress -Asynchronous: asyncore ----------------------- +High-level v3arch asyncore +-------------------------- The :mod:`asyncore` module is in Python standard library since ancient times. Main loop is built around :mod:`select` dispatcher, user @@ -71,17 +67,17 @@ 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 + /docs/hlapi/v3arch/asyncore/manager/cmdgen/getcmd + /docs/hlapi/v3arch/asyncore/manager/cmdgen/setcmd + /docs/hlapi/v3arch/asyncore/manager/cmdgen/nextcmd + /docs/hlapi/v3arch/asyncore/manager/cmdgen/bulkcmd Notification Originator .. toctree:: :maxdepth: 2 - /docs/hlapi/asyncore/agent/ntforg/notification + /docs/hlapi/v3arch/asyncore/agent/ntforg/notification Transport configuration +++++++++++++++++++++++ @@ -89,14 +85,14 @@ Transport configuration .. toctree:: :maxdepth: 2 -.. autoclass:: pysnmp.hlapi.asyncore.UdpTransportTarget +.. autoclass:: pysnmp.hlapi.v3arch.asyncore.UdpTransportTarget :members: setLocalAddress -.. autoclass:: pysnmp.hlapi.asyncore.Udp6TransportTarget +.. autoclass:: pysnmp.hlapi.v3arch.asyncore.Udp6TransportTarget :members: setLocalAddress -Asynchronous: asyncio ---------------------- +High-level v3arch asyncio +------------------------- The :mod:`asyncio` module first appeared in standard library since Python 3.3 (in provisional basis). Its main design feature is that @@ -108,17 +104,17 @@ 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 + /docs/hlapi/v3arch/asyncio/manager/cmdgen/getcmd + /docs/hlapi/v3arch/asyncio/manager/cmdgen/setcmd + /docs/hlapi/v3arch/asyncio/manager/cmdgen/nextcmd + /docs/hlapi/v3arch/asyncio/manager/cmdgen/bulkcmd Notification Originator .. toctree:: :maxdepth: 2 - /docs/hlapi/asyncio/agent/ntforg/notification + /docs/hlapi/v3arch/asyncio/agent/ntforg/notification Transport configuration +++++++++++++++++++++++ @@ -126,14 +122,14 @@ Transport configuration .. toctree:: :maxdepth: 2 -.. autoclass:: pysnmp.hlapi.asyncio.UdpTransportTarget +.. autoclass:: pysnmp.hlapi.v3arch.asyncio.UdpTransportTarget :members: setLocalAddress -.. autoclass:: pysnmp.hlapi.asyncio.Udp6TransportTarget +.. autoclass:: pysnmp.hlapi.v3arch.asyncio.Udp6TransportTarget :members: setLocalAddress -Asynchronous: trollius ----------------------- +High-level v3arch trollius +-------------------------- An almost compatible alternative to *asyncio* for pre-3.3 Python is `Trollius <http://trollius.readthedocs.org>`_ module. PySNMP's @@ -142,8 +138,8 @@ is `Trollius <http://trollius.readthedocs.org>`_ module. PySNMP's Please refer to :doc:`Trollius examples </examples/contents>` for more information. -Asynchronous: Twisted ---------------------- +High-level v3arch twisted +------------------------- `Twisted <http://twistedmatrix.org>`_ is one of the earliest and hugely popular asynchronous I/O framework. It introduced a concept of @@ -156,17 +152,17 @@ 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 + /docs/hlapi/v3arch/twisted/manager/cmdgen/getcmd + /docs/hlapi/v3arch/twisted/manager/cmdgen/setcmd + /docs/hlapi/v3arch/twisted/manager/cmdgen/nextcmd + /docs/hlapi/v3arch/twisted/manager/cmdgen/bulkcmd Notification Originator .. toctree:: :maxdepth: 2 - /docs/hlapi/twisted/agent/ntforg/notification + /docs/hlapi/v3arch/twisted/agent/ntforg/notification Transport configuration +++++++++++++++++++++++ @@ -174,14 +170,14 @@ Transport configuration .. toctree:: :maxdepth: 2 -.. autoclass:: pysnmp.hlapi.twisted.UdpTransportTarget +.. autoclass:: pysnmp.hlapi.v3arch.twisted.UdpTransportTarget :members: setLocalAddress -SNMP Engine ------------ +High-level v3arch SNMP Engine +----------------------------- SNMP Engine is a central, stateful object used by all SNMP v3 -substsems. Calls to high-level Applications API also consume SNMP +subsystems. Calls to high-level Applications API also consume SNMP Engine object on input. .. toctree:: @@ -189,8 +185,8 @@ Engine object on input. .. autoclass:: pysnmp.hlapi.SnmpEngine(snmpEngineID=None) -Security Parameters -------------------- +High-level v3arch auth +---------------------- Calls to high-level Applications API consume Security Parameters configuration object on input. The shortcut classes described in @@ -242,8 +238,8 @@ via constant OIDs: Transport configuration is I/O framework specific and is described in respective sections. -SNMP Context ------------- +High-level v3arch SNMP Context +------------------------------ SNMP engine may serve several instances of the same MIB within possibly multiple SNMP entities. SNMP context is a tool for @@ -274,6 +270,111 @@ SNMP engine. See :RFC:`3411#section-3.3.1` for details. .. autoclass:: pysnmp.hlapi.ContextData +High-level v1arch sync +---------------------- + +The synchronous `hlapi.v1arch` API is probably the easiest to use and fast to run, +however it does not support SNMPv3. + +Command Generator + +.. toctree:: + :maxdepth: 2 + + /docs/hlapi/v1arch/asyncore/sync/manager/cmdgen/getcmd + /docs/hlapi/v1arch/asyncore/sync/manager/cmdgen/setcmd + /docs/hlapi/v1arch/asyncore/sync/manager/cmdgen/nextcmd + /docs/hlapi/v1arch/asyncore/sync/manager/cmdgen/bulkcmd + +Notification Originator + +.. toctree:: + :maxdepth: 2 + + /docs/hlapi/v1arch/asyncore/sync/agent/ntforg/notification + +Transport configuration ++++++++++++++++++++++++ + +The following shortcut classes convey configuration information to +SNMP engine's Local Configuration Datastore (:RFC:`2271#section-3.4.2`) +as well as to underlying socket API. Once committed to LCD, SNMP engine +saves its configuration for the lifetime of SNMP engine object. + +.. toctree:: + :maxdepth: 2 + +.. autoclass:: pysnmp.hlapi.v1arch.UdpTransportTarget + :members: setLocalAddress + +.. autoclass:: pysnmp.hlapi.v1arch.Udp6TransportTarget + :members: setLocalAddress + +High-level v1arch 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. + +Command Generator + +.. toctree:: + :maxdepth: 2 + + /docs/hlapi/v1arch/asyncore/manager/cmdgen/getcmd + /docs/hlapi/v1arch/asyncore/manager/cmdgen/setcmd + /docs/hlapi/v1arch/asyncore/manager/cmdgen/nextcmd + /docs/hlapi/v1arch/asyncore/manager/cmdgen/bulkcmd + +Notification Originator + +.. toctree:: + :maxdepth: 2 + + /docs/hlapi/v1arch/asyncore/agent/ntforg/notification + +Transport configuration ++++++++++++++++++++++++ + +.. toctree:: + :maxdepth: 2 + +.. autoclass:: pysnmp.hlapi.v1arch.asyncore.UdpTransportTarget + :members: setLocalAddress + +.. autoclass:: pysnmp.hlapi.v1arch.asyncore.Udp6TransportTarget + :members: setLocalAddress + +High-level v1arch SNMP Dispatcher +--------------------------------- + +SNMP Dispatcher is a stateful object representing asynchronous +I/O event loop and also holding some caches. Calls to `v1arch` +always require consume SNMP Dispatcher object on input. + +.. toctree:: + :maxdepth: 2 + +.. autoclass:: pysnmp.hlapi.v1arch.SnmpDispatcher() + +High-level v1arch auth +---------------------- + +Calls to `v1arch` API require SNMP authentication object on input. + +Community-based ++++++++++++++++ + +Security Parameters object is Security Model specific. The +:py:class:`~pysnmp.hlapi.v1arch.CommunityData` +class is used for configuring Community-Based Security Model of SNMPv1/SNMPv2c. + +.. toctree:: + :maxdepth: 2 + +.. autoclass:: pysnmp.hlapi.v1arch.CommunityData(communityName, mpModel=1) + .. _mib-services: MIB services diff --git a/docs/source/docs/hlapi/v1arch/asyncore/agent/ntforg/notification.rst b/docs/source/docs/hlapi/v1arch/asyncore/agent/ntforg/notification.rst new file mode 100644 index 00000000..0787018c --- /dev/null +++ b/docs/source/docs/hlapi/v1arch/asyncore/agent/ntforg/notification.rst @@ -0,0 +1,8 @@ + +TRAP/INFORM notification +======================== + +.. toctree:: + :maxdepth: 2 + +.. autofunction:: pysnmp.hlapi.v1arch.asyncore.sendNotification diff --git a/docs/source/docs/hlapi/v1arch/asyncore/manager/cmdgen/bulkcmd.rst b/docs/source/docs/hlapi/v1arch/asyncore/manager/cmdgen/bulkcmd.rst new file mode 100644 index 00000000..de9fccf7 --- /dev/null +++ b/docs/source/docs/hlapi/v1arch/asyncore/manager/cmdgen/bulkcmd.rst @@ -0,0 +1,8 @@ + +GETBULK command +=============== + +.. toctree:: + :maxdepth: 2 + +.. autofunction:: pysnmp.hlapi.v1arch.asyncore.bulkCmd diff --git a/docs/source/docs/hlapi/v1arch/asyncore/manager/cmdgen/getcmd.rst b/docs/source/docs/hlapi/v1arch/asyncore/manager/cmdgen/getcmd.rst new file mode 100644 index 00000000..427fbd98 --- /dev/null +++ b/docs/source/docs/hlapi/v1arch/asyncore/manager/cmdgen/getcmd.rst @@ -0,0 +1,8 @@ + +GET command +=========== + +.. toctree:: + :maxdepth: 2 + +.. autofunction:: pysnmp.hlapi.v1arch.asyncore.getCmd diff --git a/docs/source/docs/hlapi/v1arch/asyncore/manager/cmdgen/nextcmd.rst b/docs/source/docs/hlapi/v1arch/asyncore/manager/cmdgen/nextcmd.rst new file mode 100644 index 00000000..3d023b64 --- /dev/null +++ b/docs/source/docs/hlapi/v1arch/asyncore/manager/cmdgen/nextcmd.rst @@ -0,0 +1,8 @@ + +GETNEXT command +=============== + +.. toctree:: + :maxdepth: 2 + +.. autofunction:: pysnmp.hlapi.v1arch.asyncore.nextCmd diff --git a/docs/source/docs/hlapi/v1arch/asyncore/manager/cmdgen/setcmd.rst b/docs/source/docs/hlapi/v1arch/asyncore/manager/cmdgen/setcmd.rst new file mode 100644 index 00000000..89460d52 --- /dev/null +++ b/docs/source/docs/hlapi/v1arch/asyncore/manager/cmdgen/setcmd.rst @@ -0,0 +1,8 @@ + +SET command +=========== + +.. toctree:: + :maxdepth: 2 + +.. autofunction:: pysnmp.hlapi.v1arch.asyncore.setCmd diff --git a/docs/source/docs/hlapi/asyncio/agent/ntforg/notification.rst b/docs/source/docs/hlapi/v1arch/asyncore/sync/agent/ntforg/notification.rst index 954c9232..91099176 100644 --- a/docs/source/docs/hlapi/asyncio/agent/ntforg/notification.rst +++ b/docs/source/docs/hlapi/v1arch/asyncore/sync/agent/ntforg/notification.rst @@ -5,4 +5,4 @@ TRAP/INFORM notification .. toctree:: :maxdepth: 2 -.. autofunction:: pysnmp.hlapi.asyncio.sendNotification +.. autofunction:: pysnmp.hlapi.v1arch.sendNotification diff --git a/docs/source/docs/hlapi/asyncio/manager/cmdgen/bulkcmd.rst b/docs/source/docs/hlapi/v1arch/asyncore/sync/manager/cmdgen/bulkcmd.rst index 970cfb11..ff578d8c 100644 --- a/docs/source/docs/hlapi/asyncio/manager/cmdgen/bulkcmd.rst +++ b/docs/source/docs/hlapi/v1arch/asyncore/sync/manager/cmdgen/bulkcmd.rst @@ -5,4 +5,4 @@ GETBULK command .. toctree:: :maxdepth: 2 -.. autofunction:: pysnmp.hlapi.asyncio.bulkCmd +.. autofunction:: pysnmp.hlapi.v1arch.bulkCmd diff --git a/docs/source/docs/hlapi/twisted/manager/cmdgen/getcmd.rst b/docs/source/docs/hlapi/v1arch/asyncore/sync/manager/cmdgen/getcmd.rst index 53d3a142..1bcfd07d 100644 --- a/docs/source/docs/hlapi/twisted/manager/cmdgen/getcmd.rst +++ b/docs/source/docs/hlapi/v1arch/asyncore/sync/manager/cmdgen/getcmd.rst @@ -5,4 +5,4 @@ GET command .. toctree:: :maxdepth: 2 -.. autofunction:: pysnmp.hlapi.twisted.getCmd +.. autofunction:: pysnmp.hlapi.v1arch.getCmd diff --git a/docs/source/docs/hlapi/twisted/manager/cmdgen/nextcmd.rst b/docs/source/docs/hlapi/v1arch/asyncore/sync/manager/cmdgen/nextcmd.rst index 54aa5401..533c3872 100644 --- a/docs/source/docs/hlapi/twisted/manager/cmdgen/nextcmd.rst +++ b/docs/source/docs/hlapi/v1arch/asyncore/sync/manager/cmdgen/nextcmd.rst @@ -5,4 +5,4 @@ GETNEXT command .. toctree:: :maxdepth: 2 -.. autofunction:: pysnmp.hlapi.twisted.nextCmd +.. autofunction:: pysnmp.hlapi.v1arch.nextCmd diff --git a/docs/source/docs/hlapi/asyncio/manager/cmdgen/setcmd.rst b/docs/source/docs/hlapi/v1arch/asyncore/sync/manager/cmdgen/setcmd.rst index c34fc44b..78a7886a 100644 --- a/docs/source/docs/hlapi/asyncio/manager/cmdgen/setcmd.rst +++ b/docs/source/docs/hlapi/v1arch/asyncore/sync/manager/cmdgen/setcmd.rst @@ -5,4 +5,4 @@ SET command .. toctree:: :maxdepth: 2 -.. autofunction:: pysnmp.hlapi.asyncio.setCmd +.. autofunction:: pysnmp.hlapi.v1arch.setCmd diff --git a/docs/source/docs/hlapi/asyncore/agent/ntforg/notification.rst b/docs/source/docs/hlapi/v3arch/asyncio/agent/ntforg/notification.rst index e9d55cfd..f701eca6 100644 --- a/docs/source/docs/hlapi/asyncore/agent/ntforg/notification.rst +++ b/docs/source/docs/hlapi/v3arch/asyncio/agent/ntforg/notification.rst @@ -5,4 +5,4 @@ TRAP/INFORM notification .. toctree:: :maxdepth: 2 -.. autofunction:: pysnmp.hlapi.asyncore.sendNotification +.. autofunction:: pysnmp.hlapi.v3arch.asyncio.sendNotification diff --git a/docs/source/docs/hlapi/asyncore/manager/cmdgen/bulkcmd.rst b/docs/source/docs/hlapi/v3arch/asyncio/manager/cmdgen/bulkcmd.rst index 59bee11f..51e93801 100644 --- a/docs/source/docs/hlapi/asyncore/manager/cmdgen/bulkcmd.rst +++ b/docs/source/docs/hlapi/v3arch/asyncio/manager/cmdgen/bulkcmd.rst @@ -5,4 +5,4 @@ GETBULK command .. toctree:: :maxdepth: 2 -.. autofunction:: pysnmp.hlapi.asyncore.bulkCmd +.. autofunction:: pysnmp.hlapi.v3arch.asyncio.bulkCmd diff --git a/docs/source/docs/hlapi/asyncore/manager/cmdgen/getcmd.rst b/docs/source/docs/hlapi/v3arch/asyncio/manager/cmdgen/getcmd.rst index c2244913..821c5e66 100644 --- a/docs/source/docs/hlapi/asyncore/manager/cmdgen/getcmd.rst +++ b/docs/source/docs/hlapi/v3arch/asyncio/manager/cmdgen/getcmd.rst @@ -5,4 +5,4 @@ GET command .. toctree:: :maxdepth: 2 -.. autofunction:: pysnmp.hlapi.asyncore.getCmd +.. autofunction:: pysnmp.hlapi.v3arch.asyncio.getCmd diff --git a/docs/source/docs/hlapi/asyncore/manager/cmdgen/nextcmd.rst b/docs/source/docs/hlapi/v3arch/asyncio/manager/cmdgen/nextcmd.rst index 1a8856a7..285c1f10 100644 --- a/docs/source/docs/hlapi/asyncore/manager/cmdgen/nextcmd.rst +++ b/docs/source/docs/hlapi/v3arch/asyncio/manager/cmdgen/nextcmd.rst @@ -5,4 +5,4 @@ GETNEXT command .. toctree:: :maxdepth: 2 -.. autofunction:: pysnmp.hlapi.asyncore.nextCmd +.. autofunction:: pysnmp.hlapi.v3arch.asyncio.nextCmd diff --git a/docs/source/docs/hlapi/twisted/manager/cmdgen/setcmd.rst b/docs/source/docs/hlapi/v3arch/asyncio/manager/cmdgen/setcmd.rst index 8a7890a0..d170d5f4 100644 --- a/docs/source/docs/hlapi/twisted/manager/cmdgen/setcmd.rst +++ b/docs/source/docs/hlapi/v3arch/asyncio/manager/cmdgen/setcmd.rst @@ -5,4 +5,4 @@ SET command .. toctree:: :maxdepth: 2 -.. autofunction:: pysnmp.hlapi.twisted.setCmd +.. autofunction:: pysnmp.hlapi.v3arch.asyncio.setCmd diff --git a/docs/source/docs/hlapi/v3arch/asyncore/agent/ntforg/notification.rst b/docs/source/docs/hlapi/v3arch/asyncore/agent/ntforg/notification.rst new file mode 100644 index 00000000..13c76a72 --- /dev/null +++ b/docs/source/docs/hlapi/v3arch/asyncore/agent/ntforg/notification.rst @@ -0,0 +1,8 @@ + +TRAP/INFORM notification +======================== + +.. toctree:: + :maxdepth: 2 + +.. autofunction:: pysnmp.hlapi.v3arch.asyncore.sendNotification diff --git a/docs/source/docs/hlapi/v3arch/asyncore/manager/cmdgen/bulkcmd.rst b/docs/source/docs/hlapi/v3arch/asyncore/manager/cmdgen/bulkcmd.rst new file mode 100644 index 00000000..a139211d --- /dev/null +++ b/docs/source/docs/hlapi/v3arch/asyncore/manager/cmdgen/bulkcmd.rst @@ -0,0 +1,8 @@ + +GETBULK command +=============== + +.. toctree:: + :maxdepth: 2 + +.. autofunction:: pysnmp.hlapi.v3arch.asyncore.bulkCmd diff --git a/docs/source/docs/hlapi/v3arch/asyncore/manager/cmdgen/getcmd.rst b/docs/source/docs/hlapi/v3arch/asyncore/manager/cmdgen/getcmd.rst new file mode 100644 index 00000000..8688df99 --- /dev/null +++ b/docs/source/docs/hlapi/v3arch/asyncore/manager/cmdgen/getcmd.rst @@ -0,0 +1,8 @@ + +GET command +=========== + +.. toctree:: + :maxdepth: 2 + +.. autofunction:: pysnmp.hlapi.v3arch.asyncore.getCmd diff --git a/docs/source/docs/hlapi/v3arch/asyncore/manager/cmdgen/nextcmd.rst b/docs/source/docs/hlapi/v3arch/asyncore/manager/cmdgen/nextcmd.rst new file mode 100644 index 00000000..5a703cba --- /dev/null +++ b/docs/source/docs/hlapi/v3arch/asyncore/manager/cmdgen/nextcmd.rst @@ -0,0 +1,8 @@ + +GETNEXT command +=============== + +.. toctree:: + :maxdepth: 2 + +.. autofunction:: pysnmp.hlapi.v3arch.asyncore.nextCmd diff --git a/docs/source/docs/hlapi/v3arch/asyncore/manager/cmdgen/setcmd.rst b/docs/source/docs/hlapi/v3arch/asyncore/manager/cmdgen/setcmd.rst new file mode 100644 index 00000000..0b548afe --- /dev/null +++ b/docs/source/docs/hlapi/v3arch/asyncore/manager/cmdgen/setcmd.rst @@ -0,0 +1,8 @@ + +SET command +=========== + +.. toctree:: + :maxdepth: 2 + +.. autofunction:: pysnmp.hlapi.v3arch.asyncore.setCmd diff --git a/docs/source/docs/hlapi/asyncore/sync/agent/ntforg/notification.rst b/docs/source/docs/hlapi/v3arch/asyncore/sync/agent/ntforg/notification.rst index 619b13dd..619b13dd 100644 --- a/docs/source/docs/hlapi/asyncore/sync/agent/ntforg/notification.rst +++ b/docs/source/docs/hlapi/v3arch/asyncore/sync/agent/ntforg/notification.rst diff --git a/docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/bulkcmd.rst b/docs/source/docs/hlapi/v3arch/asyncore/sync/manager/cmdgen/bulkcmd.rst index 5791755b..5791755b 100644 --- a/docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/bulkcmd.rst +++ b/docs/source/docs/hlapi/v3arch/asyncore/sync/manager/cmdgen/bulkcmd.rst diff --git a/docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/getcmd.rst b/docs/source/docs/hlapi/v3arch/asyncore/sync/manager/cmdgen/getcmd.rst index 8d344e9e..8d344e9e 100644 --- a/docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/getcmd.rst +++ b/docs/source/docs/hlapi/v3arch/asyncore/sync/manager/cmdgen/getcmd.rst diff --git a/docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/nextcmd.rst b/docs/source/docs/hlapi/v3arch/asyncore/sync/manager/cmdgen/nextcmd.rst index 6b8dd6b6..6b8dd6b6 100644 --- a/docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/nextcmd.rst +++ b/docs/source/docs/hlapi/v3arch/asyncore/sync/manager/cmdgen/nextcmd.rst diff --git a/docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/setcmd.rst b/docs/source/docs/hlapi/v3arch/asyncore/sync/manager/cmdgen/setcmd.rst index 09e6ad56..09e6ad56 100644 --- a/docs/source/docs/hlapi/asyncore/sync/manager/cmdgen/setcmd.rst +++ b/docs/source/docs/hlapi/v3arch/asyncore/sync/manager/cmdgen/setcmd.rst diff --git a/docs/source/docs/hlapi/twisted/agent/ntforg/notification.rst b/docs/source/docs/hlapi/v3arch/twisted/agent/ntforg/notification.rst index 7928912e..b565c46e 100644 --- a/docs/source/docs/hlapi/twisted/agent/ntforg/notification.rst +++ b/docs/source/docs/hlapi/v3arch/twisted/agent/ntforg/notification.rst @@ -5,4 +5,4 @@ TRAP/INFORM notification .. toctree:: :maxdepth: 2 -.. autofunction:: pysnmp.hlapi.twisted.sendNotification +.. autofunction:: pysnmp.hlapi.v3arch.twisted.sendNotification diff --git a/docs/source/docs/hlapi/twisted/manager/cmdgen/bulkcmd.rst b/docs/source/docs/hlapi/v3arch/twisted/manager/cmdgen/bulkcmd.rst index 24fff6e1..f0f80e34 100644 --- a/docs/source/docs/hlapi/twisted/manager/cmdgen/bulkcmd.rst +++ b/docs/source/docs/hlapi/v3arch/twisted/manager/cmdgen/bulkcmd.rst @@ -5,4 +5,4 @@ GETBULK command .. toctree:: :maxdepth: 2 -.. autofunction:: pysnmp.hlapi.twisted.bulkCmd +.. autofunction:: pysnmp.hlapi.v3arch.twisted.bulkCmd diff --git a/docs/source/docs/hlapi/asyncio/manager/cmdgen/getcmd.rst b/docs/source/docs/hlapi/v3arch/twisted/manager/cmdgen/getcmd.rst index 4ac0a524..b5d419bb 100644 --- a/docs/source/docs/hlapi/asyncio/manager/cmdgen/getcmd.rst +++ b/docs/source/docs/hlapi/v3arch/twisted/manager/cmdgen/getcmd.rst @@ -5,4 +5,4 @@ GET command .. toctree:: :maxdepth: 2 -.. autofunction:: pysnmp.hlapi.asyncio.getCmd +.. autofunction:: pysnmp.hlapi.v3arch.twisted.getCmd diff --git a/docs/source/docs/hlapi/asyncio/manager/cmdgen/nextcmd.rst b/docs/source/docs/hlapi/v3arch/twisted/manager/cmdgen/nextcmd.rst index b88291c1..d161358a 100644 --- a/docs/source/docs/hlapi/asyncio/manager/cmdgen/nextcmd.rst +++ b/docs/source/docs/hlapi/v3arch/twisted/manager/cmdgen/nextcmd.rst @@ -5,4 +5,4 @@ GETNEXT command .. toctree:: :maxdepth: 2 -.. autofunction:: pysnmp.hlapi.asyncio.nextCmd +.. autofunction:: pysnmp.hlapi.v3arch.twisted.nextCmd diff --git a/docs/source/docs/hlapi/asyncore/manager/cmdgen/setcmd.rst b/docs/source/docs/hlapi/v3arch/twisted/manager/cmdgen/setcmd.rst index 92f6c912..238537ae 100644 --- a/docs/source/docs/hlapi/asyncore/manager/cmdgen/setcmd.rst +++ b/docs/source/docs/hlapi/v3arch/twisted/manager/cmdgen/setcmd.rst @@ -5,4 +5,4 @@ SET command .. toctree:: :maxdepth: 2 -.. autofunction:: pysnmp.hlapi.asyncore.setCmd +.. autofunction:: pysnmp.hlapi.v3arch.twisted.setCmd diff --git a/docs/source/docs/pysnmp-hlapi-tutorial.rst b/docs/source/docs/pysnmp-hlapi-tutorial.rst index 22075810..82ff55a2 100644 --- a/docs/source/docs/pysnmp-hlapi-tutorial.rst +++ b/docs/source/docs/pysnmp-hlapi-tutorial.rst @@ -242,7 +242,7 @@ in `SNMPv2-MIB <http://mibs.snmplabs.com/asn1/SNMPv2-MIB>`_ module. By default PySNMP will search your local filesystem for ASN.1 MIB files you refer to. It can also be configured to automatically download them from remote hosts, as -:doc:`shown </examples/hlapi/asyncore/sync/manager/cmdgen/mib-tweaks>` +:doc:`shown </examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/mib-tweaks>` in the examples. We maintain a `collection <http://mibs.snmplabs.com/asn1/>`_ of ASN.1 MIB modules that you can use in your SNMP projects. diff --git a/docs/source/docs/tutorial.rst b/docs/source/docs/tutorial.rst index f6548818..b96f6e08 100644 --- a/docs/source/docs/tutorial.rst +++ b/docs/source/docs/tutorial.rst @@ -1,6 +1,6 @@ -Documentation -============= +Overview +======== .. toctree:: :maxdepth: 2 diff --git a/docs/source/download.rst b/docs/source/download.rst index 4026d891..849873f9 100644 --- a/docs/source/download.rst +++ b/docs/source/download.rst @@ -50,6 +50,7 @@ operational: MIB download and compilation. That helps visualizing more SNMP objects Optional: + * `pysnmpcrypto <https://pypi.org/project/pysnmpcrypto/>`_, for strong SNMPv3 crypto support diff --git a/docs/source/examples/contents.rst b/docs/source/examples/contents.rst index f179e13b..7007fee8 100644 --- a/docs/source/examples/contents.rst +++ b/docs/source/examples/contents.rst @@ -9,51 +9,82 @@ SNMP is not simple (PySNMP implementation takes over 15K lines of Python code), but PySNMP tries to hide the complexities and let you carry out typical SNMP operations in a quick and intuitive way. -PySNMP offers three groups of programming interfaces to deal with -SNMP protocol. In the order from most concise to most detailed those -APIs follow. +PySNMP offers high and low-level programming interfaces to deal with +SNMP protocol. + +The other dimension of differences in the PySNMP APIs is that there are +two different SNMP implementations - the initial architecture +(`RFC1901 <https://tools.ietf.org/html/rfc1901>`_ .. +`RFC1905 <https://tools.ietf.org/html/rfc1905>`_) also known as SNMP v1 architecture +and the redesigned variant (`RFC3413 <https://tools.ietf.org/html/rfc3413>`_ +and others) -- SNMPv3 architecture. + +.. note:: + + The SNMP v1 architecture supports SNMP protocol versions 1 and 2c, + while SNMP v3 architecture supports versions 1, 2c and 3. Whatever + new amendments to the SNMP protocol may come up in the future, they + will be implemented within the v3 model. High-level SNMP --------------- -The so called high-level API (hlapi) is designed to be simple, concise and -suitable for the most frequent operations. For that matter only -Command Generator and Notification Originator Applications are currently +The high-level API (`hlapi`) is designed to be simple, concise and +suitable for the most typical client-side operations. For that matter, +only Command Generator and Notification Originator Applications are wrapped into a nearly one-line Python expression. -It comes in several flavours: one synchronous and a bunch of bindings to -popular asynchronous I/O frameworks. Those varieties of APIs bring -subtile differences, mostly to better match particular I/O framework -customs. Unless you have a very specific task, the high-level API might -solve your SNMP needs. +The `hlapi` interfaces come in several flavours: one synchronous +and a bunch of asynchronous, adapted to work withing the event loops +of popular asynchronous I/O frameworks. + +The primary reason for maintaining high-level API over both `v1arch` and +`v3arch` is performance - `v3arch` machinery is much more functional and complicated +internally, that translates to being heavier on resources and therefore slower. + +The v3 architecture ++++++++++++++++++++ .. toctree:: :maxdepth: 2 - /examples/hlapi/asyncore/sync/contents + /examples/hlapi/v3arch/asyncore/sync/contents .. toctree:: :maxdepth: 2 - /examples/hlapi/asyncore/contents + /examples/hlapi/v3arch/asyncore/contents .. toctree:: :maxdepth: 2 - /examples/hlapi/asyncio/contents + /examples/hlapi/v3arch/asyncio/contents .. toctree:: :maxdepth: 2 - /examples/hlapi/trollius/contents + /examples/hlapi/v3arch/trollius/contents .. toctree:: :maxdepth: 2 - /examples/hlapi/twisted/contents + /examples/hlapi/v3arch/twisted/contents -Native SNMP API ---------------- +The v1 architecture ++++++++++++++++++++ + +.. toctree:: + :maxdepth: 2 + + /examples/hlapi/v1arch/asyncore/sync/contents + +.. toctree:: + :maxdepth: 2 + + /examples/hlapi/v1arch/asyncore/contents + +Low-level v3 architecture +------------------------- Complete implementation of all official Standard SNMP Applications. It should let you implement any SNMP operation defined in the standard @@ -70,8 +101,8 @@ framework being used. /examples/v3arch/trollius/contents /examples/v3arch/twisted/contents -Packet-level SNMP ------------------ +Low-level v1 architecture +------------------------- In cases where performance is your top priority and you only need to work with SNMP v1 and v2c systems and you do not mind writing much @@ -116,15 +147,14 @@ Notification Receiver /examples/v1arch/asyncore/manager/ntfrcv/transport-tweaks -Low-level MIB access --------------------- +Low-level SMI/MIB +----------------- .. toctree:: /examples/smi/manager/browsing-mib-tree /examples/smi/agent/implementing-mib-objects - Using these examples -------------------- diff --git a/docs/source/examples/hlapi/asyncio/agent/ntforg/advanced-topics.rst b/docs/source/examples/hlapi/asyncio/agent/ntforg/advanced-topics.rst deleted file mode 100644 index e1a14dea..00000000 --- a/docs/source/examples/hlapi/asyncio/agent/ntforg/advanced-topics.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Advanced Notification Originator --------------------------------- - -.. include:: /../../examples/hlapi/asyncio/agent/ntforg/multiple-notifications-at-once.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncio/agent/ntforg/multiple-notifications-at-once.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncio/agent/ntforg/multiple-notifications-at-once.py>` script. - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncio/agent/ntforg/common-notifications.rst b/docs/source/examples/hlapi/asyncio/agent/ntforg/common-notifications.rst deleted file mode 100644 index 1dbf13c1..00000000 --- a/docs/source/examples/hlapi/asyncio/agent/ntforg/common-notifications.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Common notifications --------------------- - -.. include:: /../../examples/hlapi/asyncio/agent/ntforg/default-v1-trap.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncio/agent/ntforg/default-v1-trap.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncio/agent/ntforg/default-v1-trap.py>` script. - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncio/manager/cmdgen/advanced-topics.rst b/docs/source/examples/hlapi/asyncio/manager/cmdgen/advanced-topics.rst deleted file mode 100644 index b75d6e5d..00000000 --- a/docs/source/examples/hlapi/asyncio/manager/cmdgen/advanced-topics.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Advanced Command Generator --------------------------- - -.. include:: /../../examples/hlapi/asyncio/manager/cmdgen/multiple-concurrent-queries-over-ipv4-and-ipv6.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncio/manager/cmdgen/multiple-concurrent-queries-over-ipv4-and-ipv6.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncio/manager/cmdgen/multiple-concurrent-queries-over-ipv4-and-ipv6.py>` script. - - -.. include:: /../../examples/hlapi/asyncio/manager/cmdgen/multiple-sequential-queries.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncio/manager/cmdgen/multiple-sequential-queries.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncio/manager/cmdgen/multiple-sequential-queries.py>` script. - - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncio/manager/cmdgen/snmp-versions.rst b/docs/source/examples/hlapi/asyncio/manager/cmdgen/snmp-versions.rst deleted file mode 100644 index 20d34606..00000000 --- a/docs/source/examples/hlapi/asyncio/manager/cmdgen/snmp-versions.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Various SNMP versions ----------------------- - -.. include:: /../../examples/hlapi/asyncio/manager/cmdgen/v1-get.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncio/manager/cmdgen/v1-get.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncio/manager/cmdgen/v1-get.py>` script. - - -.. include:: /../../examples/hlapi/asyncio/manager/cmdgen/getbulk-to-eom.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncio/manager/cmdgen/getbulk-to-eom.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncio/manager/cmdgen/getbulk-to-eom.py>` script. - - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncio/manager/cmdgen/walking-operations.rst b/docs/source/examples/hlapi/asyncio/manager/cmdgen/walking-operations.rst deleted file mode 100644 index 3a588cad..00000000 --- a/docs/source/examples/hlapi/asyncio/manager/cmdgen/walking-operations.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Walking operations ------------------- - -.. include:: /../../examples/hlapi/asyncio/manager/cmdgen/getbulk-to-eom.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncio/manager/cmdgen/getbulk-to-eom.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncio/manager/cmdgen/getbulk-to-eom.py>` script. - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncore/agent/ntforg/advanced-topics.rst b/docs/source/examples/hlapi/asyncore/agent/ntforg/advanced-topics.rst deleted file mode 100644 index e87cd833..00000000 --- a/docs/source/examples/hlapi/asyncore/agent/ntforg/advanced-topics.rst +++ /dev/null @@ -1,40 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Advanced Notification Originator --------------------------------- - -.. include:: /../../examples/hlapi/asyncore/agent/ntforg/multiple-traps-at-once.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/multiple-traps-at-once.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/agent/ntforg/multiple-traps-at-once.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/agent/ntforg/multiple-informs-at-once.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/multiple-informs-at-once.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/agent/ntforg/multiple-informs-at-once.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/agent/ntforg/running-multiple-snmp-engines-at-once.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/running-multiple-snmp-engines-at-once.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/agent/ntforg/running-multiple-snmp-engines-at-once.py>` script. - - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncore/agent/ntforg/common-notifications.rst b/docs/source/examples/hlapi/asyncore/agent/ntforg/common-notifications.rst deleted file mode 100644 index 3f615bd3..00000000 --- a/docs/source/examples/hlapi/asyncore/agent/ntforg/common-notifications.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Common notifications --------------------- - -.. include:: /../../examples/hlapi/asyncore/agent/ntforg/default-v1-trap.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/default-v1-trap.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/agent/ntforg/default-v1-trap.py>` script. - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncore/manager/cmdgen/advanced-topics.rst b/docs/source/examples/hlapi/asyncore/manager/cmdgen/advanced-topics.rst deleted file mode 100644 index 17a01f97..00000000 --- a/docs/source/examples/hlapi/asyncore/manager/cmdgen/advanced-topics.rst +++ /dev/null @@ -1,40 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Advanced Command Generator --------------------------- - -.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/pull-mibs-from-multiple-agents-at-once-over-ipv4-and-ipv6.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/pull-mibs-from-multiple-agents-at-once-over-ipv4-and-ipv6.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/pull-mibs-from-multiple-agents-at-once-over-ipv4-and-ipv6.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/query-multiple-snmp-engines-over-ipv4-and-ipv6.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/query-multiple-snmp-engines-over-ipv4-and-ipv6.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/query-multiple-snmp-engines-over-ipv4-and-ipv6.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/multiple-concurrent-queries-over-ipv4-and-ipv6.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/multiple-concurrent-queries-over-ipv4-and-ipv6.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/multiple-concurrent-queries-over-ipv4-and-ipv6.py>` script. - - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncore/manager/cmdgen/snmp-versions.rst b/docs/source/examples/hlapi/asyncore/manager/cmdgen/snmp-versions.rst deleted file mode 100644 index b5c3bdea..00000000 --- a/docs/source/examples/hlapi/asyncore/manager/cmdgen/snmp-versions.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Various SNMP versions ----------------------- - -.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/v2c-get.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/v2c-get.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/v2c-get.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/pull-whole-mib.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/pull-whole-mib.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/pull-whole-mib.py>` script. - - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncore/manager/cmdgen/walking-operations.rst b/docs/source/examples/hlapi/asyncore/manager/cmdgen/walking-operations.rst deleted file mode 100644 index 3cc19a07..00000000 --- a/docs/source/examples/hlapi/asyncore/manager/cmdgen/walking-operations.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Walking operations ------------------- - -.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/pull-whole-mib.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/pull-whole-mib.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/pull-whole-mib.py>` script. - - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncore/sync/agent/ntforg/advanced-topics.rst b/docs/source/examples/hlapi/asyncore/sync/agent/ntforg/advanced-topics.rst deleted file mode 100644 index 2163690d..00000000 --- a/docs/source/examples/hlapi/asyncore/sync/agent/ntforg/advanced-topics.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Advanced Notification Originator --------------------------------- - -.. include:: /../../examples/hlapi/asyncore/sync/agent/ntforg/custom-contextname.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/agent/ntforg/custom-contextname.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/agent/ntforg/custom-contextname.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/sync/agent/ntforg/custom-contextengineid.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/agent/ntforg/custom-contextengineid.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/agent/ntforg/custom-contextengineid.py>` script. - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncore/sync/agent/ntforg/common-notifications.rst b/docs/source/examples/hlapi/asyncore/sync/agent/ntforg/common-notifications.rst deleted file mode 100644 index 7b09fa90..00000000 --- a/docs/source/examples/hlapi/asyncore/sync/agent/ntforg/common-notifications.rst +++ /dev/null @@ -1,49 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Common notifications --------------------- - -.. include:: /../../examples/hlapi/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/sync/agent/ntforg/v3-inform.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/agent/ntforg/v3-inform.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/agent/ntforg/v3-inform.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/sync/agent/ntforg/default-v1-trap.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/agent/ntforg/default-v1-trap.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/agent/ntforg/default-v1-trap.py>` script. - -.. include:: /../../examples/hlapi/asyncore/sync/agent/ntforg/v3-trap.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/agent/ntforg/v3-trap.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/agent/ntforg/v3-trap.py>` script. - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncore/sync/agent/ntforg/evaluating-notification-type.rst b/docs/source/examples/hlapi/asyncore/sync/agent/ntforg/evaluating-notification-type.rst deleted file mode 100644 index f5ac1bf1..00000000 --- a/docs/source/examples/hlapi/asyncore/sync/agent/ntforg/evaluating-notification-type.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Evaluating NOTIFICATION-TYPE ----------------------------- - -.. include:: /../../examples/hlapi/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/sync/agent/ntforg/send-notification-with-additional-varbinds.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/agent/ntforg/send-notification-with-additional-varbinds.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/agent/ntforg/send-notification-with-additional-varbinds.py>` script. - - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncore/sync/agent/ntforg/snmp-v1-trap-variants.rst b/docs/source/examples/hlapi/asyncore/sync/agent/ntforg/snmp-v1-trap-variants.rst deleted file mode 100644 index 68a01e9c..00000000 --- a/docs/source/examples/hlapi/asyncore/sync/agent/ntforg/snmp-v1-trap-variants.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -SNMPv1 TRAP variants --------------------- - -.. include:: /../../examples/hlapi/asyncore/sync/agent/ntforg/custom-v1-trap.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/agent/ntforg/custom-v1-trap.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/agent/ntforg/custom-v1-trap.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/sync/agent/ntforg/default-v1-trap.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/agent/ntforg/default-v1-trap.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/agent/ntforg/default-v1-trap.py>` script. - - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/advanced-topics.rst b/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/advanced-topics.rst deleted file mode 100644 index 9854bc52..00000000 --- a/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/advanced-topics.rst +++ /dev/null @@ -1,84 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Advanced Command Generator --------------------------- - -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/getbulk-limit-number-of-packets.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/getbulk-limit-number-of-packets.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/getbulk-limit-number-of-packets.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/multiple-get-calls.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/multiple-get-calls.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/multiple-get-calls.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/custom-contextengineid.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/custom-contextengineid.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/custom-contextengineid.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/custom-contextengineid-and-contextname.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/custom-contextengineid-and-contextname.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/custom-contextengineid-and-contextname.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/custom-v3-security-name.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/custom-v3-security-name.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/custom-v3-security-name.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/specific-v3-engine-id.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/specific-v3-engine-id.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/specific-v3-engine-id.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/query-agents-from-multuple-threads-over-ipv4-and-ipv6.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/query-agents-from-multuple-threads-over-ipv4-and-ipv6.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/query-agents-from-multuple-threads-over-ipv4-and-ipv6.py>` script. - - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/mib-tweaks.rst b/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/mib-tweaks.rst deleted file mode 100644 index d1ea7ff8..00000000 --- a/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/mib-tweaks.rst +++ /dev/null @@ -1,48 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -MIB tweaks ----------- - -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/waive-mib-lookup.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/waive-mib-lookup.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/waive-mib-lookup.py>` script. - -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/preload-pysnmp-mibs.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/preload-pysnmp-mibs.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/preload-pysnmp-mibs.py>` script. - -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/custom-asn1-mib-search-path.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/custom-asn1-mib-search-path.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/custom-asn1-mib-search-path.py>` script. - -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/custom-pysnmp-mibs-search-path.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/custom-pysnmp-mibs-search-path.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/custom-pysnmp-mibs-search-path.py>` script. - - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/modifying-variables.rst b/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/modifying-variables.rst deleted file mode 100644 index 95ee0451..00000000 --- a/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/modifying-variables.rst +++ /dev/null @@ -1,30 +0,0 @@ - -.. toctree:: - :maxdepth: 2 - -Modifying variables -------------------- - -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/coerce-set-value-to-mib-spec.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/coerce-set-value-to-mib-spec.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/coerce-set-value-to-mib-spec.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/set-multiple-scalar-values.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/set-multiple-scalar-values.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/set-multiple-scalar-values.py>` script. - - -See also: :doc:`library-reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/snmp-versions.rst b/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/snmp-versions.rst deleted file mode 100644 index d1fee8dc..00000000 --- a/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/snmp-versions.rst +++ /dev/null @@ -1,72 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -SNMP versions -------------- - -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/v1-get.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/v1-get.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/v1-get.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/v2c-get.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/v2c-get.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/v2c-get.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/usm-md5-des.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/usm-md5-des.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/usm-md5-des.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/usm-md5-none.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/usm-md5-none.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/usm-md5-none.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/usm-none-none.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/usm-none-none.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/usm-none-none.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/usm-sha-aes128.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/usm-sha-aes128.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/usm-sha-aes128.py>` script. - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/transport-tweaks.rst b/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/transport-tweaks.rst deleted file mode 100644 index e3309f6b..00000000 --- a/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/transport-tweaks.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Transport tweaks ----------------- - -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/custom-timeout-and-retries.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/custom-timeout-and-retries.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/custom-timeout-and-retries.py>` script. - - -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/fetch-variables-over-ipv6.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/fetch-variables-over-ipv6.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/fetch-variables-over-ipv6.py>` script. - - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/walking-operations.rst b/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/walking-operations.rst deleted file mode 100644 index fa7ed380..00000000 --- a/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/walking-operations.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Walking operations ------------------- - -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/pull-whole-mib.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/pull-whole-mib.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/pull-whole-mib.py>` script. - - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/trollius/agent/ntforg/common-notifications.rst b/docs/source/examples/hlapi/trollius/agent/ntforg/common-notifications.rst deleted file mode 100644 index c0b78924..00000000 --- a/docs/source/examples/hlapi/trollius/agent/ntforg/common-notifications.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Common notifications --------------------- - -.. include:: /../../examples/hlapi/trollius/agent/ntforg/default-v1-trap.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/trollius/agent/ntforg/default-v1-trap.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/trollius/agent/ntforg/default-v1-trap.py>` script. - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/trollius/manager/cmdgen/snmp-versions.rst b/docs/source/examples/hlapi/trollius/manager/cmdgen/snmp-versions.rst deleted file mode 100644 index 769bd7a0..00000000 --- a/docs/source/examples/hlapi/trollius/manager/cmdgen/snmp-versions.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Various SNMP versions ----------------------- - -.. include:: /../../examples/hlapi/trollius/manager/cmdgen/v1-get.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/trollius/manager/cmdgen/v1-get.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/trollius/manager/cmdgen/v1-get.py>` script. - - -.. include:: /../../examples/hlapi/trollius/manager/cmdgen/getbulk-to-eom.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/trollius/manager/cmdgen/getbulk-to-eom.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/trollius/manager/cmdgen/getbulk-to-eom.py>` script. - - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/trollius/manager/cmdgen/walking-operations.rst b/docs/source/examples/hlapi/trollius/manager/cmdgen/walking-operations.rst deleted file mode 100644 index dcc7672a..00000000 --- a/docs/source/examples/hlapi/trollius/manager/cmdgen/walking-operations.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Walking operations ------------------- - -.. include:: /../../examples/hlapi/trollius/manager/cmdgen/getbulk-to-eom.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/trollius/manager/cmdgen/getbulk-to-eom.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/trollius/manager/cmdgen/getbulk-to-eom.py>` script. - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/twisted/agent/ntforg/advanced-topics.rst b/docs/source/examples/hlapi/twisted/agent/ntforg/advanced-topics.rst deleted file mode 100644 index 8be4effa..00000000 --- a/docs/source/examples/hlapi/twisted/agent/ntforg/advanced-topics.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Advanced Notification Originator --------------------------------- - -.. include:: /../../examples/hlapi/twisted/agent/ntforg/multiple-notifications-at-once.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/twisted/agent/ntforg/multiple-notifications-at-once.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/twisted/agent/ntforg/multiple-notifications-at-once.py>` script. - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/twisted/agent/ntforg/common-notifications.rst b/docs/source/examples/hlapi/twisted/agent/ntforg/common-notifications.rst deleted file mode 100644 index 61d8b3f5..00000000 --- a/docs/source/examples/hlapi/twisted/agent/ntforg/common-notifications.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Common notifications --------------------- - -.. include:: /../../examples/hlapi/twisted/agent/ntforg/default-v1-trap.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/twisted/agent/ntforg/default-v1-trap.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/twisted/agent/ntforg/default-v1-trap.py>` script. - -.. include:: /../../examples/hlapi/twisted/agent/ntforg/v2c-trap-inline-callbacks.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/twisted/agent/ntforg/v2c-trap-inline-callbacks.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/twisted/agent/ntforg/v2c-trap-inline-callbacks.py>` script. - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/twisted/manager/cmdgen/advanced-topics.rst b/docs/source/examples/hlapi/twisted/manager/cmdgen/advanced-topics.rst deleted file mode 100644 index 135ab533..00000000 --- a/docs/source/examples/hlapi/twisted/manager/cmdgen/advanced-topics.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Advanced Command Generator --------------------------- - -.. include:: /../../examples/hlapi/twisted/manager/cmdgen/multiple-concurrent-queries.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/twisted/manager/cmdgen/multiple-concurrent-queries.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/twisted/manager/cmdgen/multiple-concurrent-queries.py>` script. - - -.. include:: /../../examples/hlapi/twisted/manager/cmdgen/pull-mibs-from-multiple-agents-at-once.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/twisted/manager/cmdgen/pull-mibs-from-multiple-agents-at-once.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/twisted/manager/cmdgen/pull-mibs-from-multiple-agents-at-once.py>` script. - - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/twisted/manager/cmdgen/snmp-versions.rst b/docs/source/examples/hlapi/twisted/manager/cmdgen/snmp-versions.rst deleted file mode 100644 index b2d94b09..00000000 --- a/docs/source/examples/hlapi/twisted/manager/cmdgen/snmp-versions.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Various SNMP versions ----------------------- - -.. include:: /../../examples/hlapi/twisted/manager/cmdgen/v1-get.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/twisted/manager/cmdgen/v1-get.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/twisted/manager/cmdgen/v1-get.py>` script. - - -.. include:: /../../examples/hlapi/twisted/manager/cmdgen/getbulk-to-eom.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/twisted/manager/cmdgen/getbulk-to-eom.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/twisted/manager/cmdgen/getbulk-to-eom.py>` script. - - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/twisted/manager/cmdgen/transport-tweaks.rst b/docs/source/examples/hlapi/twisted/manager/cmdgen/transport-tweaks.rst deleted file mode 100644 index bddd96c9..00000000 --- a/docs/source/examples/hlapi/twisted/manager/cmdgen/transport-tweaks.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Transport tweaks ----------------- - -.. include:: /../../examples/hlapi/twisted/manager/cmdgen/custom-timeout-and-retries.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/twisted/manager/cmdgen/custom-timeout-and-retries.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/twisted/manager/cmdgen/custom-timeout-and-retries.py>` script. - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/twisted/manager/cmdgen/walking-operations.rst b/docs/source/examples/hlapi/twisted/manager/cmdgen/walking-operations.rst deleted file mode 100644 index 71058bb9..00000000 --- a/docs/source/examples/hlapi/twisted/manager/cmdgen/walking-operations.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. toctree:: - :maxdepth: 2 - -Walking operations ------------------- - -.. include:: /../../examples/hlapi/twisted/manager/cmdgen/getbulk-to-eom.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/twisted/manager/cmdgen/getbulk-to-eom.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/twisted/manager/cmdgen/getbulk-to-eom.py>` script. - -.. include:: /../../examples/hlapi/twisted/manager/cmdgen/pull-whole-mib.py - :start-after: """ - :end-before: """# - -.. literalinclude:: /../../examples/hlapi/twisted/manager/cmdgen/pull-whole-mib.py - :start-after: """# - :language: python - -:download:`Download</../../examples/hlapi/twisted/manager/cmdgen/pull-whole-mib.py>` script. - -See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v1arch/asyncore/agent/ntforg/advanced-topics.rst b/docs/source/examples/hlapi/v1arch/asyncore/agent/ntforg/advanced-topics.rst new file mode 100644 index 00000000..a1dec24c --- /dev/null +++ b/docs/source/examples/hlapi/v1arch/asyncore/agent/ntforg/advanced-topics.rst @@ -0,0 +1,7 @@ +.. toctree:: + :maxdepth: 2 + +Advanced Notification Originator +-------------------------------- + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v1arch/asyncore/agent/ntforg/common-notifications.rst b/docs/source/examples/hlapi/v1arch/asyncore/agent/ntforg/common-notifications.rst new file mode 100644 index 00000000..3bfbde3a --- /dev/null +++ b/docs/source/examples/hlapi/v1arch/asyncore/agent/ntforg/common-notifications.rst @@ -0,0 +1,49 @@ +.. toctree:: + :maxdepth: 2 + +Common notifications +-------------------- + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py>` script. + + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/v2c-inform.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/v2c-inform.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/v2c-inform.py>` script. + + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/generic-v1-trap.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/generic-v1-trap.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/generic-v1-trap.py>` script. + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/generic-v2c-trap.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/generic-v2c-trap.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/generic-v2c-trap.py>` script. + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v1arch/asyncore/agent/ntforg/evaluating-notification-type.rst b/docs/source/examples/hlapi/v1arch/asyncore/agent/ntforg/evaluating-notification-type.rst new file mode 100644 index 00000000..b3b14adf --- /dev/null +++ b/docs/source/examples/hlapi/v1arch/asyncore/agent/ntforg/evaluating-notification-type.rst @@ -0,0 +1,18 @@ +.. toctree:: + :maxdepth: 2 + +Evaluating NOTIFICATION-TYPE +---------------------------- + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v1arch/asyncore/contents.rst b/docs/source/examples/hlapi/v1arch/asyncore/contents.rst new file mode 100644 index 00000000..5f1e16d9 --- /dev/null +++ b/docs/source/examples/hlapi/v1arch/asyncore/contents.rst @@ -0,0 +1,60 @@ + +Asynchronous SNMP (asyncore, v1arch) +==================================== + +Applications build around :mod:`asyncore` get CPU time on :mod:`socket` +events being watched for by :mod:`select` dispatcher. User code +lives mostly in isolated functions (or any callable objects). + +As it is with any asynchronous I/O system, `asyncore` lets you run +many SNMP queries in parallel and/or sequentially, interleave SNMP +queries with other I/O operations for as long as they are managed +within the same event loop. + +The :mod:`pysnmp.hlapi.v1arch.asyncore` package implements `asyncore` +binding to pysnmp's `v1arch` services. + +In most examples approximate analogues of well known Net-SNMP snmp* tools +command line options are shown. That may help those readers who, by chance +are familiar with Net-SNMP tools, better understanding what example code doe + +Here's a quick example on a simple SNMP GET by high-level API: + +.. include:: /../../examples/hlapi/v1arch/asyncore/manager/cmdgen/v2c-get.py + :start-after: options: + :end-before: Functionally + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/manager/cmdgen/v2c-get.py + :start-after: """# + :language: python + +.. toctree:: + + /examples/hlapi/v1arch/asyncore/manager/cmdgen/snmp-versions + /examples/hlapi/v1arch/asyncore/manager/cmdgen/modifying-variables + /examples/hlapi/v1arch/asyncore/manager/cmdgen/walking-operations + /examples/hlapi/v1arch/asyncore/manager/cmdgen/table-operations + /examples/hlapi/v1arch/asyncore/manager/cmdgen/mib-tweaks + /examples/hlapi/v1arch/asyncore/manager/cmdgen/transport-tweaks + /examples/hlapi/v1arch/asyncore/manager/cmdgen/advanced-topics + +The following code sends SNMP TRAP: + + .. include:: /../../examples/hlapi/v1arch/asyncore/agent/ntforg/generic-v1-trap.py + :start-after: options: + :end-before: Functionally + + .. literalinclude:: /../../examples/hlapi/v1arch/asyncore/agent/ntforg/generic-v1-trap.py + :start-after: """# + :language: python + +More examples on Notification Originator API usage follow. + +.. toctree:: + + /examples/hlapi/v1arch/asyncore/agent/ntforg/common-notifications + /examples/hlapi/v1arch/asyncore/agent/ntforg/evaluating-notification-type + /examples/hlapi/v1arch/asyncore/agent/ntforg/advanced-topics + +More sophisticated SNMP operations can still be performed with +PySNMP via its Native API to Standard SNMP Applications. diff --git a/docs/source/examples/hlapi/v1arch/asyncore/manager/cmdgen/advanced-topics.rst b/docs/source/examples/hlapi/v1arch/asyncore/manager/cmdgen/advanced-topics.rst new file mode 100644 index 00000000..aec0b85b --- /dev/null +++ b/docs/source/examples/hlapi/v1arch/asyncore/manager/cmdgen/advanced-topics.rst @@ -0,0 +1,39 @@ +.. toctree:: + :maxdepth: 2 + +Advanced Command Generator +-------------------------- + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/getbulk-limit-number-of-packets.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/getbulk-limit-number-of-packets.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/getbulk-limit-number-of-packets.py>` script. + + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/multiple-get-calls.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/multiple-get-calls.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/multiple-get-calls.py>` script. + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/query-agents-from-multuple-threads-over-ipv4-and-ipv6.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/query-agents-from-multuple-threads-over-ipv4-and-ipv6.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/query-agents-from-multuple-threads-over-ipv4-and-ipv6.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v1arch/asyncore/manager/cmdgen/mib-tweaks.rst b/docs/source/examples/hlapi/v1arch/asyncore/manager/cmdgen/mib-tweaks.rst new file mode 100644 index 00000000..3bc98656 --- /dev/null +++ b/docs/source/examples/hlapi/v1arch/asyncore/manager/cmdgen/mib-tweaks.rst @@ -0,0 +1,48 @@ +.. toctree:: + :maxdepth: 2 + +MIB tweaks +---------- + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/enable-mib-lookup.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/enable-mib-lookup.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/enable-mib-lookup.py>` script. + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/preload-pysnmp-mibs.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/preload-pysnmp-mibs.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/preload-pysnmp-mibs.py>` script. + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/custom-asn1-mib-search-path.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/custom-asn1-mib-search-path.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/custom-asn1-mib-search-path.py>` script. + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/custom-pysnmp-mibs-search-path.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/custom-pysnmp-mibs-search-path.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/custom-pysnmp-mibs-search-path.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v1arch/asyncore/manager/cmdgen/modifying-variables.rst b/docs/source/examples/hlapi/v1arch/asyncore/manager/cmdgen/modifying-variables.rst new file mode 100644 index 00000000..b6aa9add --- /dev/null +++ b/docs/source/examples/hlapi/v1arch/asyncore/manager/cmdgen/modifying-variables.rst @@ -0,0 +1,30 @@ + +.. toctree:: + :maxdepth: 2 + +Modifying variables +------------------- + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/coerce-set-value-to-mib-spec.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/coerce-set-value-to-mib-spec.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/coerce-set-value-to-mib-spec.py>` script. + + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/set-multiple-scalar-values.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/set-multiple-scalar-values.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/set-multiple-scalar-values.py>` script. + + +See also: :doc:`library-reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v1arch/asyncore/manager/cmdgen/snmp-versions.rst b/docs/source/examples/hlapi/v1arch/asyncore/manager/cmdgen/snmp-versions.rst new file mode 100644 index 00000000..9f9c0ec5 --- /dev/null +++ b/docs/source/examples/hlapi/v1arch/asyncore/manager/cmdgen/snmp-versions.rst @@ -0,0 +1,30 @@ +.. toctree:: + :maxdepth: 2 + +Various SNMP versions +---------------------- + +.. include:: /../../examples/hlapi/v1arch/asyncore/manager/cmdgen/v2c-get.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/manager/cmdgen/v2c-get.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/manager/cmdgen/v2c-get.py>` script. + +.. comment + + .. include:: /../../examples/hlapi/v1arch/asyncore/manager/cmdgen/pull-whole-mib.py + :start-after: """ + :end-before: """# + + .. literalinclude:: /../../examples/hlapi/v1arch/asyncore/manager/cmdgen/pull-whole-mib.py + :start-after: """# + :language: python + + :download:`Download</../../examples/hlapi/v1arch/asyncore/manager/cmdgen/pull-whole-mib.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v1arch/asyncore/manager/cmdgen/table-operations.rst b/docs/source/examples/hlapi/v1arch/asyncore/manager/cmdgen/table-operations.rst new file mode 100644 index 00000000..ede8a8ed --- /dev/null +++ b/docs/source/examples/hlapi/v1arch/asyncore/manager/cmdgen/table-operations.rst @@ -0,0 +1,50 @@ +.. toctree:: + :maxdepth: 2 + +Table operations +---------------- + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/get-table-object-by-index.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/get-table-object-by-index.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/get-table-object-by-index.py>` script. + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/get-table-object-by-multiple-indices.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/get-table-object-by-multiple-indices.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/get-table-object-by-multiple-indices.py>` script. + + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/getbulk-fetch-scalar-and-table-variables-over-ipv6.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/getbulk-fetch-scalar-and-table-variables-over-ipv6.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/getbulk-fetch-scalar-and-table-variables-over-ipv6.py>` script. + + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/pull-whole-snmp-table.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/pull-whole-snmp-table.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/pull-whole-snmp-table.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v1arch/asyncore/manager/cmdgen/transport-tweaks.rst b/docs/source/examples/hlapi/v1arch/asyncore/manager/cmdgen/transport-tweaks.rst new file mode 100644 index 00000000..5c948d51 --- /dev/null +++ b/docs/source/examples/hlapi/v1arch/asyncore/manager/cmdgen/transport-tweaks.rst @@ -0,0 +1,29 @@ +.. toctree:: + :maxdepth: 2 + +Transport tweaks +---------------- + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/custom-timeout-and-retries.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/custom-timeout-and-retries.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/custom-timeout-and-retries.py>` script. + + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/fetch-variables-over-ipv6.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/fetch-variables-over-ipv6.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/fetch-variables-over-ipv6.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v1arch/asyncore/manager/cmdgen/walking-operations.rst b/docs/source/examples/hlapi/v1arch/asyncore/manager/cmdgen/walking-operations.rst new file mode 100644 index 00000000..e843fb42 --- /dev/null +++ b/docs/source/examples/hlapi/v1arch/asyncore/manager/cmdgen/walking-operations.rst @@ -0,0 +1,18 @@ +.. toctree:: + :maxdepth: 2 + +Walking operations +------------------ + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/pull-whole-mib.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/pull-whole-mib.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/pull-whole-mib.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v1arch/asyncore/sync/agent/ntforg/common-notifications.rst b/docs/source/examples/hlapi/v1arch/asyncore/sync/agent/ntforg/common-notifications.rst new file mode 100644 index 00000000..bf3b4fbc --- /dev/null +++ b/docs/source/examples/hlapi/v1arch/asyncore/sync/agent/ntforg/common-notifications.rst @@ -0,0 +1,59 @@ +.. toctree:: + :maxdepth: 2 + +Common notifications +-------------------- + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/generic-v1-trap.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/generic-v1-trap.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/generic-v1-trap.py>` script. + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/generic-v2c-trap.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/generic-v2c-trap.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/generic-v2c-trap.py>` script. + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py>` script. + + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/v2c-inform.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/v2c-inform.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/v2c-inform.py>` script. + + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/generic-v1-trap.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/generic-v1-trap.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/generic-v1-trap.py>` script. + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v1arch/asyncore/sync/agent/ntforg/evaluating-notification-type.rst b/docs/source/examples/hlapi/v1arch/asyncore/sync/agent/ntforg/evaluating-notification-type.rst new file mode 100644 index 00000000..c40ca45e --- /dev/null +++ b/docs/source/examples/hlapi/v1arch/asyncore/sync/agent/ntforg/evaluating-notification-type.rst @@ -0,0 +1,17 @@ +.. toctree:: + :maxdepth: 2 + +Evaluating NOTIFICATION-TYPE +---------------------------- + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py>` script. + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v1arch/asyncore/sync/contents.rst b/docs/source/examples/hlapi/v1arch/asyncore/sync/contents.rst new file mode 100644 index 00000000..046138ff --- /dev/null +++ b/docs/source/examples/hlapi/v1arch/asyncore/sync/contents.rst @@ -0,0 +1,74 @@ + +Synchronous SNMP (v1arch) +========================= + +This chapter illustrates various uses of the synchronous high-level +programming interface to client-side SNMP entities along the lines +of `RFC1905 <https://tools.ietf.org/html/rfc1905>`_. + +.. note:: The following examples involve creating Python iterator, + the next() call is used to invoke iterator just once. + +In most examples approximate analogues of well known Net-SNMP snmp* tools +command line options are shown. That may help those readers who, by chance +are familiar with Net-SNMP tools, better understanding what the example +code does. + +Here's a quick example on a simple SNMP GET by high-level API: + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/v1-get.py + :start-after: options: + :end-before: Functionally + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/v1-get.py + :start-after: """# + :language: python + +.. note:: + + If MIB lookup is required (e.g. when :py:class:`~pysnmp.smi.rfc1902.ObjectIdentity`, + :py:class:`~pysnmp.smi.rfc1902.ObjectType` or :py:class:`~pysnmp.smi.rfc1902.NotificationType` + objects being used), the `lookupMib=True` should also be passed. + +The following code performs a series of SNMP GETNEXT operations +fetching a table of SNMP variables from SNMP Agent: + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/pull-whole-mib.py + :start-after: options: + :end-before: Functionally + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/pull-whole-mib.py + :start-after: """# + :language: python + +More examples on Command Generator API usage follow. + +.. toctree:: + + /examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/snmp-versions + /examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/modifying-variables + /examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/walking-operations + /examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/table-operations + /examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/mib-tweaks + /examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/transport-tweaks + /examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/advanced-topics + +The following code sends SNMP TRAP: + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/generic-v2c-trap.py + :start-after: options: + :end-before: Functionally + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/agent/ntforg/generic-v2c-trap.py + :start-after: """# + :language: python + +More examples on Notification Originator API usage follow. + +.. toctree:: + + /examples/hlapi/v1arch/asyncore/sync/agent/ntforg/common-notifications + /examples/hlapi/v1arch/asyncore/sync/agent/ntforg/evaluating-notification-type + +More specific SNMP operations can still be performed with PySNMP via +its Native API to Standard SNMP Applications. diff --git a/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/advanced-topics.rst b/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/advanced-topics.rst new file mode 100644 index 00000000..aec0b85b --- /dev/null +++ b/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/advanced-topics.rst @@ -0,0 +1,39 @@ +.. toctree:: + :maxdepth: 2 + +Advanced Command Generator +-------------------------- + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/getbulk-limit-number-of-packets.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/getbulk-limit-number-of-packets.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/getbulk-limit-number-of-packets.py>` script. + + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/multiple-get-calls.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/multiple-get-calls.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/multiple-get-calls.py>` script. + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/query-agents-from-multuple-threads-over-ipv4-and-ipv6.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/query-agents-from-multuple-threads-over-ipv4-and-ipv6.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/query-agents-from-multuple-threads-over-ipv4-and-ipv6.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/mib-tweaks.rst b/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/mib-tweaks.rst new file mode 100644 index 00000000..3bc98656 --- /dev/null +++ b/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/mib-tweaks.rst @@ -0,0 +1,48 @@ +.. toctree:: + :maxdepth: 2 + +MIB tweaks +---------- + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/enable-mib-lookup.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/enable-mib-lookup.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/enable-mib-lookup.py>` script. + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/preload-pysnmp-mibs.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/preload-pysnmp-mibs.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/preload-pysnmp-mibs.py>` script. + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/custom-asn1-mib-search-path.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/custom-asn1-mib-search-path.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/custom-asn1-mib-search-path.py>` script. + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/custom-pysnmp-mibs-search-path.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/custom-pysnmp-mibs-search-path.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/custom-pysnmp-mibs-search-path.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/modifying-variables.rst b/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/modifying-variables.rst new file mode 100644 index 00000000..b6aa9add --- /dev/null +++ b/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/modifying-variables.rst @@ -0,0 +1,30 @@ + +.. toctree:: + :maxdepth: 2 + +Modifying variables +------------------- + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/coerce-set-value-to-mib-spec.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/coerce-set-value-to-mib-spec.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/coerce-set-value-to-mib-spec.py>` script. + + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/set-multiple-scalar-values.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/set-multiple-scalar-values.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/set-multiple-scalar-values.py>` script. + + +See also: :doc:`library-reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/snmp-versions.rst b/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/snmp-versions.rst new file mode 100644 index 00000000..2d408866 --- /dev/null +++ b/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/snmp-versions.rst @@ -0,0 +1,29 @@ +.. toctree:: + :maxdepth: 2 + +SNMP versions +------------- + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/v1-get.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/v1-get.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/v1-get.py>` script. + + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/v2c-get.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/v2c-get.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/v2c-get.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/table-operations.rst b/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/table-operations.rst new file mode 100644 index 00000000..ede8a8ed --- /dev/null +++ b/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/table-operations.rst @@ -0,0 +1,50 @@ +.. toctree:: + :maxdepth: 2 + +Table operations +---------------- + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/get-table-object-by-index.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/get-table-object-by-index.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/get-table-object-by-index.py>` script. + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/get-table-object-by-multiple-indices.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/get-table-object-by-multiple-indices.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/get-table-object-by-multiple-indices.py>` script. + + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/getbulk-fetch-scalar-and-table-variables-over-ipv6.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/getbulk-fetch-scalar-and-table-variables-over-ipv6.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/getbulk-fetch-scalar-and-table-variables-over-ipv6.py>` script. + + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/pull-whole-snmp-table.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/pull-whole-snmp-table.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/pull-whole-snmp-table.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/table-operations.rst b/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/table-operations.rst- index 7314acd1..7314acd1 100644 --- a/docs/source/examples/hlapi/asyncore/sync/manager/cmdgen/table-operations.rst +++ b/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/table-operations.rst- diff --git a/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/transport-tweaks.rst b/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/transport-tweaks.rst new file mode 100644 index 00000000..5c948d51 --- /dev/null +++ b/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/transport-tweaks.rst @@ -0,0 +1,29 @@ +.. toctree:: + :maxdepth: 2 + +Transport tweaks +---------------- + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/custom-timeout-and-retries.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/custom-timeout-and-retries.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/custom-timeout-and-retries.py>` script. + + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/fetch-variables-over-ipv6.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/fetch-variables-over-ipv6.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/fetch-variables-over-ipv6.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/walking-operations.rst b/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/walking-operations.rst new file mode 100644 index 00000000..e843fb42 --- /dev/null +++ b/docs/source/examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/walking-operations.rst @@ -0,0 +1,18 @@ +.. toctree:: + :maxdepth: 2 + +Walking operations +------------------ + +.. include:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/pull-whole-mib.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/pull-whole-mib.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v1arch/asyncore/sync/manager/cmdgen/pull-whole-mib.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/asyncio/agent/ntforg/advanced-topics.rst b/docs/source/examples/hlapi/v3arch/asyncio/agent/ntforg/advanced-topics.rst new file mode 100644 index 00000000..37a23b64 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/asyncio/agent/ntforg/advanced-topics.rst @@ -0,0 +1,17 @@ +.. toctree:: + :maxdepth: 2 + +Advanced Notification Originator +-------------------------------- + +.. include:: /../../examples/hlapi/v3arch/asyncio/agent/ntforg/multiple-notifications-at-once.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncio/agent/ntforg/multiple-notifications-at-once.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncio/agent/ntforg/multiple-notifications-at-once.py>` script. + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/asyncio/agent/ntforg/common-notifications.rst b/docs/source/examples/hlapi/v3arch/asyncio/agent/ntforg/common-notifications.rst new file mode 100644 index 00000000..b56622f4 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/asyncio/agent/ntforg/common-notifications.rst @@ -0,0 +1,17 @@ +.. toctree:: + :maxdepth: 2 + +Common notifications +-------------------- + +.. include:: /../../examples/hlapi/v3arch/asyncio/agent/ntforg/default-v1-trap.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncio/agent/ntforg/default-v1-trap.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncio/agent/ntforg/default-v1-trap.py>` script. + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncio/contents.rst b/docs/source/examples/hlapi/v3arch/asyncio/contents.rst index 4283d67e..2057d56f 100644 --- a/docs/source/examples/hlapi/asyncio/contents.rst +++ b/docs/source/examples/hlapi/v3arch/asyncio/contents.rst @@ -1,6 +1,6 @@ -Asynchronous: asyncio -===================== +Asynchronous SNMP (asynio, v3arch) +================================== The :mod:`asyncio` module first appeared in standard library since Python 3.3 (in provisional basis). Its main design feature is that it @@ -8,8 +8,8 @@ makes asynchronous code looking like synchronous one thus eliminating "callback hell". With `asyncio` built-in facilities, you could run many SNMP queries -in parallel and/or sequentially, interleave SNMP queries with I/O -operations with other systems. See `asyncio resources <http://asyncio.org>`_ +in parallel and/or sequentially, interleave SNMP queries with other I/O +operations. See `asyncio resources <http://asyncio.org>`_ repository for other `asyncio`-compatible modules. In most examples approximate analogues of well known Net-SNMP snmp* tools @@ -18,11 +18,11 @@ are familiar with Net-SNMP tools, better understanding what example code doe Here's a quick example on a simple SNMP GET by high-level API: -.. include:: /../../examples/hlapi/asyncio/manager/cmdgen/v1-get.py +.. include:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/v1-get.py :start-after: options: :end-before: Functionally -.. literalinclude:: /../../examples/hlapi/asyncio/manager/cmdgen/v1-get.py +.. literalinclude:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/v1-get.py :start-after: """# :language: python @@ -30,11 +30,11 @@ To make use of SNMPv3 and USM, the following code performs a series of SNMP GETNEXT operations effectively fetching a table of SNMP variables from SNMP Agent: -.. include:: /../../examples/hlapi/asyncio/manager/cmdgen/getbulk-to-eom.py +.. include:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/getbulk-to-eom.py :start-after: options: :end-before: Functionally -.. literalinclude:: /../../examples/hlapi/asyncio/manager/cmdgen/getbulk-to-eom.py +.. literalinclude:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/getbulk-to-eom.py :start-after: """# :language: python @@ -42,18 +42,18 @@ More examples on Command Generator API usage follow. .. toctree:: - /examples/hlapi/asyncio/manager/cmdgen/snmp-versions - /examples/hlapi/asyncio/manager/cmdgen/walking-operations - /examples/hlapi/asyncio/manager/cmdgen/advanced-topics + /examples/hlapi/v3arch/asyncio/manager/cmdgen/snmp-versions + /examples/hlapi/v3arch/asyncio/manager/cmdgen/walking-operations + /examples/hlapi/v3arch/asyncio/manager/cmdgen/advanced-topics Sending SNMP TRAP's and INFORM's is as easy with PySNMP library. The following code sends SNMP TRAP: -.. include:: /../../examples/hlapi/asyncio/agent/ntforg/default-v1-trap.py +.. include:: /../../examples/hlapi/v3arch/asyncio/agent/ntforg/default-v1-trap.py :start-after: options: :end-before: Functionally -.. literalinclude:: /../../examples/hlapi/asyncio/agent/ntforg/default-v1-trap.py +.. literalinclude:: /../../examples/hlapi/v3arch/asyncio/agent/ntforg/default-v1-trap.py :start-after: """# :language: python @@ -61,8 +61,8 @@ More examples on Notification Originator API usage follow. .. toctree:: - /examples/hlapi/asyncio/agent/ntforg/common-notifications - /examples/hlapi/asyncio/agent/ntforg/advanced-topics + /examples/hlapi/v3arch/asyncio/agent/ntforg/common-notifications + /examples/hlapi/v3arch/asyncio/agent/ntforg/advanced-topics More sophisticated or less popular SNMP operations can still be performed with PySNMP through its Native API to Standard SNMP Applications. diff --git a/docs/source/examples/hlapi/v3arch/asyncio/manager/cmdgen/advanced-topics.rst b/docs/source/examples/hlapi/v3arch/asyncio/manager/cmdgen/advanced-topics.rst new file mode 100644 index 00000000..ed74be3b --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/asyncio/manager/cmdgen/advanced-topics.rst @@ -0,0 +1,29 @@ +.. toctree:: + :maxdepth: 2 + +Advanced Command Generator +-------------------------- + +.. include:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/multiple-concurrent-queries-over-ipv4-and-ipv6.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/multiple-concurrent-queries-over-ipv4-and-ipv6.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncio/manager/cmdgen/multiple-concurrent-queries-over-ipv4-and-ipv6.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/multiple-sequential-queries.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/multiple-sequential-queries.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncio/manager/cmdgen/multiple-sequential-queries.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/asyncio/manager/cmdgen/snmp-versions.rst b/docs/source/examples/hlapi/v3arch/asyncio/manager/cmdgen/snmp-versions.rst new file mode 100644 index 00000000..e2496ed2 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/asyncio/manager/cmdgen/snmp-versions.rst @@ -0,0 +1,29 @@ +.. toctree:: + :maxdepth: 2 + +Various SNMP versions +---------------------- + +.. include:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/v1-get.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/v1-get.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncio/manager/cmdgen/v1-get.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/getbulk-to-eom.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/getbulk-to-eom.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncio/manager/cmdgen/getbulk-to-eom.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/asyncio/manager/cmdgen/walking-operations.rst b/docs/source/examples/hlapi/v3arch/asyncio/manager/cmdgen/walking-operations.rst new file mode 100644 index 00000000..68d05dc0 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/asyncio/manager/cmdgen/walking-operations.rst @@ -0,0 +1,17 @@ +.. toctree:: + :maxdepth: 2 + +Walking operations +------------------ + +.. include:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/getbulk-to-eom.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/getbulk-to-eom.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncio/manager/cmdgen/getbulk-to-eom.py>` script. + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/asyncore/agent/ntforg/advanced-topics.rst b/docs/source/examples/hlapi/v3arch/asyncore/agent/ntforg/advanced-topics.rst new file mode 100644 index 00000000..60d45a08 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/asyncore/agent/ntforg/advanced-topics.rst @@ -0,0 +1,40 @@ +.. toctree:: + :maxdepth: 2 + +Advanced Notification Originator +-------------------------------- + +.. include:: /../../examples/hlapi/v3arch/asyncore/agent/ntforg/multiple-traps-at-once.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/agent/ntforg/multiple-traps-at-once.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/agent/ntforg/multiple-traps-at-once.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/agent/ntforg/multiple-informs-at-once.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/agent/ntforg/multiple-informs-at-once.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/agent/ntforg/multiple-informs-at-once.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/agent/ntforg/running-multiple-snmp-engines-at-once.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/agent/ntforg/running-multiple-snmp-engines-at-once.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/agent/ntforg/running-multiple-snmp-engines-at-once.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/asyncore/agent/ntforg/common-notifications.rst b/docs/source/examples/hlapi/v3arch/asyncore/agent/ntforg/common-notifications.rst new file mode 100644 index 00000000..75c614d3 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/asyncore/agent/ntforg/common-notifications.rst @@ -0,0 +1,17 @@ +.. toctree:: + :maxdepth: 2 + +Common notifications +-------------------- + +.. include:: /../../examples/hlapi/v3arch/asyncore/agent/ntforg/default-v1-trap.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/agent/ntforg/default-v1-trap.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/agent/ntforg/default-v1-trap.py>` script. + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncore/contents.rst b/docs/source/examples/hlapi/v3arch/asyncore/contents.rst index c589cd09..f9d70c49 100644 --- a/docs/source/examples/hlapi/asyncore/contents.rst +++ b/docs/source/examples/hlapi/v3arch/asyncore/contents.rst @@ -1,22 +1,30 @@ -Asynchronous: asyncore -====================== +Asynchronous SNMP (asyncore, v3arch) +==================================== With :mod:`asyncore` API your scripts get CPU time on :mod:`socket` events being watched for by :mod:`select` dispatcher. Your code live mostly in isolated functions (or any callable objects). +As it is with any asynchronous I/O system, `asyncore` lets you run +many SNMP queries in parallel and/or sequentially, interleave SNMP +queries with other I/O operations for as long as they are managed +within the same event loop. + +The :mod:`pysnmp.hlapi.v3arch.asyncore` package implements `asyncore` +binding to pysnmp's `v3arch` services. + In most examples approximate analogues of well known Net-SNMP snmp* tools command line options are shown. That may help those readers who, by chance are familiar with Net-SNMP tools, better understanding what example code doe Here's a quick example on a simple SNMP GET by high-level API: -.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/v2c-get.py +.. include:: /../../examples/hlapi/v3arch/asyncore/manager/cmdgen/v2c-get.py :start-after: options: :end-before: Functionally -.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/v2c-get.py +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/manager/cmdgen/v2c-get.py :start-after: """# :language: python @@ -24,11 +32,11 @@ To make use of SNMPv3 and USM, the following code performs a series of SNMP GETNEXT operations effectively fetching a table of SNMP variables from SNMP Agent: -.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/pull-whole-mib.py +.. include:: /../../examples/hlapi/v3arch/asyncore/manager/cmdgen/pull-whole-mib.py :start-after: options: :end-before: Functionally -.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/pull-whole-mib.py +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/manager/cmdgen/pull-whole-mib.py :start-after: """# :language: python @@ -36,18 +44,18 @@ More examples on Command Generator API usage follow. .. toctree:: - /examples/hlapi/asyncore/manager/cmdgen/snmp-versions - /examples/hlapi/asyncore/manager/cmdgen/walking-operations - /examples/hlapi/asyncore/manager/cmdgen/advanced-topics + /examples/hlapi/v3arch/asyncore/manager/cmdgen/snmp-versions + /examples/hlapi/v3arch/asyncore/manager/cmdgen/walking-operations + /examples/hlapi/v3arch/asyncore/manager/cmdgen/advanced-topics Sending SNMP TRAP's and INFORM's is as easy with PySNMP library. The following code sends SNMP TRAP: -.. include:: /../../examples/hlapi/asyncore/agent/ntforg/default-v1-trap.py +.. include:: /../../examples/hlapi/v3arch/asyncore/agent/ntforg/default-v1-trap.py :start-after: options: :end-before: Functionally -.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/default-v1-trap.py +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/agent/ntforg/default-v1-trap.py :start-after: """# :language: python @@ -55,8 +63,8 @@ More examples on Notification Originator API usage follow. .. toctree:: - /examples/hlapi/asyncore/agent/ntforg/common-notifications - /examples/hlapi/asyncore/agent/ntforg/advanced-topics + /examples/hlapi/v3arch/asyncore/agent/ntforg/common-notifications + /examples/hlapi/v3arch/asyncore/agent/ntforg/advanced-topics More sophisticated or less popular SNMP operations can still be performed with PySNMP through its Native API to Standard SNMP Applications. diff --git a/docs/source/examples/hlapi/v3arch/asyncore/manager/cmdgen/advanced-topics.rst b/docs/source/examples/hlapi/v3arch/asyncore/manager/cmdgen/advanced-topics.rst new file mode 100644 index 00000000..7249f918 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/asyncore/manager/cmdgen/advanced-topics.rst @@ -0,0 +1,40 @@ +.. toctree:: + :maxdepth: 2 + +Advanced Command Generator +-------------------------- + +.. include:: /../../examples/hlapi/v3arch/asyncore/manager/cmdgen/pull-mibs-from-multiple-agents-at-once-over-ipv4-and-ipv6.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/manager/cmdgen/pull-mibs-from-multiple-agents-at-once-over-ipv4-and-ipv6.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/manager/cmdgen/pull-mibs-from-multiple-agents-at-once-over-ipv4-and-ipv6.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/manager/cmdgen/query-multiple-snmp-engines-over-ipv4-and-ipv6.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/manager/cmdgen/query-multiple-snmp-engines-over-ipv4-and-ipv6.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/manager/cmdgen/query-multiple-snmp-engines-over-ipv4-and-ipv6.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/manager/cmdgen/multiple-concurrent-queries-over-ipv4-and-ipv6.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/manager/cmdgen/multiple-concurrent-queries-over-ipv4-and-ipv6.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/manager/cmdgen/multiple-concurrent-queries-over-ipv4-and-ipv6.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/asyncore/manager/cmdgen/snmp-versions.rst b/docs/source/examples/hlapi/v3arch/asyncore/manager/cmdgen/snmp-versions.rst new file mode 100644 index 00000000..b9dddb22 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/asyncore/manager/cmdgen/snmp-versions.rst @@ -0,0 +1,29 @@ +.. toctree:: + :maxdepth: 2 + +Various SNMP versions +---------------------- + +.. include:: /../../examples/hlapi/v3arch/asyncore/manager/cmdgen/v2c-get.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/manager/cmdgen/v2c-get.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/manager/cmdgen/v2c-get.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/manager/cmdgen/pull-whole-mib.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/manager/cmdgen/pull-whole-mib.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/manager/cmdgen/pull-whole-mib.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/asyncore/manager/cmdgen/walking-operations.rst b/docs/source/examples/hlapi/v3arch/asyncore/manager/cmdgen/walking-operations.rst new file mode 100644 index 00000000..dcd5da25 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/asyncore/manager/cmdgen/walking-operations.rst @@ -0,0 +1,18 @@ +.. toctree:: + :maxdepth: 2 + +Walking operations +------------------ + +.. include:: /../../examples/hlapi/v3arch/asyncore/manager/cmdgen/pull-whole-mib.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/manager/cmdgen/pull-whole-mib.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/manager/cmdgen/pull-whole-mib.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/asyncore/sync/agent/ntforg/advanced-topics.rst b/docs/source/examples/hlapi/v3arch/asyncore/sync/agent/ntforg/advanced-topics.rst new file mode 100644 index 00000000..d7a82b2c --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/asyncore/sync/agent/ntforg/advanced-topics.rst @@ -0,0 +1,28 @@ +.. toctree:: + :maxdepth: 2 + +Advanced Notification Originator +-------------------------------- + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/custom-contextname.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/custom-contextname.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/custom-contextname.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/custom-contextengineid.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/custom-contextengineid.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/custom-contextengineid.py>` script. + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/asyncore/sync/agent/ntforg/common-notifications.rst b/docs/source/examples/hlapi/v3arch/asyncore/sync/agent/ntforg/common-notifications.rst new file mode 100644 index 00000000..4aabf1b1 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/asyncore/sync/agent/ntforg/common-notifications.rst @@ -0,0 +1,49 @@ +.. toctree:: + :maxdepth: 2 + +Common notifications +-------------------- + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/v3-inform.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/v3-inform.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/v3-inform.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/default-v1-trap.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/default-v1-trap.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/default-v1-trap.py>` script. + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/v3-trap.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/v3-trap.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/v3-trap.py>` script. + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/asyncore/sync/agent/ntforg/evaluating-notification-type.rst b/docs/source/examples/hlapi/v3arch/asyncore/sync/agent/ntforg/evaluating-notification-type.rst new file mode 100644 index 00000000..255bd7d1 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/asyncore/sync/agent/ntforg/evaluating-notification-type.rst @@ -0,0 +1,29 @@ +.. toctree:: + :maxdepth: 2 + +Evaluating NOTIFICATION-TYPE +---------------------------- + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/v2c-trap-with-notification-objects.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/send-notification-with-additional-varbinds.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/send-notification-with-additional-varbinds.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/send-notification-with-additional-varbinds.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/asyncore/sync/agent/ntforg/snmp-v1-trap-variants.rst b/docs/source/examples/hlapi/v3arch/asyncore/sync/agent/ntforg/snmp-v1-trap-variants.rst new file mode 100644 index 00000000..90bf0941 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/asyncore/sync/agent/ntforg/snmp-v1-trap-variants.rst @@ -0,0 +1,29 @@ +.. toctree:: + :maxdepth: 2 + +SNMPv1 TRAP variants +-------------------- + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/custom-v1-trap.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/custom-v1-trap.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/custom-v1-trap.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/default-v1-trap.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/default-v1-trap.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/default-v1-trap.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/asyncore/sync/contents.rst b/docs/source/examples/hlapi/v3arch/asyncore/sync/contents.rst index 29211c7c..031cae7d 100644 --- a/docs/source/examples/hlapi/asyncore/sync/contents.rst +++ b/docs/source/examples/hlapi/v3arch/asyncore/sync/contents.rst @@ -1,6 +1,6 @@ -Synchronous SNMP -================ +Synchronous SNMP (v3arch) +========================= This chapter illustrates various uses of the synchronous high-level programming interface to some of Standard SNMP Applications, as defined in @@ -11,15 +11,16 @@ programming interface to some of Standard SNMP Applications, as defined in In most examples approximate analogues of well known Net-SNMP snmp* tools command line options are shown. That may help those readers who, by chance -are familiar with Net-SNMP tools, better understanding what example code doe +are familiar with Net-SNMP tools, better understanding what the example code +does. Here's a quick example on a simple SNMP GET by high-level API: -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/v1-get.py +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/v1-get.py :start-after: options: :end-before: Functionally -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/v1-get.py +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/v1-get.py :start-after: """# :language: python @@ -27,11 +28,11 @@ To make use of SNMPv3 and USM, the following code performs a series of SNMP GETNEXT operations effectively fetching a table of SNMP variables from SNMP Agent: -.. include:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/pull-whole-mib.py +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/pull-whole-mib.py :start-after: options: :end-before: Functionally -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/pull-whole-mib.py +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/pull-whole-mib.py :start-after: """# :language: python @@ -39,22 +40,22 @@ More examples on Command Generator API usage follow. .. toctree:: - /examples/hlapi/asyncore/sync/manager/cmdgen/snmp-versions - /examples/hlapi/asyncore/sync/manager/cmdgen/modifying-variables - /examples/hlapi/asyncore/sync/manager/cmdgen/walking-operations - /examples/hlapi/asyncore/sync/manager/cmdgen/table-operations - /examples/hlapi/asyncore/sync/manager/cmdgen/mib-tweaks - /examples/hlapi/asyncore/sync/manager/cmdgen/transport-tweaks - /examples/hlapi/asyncore/sync/manager/cmdgen/advanced-topics + /examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/snmp-versions + /examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/modifying-variables + /examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/walking-operations + /examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/table-operations + /examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/mib-tweaks + /examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/transport-tweaks + /examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/advanced-topics Sending SNMP TRAP's and INFORM's is as easy with PySNMP library. The following code sends SNMP TRAP: -.. include:: /../../examples/hlapi/asyncore/sync/agent/ntforg/default-v1-trap.py +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/default-v1-trap.py :start-after: options: :end-before: Functionally -.. literalinclude:: /../../examples/hlapi/asyncore/sync/agent/ntforg/default-v1-trap.py +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/default-v1-trap.py :start-after: """# :language: python @@ -62,10 +63,10 @@ More examples on Notification Originator API usage follow. .. toctree:: - /examples/hlapi/asyncore/sync/agent/ntforg/common-notifications - /examples/hlapi/asyncore/sync/agent/ntforg/snmp-v1-trap-variants - /examples/hlapi/asyncore/sync/agent/ntforg/evaluating-notification-type - /examples/hlapi/asyncore/sync/agent/ntforg/advanced-topics + /examples/hlapi/v3arch/asyncore/sync/agent/ntforg/common-notifications + /examples/hlapi/v3arch/asyncore/sync/agent/ntforg/snmp-v1-trap-variants + /examples/hlapi/v3arch/asyncore/sync/agent/ntforg/evaluating-notification-type + /examples/hlapi/v3arch/asyncore/sync/agent/ntforg/advanced-topics More sophisticated or less popular SNMP operations can still be performed with PySNMP through its Native API to Standard SNMP Applications. diff --git a/docs/source/examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/advanced-topics.rst b/docs/source/examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/advanced-topics.rst new file mode 100644 index 00000000..0b9c5df0 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/advanced-topics.rst @@ -0,0 +1,84 @@ +.. toctree:: + :maxdepth: 2 + +Advanced Command Generator +-------------------------- + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/getbulk-limit-number-of-packets.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/getbulk-limit-number-of-packets.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/getbulk-limit-number-of-packets.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/multiple-get-calls.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/multiple-get-calls.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/multiple-get-calls.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/custom-contextengineid.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/custom-contextengineid.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/custom-contextengineid.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/custom-contextengineid-and-contextname.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/custom-contextengineid-and-contextname.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/custom-contextengineid-and-contextname.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/custom-v3-security-name.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/custom-v3-security-name.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/custom-v3-security-name.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/specific-v3-engine-id.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/specific-v3-engine-id.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/specific-v3-engine-id.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/query-agents-from-multuple-threads-over-ipv4-and-ipv6.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/query-agents-from-multuple-threads-over-ipv4-and-ipv6.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/query-agents-from-multuple-threads-over-ipv4-and-ipv6.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/mib-tweaks.rst b/docs/source/examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/mib-tweaks.rst new file mode 100644 index 00000000..34e8988a --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/mib-tweaks.rst @@ -0,0 +1,48 @@ +.. toctree:: + :maxdepth: 2 + +MIB tweaks +---------- + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/waive-mib-lookup.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/waive-mib-lookup.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/waive-mib-lookup.py>` script. + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/preload-pysnmp-mibs.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/preload-pysnmp-mibs.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/preload-pysnmp-mibs.py>` script. + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/custom-asn1-mib-search-path.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/custom-asn1-mib-search-path.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/custom-asn1-mib-search-path.py>` script. + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/custom-pysnmp-mibs-search-path.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/custom-pysnmp-mibs-search-path.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/custom-pysnmp-mibs-search-path.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/modifying-variables.rst b/docs/source/examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/modifying-variables.rst new file mode 100644 index 00000000..384fc3b8 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/modifying-variables.rst @@ -0,0 +1,30 @@ + +.. toctree:: + :maxdepth: 2 + +Modifying variables +------------------- + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/coerce-set-value-to-mib-spec.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/coerce-set-value-to-mib-spec.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/coerce-set-value-to-mib-spec.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/set-multiple-scalar-values.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/set-multiple-scalar-values.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/set-multiple-scalar-values.py>` script. + + +See also: :doc:`library-reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/snmp-versions.rst b/docs/source/examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/snmp-versions.rst new file mode 100644 index 00000000..087df557 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/snmp-versions.rst @@ -0,0 +1,72 @@ +.. toctree:: + :maxdepth: 2 + +SNMP versions +------------- + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/v1-get.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/v1-get.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/v1-get.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/v2c-get.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/v2c-get.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/v2c-get.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/usm-md5-des.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/usm-md5-des.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/usm-md5-des.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/usm-md5-none.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/usm-md5-none.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/usm-md5-none.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/usm-none-none.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/usm-none-none.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/usm-none-none.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/usm-sha-aes128.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/usm-sha-aes128.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/usm-sha-aes128.py>` script. + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/table-operations.rst b/docs/source/examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/table-operations.rst new file mode 100644 index 00000000..59066848 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/table-operations.rst @@ -0,0 +1,50 @@ +.. toctree:: + :maxdepth: 2 + +Table operations +---------------- + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/get-table-object-by-index.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/get-table-object-by-index.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/get-table-object-by-index.py>` script. + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/get-table-object-by-multiple-indices.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/get-table-object-by-multiple-indices.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/get-table-object-by-multiple-indices.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/getbulk-fetch-scalar-and-table-variables-over-ipv6.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/getbulk-fetch-scalar-and-table-variables-over-ipv6.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/getbulk-fetch-scalar-and-table-variables-over-ipv6.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/pull-whole-snmp-table.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/pull-whole-snmp-table.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/pull-whole-snmp-table.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/transport-tweaks.rst b/docs/source/examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/transport-tweaks.rst new file mode 100644 index 00000000..5d6a29a7 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/transport-tweaks.rst @@ -0,0 +1,29 @@ +.. toctree:: + :maxdepth: 2 + +Transport tweaks +---------------- + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/custom-timeout-and-retries.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/custom-timeout-and-retries.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/custom-timeout-and-retries.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/fetch-variables-over-ipv6.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/fetch-variables-over-ipv6.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/fetch-variables-over-ipv6.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/walking-operations.rst b/docs/source/examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/walking-operations.rst new file mode 100644 index 00000000..44a4888e --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/walking-operations.rst @@ -0,0 +1,18 @@ +.. toctree:: + :maxdepth: 2 + +Walking operations +------------------ + +.. include:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/pull-whole-mib.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/pull-whole-mib.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/pull-whole-mib.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/trollius/agent/ntforg/common-notifications.rst b/docs/source/examples/hlapi/v3arch/trollius/agent/ntforg/common-notifications.rst new file mode 100644 index 00000000..169af765 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/trollius/agent/ntforg/common-notifications.rst @@ -0,0 +1,17 @@ +.. toctree:: + :maxdepth: 2 + +Common notifications +-------------------- + +.. include:: /../../examples/hlapi/v3arch/trollius/agent/ntforg/default-v1-trap.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/trollius/agent/ntforg/default-v1-trap.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/trollius/agent/ntforg/default-v1-trap.py>` script. + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/trollius/contents.rst b/docs/source/examples/hlapi/v3arch/trollius/contents.rst index 1424c7d0..159d4cda 100644 --- a/docs/source/examples/hlapi/trollius/contents.rst +++ b/docs/source/examples/hlapi/v3arch/trollius/contents.rst @@ -1,6 +1,6 @@ -Asynchronous: trollius -====================== +Asynchronous SNMP (trollius, v3arch) +==================================== In order to use :mod:`asyncio` features with older Python (2.6+), you could download and install `Trollius <http://trollius.readthedocs.org/>`_ @@ -12,11 +12,11 @@ are familiar with Net-SNMP tools, better understanding what example code doe Here's a quick example on a simple SNMP GET by high-level API: -.. include:: /../../examples/hlapi/trollius/manager/cmdgen/v1-get.py +.. include:: /../../examples/hlapi/v3arch/trollius/manager/cmdgen/v1-get.py :start-after: options: :end-before: Functionally -.. literalinclude:: /../../examples/hlapi/trollius/manager/cmdgen/v1-get.py +.. literalinclude:: /../../examples/hlapi/v3arch/trollius/manager/cmdgen/v1-get.py :start-after: """# :language: python @@ -24,11 +24,11 @@ To make use of SNMPv3 and USM, the following code performs a series of SNMP GETNEXT operations effectively fetching a table of SNMP variables from SNMP Agent: -.. include:: /../../examples/hlapi/trollius/manager/cmdgen/getbulk-to-eom.py +.. include:: /../../examples/hlapi/v3arch/trollius/manager/cmdgen/getbulk-to-eom.py :start-after: options: :end-before: Functionally -.. literalinclude:: /../../examples/hlapi/trollius/manager/cmdgen/getbulk-to-eom.py +.. literalinclude:: /../../examples/hlapi/v3arch/trollius/manager/cmdgen/getbulk-to-eom.py :start-after: """# :language: python @@ -36,17 +36,17 @@ More examples on Command Generator API usage follow. .. toctree:: - /examples/hlapi/trollius/manager/cmdgen/snmp-versions - /examples/hlapi/trollius/manager/cmdgen/walking-operations + /examples/hlapi/v3arch/trollius/manager/cmdgen/snmp-versions + /examples/hlapi/v3arch/trollius/manager/cmdgen/walking-operations Sending SNMP TRAP's and INFORM's is as easy with PySNMP library. The following code sends SNMP TRAP: -.. include:: /../../examples/hlapi/trollius/agent/ntforg/default-v1-trap.py +.. include:: /../../examples/hlapi/v3arch/trollius/agent/ntforg/default-v1-trap.py :start-after: options: :end-before: Functionally -.. literalinclude:: /../../examples/hlapi/trollius/agent/ntforg/default-v1-trap.py +.. literalinclude:: /../../examples/hlapi/v3arch/trollius/agent/ntforg/default-v1-trap.py :start-after: """# :language: python @@ -54,7 +54,7 @@ More examples on Notification Originator API usage follow. .. toctree:: - /examples/hlapi/trollius/agent/ntforg/common-notifications + /examples/hlapi/v3arch/trollius/agent/ntforg/common-notifications More sophisticated or less popular SNMP operations can still be performed with PySNMP through its Native API to Standard SNMP Applications. diff --git a/docs/source/examples/hlapi/v3arch/trollius/manager/cmdgen/snmp-versions.rst b/docs/source/examples/hlapi/v3arch/trollius/manager/cmdgen/snmp-versions.rst new file mode 100644 index 00000000..3b70a61c --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/trollius/manager/cmdgen/snmp-versions.rst @@ -0,0 +1,29 @@ +.. toctree:: + :maxdepth: 2 + +Various SNMP versions +---------------------- + +.. include:: /../../examples/hlapi/v3arch/trollius/manager/cmdgen/v1-get.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/trollius/manager/cmdgen/v1-get.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/trollius/manager/cmdgen/v1-get.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/trollius/manager/cmdgen/getbulk-to-eom.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/trollius/manager/cmdgen/getbulk-to-eom.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/trollius/manager/cmdgen/getbulk-to-eom.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/trollius/manager/cmdgen/walking-operations.rst b/docs/source/examples/hlapi/v3arch/trollius/manager/cmdgen/walking-operations.rst new file mode 100644 index 00000000..ec416080 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/trollius/manager/cmdgen/walking-operations.rst @@ -0,0 +1,17 @@ +.. toctree:: + :maxdepth: 2 + +Walking operations +------------------ + +.. include:: /../../examples/hlapi/v3arch/trollius/manager/cmdgen/getbulk-to-eom.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/trollius/manager/cmdgen/getbulk-to-eom.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/trollius/manager/cmdgen/getbulk-to-eom.py>` script. + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/twisted/agent/ntforg/advanced-topics.rst b/docs/source/examples/hlapi/v3arch/twisted/agent/ntforg/advanced-topics.rst new file mode 100644 index 00000000..fd209711 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/twisted/agent/ntforg/advanced-topics.rst @@ -0,0 +1,17 @@ +.. toctree:: + :maxdepth: 2 + +Advanced Notification Originator +-------------------------------- + +.. include:: /../../examples/hlapi/v3arch/twisted/agent/ntforg/multiple-notifications-at-once.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/twisted/agent/ntforg/multiple-notifications-at-once.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/twisted/agent/ntforg/multiple-notifications-at-once.py>` script. + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/twisted/agent/ntforg/common-notifications.rst b/docs/source/examples/hlapi/v3arch/twisted/agent/ntforg/common-notifications.rst new file mode 100644 index 00000000..d02ca5e6 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/twisted/agent/ntforg/common-notifications.rst @@ -0,0 +1,27 @@ +.. toctree:: + :maxdepth: 2 + +Common notifications +-------------------- + +.. include:: /../../examples/hlapi/v3arch/twisted/agent/ntforg/default-v1-trap.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/twisted/agent/ntforg/default-v1-trap.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/twisted/agent/ntforg/default-v1-trap.py>` script. + +.. include:: /../../examples/hlapi/v3arch/twisted/agent/ntforg/v2c-trap-inline-callbacks.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/twisted/agent/ntforg/v2c-trap-inline-callbacks.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/twisted/agent/ntforg/v2c-trap-inline-callbacks.py>` script. + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/twisted/contents.rst b/docs/source/examples/hlapi/v3arch/twisted/contents.rst index 1b06d576..e4d221de 100644 --- a/docs/source/examples/hlapi/twisted/contents.rst +++ b/docs/source/examples/hlapi/v3arch/twisted/contents.rst @@ -1,8 +1,8 @@ -Asynchronous: Twisted -===================== +Asynchronous SNMP (twisted, v3arch) +=================================== -`Twisted <http://twistedmatrix.com>`_ is quite old and widly used +`Twisted <http://twistedmatrix.com>`_ is quite old but still widely used I/O framework. With Twisted, your code will mostly live in isolated functions, but unlike as it is with callback-based design, with Twisted work-in-progress is represented by a @@ -20,11 +20,11 @@ are familiar with Net-SNMP tools, better understanding what example code doe Here's a quick example on a simple SNMP GET by high-level API: -.. include:: /../../examples/hlapi/twisted/manager/cmdgen/v1-get.py +.. include:: /../../examples/hlapi/v3arch/twisted/manager/cmdgen/v1-get.py :start-after: options: :end-before: Functionally -.. literalinclude:: /../../examples/hlapi/twisted/manager/cmdgen/v1-get.py +.. literalinclude:: /../../examples/hlapi/v3arch/twisted/manager/cmdgen/v1-get.py :start-after: """# :language: python @@ -32,11 +32,11 @@ To make use of SNMPv3 and USM, the following code performs a series of SNMP GETNEXT operations effectively fetching a table of SNMP variables from SNMP Agent: -.. include:: /../../examples/hlapi/twisted/manager/cmdgen/getbulk-to-eom.py +.. include:: /../../examples/hlapi/v3arch/twisted/manager/cmdgen/getbulk-to-eom.py :start-after: options: :end-before: Functionally -.. literalinclude:: /../../examples/hlapi/twisted/manager/cmdgen/getbulk-to-eom.py +.. literalinclude:: /../../examples/hlapi/v3arch/twisted/manager/cmdgen/getbulk-to-eom.py :start-after: """# :language: python @@ -44,19 +44,19 @@ More examples on Command Generator API usage follow. .. toctree:: - /examples/hlapi/twisted/manager/cmdgen/snmp-versions - /examples/hlapi/twisted/manager/cmdgen/walking-operations - /examples/hlapi/twisted/manager/cmdgen/transport-tweaks - /examples/hlapi/twisted/manager/cmdgen/advanced-topics + /examples/hlapi/v3arch/twisted/manager/cmdgen/snmp-versions + /examples/hlapi/v3arch/twisted/manager/cmdgen/walking-operations + /examples/hlapi/v3arch/twisted/manager/cmdgen/transport-tweaks + /examples/hlapi/v3arch/twisted/manager/cmdgen/advanced-topics Sending SNMP TRAP's and INFORM's is as easy with PySNMP library. The following code sends SNMP TRAP: -.. include:: /../../examples/hlapi/twisted/agent/ntforg/default-v1-trap.py +.. include:: /../../examples/hlapi/v3arch/twisted/agent/ntforg/default-v1-trap.py :start-after: options: :end-before: Functionally -.. literalinclude:: /../../examples/hlapi/twisted/agent/ntforg/default-v1-trap.py +.. literalinclude:: /../../examples/hlapi/v3arch/twisted/agent/ntforg/default-v1-trap.py :start-after: """# :language: python @@ -64,8 +64,8 @@ More examples on Notification Originator API usage follow. .. toctree:: - /examples/hlapi/twisted/agent/ntforg/common-notifications - /examples/hlapi/twisted/agent/ntforg/advanced-topics + /examples/hlapi/v3arch/twisted/agent/ntforg/common-notifications + /examples/hlapi/v3arch/twisted/agent/ntforg/advanced-topics More sophisticated or less popular SNMP operations can still be performed with PySNMP through its Native API to Standard SNMP Applications. diff --git a/docs/source/examples/hlapi/v3arch/twisted/manager/cmdgen/advanced-topics.rst b/docs/source/examples/hlapi/v3arch/twisted/manager/cmdgen/advanced-topics.rst new file mode 100644 index 00000000..e094ac67 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/twisted/manager/cmdgen/advanced-topics.rst @@ -0,0 +1,29 @@ +.. toctree:: + :maxdepth: 2 + +Advanced Command Generator +-------------------------- + +.. include:: /../../examples/hlapi/v3arch/twisted/manager/cmdgen/multiple-concurrent-queries.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/twisted/manager/cmdgen/multiple-concurrent-queries.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/twisted/manager/cmdgen/multiple-concurrent-queries.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/twisted/manager/cmdgen/pull-mibs-from-multiple-agents-at-once.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/twisted/manager/cmdgen/pull-mibs-from-multiple-agents-at-once.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/twisted/manager/cmdgen/pull-mibs-from-multiple-agents-at-once.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/twisted/manager/cmdgen/snmp-versions.rst b/docs/source/examples/hlapi/v3arch/twisted/manager/cmdgen/snmp-versions.rst new file mode 100644 index 00000000..7b1746e0 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/twisted/manager/cmdgen/snmp-versions.rst @@ -0,0 +1,29 @@ +.. toctree:: + :maxdepth: 2 + +Various SNMP versions +---------------------- + +.. include:: /../../examples/hlapi/v3arch/twisted/manager/cmdgen/v1-get.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/twisted/manager/cmdgen/v1-get.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/twisted/manager/cmdgen/v1-get.py>` script. + + +.. include:: /../../examples/hlapi/v3arch/twisted/manager/cmdgen/getbulk-to-eom.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/twisted/manager/cmdgen/getbulk-to-eom.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/twisted/manager/cmdgen/getbulk-to-eom.py>` script. + + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/twisted/manager/cmdgen/transport-tweaks.rst b/docs/source/examples/hlapi/v3arch/twisted/manager/cmdgen/transport-tweaks.rst new file mode 100644 index 00000000..dbadb831 --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/twisted/manager/cmdgen/transport-tweaks.rst @@ -0,0 +1,17 @@ +.. toctree:: + :maxdepth: 2 + +Transport tweaks +---------------- + +.. include:: /../../examples/hlapi/v3arch/twisted/manager/cmdgen/custom-timeout-and-retries.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/twisted/manager/cmdgen/custom-timeout-and-retries.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/twisted/manager/cmdgen/custom-timeout-and-retries.py>` script. + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/hlapi/v3arch/twisted/manager/cmdgen/walking-operations.rst b/docs/source/examples/hlapi/v3arch/twisted/manager/cmdgen/walking-operations.rst new file mode 100644 index 00000000..7c87bc5a --- /dev/null +++ b/docs/source/examples/hlapi/v3arch/twisted/manager/cmdgen/walking-operations.rst @@ -0,0 +1,27 @@ +.. toctree:: + :maxdepth: 2 + +Walking operations +------------------ + +.. include:: /../../examples/hlapi/v3arch/twisted/manager/cmdgen/getbulk-to-eom.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/twisted/manager/cmdgen/getbulk-to-eom.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/twisted/manager/cmdgen/getbulk-to-eom.py>` script. + +.. include:: /../../examples/hlapi/v3arch/twisted/manager/cmdgen/pull-whole-mib.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/v3arch/twisted/manager/cmdgen/pull-whole-mib.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/v3arch/twisted/manager/cmdgen/pull-whole-mib.py>` script. + +See also: :doc:`library reference </docs/api-reference>`. diff --git a/docs/source/examples/v3arch/asyncio/contents.rst b/docs/source/examples/v3arch/asyncio/contents.rst index 21b00a88..c64fec52 100644 --- a/docs/source/examples/v3arch/asyncio/contents.rst +++ b/docs/source/examples/v3arch/asyncio/contents.rst @@ -1,6 +1,6 @@ -Asynchronous: asyncio -===================== +Asynchronous SNMP (asyncio, v3arch) +=================================== Python 3.4 introduced a new module - `asyncio <https://docs.python.org/3/library/asyncio.html>`_ (former Tulip, PEP 3156) featuring infrastructure for writing single-threaded concurrent @@ -26,7 +26,7 @@ remains available to asyncio-backed applications. We do not provide Command Generator and Notification Originator examples, as it is much easier to use -:doc:`high-level interfaces </examples/hlapi/asyncio/contents>` instead. +:doc:`high-level interfaces </examples/hlapi/v3arch/asyncio/contents>` instead. Command Responder Applications ------------------------------ diff --git a/docs/source/examples/v3arch/asyncore/contents.rst b/docs/source/examples/v3arch/asyncore/contents.rst index 17ebfc70..e677029b 100644 --- a/docs/source/examples/v3arch/asyncore/contents.rst +++ b/docs/source/examples/v3arch/asyncore/contents.rst @@ -1,6 +1,6 @@ -Asynchronous: asyncore -====================== +Asynchronous SNMP (asyncore, v3arch) +==================================== If you find yourself unable to use particular SNMP feature with the high-level (hlapi) API, your next step would be to use SNMPv3 diff --git a/docs/source/examples/v3arch/trollius/contents.rst b/docs/source/examples/v3arch/trollius/contents.rst index 89be5185..68ad70a3 100644 --- a/docs/source/examples/v3arch/trollius/contents.rst +++ b/docs/source/examples/v3arch/trollius/contents.rst @@ -1,6 +1,6 @@ -Asynchronous: trollius -====================== +Asynchronous SNMP (trollius, v3arch) +==================================== `Trollius <http://trollius.readthedocs.org/>`_ framework offers infrastructure that allows you writing single-threaded, concurrent code @@ -16,7 +16,7 @@ remains available to asyncio-backed applications. We do not provide Command Generator and Notification Originator examples, as it is much easier to use -:doc:`high-level interfaces </examples/hlapi/trollius/contents>` instead. +:doc:`high-level interfaces </examples/hlapi/v3arch/trollius/contents>` instead. As for Command Responder and Notification Receiver, those could be use in the same way as with :doc:`asyncio </examples/v3arch/asyncio/contents>`. diff --git a/docs/source/examples/v3arch/twisted/contents.rst b/docs/source/examples/v3arch/twisted/contents.rst index 6127b373..60626c29 100644 --- a/docs/source/examples/v3arch/twisted/contents.rst +++ b/docs/source/examples/v3arch/twisted/contents.rst @@ -1,6 +1,6 @@ -Asynchronous: Twisted -===================== +Asynchronous SNMP (twisted, v3arch) +=================================== `Twisted <http://twistedmatrix.com/>`_ is event-driven networking engine written in Python. It takes shape of a Python library which is used by many @@ -11,7 +11,7 @@ remains available to Twisted applications. We do not provide Command Generator and Notification Originator examples, as it is much easier to use -:doc:`high-level interfaces </examples/hlapi/twisted/contents>` instead. +:doc:`high-level interfaces </examples/hlapi/v3arch/twisted/contents>` instead. Command Responder Applications ------------------------------ diff --git a/docs/source/faq/pass-custom-mib-to-manager.rst b/docs/source/faq/pass-custom-mib-to-manager.rst index b42e6839..ded4de29 100644 --- a/docs/source/faq/pass-custom-mib-to-manager.rst +++ b/docs/source/faq/pass-custom-mib-to-manager.rst @@ -17,7 +17,7 @@ A. Starting from PySNMP 4.3.x, plain-text (ASN.1) MIBs can be `http://mibs.snmplabs.com/asn1/ <http://mibs.snmplabs.com/asn1/>`_ as shown below. -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/custom-asn1-mib-search-path.py +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/custom-asn1-mib-search-path.py :start-after: """# :language: python @@ -36,7 +36,7 @@ A. Starting from PySNMP 4.3.x, plain-text (ASN.1) MIBs can be 'http://mibs.snmplabs.com/asn1/@mib@', ]) -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/custom-asn1-mib-search-path.py>` script. +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/custom-asn1-mib-search-path.py>` script. Alternatively, you can invoke the `mibdump.py <http://snmplabs.com/pysmi/mibdump.html>`_ diff --git a/docs/source/quick-start.rst b/docs/source/quick-start.rst index 73040e4c..9fbda6ab 100644 --- a/docs/source/quick-start.rst +++ b/docs/source/quick-start.rst @@ -18,11 +18,11 @@ code will performs SNMP GET operation for a sysDescr.0 object at a publically available SNMP Command Responder at `demo.snmplabs.com <http://snmplabs.com/snmpsim/public-snmp-simulator.html>`_: -.. literalinclude:: /../../examples/hlapi/asyncore/sync/manager/cmdgen/v1-get.py +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/v1-get.py :start-after: """# :language: python -:download:`Download</../../examples/hlapi/asyncore/sync/manager/cmdgen/v1-get.py>` script. +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/manager/cmdgen/v1-get.py>` script. If everything works as it should you will get: @@ -41,11 +41,11 @@ To send a trivial TRAP message to our hosted Notification Receiver at `demo.snmplabs.com <http://snmplabs.com/snmpsim/public-snmp-simulator.html>`_ , just cut&paste the following code into your interactive Python session: -.. literalinclude:: /../../examples/hlapi/asyncore/sync/agent/ntforg/default-v1-trap.py +.. literalinclude:: /../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/default-v1-trap.py :start-after: """# :language: python -:download:`Download</../../examples/hlapi/asyncore/sync/agent/ntforg/default-v1-trap.py>` script. +:download:`Download</../../examples/hlapi/v3arch/asyncore/sync/agent/ntforg/default-v1-trap.py>` script. Many ASN.1 MIB files could be downloaded from `mibs.snmplabs.com <http://mibs.snmplabs.com/asn1/>`_ or PySNMP could |