summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorelie <elie>2015-09-27 17:29:37 +0000
committerelie <elie>2015-09-27 17:29:37 +0000
commitc77a2323681984217e90ec1b68fa51be34dce8d8 (patch)
treea13f4eaa2c30187a5ac82590466484dd79a73394
parent9e84833cc5565abfff07477e3528cc7f155b36eb (diff)
downloadpysnmp-git-c77a2323681984217e90ec1b68fa51be34dce8d8.tar.gz
asyncio examples documented
-rw-r--r--docs/source/examples/contents.rst17
-rw-r--r--docs/source/examples/hlapi/asyncio/agent/ntforg/advanced-topics.rst17
-rw-r--r--docs/source/examples/hlapi/asyncio/agent/ntforg/common-notifications.rst17
-rw-r--r--docs/source/examples/hlapi/asyncio/manager/cmdgen/advanced-topics.rst29
-rw-r--r--docs/source/examples/hlapi/asyncio/manager/cmdgen/snmp-versions.rst29
-rw-r--r--docs/source/examples/hlapi/asyncio/manager/cmdgen/walking-operations.rst17
-rw-r--r--examples/hlapi/asyncio/manager/cmdgen/multiple-sequential-queries.py2
7 files changed, 122 insertions, 6 deletions
diff --git a/docs/source/examples/contents.rst b/docs/source/examples/contents.rst
index 3d421794..6064260b 100644
--- a/docs/source/examples/contents.rst
+++ b/docs/source/examples/contents.rst
@@ -92,11 +92,18 @@ easy_install: ::
# pip pysnmp
-There's a public SNMP responder configured at *demo.snmplabs.com:161* to
-let you run PySNMP examples scripts in a cut&paste fashion. If you
-wish to use your own SNMP Agent with these scripts, make sure to either
-configure your local snmpd and/or snmptrapd or use a valid address and
-SNMP credentials of your SNMP Agent in the examples to let them work.
+There's a `public SNMP responder <http://snmpsim.sourceforge.net/public-snmp-simulator.html>`_
+configured at *demo.snmplabs.com:161* to let you run PySNMP examples
+scripts in a cut&paste fashion. If you wish to use your own SNMP Agent
+with these scripts, make sure to either configure your local snmpd and/or
+snmptrapd or use a valid address and SNMP credentials of your SNMP Agent
+in the examples to let them work.
+
+Should you want to use a MIB to make SNMP operations more human-friendly,
+you are welcome to search for it and possibly download one from our
+`public MIB repository <http://mibs.snmplabs.com/asn1/>`_. Alternatively,
+you can configure PySNMP to fetch and cache required MIBs from there
+automatically.
If you find your PySNMP application behaving unexpectedly, try to enable
a /more or less verbose/ built-in PySNMP debugging by adding the
diff --git a/docs/source/examples/hlapi/asyncio/agent/ntforg/advanced-topics.rst b/docs/source/examples/hlapi/asyncio/agent/ntforg/advanced-topics.rst
new file mode 100644
index 00000000..e19cb070
--- /dev/null
+++ b/docs/source/examples/hlapi/asyncio/agent/ntforg/advanced-topics.rst
@@ -0,0 +1,17 @@
+.. toctree::
+ :maxdepth: 2
+
+Advanced Notification Originator
+--------------------------------
+
+.. include:: /../../examples/hlapi/asyncio/agent/ntforg/multiple-notifications-at-once.py
+ :start-after: """
+ :end-before: """#
+
+.. literalinclude:: /../../examples/hlapi/asyncio/agent/ntforg/multiple-notifications-at-once.py
+ :start-after: """#
+ :language: python
+
+:download:`Download</../../examples/hlapi/asyncio/agent/ntforg/multiple-notifications-at-once.py>` script.
+
+See also: :doc:`library reference </docs/contents>`.
diff --git a/docs/source/examples/hlapi/asyncio/agent/ntforg/common-notifications.rst b/docs/source/examples/hlapi/asyncio/agent/ntforg/common-notifications.rst
new file mode 100644
index 00000000..3a62c80f
--- /dev/null
+++ b/docs/source/examples/hlapi/asyncio/agent/ntforg/common-notifications.rst
@@ -0,0 +1,17 @@
+.. toctree::
+ :maxdepth: 2
+
+Common notifications
+--------------------
+
+.. include:: /../../examples/hlapi/asyncio/agent/ntforg/default-v1-trap.py
+ :start-after: """
+ :end-before: """#
+
+.. literalinclude:: /../../examples/hlapi/asyncio/agent/ntforg/default-v1-trap.py
+ :start-after: """#
+ :language: python
+
+:download:`Download</../../examples/hlapi/asyncio/agent/ntforg/default-v1-trap.py>` script.
+
+See also: :doc:`library reference </docs/contents>`.
diff --git a/docs/source/examples/hlapi/asyncio/manager/cmdgen/advanced-topics.rst b/docs/source/examples/hlapi/asyncio/manager/cmdgen/advanced-topics.rst
new file mode 100644
index 00000000..8e12349a
--- /dev/null
+++ b/docs/source/examples/hlapi/asyncio/manager/cmdgen/advanced-topics.rst
@@ -0,0 +1,29 @@
+.. toctree::
+ :maxdepth: 2
+
+Advanced Command Generator
+--------------------------
+
+.. include:: /../../examples/hlapi/asyncio/manager/cmdgen/multiple-concurrent-async-queries.py
+ :start-after: """
+ :end-before: """#
+
+.. literalinclude:: /../../examples/hlapi/asyncio/manager/cmdgen/multiple-concurrent-async-queries.py
+ :start-after: """#
+ :language: python
+
+:download:`Download</../../examples/hlapi/asyncio/manager/cmdgen/multiple-concurrent-async-queries.py>` script.
+
+
+.. include:: /../../examples/hlapi/asyncio/manager/cmdgen/multiple-sequential-async-queries.py
+ :start-after: """
+ :end-before: """#
+
+.. literalinclude:: /../../examples/hlapi/asyncio/manager/cmdgen/multiple-sequential-async-queries.py
+ :start-after: """#
+ :language: python
+
+:download:`Download</../../examples/hlapi/asyncio/manager/cmdgen/multiple-sequential-async-queries.py>` script.
+
+
+See also: :doc:`library reference </docs/contents>`.
diff --git a/docs/source/examples/hlapi/asyncio/manager/cmdgen/snmp-versions.rst b/docs/source/examples/hlapi/asyncio/manager/cmdgen/snmp-versions.rst
new file mode 100644
index 00000000..0efcacec
--- /dev/null
+++ b/docs/source/examples/hlapi/asyncio/manager/cmdgen/snmp-versions.rst
@@ -0,0 +1,29 @@
+.. toctree::
+ :maxdepth: 2
+
+Various SNMP versions
+----------------------
+
+.. include:: /../../examples/hlapi/asyncio/manager/cmdgen/v1-get.py
+ :start-after: """
+ :end-before: """#
+
+.. literalinclude:: /../../examples/hlapi/asyncio/manager/cmdgen/v1-get.py
+ :start-after: """#
+ :language: python
+
+:download:`Download</../../examples/hlapi/asyncio/manager/cmdgen/v1-get.py>` script.
+
+
+.. include:: /../../examples/hlapi/asyncio/manager/cmdgen/getbulk-to-eom.py
+ :start-after: """
+ :end-before: """#
+
+.. literalinclude:: /../../examples/hlapi/asyncio/manager/cmdgen/getbulk-to-eom.py
+ :start-after: """#
+ :language: python
+
+:download:`Download</../../examples/hlapi/asyncio/manager/cmdgen/getbulk-to-eom.py>` script.
+
+
+See also: :doc:`library reference </docs/contents>`.
diff --git a/docs/source/examples/hlapi/asyncio/manager/cmdgen/walking-operations.rst b/docs/source/examples/hlapi/asyncio/manager/cmdgen/walking-operations.rst
new file mode 100644
index 00000000..aabb71a7
--- /dev/null
+++ b/docs/source/examples/hlapi/asyncio/manager/cmdgen/walking-operations.rst
@@ -0,0 +1,17 @@
+.. toctree::
+ :maxdepth: 2
+
+Walking operations
+------------------
+
+.. include:: /../../examples/hlapi/asyncio/manager/cmdgen/getbulk-to-eom.py
+ :start-after: """
+ :end-before: """#
+
+.. literalinclude:: /../../examples/hlapi/asyncio/manager/cmdgen/getbulk-to-eom.py
+ :start-after: """#
+ :language: python
+
+:download:`Download</../../examples/hlapi/asyncio/manager/cmdgen/getbulk-to-eom.py>` script.
+
+See also: :doc:`library reference </docs/contents>`.
diff --git a/examples/hlapi/asyncio/manager/cmdgen/multiple-sequential-queries.py b/examples/hlapi/asyncio/manager/cmdgen/multiple-sequential-queries.py
index 1867d5ba..0aac7eeb 100644
--- a/examples/hlapi/asyncio/manager/cmdgen/multiple-sequential-queries.py
+++ b/examples/hlapi/asyncio/manager/cmdgen/multiple-sequential-queries.py
@@ -1,5 +1,5 @@
"""
-Concurrent queries
+Sequential queries
++++++++++++++++++
Send multiple SNMP GET requests one by one using the following options: