From f99f429bf1ed6c6e73966cb94990a55c9649baad Mon Sep 17 00:00:00 2001 From: elie Date: Mon, 14 Sep 2015 21:26:29 +0000 Subject: missing examples harness added --- .../cmdrsp/agent-side-mib-implementations.rst | 16 +++++ .../asyncore/agent/ntforg/transport-tweaks.rst | 27 +++++++ docs/source/examples/v1arch/asyncore/contents.rst | 51 +++++++++++++ .../asyncore/manager/cmdgen/advanced-topics.rst | 27 +++++++ .../asyncore/manager/cmdgen/fetching-variables.rst | 16 +++++ .../manager/cmdgen/modifying-variables.rst | 16 +++++ .../asyncore/manager/cmdgen/walking-operations.rst | 27 +++++++ .../asyncore/manager/ntfrcv/transport-tweaks.rst | 16 +++++ .../v3arch/asyncio/agent/cmdrsp/snmp-versions.rst | 16 +++++ .../asyncio/agent/ntforg/common-notifications.rst | 26 +++++++ docs/source/examples/v3arch/asyncio/contents.rst | 63 ++++++++++++++++ .../asyncio/manager/cmdgen/modifying-variables.rst | 16 +++++ .../asyncio/manager/cmdgen/snmp-versions.rst | 16 +++++ .../asyncio/manager/cmdgen/transport-tweaks.rst | 16 +++++ .../asyncio/manager/cmdgen/walking-operations.rst | 27 +++++++ .../asyncio/manager/ntfrcv/transport-tweaks.rst | 16 +++++ .../asyncore/agent/cmdrsp/advanced-topics.rst | 38 ++++++++++ .../cmdrsp/agent-side-mib-implementations.rst | 49 +++++++++++++ .../v3arch/asyncore/agent/cmdrsp/snmp-versions.rst | 27 +++++++ .../asyncore/agent/cmdrsp/transport-tweaks.rst | 38 ++++++++++ .../asyncore/agent/ntforg/advanced-topics.rst | 16 +++++ .../asyncore/agent/ntforg/common-notifications.rst | 46 ++++++++++++ .../agent/ntforg/evaluating-notification-type.rst | 26 +++++++ .../agent/ntforg/multiple-managers-operations.rst | 42 +++++++++++ .../agent/ntforg/snmp-v1-trap-variants.rst | 28 ++++++++ .../v3arch/asyncore/agent/ntforg/snmp-versions.rst | 39 ++++++++++ .../asyncore/agent/ntforg/transport-tweaks.rst | 16 +++++ docs/source/examples/v3arch/asyncore/contents.rst | 81 +++++++++++++++++++++ .../asyncore/manager/cmdgen/advanced-topics.rst | 28 ++++++++ .../manager/cmdgen/asynchronous-operations.rst | 42 +++++++++++ .../v3arch/asyncore/manager/cmdgen/mib-tweaks.rst | 47 ++++++++++++ .../manager/cmdgen/modifying-variables.rst | 40 +++++++++++ .../asyncore/manager/cmdgen/snmp-versions.rst | 72 +++++++++++++++++++ .../asyncore/manager/cmdgen/table-operations.rst | 59 +++++++++++++++ .../asyncore/manager/cmdgen/transport-tweaks.rst | 40 +++++++++++ .../asyncore/manager/cmdgen/walking-operations.rst | 61 ++++++++++++++++ .../asyncore/manager/ntfrcv/advanced-topics.rst | 28 ++++++++ .../asyncore/manager/ntfrcv/snmp-versions.rst | 17 +++++ .../asyncore/manager/ntfrcv/transport-tweaks.rst | 39 ++++++++++ .../oneliner/agent/ntforg/advanced-topics.rst | 27 +++++++ .../agent/ntforg/asynchronous-operations.rst | 27 +++++++ .../oneliner/agent/ntforg/common-notifications.rst | 27 +++++++ .../agent/ntforg/evaluating-notification-type.rst | 17 +++++ .../agent/ntforg/snmp-v1-trap-variants.rst | 28 ++++++++ .../oneliner/agent/ntforg/snmp-versions.rst | 39 ++++++++++ .../examples/v3arch/asyncore/oneliner/contents.rst | 84 ++++++++++++++++++++++ .../oneliner/manager/cmdgen/advanced-topics.rst | 75 +++++++++++++++++++ .../manager/cmdgen/asynchronous-operations.rst | 42 +++++++++++ .../oneliner/manager/cmdgen/mib-tweaks.rst | 47 ++++++++++++ .../manager/cmdgen/modifying-variables.rst | 40 +++++++++++ .../oneliner/manager/cmdgen/snmp-versions.rst | 72 +++++++++++++++++++ .../oneliner/manager/cmdgen/table-operations.rst | 59 +++++++++++++++ .../oneliner/manager/cmdgen/transport-tweaks.rst | 29 ++++++++ .../oneliner/manager/cmdgen/walking-operations.rst | 61 ++++++++++++++++ .../asyncore/proxy/command/protocol-conversion.rst | 38 ++++++++++ .../proxy/command/transport-conversion.rst | 16 +++++ .../trollius/agent/ntforg/common-notifications.rst | 26 +++++++ docs/source/examples/v3arch/trollius/contents.rst | 37 ++++++++++ .../trollius/manager/cmdgen/fetching-values.rst | 16 +++++ .../manager/cmdgen/modifying-variables.rst | 16 +++++ .../trollius/manager/cmdgen/transport-tweaks.rst | 16 +++++ .../trollius/manager/cmdgen/walking-operations.rst | 26 +++++++ .../cmdrsp/agent-side-mib-implementations.rst | 16 +++++ .../v3arch/twisted/agent/cmdrsp/snmp-versions.rst | 27 +++++++ .../twisted/agent/cmdrsp/transport-tweaks.rst | 16 +++++ .../twisted/agent/ntforg/common-notifications.rst | 48 +++++++++++++ .../agent/ntforg/multiple-managers-operations.rst | 16 +++++ docs/source/examples/v3arch/twisted/contents.rst | 56 +++++++++++++++ .../twisted/manager/cmdgen/advanced-topics.rst | 16 +++++ .../twisted/manager/cmdgen/snmp-versions.rst | 27 +++++++ .../twisted/manager/cmdgen/table-operations.rst | 16 +++++ .../twisted/manager/cmdgen/transport-tweaks.rst | 27 +++++++ .../twisted/manager/cmdgen/walking-operations.rst | 38 ++++++++++ .../twisted/manager/ntfrcv/snmp-versions.rst | 16 +++++ .../twisted/manager/ntfrcv/transport-tweaks.rst | 16 +++++ 75 files changed, 2511 insertions(+) create mode 100644 docs/source/examples/v1arch/asyncore/agent/cmdrsp/agent-side-mib-implementations.rst create mode 100644 docs/source/examples/v1arch/asyncore/agent/ntforg/transport-tweaks.rst create mode 100644 docs/source/examples/v1arch/asyncore/contents.rst create mode 100644 docs/source/examples/v1arch/asyncore/manager/cmdgen/advanced-topics.rst create mode 100644 docs/source/examples/v1arch/asyncore/manager/cmdgen/fetching-variables.rst create mode 100644 docs/source/examples/v1arch/asyncore/manager/cmdgen/modifying-variables.rst create mode 100644 docs/source/examples/v1arch/asyncore/manager/cmdgen/walking-operations.rst create mode 100644 docs/source/examples/v1arch/asyncore/manager/ntfrcv/transport-tweaks.rst create mode 100644 docs/source/examples/v3arch/asyncio/agent/cmdrsp/snmp-versions.rst create mode 100644 docs/source/examples/v3arch/asyncio/agent/ntforg/common-notifications.rst create mode 100644 docs/source/examples/v3arch/asyncio/contents.rst create mode 100644 docs/source/examples/v3arch/asyncio/manager/cmdgen/modifying-variables.rst create mode 100644 docs/source/examples/v3arch/asyncio/manager/cmdgen/snmp-versions.rst create mode 100644 docs/source/examples/v3arch/asyncio/manager/cmdgen/transport-tweaks.rst create mode 100644 docs/source/examples/v3arch/asyncio/manager/cmdgen/walking-operations.rst create mode 100644 docs/source/examples/v3arch/asyncio/manager/ntfrcv/transport-tweaks.rst create mode 100644 docs/source/examples/v3arch/asyncore/agent/cmdrsp/advanced-topics.rst create mode 100644 docs/source/examples/v3arch/asyncore/agent/cmdrsp/agent-side-mib-implementations.rst create mode 100644 docs/source/examples/v3arch/asyncore/agent/cmdrsp/snmp-versions.rst create mode 100644 docs/source/examples/v3arch/asyncore/agent/cmdrsp/transport-tweaks.rst create mode 100644 docs/source/examples/v3arch/asyncore/agent/ntforg/advanced-topics.rst create mode 100644 docs/source/examples/v3arch/asyncore/agent/ntforg/common-notifications.rst create mode 100644 docs/source/examples/v3arch/asyncore/agent/ntforg/evaluating-notification-type.rst create mode 100644 docs/source/examples/v3arch/asyncore/agent/ntforg/multiple-managers-operations.rst create mode 100644 docs/source/examples/v3arch/asyncore/agent/ntforg/snmp-v1-trap-variants.rst create mode 100644 docs/source/examples/v3arch/asyncore/agent/ntforg/snmp-versions.rst create mode 100644 docs/source/examples/v3arch/asyncore/agent/ntforg/transport-tweaks.rst create mode 100644 docs/source/examples/v3arch/asyncore/contents.rst create mode 100644 docs/source/examples/v3arch/asyncore/manager/cmdgen/advanced-topics.rst create mode 100644 docs/source/examples/v3arch/asyncore/manager/cmdgen/asynchronous-operations.rst create mode 100644 docs/source/examples/v3arch/asyncore/manager/cmdgen/mib-tweaks.rst create mode 100644 docs/source/examples/v3arch/asyncore/manager/cmdgen/modifying-variables.rst create mode 100644 docs/source/examples/v3arch/asyncore/manager/cmdgen/snmp-versions.rst create mode 100644 docs/source/examples/v3arch/asyncore/manager/cmdgen/table-operations.rst create mode 100644 docs/source/examples/v3arch/asyncore/manager/cmdgen/transport-tweaks.rst create mode 100644 docs/source/examples/v3arch/asyncore/manager/cmdgen/walking-operations.rst create mode 100644 docs/source/examples/v3arch/asyncore/manager/ntfrcv/advanced-topics.rst create mode 100644 docs/source/examples/v3arch/asyncore/manager/ntfrcv/snmp-versions.rst create mode 100644 docs/source/examples/v3arch/asyncore/manager/ntfrcv/transport-tweaks.rst create mode 100644 docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/advanced-topics.rst create mode 100644 docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/asynchronous-operations.rst create mode 100644 docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/common-notifications.rst create mode 100644 docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/evaluating-notification-type.rst create mode 100644 docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/snmp-v1-trap-variants.rst create mode 100644 docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/snmp-versions.rst create mode 100644 docs/source/examples/v3arch/asyncore/oneliner/contents.rst create mode 100644 docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/advanced-topics.rst create mode 100644 docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/asynchronous-operations.rst create mode 100644 docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/mib-tweaks.rst create mode 100644 docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/modifying-variables.rst create mode 100644 docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/snmp-versions.rst create mode 100644 docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/table-operations.rst create mode 100644 docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/transport-tweaks.rst create mode 100644 docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/walking-operations.rst create mode 100644 docs/source/examples/v3arch/asyncore/proxy/command/protocol-conversion.rst create mode 100644 docs/source/examples/v3arch/asyncore/proxy/command/transport-conversion.rst create mode 100644 docs/source/examples/v3arch/trollius/agent/ntforg/common-notifications.rst create mode 100644 docs/source/examples/v3arch/trollius/contents.rst create mode 100644 docs/source/examples/v3arch/trollius/manager/cmdgen/fetching-values.rst create mode 100644 docs/source/examples/v3arch/trollius/manager/cmdgen/modifying-variables.rst create mode 100644 docs/source/examples/v3arch/trollius/manager/cmdgen/transport-tweaks.rst create mode 100644 docs/source/examples/v3arch/trollius/manager/cmdgen/walking-operations.rst create mode 100644 docs/source/examples/v3arch/twisted/agent/cmdrsp/agent-side-mib-implementations.rst create mode 100644 docs/source/examples/v3arch/twisted/agent/cmdrsp/snmp-versions.rst create mode 100644 docs/source/examples/v3arch/twisted/agent/cmdrsp/transport-tweaks.rst create mode 100644 docs/source/examples/v3arch/twisted/agent/ntforg/common-notifications.rst create mode 100644 docs/source/examples/v3arch/twisted/agent/ntforg/multiple-managers-operations.rst create mode 100644 docs/source/examples/v3arch/twisted/contents.rst create mode 100644 docs/source/examples/v3arch/twisted/manager/cmdgen/advanced-topics.rst create mode 100644 docs/source/examples/v3arch/twisted/manager/cmdgen/snmp-versions.rst create mode 100644 docs/source/examples/v3arch/twisted/manager/cmdgen/table-operations.rst create mode 100644 docs/source/examples/v3arch/twisted/manager/cmdgen/transport-tweaks.rst create mode 100644 docs/source/examples/v3arch/twisted/manager/cmdgen/walking-operations.rst create mode 100644 docs/source/examples/v3arch/twisted/manager/ntfrcv/snmp-versions.rst create mode 100644 docs/source/examples/v3arch/twisted/manager/ntfrcv/transport-tweaks.rst diff --git a/docs/source/examples/v1arch/asyncore/agent/cmdrsp/agent-side-mib-implementations.rst b/docs/source/examples/v1arch/asyncore/agent/cmdrsp/agent-side-mib-implementations.rst new file mode 100644 index 0000000..1cee1f4 --- /dev/null +++ b/docs/source/examples/v1arch/asyncore/agent/cmdrsp/agent-side-mib-implementations.rst @@ -0,0 +1,16 @@ +.. toctree:: + :maxdepth: 2 + +Agent-side MIB implementations +------------------------------ + +.. include:: /../../examples/v1arch/asyncore/agent/cmdrsp/v2c-custom-scalar-mib-objects.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v1arch/asyncore/agent/cmdrsp/v2c-custom-scalar-mib-objects.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v1arch/asyncore/agent/ntforg/transport-tweaks.rst b/docs/source/examples/v1arch/asyncore/agent/ntforg/transport-tweaks.rst new file mode 100644 index 0000000..3d31d4c --- /dev/null +++ b/docs/source/examples/v1arch/asyncore/agent/ntforg/transport-tweaks.rst @@ -0,0 +1,27 @@ +.. toctree:: + :maxdepth: 2 + +Transport tweaks +---------------- + +.. include:: /../../examples/v1arch/asyncore/agent/ntforg/trap-v1-multiple-transports.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v1arch/asyncore/agent/ntforg/trap-v1-multiple-transports.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v1arch/asyncore/agent/ntforg/inform-v2c.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v1arch/asyncore/agent/ntforg/inform-v2c.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v1arch/asyncore/contents.rst b/docs/source/examples/v1arch/asyncore/contents.rst new file mode 100644 index 0000000..a4b1281 --- /dev/null +++ b/docs/source/examples/v1arch/asyncore/contents.rst @@ -0,0 +1,51 @@ + +Packet-level SNMP +================= + +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 +more code, then there is a low-level API to SNMP v1/v2c PDU and +PySNMP I/O engine. There's practically no SNMP engine or SMI +infrastructure involved in the operations of these almost wire-level +interfaces. Although MIB services can still be used separately. + +A packet-level API-based application typically manages both SNMP +message building/parsing and network communication via one or more +transports. It's fully up to the application to handle failures on +message and transport levels. + +Command Generator Applications +------------------------------ + +.. toctree:: + + /examples/v1arch/asyncore/manager/cmdgen/fetching-variables + /examples/v1arch/asyncore/manager/cmdgen/modifying-variables + /examples/v1arch/asyncore/manager/cmdgen/walking-operations + /examples/v1arch/asyncore/manager/cmdgen/advanced-topics + +Command Responder Applications +------------------------------ + +.. toctree:: + + /examples/v1arch/asyncore/agent/cmdrsp/agent-side-mib-implementations + +Notification Originator Applications +------------------------------------ + +.. toctree:: + + /examples/v1arch/asyncore/agent/ntforg/transport-tweaks + +Notification Receiver Applications +---------------------------------- + +.. toctree:: + + /examples/v1arch/asyncore/manager/ntfrcv/transport-tweaks + +For more details on PySNMP programming model and interfaces, please +refer to the documentation + + diff --git a/docs/source/examples/v1arch/asyncore/manager/cmdgen/advanced-topics.rst b/docs/source/examples/v1arch/asyncore/manager/cmdgen/advanced-topics.rst new file mode 100644 index 0000000..3b1541a --- /dev/null +++ b/docs/source/examples/v1arch/asyncore/manager/cmdgen/advanced-topics.rst @@ -0,0 +1,27 @@ +.. toctree:: + :maxdepth: 2 + +Advanced topics +--------------- + +.. include:: /../../examples/v1arch/asyncore/manager/cmdgen/get-v2c-spoof-source-address.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v1arch/asyncore/manager/cmdgen/get-v2c-spoof-source-address.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v1arch/asyncore/manager/cmdgen/get-v2c-udp-broadcast-agent-discovery.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v1arch/asyncore/manager/cmdgen/get-v2c-udp-broadcast-agent-discovery.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v1arch/asyncore/manager/cmdgen/fetching-variables.rst b/docs/source/examples/v1arch/asyncore/manager/cmdgen/fetching-variables.rst new file mode 100644 index 0000000..590a3a1 --- /dev/null +++ b/docs/source/examples/v1arch/asyncore/manager/cmdgen/fetching-variables.rst @@ -0,0 +1,16 @@ +.. toctree:: + :maxdepth: 2 + +Fetching variables +------------------ + +.. include:: /../../examples/v1arch/asyncore/manager/cmdgen/get-v1.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v1arch/asyncore/manager/cmdgen/get-v1.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v1arch/asyncore/manager/cmdgen/modifying-variables.rst b/docs/source/examples/v1arch/asyncore/manager/cmdgen/modifying-variables.rst new file mode 100644 index 0000000..4c77528 --- /dev/null +++ b/docs/source/examples/v1arch/asyncore/manager/cmdgen/modifying-variables.rst @@ -0,0 +1,16 @@ +.. toctree:: + :maxdepth: 2 + +Modifying variables +------------------- + +.. include:: /../../examples/v1arch/asyncore/manager/cmdgen/set-v2c.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v1arch/asyncore/manager/cmdgen/set-v2c.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v1arch/asyncore/manager/cmdgen/walking-operations.rst b/docs/source/examples/v1arch/asyncore/manager/cmdgen/walking-operations.rst new file mode 100644 index 0000000..d3bbf7b --- /dev/null +++ b/docs/source/examples/v1arch/asyncore/manager/cmdgen/walking-operations.rst @@ -0,0 +1,27 @@ +.. toctree:: + :maxdepth: 2 + +MIB walking operations +---------------------- + +.. include:: /../../examples/v1arch/asyncore/manager/cmdgen/getnext-v1.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v1arch/asyncore/manager/cmdgen/getnext-v1.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v1arch/asyncore/manager/cmdgen/getbulk-v2c.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v1arch/asyncore/manager/cmdgen/getbulk-v2c.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v1arch/asyncore/manager/ntfrcv/transport-tweaks.rst b/docs/source/examples/v1arch/asyncore/manager/ntfrcv/transport-tweaks.rst new file mode 100644 index 0000000..41ee459 --- /dev/null +++ b/docs/source/examples/v1arch/asyncore/manager/ntfrcv/transport-tweaks.rst @@ -0,0 +1,16 @@ +.. toctree:: + :maxdepth: 2 + +Transport tweaks +---------------- + +.. include:: /../../examples/v1arch/asyncore/manager/ntfrcv/v1-multiple-transports.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v1arch/asyncore/manager/ntfrcv/v1-multiple-transports.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/asyncio/agent/cmdrsp/snmp-versions.rst b/docs/source/examples/v3arch/asyncio/agent/cmdrsp/snmp-versions.rst new file mode 100644 index 0000000..b067178 --- /dev/null +++ b/docs/source/examples/v3arch/asyncio/agent/cmdrsp/snmp-versions.rst @@ -0,0 +1,16 @@ +.. toctree:: + :maxdepth: 2 + +Various SNMP versions +---------------------- + +.. include:: /../../examples/v3arch/asyncio/agent/cmdrsp/v3-multiple-users.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncio/agent/cmdrsp/v3-multiple-users.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/asyncio/agent/ntforg/common-notifications.rst b/docs/source/examples/v3arch/asyncio/agent/ntforg/common-notifications.rst new file mode 100644 index 0000000..0e1ff6e --- /dev/null +++ b/docs/source/examples/v3arch/asyncio/agent/ntforg/common-notifications.rst @@ -0,0 +1,26 @@ +.. toctree:: + :maxdepth: 2 + +Common notifications +-------------------- + +.. include:: /../../examples/v3arch/asyncio/agent/ntforg/trap-v1.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncio/agent/ntforg/trap-v1.py + :start-after: """# + :language: python + +:download:`Download` script. + +.. include:: /../../examples/v3arch/asyncio/agent/ntforg/inform-v3.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncio/agent/ntforg/inform-v3.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/asyncio/contents.rst b/docs/source/examples/v3arch/asyncio/contents.rst new file mode 100644 index 0000000..c668f2f --- /dev/null +++ b/docs/source/examples/v3arch/asyncio/contents.rst @@ -0,0 +1,63 @@ + +SNMP with Asynio +================ + +Python 3.4 introduced a new module - `asyncio `_ (former Tulip, +PEP 3156) featuring infrastructure for writing single-threaded concurrent +code using coroutines, multiplexing I/O access over sockets and other +resources. + +PySNMP library was originally built on top of Python's asynchronous I/O +library called asyncio. The asyncio module offers similar functionality +but uses much more modern and powerful language facilities. Functionally, +asyncio can replace asyncio in PySNMP however its use requires understanding +the concepts such as coroutines and generators. If your task is to embed SNMP +stack into an existing asyncio-based app, using PySNMP's asyncio interfaces +greatly simplifies the task. + +Older applications (Python 2.6+) can alternatively use +`Trollius `_ instead of asyncio. Trollius +is a backport of asyncio so it `supports `_ nearly the same API as asyncio. Full support of both modules is +built into pysnmp. + +All SNMP-related functionality of Native PySNMP API to Standard SNMP +Applications (`RFC3413 `_) +remains available to asyncio-backed applications. + +Command Generator Applications +------------------------------ + +.. toctree:: + + /examples/v3arch/asyncio/manager/cmdgen/snmp-versions + /examples/v3arch/asyncio/manager/cmdgen/modifying-variables + /examples/v3arch/asyncio/manager/cmdgen/walking-operations + /examples/v3arch/asyncio/manager/cmdgen/transport-tweaks + + +Command Responder Applications +------------------------------ + +.. toctree:: + + /examples/v3arch/asyncio/agent/cmdrsp/snmp-versions + +Notification Originator Applications +------------------------------------ + +.. toctree:: + + /examples/v3arch/asyncio/agent/ntforg/common-notifications + + +Notification Receiver Applications +---------------------------------- + +.. toctree:: + + /examples/v3arch/asyncio/manager/ntfrcv/transport-tweaks + +For more details on PySNMP programming model and interfaces, please +refer to the documentation + + diff --git a/docs/source/examples/v3arch/asyncio/manager/cmdgen/modifying-variables.rst b/docs/source/examples/v3arch/asyncio/manager/cmdgen/modifying-variables.rst new file mode 100644 index 0000000..b148147 --- /dev/null +++ b/docs/source/examples/v3arch/asyncio/manager/cmdgen/modifying-variables.rst @@ -0,0 +1,16 @@ +.. toctree:: + :maxdepth: 2 + +Modifying values +---------------- + +.. include:: /../../examples/v3arch/asyncio/manager/cmdgen/set-v2c.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncio/manager/cmdgen/set-v2c.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/asyncio/manager/cmdgen/snmp-versions.rst b/docs/source/examples/v3arch/asyncio/manager/cmdgen/snmp-versions.rst new file mode 100644 index 0000000..e525dbc --- /dev/null +++ b/docs/source/examples/v3arch/asyncio/manager/cmdgen/snmp-versions.rst @@ -0,0 +1,16 @@ +.. toctree:: + :maxdepth: 2 + +Various SNMP versions +---------------------- + +.. include:: /../../examples/v3arch/asyncio/manager/cmdgen/get-v2c-custom-timeout.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncio/manager/cmdgen/get-v2c-custom-timeout.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/asyncio/manager/cmdgen/transport-tweaks.rst b/docs/source/examples/v3arch/asyncio/manager/cmdgen/transport-tweaks.rst new file mode 100644 index 0000000..48aae2d --- /dev/null +++ b/docs/source/examples/v3arch/asyncio/manager/cmdgen/transport-tweaks.rst @@ -0,0 +1,16 @@ +.. toctree:: + :maxdepth: 2 + +Transport tweaks +---------------- + +.. include:: /../../examples/v3arch/asyncio/manager/cmdgen/get-v2c-over-ipv6.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncio/manager/cmdgen/get-v2c-over-ipv6.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/asyncio/manager/cmdgen/walking-operations.rst b/docs/source/examples/v3arch/asyncio/manager/cmdgen/walking-operations.rst new file mode 100644 index 0000000..52f3ed7 --- /dev/null +++ b/docs/source/examples/v3arch/asyncio/manager/cmdgen/walking-operations.rst @@ -0,0 +1,27 @@ +.. toctree:: + :maxdepth: 2 + +Walking operations +------------------ + +.. include:: /../../examples/v3arch/asyncio/manager/cmdgen/getnext-v2c-from-specific-address.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncio/manager/cmdgen/getnext-v2c-from-specific-address.py + :start-after: """# + :language: python + +:download:`Download` script + + +.. include:: /../../examples/v3arch/asyncio/manager/cmdgen/getbulk-v2c.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncio/manager/cmdgen/getbulk-v2c.py + :start-after: """# + :language: python + +:download:`Download` script + diff --git a/docs/source/examples/v3arch/asyncio/manager/ntfrcv/transport-tweaks.rst b/docs/source/examples/v3arch/asyncio/manager/ntfrcv/transport-tweaks.rst new file mode 100644 index 0000000..77d85b7 --- /dev/null +++ b/docs/source/examples/v3arch/asyncio/manager/ntfrcv/transport-tweaks.rst @@ -0,0 +1,16 @@ +.. toctree:: + :maxdepth: 2 + +Transport tweaks +---------------- + +.. include:: /../../examples/v3arch/asyncio/manager/ntfrcv/v2c-multiple-interfaces.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncio/manager/ntfrcv/v2c-multiple-interfaces.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/asyncore/agent/cmdrsp/advanced-topics.rst b/docs/source/examples/v3arch/asyncore/agent/cmdrsp/advanced-topics.rst new file mode 100644 index 0000000..7bfcc0c --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/agent/cmdrsp/advanced-topics.rst @@ -0,0 +1,38 @@ +.. toctree:: + :maxdepth: 2 + +Advanced topics +--------------- + +.. include:: /../../examples/v3arch/asyncore/agent/cmdrsp/v3-custom-engine-id.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/cmdrsp/v3-custom-engine-id.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/agent/cmdrsp/v3-observe-request-processing.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/cmdrsp/v3-observe-request-processing.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/agent/cmdrsp/v3-multiple-snmp-engines.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/cmdrsp/v3-multiple-snmp-engines.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/asyncore/agent/cmdrsp/agent-side-mib-implementations.rst b/docs/source/examples/v3arch/asyncore/agent/cmdrsp/agent-side-mib-implementations.rst new file mode 100644 index 0000000..f685ff3 --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/agent/cmdrsp/agent-side-mib-implementations.rst @@ -0,0 +1,49 @@ +.. toctree:: + :maxdepth: 2 + +Agent-side MIB implementations +------------------------------ + +.. include:: /../../examples/v3arch/asyncore/agent/cmdrsp/v2c-custom-scalar-mib-objects.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/cmdrsp/v2c-custom-scalar-mib-objects.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/agent/cmdrsp/v2c-custom-tabular-mib-objects.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/cmdrsp/v2c-custom-tabular-mib-objects.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/agent/cmdrsp/v3-alternative-mib.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/cmdrsp/v3-alternative-mib.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/agent/cmdrsp/v3-alternative-mib-controller.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/cmdrsp/v3-alternative-mib-controller.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/asyncore/agent/cmdrsp/snmp-versions.rst b/docs/source/examples/v3arch/asyncore/agent/cmdrsp/snmp-versions.rst new file mode 100644 index 0000000..3bbc86e --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/agent/cmdrsp/snmp-versions.rst @@ -0,0 +1,27 @@ +.. toctree:: + :maxdepth: 2 + +Various SNMP versions +---------------------- + +.. include:: /../../examples/v3arch/asyncore/agent/cmdrsp/v1-read-and-write-communities.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/cmdrsp/v1-read-and-write-communities.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/agent/cmdrsp/v3-multiple-users.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/cmdrsp/v3-multiple-users.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/asyncore/agent/cmdrsp/transport-tweaks.rst b/docs/source/examples/v3arch/asyncore/agent/cmdrsp/transport-tweaks.rst new file mode 100644 index 0000000..bb7d0db --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/agent/cmdrsp/transport-tweaks.rst @@ -0,0 +1,38 @@ +.. toctree:: + :maxdepth: 2 + +Transport tweaks +---------------- + +.. include:: /../../examples/v3arch/asyncore/agent/cmdrsp/v2c-multiple-interfaces.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/cmdrsp/v2c-multiple-interfaces.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/agent/cmdrsp/v2c-multiple-transports.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/cmdrsp/v2c-multiple-transports.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/agent/cmdrsp/v3-preserve-original-destination-address.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/cmdrsp/v3-preserve-original-destination-address.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/asyncore/agent/ntforg/advanced-topics.rst b/docs/source/examples/v3arch/asyncore/agent/ntforg/advanced-topics.rst new file mode 100644 index 0000000..83fda00 --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/agent/ntforg/advanced-topics.rst @@ -0,0 +1,16 @@ +.. toctree:: + :maxdepth: 2 + +Advanced topic +-------------- + +.. include:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v2c-custom-pdu.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v2c-custom-pdu.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/asyncore/agent/ntforg/common-notifications.rst b/docs/source/examples/v3arch/asyncore/agent/ntforg/common-notifications.rst new file mode 100644 index 0000000..749c4ff --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/agent/ntforg/common-notifications.rst @@ -0,0 +1,46 @@ +.. toctree:: + :maxdepth: 2 + +Common notifications +-------------------- + +.. include:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v1.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v1.py + :start-after: """# + :language: python + +:download:`Download` script. + +.. include:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v2c.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v2c.py + :start-after: """# + :language: python + +:download:`Download` script. + +.. include:: /../../examples/v3arch/asyncore/agent/ntforg/inform-v2c.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/ntforg/inform-v2c.py + :start-after: """# + :language: python + +:download:`Download` script. + +.. include:: /../../examples/v3arch/asyncore/agent/ntforg/inform-v3.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/ntforg/inform-v3.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/asyncore/agent/ntforg/evaluating-notification-type.rst b/docs/source/examples/v3arch/asyncore/agent/ntforg/evaluating-notification-type.rst new file mode 100644 index 0000000..6ec5acc --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/agent/ntforg/evaluating-notification-type.rst @@ -0,0 +1,26 @@ +.. toctree:: + :maxdepth: 2 + +Evaluating NOTIFICATION-TYPE +---------------------------- + +SNMP SMI defines notifications as a TRAP or INFORM PDU containing +the indication of type (snmpTrapOID) and a set of MIB variables +(Managed Objects Instances) fetched from Agent's MIB at the moment +of notification. + +Consequently, sending specific NOTIFICATION-TYPE implies including certain +set of OIDs into PDU. PySNMP offers this facility through NotificationType +class. + +.. include:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v2c-with-objects.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v2c-with-objects.py + :start-after: """# + :language: python + +:download:`Download` script. + + diff --git a/docs/source/examples/v3arch/asyncore/agent/ntforg/multiple-managers-operations.rst b/docs/source/examples/v3arch/asyncore/agent/ntforg/multiple-managers-operations.rst new file mode 100644 index 0000000..538f40b --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/agent/ntforg/multiple-managers-operations.rst @@ -0,0 +1,42 @@ +.. toctree:: + :maxdepth: 2 + +Multiple managers operations +---------------------------- + +SNMPv3 framework is designed to allow Agents sending the same PDU +to multiple Managers over different network transports, listening at +different network addresses over different SNMP versions/credentials. + +The following few examples use this facility. + +.. include:: /../../examples/v3arch/asyncore/agent/ntforg/inform-multiple-protocols.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/ntforg/inform-multiple-protocols.py + :start-after: """# + :language: python + +:download:`Download` script. + +.. include:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v2c-multiple-addresses.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v2c-multiple-addresses.py + :start-after: """# + :language: python + +:download:`Download` script. + +.. include:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v2c-multiple-transports.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v2c-multiple-transports.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/asyncore/agent/ntforg/snmp-v1-trap-variants.rst b/docs/source/examples/v3arch/asyncore/agent/ntforg/snmp-v1-trap-variants.rst new file mode 100644 index 0000000..bab44c8 --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/agent/ntforg/snmp-v1-trap-variants.rst @@ -0,0 +1,28 @@ +.. toctree:: + :maxdepth: 2 + +SNMPv1 TRAP variants +-------------------- + +.. include:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v1-with-default-values.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v1-with-default-values.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v1-with-custom-values.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v1-with-custom-values.py + :start-after: """# + :language: python + +:download:`Download` script. + + diff --git a/docs/source/examples/v3arch/asyncore/agent/ntforg/snmp-versions.rst b/docs/source/examples/v3arch/asyncore/agent/ntforg/snmp-versions.rst new file mode 100644 index 0000000..2b56cba --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/agent/ntforg/snmp-versions.rst @@ -0,0 +1,39 @@ +.. toctree:: + :maxdepth: 2 + +Various SNMP versions +---------------------- + +.. include:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v1.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v1.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v2c.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v2c.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v3.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v3.py + :start-after: """# + :language: python + +:download:`Download` script. + + diff --git a/docs/source/examples/v3arch/asyncore/agent/ntforg/transport-tweaks.rst b/docs/source/examples/v3arch/asyncore/agent/ntforg/transport-tweaks.rst new file mode 100644 index 0000000..e949255 --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/agent/ntforg/transport-tweaks.rst @@ -0,0 +1,16 @@ +.. toctree:: + :maxdepth: 2 + +Transport tweaks +---------------- + +.. include:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v1-from-specific-address.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/agent/ntforg/trap-v1-from-specific-address.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/asyncore/contents.rst b/docs/source/examples/v3arch/asyncore/contents.rst new file mode 100644 index 0000000..54db9fc --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/contents.rst @@ -0,0 +1,81 @@ + +SNMP with Asyncore +================== + +If you find yourself unable to use particular SNMP feature with the +high-level, "oneliner" API, your next step would be to use SNMPv3 +engine services through one of the Standard SNMP Applications +(`RFC3413 `_). + +There're a large number of SNMPv3 Native API example scripts on this +website. Most of them serve a very specific purpose like talking arbitrary +SNMP version or handling particular PDU type. That dedication of +features serve the purpose of simplifying example code and easing +your studies. + +Since all these examples are built on top of common PySNMP components +like SNMP engine, asyncore-based I/O dispatcher, configuration datastore, +you could always combine parts of the examples for getting a new breed +of SNMP application best matching your needs. + +Command Generator Applications +------------------------------ + +.. toctree:: + + /examples/v3arch/asyncore/manager/cmdgen/snmp-versions + /examples/v3arch/asyncore/manager/cmdgen/modifying-variables + /examples/v3arch/asyncore/manager/cmdgen/walking-operations + /examples/v3arch/asyncore/manager/cmdgen/table-operations + /examples/v3arch/asyncore/manager/cmdgen/mib-tweaks + /examples/v3arch/asyncore/manager/cmdgen/transport-tweaks + /examples/v3arch/asyncore/manager/cmdgen/advanced-topics +.. XXX /examples/v3arch/asyncore/manager/cmdgen/asynchronous-operations + + +Command Responder Applications +------------------------------ + +.. toctree:: + + /examples/v3arch/asyncore/agent/cmdrsp/snmp-versions + /examples/v3arch/asyncore/agent/cmdrsp/agent-side-mib-implementations + /examples/v3arch/asyncore/agent/cmdrsp/transport-tweaks + /examples/v3arch/asyncore/agent/cmdrsp/advanced-topics + +Notification Originator Applications +------------------------------------ + +.. toctree:: + + /examples/v3arch/asyncore/agent/ntforg/snmp-versions + /examples/v3arch/asyncore/agent/ntforg/common-notifications + /examples/v3arch/asyncore/agent/ntforg/evaluating-notification-type + /examples/v3arch/asyncore/agent/ntforg/multiple-managers-operations + /examples/v3arch/asyncore/agent/ntforg/transport-tweaks + /examples/v3arch/asyncore/agent/ntforg/advanced-topics +.. XXX /examples/v3arch/asyncore/agent/ntforg/snmp-v1-trap-variants + + +Notification Receiver Applications +---------------------------------- + +.. toctree:: + + /examples/v3arch/asyncore/manager/ntfrcv/snmp-versions + /examples/v3arch/asyncore/manager/ntfrcv/transport-tweaks + /examples/v3arch/asyncore/manager/ntfrcv/advanced-topics + +Proxy Forwarder Applications +---------------------------- + +.. toctree:: + + /examples/v3arch/asyncore/proxy/command/transport-conversion + /examples/v3arch/asyncore/proxy/command/protocol-conversion + + +For more details on PySNMP programming model and interfaces, please +refer to the documentation + + diff --git a/docs/source/examples/v3arch/asyncore/manager/cmdgen/advanced-topics.rst b/docs/source/examples/v3arch/asyncore/manager/cmdgen/advanced-topics.rst new file mode 100644 index 0000000..1514953 --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/manager/cmdgen/advanced-topics.rst @@ -0,0 +1,28 @@ +.. toctree:: + :maxdepth: 2 + +Advanced topics +--------------- + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/get-v3-custom-context.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/get-v3-custom-context.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/get-v3-observe-request-processing.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/get-v3-observe-request-processing.py + :start-after: """# + :language: python + +:download:`Download` script. + + diff --git a/docs/source/examples/v3arch/asyncore/manager/cmdgen/asynchronous-operations.rst b/docs/source/examples/v3arch/asyncore/manager/cmdgen/asynchronous-operations.rst new file mode 100644 index 0000000..b560f72 --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/manager/cmdgen/asynchronous-operations.rst @@ -0,0 +1,42 @@ +.. toctree:: + :maxdepth: 2 + +Asynchronous operations +----------------------- + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/get-async-multiple-transports-and-protocols.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/get-async-multiple-transports-and-protocols.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/get-async-multiple-snmp-engines.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/get-async-multiple-snmp-engines.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/getnext-async-multiple-transports-and-protocols.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/getnext-async-multiple-transports-and-protocols.py + :start-after: """# + :language: python + +:download:`Download` script. + + + + + diff --git a/docs/source/examples/v3arch/asyncore/manager/cmdgen/mib-tweaks.rst b/docs/source/examples/v3arch/asyncore/manager/cmdgen/mib-tweaks.rst new file mode 100644 index 0000000..36bcbde --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/manager/cmdgen/mib-tweaks.rst @@ -0,0 +1,47 @@ +.. toctree:: + :maxdepth: 2 + +MIB tweaks +---------- + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/getnext-v2c-with-mib-compilation-and-lookup.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/getnext-v2c-with-mib-compilation-and-lookup.py + :start-after: """# + :language: python + +:download:`Download` script. + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/getbulk-v3-with-custom-mib-path-and-options.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/getbulk-v3-with-custom-mib-path-and-options.py + :start-after: """# + :language: python + +:download:`Download` script. + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/getnext-v3-over-ipv6-with-mib-lookup.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/getnext-v3-over-ipv6-with-mib-lookup.py + :start-after: """# + :language: python + +:download:`Download` script. + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/getnext-v2c-with-mib-resolution.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/getnext-v2c-with-mib-resolution.py + :start-after: """# + :language: python + +:download:`Download` script. + + diff --git a/docs/source/examples/v3arch/asyncore/manager/cmdgen/modifying-variables.rst b/docs/source/examples/v3arch/asyncore/manager/cmdgen/modifying-variables.rst new file mode 100644 index 0000000..d8f659e --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/manager/cmdgen/modifying-variables.rst @@ -0,0 +1,40 @@ + +.. toctree:: + :maxdepth: 2 + +Modifying values +---------------- + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/set-v1.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/set-v1.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/set-v2c.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/set-v2c.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/set-v3.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/set-v3.py + :start-after: """# + :language: python + +:download:`Download` script. + + diff --git a/docs/source/examples/v3arch/asyncore/manager/cmdgen/snmp-versions.rst b/docs/source/examples/v3arch/asyncore/manager/cmdgen/snmp-versions.rst new file mode 100644 index 0000000..803dfb2 --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/manager/cmdgen/snmp-versions.rst @@ -0,0 +1,72 @@ +.. toctree:: + :maxdepth: 2 + +Various SNMP versions +---------------------- + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/get-v1.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/get-v1.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/get-v2c-custom-timeout.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/get-v2c-custom-timeout.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/get-v3.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/get-v3.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/get-v3-with-mib-lookup.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/get-v3-with-mib-lookup.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/get-v3-auth-priv.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/get-v3-auth-priv.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/get-v3-auth-priv-sha-aes128.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/get-v3-auth-priv-sha-aes128.py + :start-after: """# + :language: python + +:download:`Download` script. + + diff --git a/docs/source/examples/v3arch/asyncore/manager/cmdgen/table-operations.rst b/docs/source/examples/v3arch/asyncore/manager/cmdgen/table-operations.rst new file mode 100644 index 0000000..a650698 --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/manager/cmdgen/table-operations.rst @@ -0,0 +1,59 @@ +.. toctree:: + :maxdepth: 2 + +Table operations +---------------- + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/getnext-v1.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/getnext-v1.py + :start-after: """# + :language: python + +:download:`Download` script. + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/get-v3-table-object-by-index.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/get-v3-table-object-by-index.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/get-v3-table-object-by-multiple-indices.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/get-v3-table-object-by-multiple-indices.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/getbulk-v3-over-ipv6-with-mib-lookup.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/getbulk-v3-over-ipv6-with-mib-lookup.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/getbulk-v2c-limiting-number-of-rows.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/getbulk-v2c-limiting-number-of-rows.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/asyncore/manager/cmdgen/transport-tweaks.rst b/docs/source/examples/v3arch/asyncore/manager/cmdgen/transport-tweaks.rst new file mode 100644 index 0000000..e519230 --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/manager/cmdgen/transport-tweaks.rst @@ -0,0 +1,40 @@ +.. toctree:: + :maxdepth: 2 + +Transport tweaks +---------------- + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/get-v2c-spoof-source-address.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/get-v2c-spoof-source-address.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/getnext-v2c-from-specific-address.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/getnext-v2c-from-specific-address.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/getnext-v3-over-ipv6.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/getnext-v3-over-ipv6.py + :start-after: """# + :language: python + +:download:`Download` script. + + + diff --git a/docs/source/examples/v3arch/asyncore/manager/cmdgen/walking-operations.rst b/docs/source/examples/v3arch/asyncore/manager/cmdgen/walking-operations.rst new file mode 100644 index 0000000..334b820 --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/manager/cmdgen/walking-operations.rst @@ -0,0 +1,61 @@ +.. toctree:: + :maxdepth: 2 + +Walking operations +------------------ + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/getbulk-v2c.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/getbulk-v2c.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/getbulk-v3.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/getbulk-v3.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/getnext-v1.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/getnext-v1.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/getnext-v3-pull-subtree.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/getnext-v3-pull-subtree.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/manager/cmdgen/getnext-v2c.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/cmdgen/getnext-v2c.py + :start-after: """# + :language: python + +:download:`Download` script. + + diff --git a/docs/source/examples/v3arch/asyncore/manager/ntfrcv/advanced-topics.rst b/docs/source/examples/v3arch/asyncore/manager/ntfrcv/advanced-topics.rst new file mode 100644 index 0000000..c7222f6 --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/manager/ntfrcv/advanced-topics.rst @@ -0,0 +1,28 @@ +.. toctree:: + :maxdepth: 2 + +Advanced topics +--------------- + +.. include:: /../../examples/v3arch/asyncore/manager/ntfrcv/v2c-observe-request-processing.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/ntfrcv/v2c-observe-request-processing.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/manager/ntfrcv/v2c-with-regexp-community-name.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/ntfrcv/v2c-with-regexp-community-name.py + :start-after: """# + :language: python + +:download:`Download` script. + + diff --git a/docs/source/examples/v3arch/asyncore/manager/ntfrcv/snmp-versions.rst b/docs/source/examples/v3arch/asyncore/manager/ntfrcv/snmp-versions.rst new file mode 100644 index 0000000..2f67e9d --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/manager/ntfrcv/snmp-versions.rst @@ -0,0 +1,17 @@ +.. toctree:: + :maxdepth: 2 + +Various SNMP versions +---------------------- + +.. include:: /../../examples/v3arch/asyncore/manager/ntfrcv/v3-multiple-users.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/ntfrcv/v3-multiple-users.py + :start-after: """# + :language: python + +:download:`Download` script. + + diff --git a/docs/source/examples/v3arch/asyncore/manager/ntfrcv/transport-tweaks.rst b/docs/source/examples/v3arch/asyncore/manager/ntfrcv/transport-tweaks.rst new file mode 100644 index 0000000..8e4272f --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/manager/ntfrcv/transport-tweaks.rst @@ -0,0 +1,39 @@ +.. toctree:: + :maxdepth: 2 + +Transport tweaks +---------------- + +.. include:: /../../examples/v3arch/asyncore/manager/ntfrcv/v2c-multiple-interfaces.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/ntfrcv/v2c-multiple-interfaces.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/manager/ntfrcv/v2c-multiple-transports.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/ntfrcv/v2c-multiple-transports.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/manager/ntfrcv/v2c-with-request-details.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/manager/ntfrcv/v2c-with-request-details.py + :start-after: """# + :language: python + +:download:`Download` script. + + diff --git a/docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/advanced-topics.rst b/docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/advanced-topics.rst new file mode 100644 index 0000000..2c44e98 --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/advanced-topics.rst @@ -0,0 +1,27 @@ +.. toctree:: + :maxdepth: 2 + +Advanced topic +-------------- + +.. include:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/inform-v3-with-custom-contextname.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/inform-v3-with-custom-contextname.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/inform-v3-with-custom-contextengineid.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/inform-v3-with-custom-contextengineid.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/asynchronous-operations.rst b/docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/asynchronous-operations.rst new file mode 100644 index 0000000..4bde125 --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/asynchronous-operations.rst @@ -0,0 +1,27 @@ +.. toctree:: + :maxdepth: 2 + +Asynchronous operations +----------------------- + +.. include:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/trap-async-multiple-transports-and-protocols.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/trap-async-multiple-transports-and-protocols.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/inform-async-multiple-snmp-engines.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/inform-async-multiple-snmp-engines.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/common-notifications.rst b/docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/common-notifications.rst new file mode 100644 index 0000000..c4eb733 --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/common-notifications.rst @@ -0,0 +1,27 @@ +.. toctree:: + :maxdepth: 2 + +Common notifications +-------------------- + +.. include:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/trap-v2c-with-mib-lookup.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/trap-v2c-with-mib-lookup.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/inform-v3.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/inform-v3.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/evaluating-notification-type.rst b/docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/evaluating-notification-type.rst new file mode 100644 index 0000000..1a0c8f5 --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/evaluating-notification-type.rst @@ -0,0 +1,17 @@ +.. toctree:: + :maxdepth: 2 + +Evaluating NOTIFICATION-TYPE +---------------------------- + +.. include:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/inform-v2c-with-mib-lookup.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/inform-v2c-with-mib-lookup.py + :start-after: """# + :language: python + +:download:`Download` script. + + diff --git a/docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/snmp-v1-trap-variants.rst b/docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/snmp-v1-trap-variants.rst new file mode 100644 index 0000000..8ed93c8 --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/snmp-v1-trap-variants.rst @@ -0,0 +1,28 @@ +.. toctree:: + :maxdepth: 2 + +SNMPv1 TRAP variants +-------------------- + +.. include:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/trap-v1-with-default-values.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/trap-v1-with-default-values.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/trap-v1-with-custom-values.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/trap-v1-with-custom-values.py + :start-after: """# + :language: python + +:download:`Download` script. + + diff --git a/docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/snmp-versions.rst b/docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/snmp-versions.rst new file mode 100644 index 0000000..573af2e --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/oneliner/agent/ntforg/snmp-versions.rst @@ -0,0 +1,39 @@ +.. toctree:: + :maxdepth: 2 + +Various SNMP versions +---------------------- + +.. include:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/trap-v1-with-default-values.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/trap-v1-with-default-values.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/trap-v2c-with-mib-lookup.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/trap-v2c-with-mib-lookup.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/trap-v3-with-custom-engineid.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/trap-v3-with-custom-engineid.py + :start-after: """# + :language: python + +:download:`Download` script. + + diff --git a/docs/source/examples/v3arch/asyncore/oneliner/contents.rst b/docs/source/examples/v3arch/asyncore/oneliner/contents.rst new file mode 100644 index 0000000..cf9787f --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/oneliner/contents.rst @@ -0,0 +1,84 @@ + +PySNMP Oneliner Examples +======================== + +This chapter illustrates various uses of the high-level programming +interfaces to some of Standard SNMP Applicaitons, as defined in +`RFC3413 `_. +The so called "oneliner" API 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 +wrapped into a nearly one-line Python expression. + +.. 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 example code doe + +Command Generator Applications +------------------------------ + +Here's a quick example on a simple SNMP GET by oneliner API: + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v1.py + :start-after: options: + :end-before: Functionally + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v1.py + :start-after: """# + :language: python + +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/v3arch/asyncore/oneliner/manager/cmdgen/getnext-v3-pull-whole-mib-with-mib-lookup.py + :start-after: options: + :end-before: Functionally + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getnext-v3-pull-whole-mib-with-mib-lookup.py + :start-after: """# + :language: python + +More examples on Command Generator API usage follow. + +.. toctree:: + + /examples/v3arch/asyncore/oneliner/manager/cmdgen/snmp-versions + /examples/v3arch/asyncore/oneliner/manager/cmdgen/modifying-variables + /examples/v3arch/asyncore/oneliner/manager/cmdgen/walking-operations + /examples/v3arch/asyncore/oneliner/manager/cmdgen/table-operations + /examples/v3arch/asyncore/oneliner/manager/cmdgen/mib-tweaks + /examples/v3arch/asyncore/oneliner/manager/cmdgen/transport-tweaks + /examples/v3arch/asyncore/oneliner/manager/cmdgen/asynchronous-operations + /examples/v3arch/asyncore/oneliner/manager/cmdgen/advanced-topics + +Notification Originator Application +----------------------------------- + +Sending SNMP TRAP's and INFORM's is as easy with PySNMP's oneliner +library. The following code sends SNMP TRAP: + +.. include:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/trap-v1-with-custom-values.py + :start-after: options: + :end-before: Functionally + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/trap-v1-with-custom-values.py + :start-after: """# + :language: python + +More examples on Notification Originator API usage follow. + +.. toctree:: + + /examples/v3arch/asyncore/oneliner/agent/ntforg/snmp-versions + /examples/v3arch/asyncore/oneliner/agent/ntforg/common-notifications + /examples/v3arch/asyncore/oneliner/agent/ntforg/snmp-v1-trap-variants + /examples/v3arch/asyncore/oneliner/agent/ntforg/evaluating-notification-type + /examples/v3arch/asyncore/oneliner/agent/ntforg/asynchronous-operations + /examples/v3arch/asyncore/oneliner/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/v3arch/asyncore/oneliner/manager/cmdgen/advanced-topics.rst b/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/advanced-topics.rst new file mode 100644 index 0000000..02a21fb --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/advanced-topics.rst @@ -0,0 +1,75 @@ +.. toctree:: + :maxdepth: 2 + +Advanced topics +--------------- + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v3-multiple-calls.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v3-multiple-calls.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v3-with-specific-engine-id.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v3-with-specific-engine-id.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v3-with-custom-security-name.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v3-with-custom-security-name.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/set-v3-with-custom-contextengineid.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/set-v3-with-custom-contextengineid.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/set-v3-with-custom-contextengineid-and-contextname.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/set-v3-with-custom-contextengineid-and-contextname.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-threaded-multiple-transports-and-protocols.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-threaded-multiple-transports-and-protocols.py + :start-after: """# + :language: python + +:download:`Download` script. + + + + + diff --git a/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/asynchronous-operations.rst b/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/asynchronous-operations.rst new file mode 100644 index 0000000..eb80eb5 --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/asynchronous-operations.rst @@ -0,0 +1,42 @@ +.. toctree:: + :maxdepth: 2 + +Asynchronous operations +----------------------- + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-async-multiple-transports-and-protocols.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-async-multiple-transports-and-protocols.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-async-multiple-snmp-engines.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-async-multiple-snmp-engines.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getnext-async-multiple-transports-and-protocols.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getnext-async-multiple-transports-and-protocols.py + :start-after: """# + :language: python + +:download:`Download` script. + + + + + diff --git a/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/mib-tweaks.rst b/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/mib-tweaks.rst new file mode 100644 index 0000000..faf1742 --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/mib-tweaks.rst @@ -0,0 +1,47 @@ +.. toctree:: + :maxdepth: 2 + +MIB tweaks +---------- + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v2c-with-mib-compilation-and-lookup.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v2c-with-mib-compilation-and-lookup.py + :start-after: """# + :language: python + +:download:`Download` script. + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getbulk-v3-with-custom-mib-path-and-options.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getbulk-v3-with-custom-mib-path-and-options.py + :start-after: """# + :language: python + +:download:`Download` script. + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getnext-v3-over-ipv6-with-mib-lookup.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getnext-v3-over-ipv6-with-mib-lookup.py + :start-after: """# + :language: python + +:download:`Download` script. + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getnext-v2c-with-mib-resolution.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getnext-v2c-with-mib-resolution.py + :start-after: """# + :language: python + +:download:`Download` script. + + diff --git a/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/modifying-variables.rst b/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/modifying-variables.rst new file mode 100644 index 0000000..a84e2b7 --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/modifying-variables.rst @@ -0,0 +1,40 @@ + +.. toctree:: + :maxdepth: 2 + +Modifying values +---------------- + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/set-v1-multiple-values.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/set-v1-multiple-values.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/set-v2c-with-value-type-mib-lookup.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/set-v2c-with-value-type-mib-lookup.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/set-v3-with-value-type-mib-lookup.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/set-v3-with-value-type-mib-lookup.py + :start-after: """# + :language: python + +:download:`Download` script. + + diff --git a/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/snmp-versions.rst b/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/snmp-versions.rst new file mode 100644 index 0000000..6272478 --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/snmp-versions.rst @@ -0,0 +1,72 @@ +.. toctree:: + :maxdepth: 2 + +Various SNMP versions +---------------------- + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v1.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v1.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v2c.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v2c.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v3-noauth-nopriv.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v3-noauth-nopriv.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v3-with-mib-lookup.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v3-with-mib-lookup.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v3-auth-priv.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v3-auth-priv.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v3-auth-priv-sha-aes128.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v3-auth-priv-sha-aes128.py + :start-after: """# + :language: python + +:download:`Download` script. + + diff --git a/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/table-operations.rst b/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/table-operations.rst new file mode 100644 index 0000000..b7a6586 --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/table-operations.rst @@ -0,0 +1,59 @@ +.. toctree:: + :maxdepth: 2 + +Table operations +---------------- + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getnext-v1.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getnext-v1.py + :start-after: """# + :language: python + +:download:`Download` script. + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v3-table-object-by-index.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v3-table-object-by-index.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v3-table-object-by-multiple-indices.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v3-table-object-by-multiple-indices.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getbulk-v3-over-ipv6-with-mib-lookup.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getbulk-v3-over-ipv6-with-mib-lookup.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getbulk-v2c-limiting-number-of-rows.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getbulk-v2c-limiting-number-of-rows.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/transport-tweaks.rst b/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/transport-tweaks.rst new file mode 100644 index 0000000..4b191e2 --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/transport-tweaks.rst @@ -0,0 +1,29 @@ +.. toctree:: + :maxdepth: 2 + +Transport tweaks +---------------- + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v2c-with-custom-timeout-and-retries.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v2c-with-custom-timeout-and-retries.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v3-over-ipv6-with-mib-lookup.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/get-v3-over-ipv6-with-mib-lookup.py + :start-after: """# + :language: python + +:download:`Download` script. + + + diff --git a/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/walking-operations.rst b/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/walking-operations.rst new file mode 100644 index 0000000..d67d5fd --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/walking-operations.rst @@ -0,0 +1,61 @@ +.. toctree:: + :maxdepth: 2 + +Walking operations +------------------ + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getnext-v3-pull-whole-mib-with-mib-lookup.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getnext-v3-pull-whole-mib-with-mib-lookup.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getbulk-v2c.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getbulk-v2c.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getnext-v3-pull-whole-mib-with-options.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getnext-v3-pull-whole-mib-with-options.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getbulk-v3-limiting-number-of-packets.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getbulk-v3-limiting-number-of-packets.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getnext-v2c.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getnext-v2c.py + :start-after: """# + :language: python + +:download:`Download` script. + + diff --git a/docs/source/examples/v3arch/asyncore/proxy/command/protocol-conversion.rst b/docs/source/examples/v3arch/asyncore/proxy/command/protocol-conversion.rst new file mode 100644 index 0000000..5bfa01b --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/proxy/command/protocol-conversion.rst @@ -0,0 +1,38 @@ +.. toctree:: + :maxdepth: 2 + +Protocol conversion +------------------- + +.. include:: /../../examples/v3arch/asyncore/proxy/command/v2c-to-v1-conversion.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/proxy/command/v2c-to-v1-conversion.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/proxy/command/v2c-to-v3-conversion.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/proxy/command/v2c-to-v3-conversion.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/asyncore/proxy/command/v3-to-v2c-conversion.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/proxy/command/v3-to-v2c-conversion.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/asyncore/proxy/command/transport-conversion.rst b/docs/source/examples/v3arch/asyncore/proxy/command/transport-conversion.rst new file mode 100644 index 0000000..d7244cc --- /dev/null +++ b/docs/source/examples/v3arch/asyncore/proxy/command/transport-conversion.rst @@ -0,0 +1,16 @@ +.. toctree:: + :maxdepth: 2 + +Transport conversion +-------------------- + +.. include:: /../../examples/v3arch/asyncore/proxy/command/udp6-to-udp4-conversion.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/asyncore/proxy/command/udp6-to-udp4-conversion.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/trollius/agent/ntforg/common-notifications.rst b/docs/source/examples/v3arch/trollius/agent/ntforg/common-notifications.rst new file mode 100644 index 0000000..e20d4cc --- /dev/null +++ b/docs/source/examples/v3arch/trollius/agent/ntforg/common-notifications.rst @@ -0,0 +1,26 @@ +.. toctree:: + :maxdepth: 2 + +Common notifications +-------------------- + +.. include:: /../../examples/v3arch/trollius/agent/ntforg/trap-v1.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/trollius/agent/ntforg/trap-v1.py + :start-after: """# + :language: python + +:download:`Download` script. + +.. include:: /../../examples/v3arch/trollius/agent/ntforg/inform-v3.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/trollius/agent/ntforg/inform-v3.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/trollius/contents.rst b/docs/source/examples/v3arch/trollius/contents.rst new file mode 100644 index 0000000..b223e64 --- /dev/null +++ b/docs/source/examples/v3arch/trollius/contents.rst @@ -0,0 +1,37 @@ + +SNMP with Trollius +================== + +`Trollius `_ framework offers +infrastructure that allows you writing single-threaded, concurrent code +using Python coroutines. + +Trollius is a backport of `asyncio `_ to Python versions older than 3.3. Trollius supports nearly the same +API as asyncio. Full support of both asyncio and trollius modules is +built into pysnmp. + +All SNMP-related functionality of Native PySNMP API to Standard SNMP +Applications (`RFC3413 `_) +remains available to asyncio-backed applications. + +Command Generator Applications +------------------------------ + +.. toctree:: + + /examples/v3arch/trollius/manager/cmdgen/fetching-values + /examples/v3arch/trollius/manager/cmdgen/modifying-variables + /examples/v3arch/trollius/manager/cmdgen/walking-operations + /examples/v3arch/trollius/manager/cmdgen/transport-tweaks + +Notification Originator Applications +------------------------------------ + +.. toctree:: + + /examples/v3arch/trollius/agent/ntforg/common-notifications + +For more details on PySNMP programming model and interfaces, please +refer to the documentation + + diff --git a/docs/source/examples/v3arch/trollius/manager/cmdgen/fetching-values.rst b/docs/source/examples/v3arch/trollius/manager/cmdgen/fetching-values.rst new file mode 100644 index 0000000..3ce4683 --- /dev/null +++ b/docs/source/examples/v3arch/trollius/manager/cmdgen/fetching-values.rst @@ -0,0 +1,16 @@ +.. toctree:: + :maxdepth: 2 + +Fetching values +--------------- + +.. include:: /../../examples/v3arch/trollius/manager/cmdgen/get-v1.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/trollius/manager/cmdgen/get-v1.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/trollius/manager/cmdgen/modifying-variables.rst b/docs/source/examples/v3arch/trollius/manager/cmdgen/modifying-variables.rst new file mode 100644 index 0000000..148f305 --- /dev/null +++ b/docs/source/examples/v3arch/trollius/manager/cmdgen/modifying-variables.rst @@ -0,0 +1,16 @@ +.. toctree:: + :maxdepth: 2 + +Modifying values +---------------- + +.. include:: /../../examples/v3arch/trollius/manager/cmdgen/set-v2c.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/trollius/manager/cmdgen/set-v2c.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/trollius/manager/cmdgen/transport-tweaks.rst b/docs/source/examples/v3arch/trollius/manager/cmdgen/transport-tweaks.rst new file mode 100644 index 0000000..ef44d47 --- /dev/null +++ b/docs/source/examples/v3arch/trollius/manager/cmdgen/transport-tweaks.rst @@ -0,0 +1,16 @@ +.. toctree:: + :maxdepth: 2 + +Transport tweaks +---------------- + +.. include:: /../../examples/v3arch/trollius/manager/cmdgen/get-v2c-custom-timeout.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/trollius/manager/cmdgen/get-v2c-custom-timeout.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/trollius/manager/cmdgen/walking-operations.rst b/docs/source/examples/v3arch/trollius/manager/cmdgen/walking-operations.rst new file mode 100644 index 0000000..3151147 --- /dev/null +++ b/docs/source/examples/v3arch/trollius/manager/cmdgen/walking-operations.rst @@ -0,0 +1,26 @@ +.. toctree:: + :maxdepth: 2 + +Walking operations +------------------ + +.. include:: /../../examples/v3arch/trollius/manager/cmdgen/getnext-v3.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/trollius/manager/cmdgen/getnext-v3.py + :start-after: """# + :language: python + +:download:`Download` script. + +.. include:: /../../examples/v3arch/trollius/manager/cmdgen/getbulk-v3.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/trollius/manager/cmdgen/getbulk-v3.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/twisted/agent/cmdrsp/agent-side-mib-implementations.rst b/docs/source/examples/v3arch/twisted/agent/cmdrsp/agent-side-mib-implementations.rst new file mode 100644 index 0000000..38b17d1 --- /dev/null +++ b/docs/source/examples/v3arch/twisted/agent/cmdrsp/agent-side-mib-implementations.rst @@ -0,0 +1,16 @@ +.. toctree:: + :maxdepth: 2 + +Agent-side MIB implementations +------------------------------ + +.. include:: /../../examples/v3arch/twisted/agent/cmdrsp/v2c-custom-scalar-mib-objects.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/twisted/agent/cmdrsp/v2c-custom-scalar-mib-objects.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/twisted/agent/cmdrsp/snmp-versions.rst b/docs/source/examples/v3arch/twisted/agent/cmdrsp/snmp-versions.rst new file mode 100644 index 0000000..3691182 --- /dev/null +++ b/docs/source/examples/v3arch/twisted/agent/cmdrsp/snmp-versions.rst @@ -0,0 +1,27 @@ +.. toctree:: + :maxdepth: 2 + +Various SNMP versions +---------------------- + +.. include:: /../../examples/v3arch/twisted/agent/cmdrsp/v1-read-and-write-communities.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/twisted/agent/cmdrsp/v1-read-and-write-communities.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/twisted/agent/cmdrsp/v3-multiple-users.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/twisted/agent/cmdrsp/v3-multiple-users.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/twisted/agent/cmdrsp/transport-tweaks.rst b/docs/source/examples/v3arch/twisted/agent/cmdrsp/transport-tweaks.rst new file mode 100644 index 0000000..fc1764f --- /dev/null +++ b/docs/source/examples/v3arch/twisted/agent/cmdrsp/transport-tweaks.rst @@ -0,0 +1,16 @@ +.. toctree:: + :maxdepth: 2 + +Transport tweaks +---------------- + +.. include:: /../../examples/v3arch/twisted/agent/cmdrsp/v2c-multiple-interfaces.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/twisted/agent/cmdrsp/v2c-multiple-interfaces.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/twisted/agent/ntforg/common-notifications.rst b/docs/source/examples/v3arch/twisted/agent/ntforg/common-notifications.rst new file mode 100644 index 0000000..f90cf46 --- /dev/null +++ b/docs/source/examples/v3arch/twisted/agent/ntforg/common-notifications.rst @@ -0,0 +1,48 @@ +.. toctree:: + :maxdepth: 2 + +Common notifications +-------------------- + +.. include:: /../../examples/v3arch/twisted/agent/ntforg/trap-v1.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/twisted/agent/ntforg/trap-v1.py + :start-after: """# + :language: python + +:download:`Download` script. + +.. include:: /../../examples/v3arch/twisted/agent/ntforg/trap-v3.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/twisted/agent/ntforg/trap-v3.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/twisted/agent/ntforg/inform-v2c.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/twisted/agent/ntforg/inform-v2c.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/twisted/agent/ntforg/inform-v3.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/twisted/agent/ntforg/inform-v3.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/twisted/agent/ntforg/multiple-managers-operations.rst b/docs/source/examples/v3arch/twisted/agent/ntforg/multiple-managers-operations.rst new file mode 100644 index 0000000..858d9fc --- /dev/null +++ b/docs/source/examples/v3arch/twisted/agent/ntforg/multiple-managers-operations.rst @@ -0,0 +1,16 @@ +.. toctree:: + :maxdepth: 2 + +Multiple managers operations +---------------------------- + +.. include:: /../../examples/v3arch/twisted/agent/ntforg/trap-v2c-multiple-targets.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/twisted/agent/ntforg/trap-v2c-multiple-targets.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/twisted/contents.rst b/docs/source/examples/v3arch/twisted/contents.rst new file mode 100644 index 0000000..500cdba --- /dev/null +++ b/docs/source/examples/v3arch/twisted/contents.rst @@ -0,0 +1,56 @@ + +SNMP with Twisted +================= + +`Twisted `_ is event-driven networking engine +written in Python. It takes shape of a Python library which is used by many +Python applications mostly for network communication purposes. Twisted can +be seen as a predecessor of eventlet, asyncio. + +Twisted offers similar functionality to asyncio and twisted, it can +replace twisted in PySNMP wrapped by a thin PySNMP Transport Dispatcher +abstraction layer. All SNMP-related functionality of Native API to +Standard SNMP Applications remains available to Twisted applications. + +Command Generator Applications +------------------------------ + +.. toctree:: + + /examples/v3arch/twisted/manager/cmdgen/snmp-versions + /examples/v3arch/twisted/manager/cmdgen/modifying-variables + /examples/v3arch/twisted/manager/cmdgen/walking-operations + /examples/v3arch/twisted/manager/cmdgen/table-operations + /examples/v3arch/twisted/manager/cmdgen/transport-tweaks + /examples/v3arch/twisted/manager/cmdgen/advanced-topics + + +Command Responder Applications +------------------------------ + +.. toctree:: + + /examples/v3arch/twisted/agent/cmdrsp/snmp-versions + /examples/v3arch/twisted/agent/cmdrsp/agent-side-mib-implementations + /examples/v3arch/twisted/agent/cmdrsp/transport-tweaks + +Notification Originator Applications +------------------------------------ + +.. toctree:: + + /examples/v3arch/twisted/agent/ntforg/common-notifications + /examples/v3arch/twisted/agent/ntforg/multiple-managers-operations + +Notification Receiver Applications +---------------------------------- + +.. toctree:: + + /examples/v3arch/twisted/manager/ntfrcv/snmp-versions + /examples/v3arch/twisted/manager/ntfrcv/transport-tweaks + +For more details on PySNMP programming model and interfaces, please +refer to the documentation + + diff --git a/docs/source/examples/v3arch/twisted/manager/cmdgen/advanced-topics.rst b/docs/source/examples/v3arch/twisted/manager/cmdgen/advanced-topics.rst new file mode 100644 index 0000000..9a6bcdf --- /dev/null +++ b/docs/source/examples/v3arch/twisted/manager/cmdgen/advanced-topics.rst @@ -0,0 +1,16 @@ +.. toctree:: + :maxdepth: 2 + +Advanced topics +--------------- + +.. include:: /../../examples/v3arch/twisted/manager/cmdgen/get-v3-custom-context.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/twisted/manager/cmdgen/get-v3-custom-context.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/twisted/manager/cmdgen/snmp-versions.rst b/docs/source/examples/v3arch/twisted/manager/cmdgen/snmp-versions.rst new file mode 100644 index 0000000..c2f6695 --- /dev/null +++ b/docs/source/examples/v3arch/twisted/manager/cmdgen/snmp-versions.rst @@ -0,0 +1,27 @@ +.. toctree:: + :maxdepth: 2 + +Various SNMP versions +---------------------- + +.. include:: /../../examples/v3arch/twisted/manager/cmdgen/get-v1.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/twisted/manager/cmdgen/get-v1.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/twisted/manager/cmdgen/get-v3.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/twisted/manager/cmdgen/get-v3.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/twisted/manager/cmdgen/table-operations.rst b/docs/source/examples/v3arch/twisted/manager/cmdgen/table-operations.rst new file mode 100644 index 0000000..22a5ca9 --- /dev/null +++ b/docs/source/examples/v3arch/twisted/manager/cmdgen/table-operations.rst @@ -0,0 +1,16 @@ +.. toctree:: + :maxdepth: 2 + +SNMP conceptual table operations +-------------------------------- + +.. include:: /../../examples/v3arch/twisted/manager/cmdgen/getnext-v3-pull-subtree.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/twisted/manager/cmdgen/getnext-v3-pull-subtree.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/twisted/manager/cmdgen/transport-tweaks.rst b/docs/source/examples/v3arch/twisted/manager/cmdgen/transport-tweaks.rst new file mode 100644 index 0000000..332ee9c --- /dev/null +++ b/docs/source/examples/v3arch/twisted/manager/cmdgen/transport-tweaks.rst @@ -0,0 +1,27 @@ +.. toctree:: + :maxdepth: 2 + +Transport tweaks +---------------- + +.. include:: /../../examples/v3arch/twisted/manager/cmdgen/getnext-v2c-from-specific-address.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/twisted/manager/cmdgen/getnext-v2c-from-specific-address.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/twisted/manager/cmdgen/get-v2c-custom-timeout.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/twisted/manager/cmdgen/get-v2c-custom-timeout.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/twisted/manager/cmdgen/walking-operations.rst b/docs/source/examples/v3arch/twisted/manager/cmdgen/walking-operations.rst new file mode 100644 index 0000000..cb8537d --- /dev/null +++ b/docs/source/examples/v3arch/twisted/manager/cmdgen/walking-operations.rst @@ -0,0 +1,38 @@ +.. toctree:: + :maxdepth: 2 + +Walking operations +------------------ + +.. include:: /../../examples/v3arch/twisted/manager/cmdgen/getnext-v1.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/twisted/manager/cmdgen/getnext-v1.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/twisted/manager/cmdgen/getbulk-v2c.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/twisted/manager/cmdgen/getbulk-v2c.py + :start-after: """# + :language: python + +:download:`Download` script. + + +.. include:: /../../examples/v3arch/twisted/manager/cmdgen/getbulk-v3.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/twisted/manager/cmdgen/getbulk-v3.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/twisted/manager/ntfrcv/snmp-versions.rst b/docs/source/examples/v3arch/twisted/manager/ntfrcv/snmp-versions.rst new file mode 100644 index 0000000..cc3900c --- /dev/null +++ b/docs/source/examples/v3arch/twisted/manager/ntfrcv/snmp-versions.rst @@ -0,0 +1,16 @@ +.. toctree:: + :maxdepth: 2 + +Various SNMP versions +--------------------- + +.. include:: /../../examples/v3arch/twisted/manager/ntfrcv/v3-multiple-users.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/twisted/manager/ntfrcv/v3-multiple-users.py + :start-after: """# + :language: python + +:download:`Download` script. + diff --git a/docs/source/examples/v3arch/twisted/manager/ntfrcv/transport-tweaks.rst b/docs/source/examples/v3arch/twisted/manager/ntfrcv/transport-tweaks.rst new file mode 100644 index 0000000..2db628b --- /dev/null +++ b/docs/source/examples/v3arch/twisted/manager/ntfrcv/transport-tweaks.rst @@ -0,0 +1,16 @@ +.. toctree:: + :maxdepth: 2 + +Transport tweaks +---------------- + +.. include:: /../../examples/v3arch/twisted/manager/ntfrcv/v2c-multiple-interfaces.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/v3arch/twisted/manager/ntfrcv/v2c-multiple-interfaces.py + :start-after: """# + :language: python + +:download:`Download` script. + -- cgit v1.2.1