diff options
Diffstat (limited to 'docs/source/examples')
17 files changed, 683 insertions, 2 deletions
diff --git a/docs/source/examples/contents.rst b/docs/source/examples/contents.rst index eabdafe..a93af0f 100644 --- a/docs/source/examples/contents.rst +++ b/docs/source/examples/contents.rst @@ -18,7 +18,7 @@ APIs are: .. toctree:: :maxdepth: 2 - /examples/v3arch/asyncore/oneliner/contents + /examples/hlapi/asyncore/contents #. Complete implementation of all official Standard SNMP Applications. It should let you implement any SNMP operation defined in the standard. diff --git a/docs/source/examples/hlapi/asyncore/agent/ntforg/advanced-topics.rst b/docs/source/examples/hlapi/asyncore/agent/ntforg/advanced-topics.rst new file mode 100644 index 0000000..06eb06b --- /dev/null +++ b/docs/source/examples/hlapi/asyncore/agent/ntforg/advanced-topics.rst @@ -0,0 +1,28 @@ +.. toctree:: + :maxdepth: 2 + +Advanced topic +-------------- + +.. include:: /../../examples/hlapi/asyncore/agent/ntforg/custom-contextname.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/custom-contextname.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/agent/ntforg/custom-contextname.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/agent/ntforg/custom-contextengineid.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/custom-contextengineid.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/agent/ntforg/custom-contextengineid.py>` script. + +See also: :doc:`library reference </docs/contents>`. diff --git a/docs/source/examples/hlapi/asyncore/agent/ntforg/asynchronous-operations.rst b/docs/source/examples/hlapi/asyncore/agent/ntforg/asynchronous-operations.rst new file mode 100644 index 0000000..0ff429a --- /dev/null +++ b/docs/source/examples/hlapi/asyncore/agent/ntforg/asynchronous-operations.rst @@ -0,0 +1,40 @@ +.. toctree:: + :maxdepth: 2 + +Asynchronous operations +----------------------- + +.. include:: /../../examples/hlapi/asyncore/agent/ntforg/async-multiple-traps-at-once.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/async-multiple-traps-at-once.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/agent/ntforg/async-multiple-traps-at-once.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/agent/ntforg/async-multiple-informs-at-once.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/async-multiple-informs-at-once.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/agent/ntforg/async-multiple-informs-at-once.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/agent/ntforg/async-running-multiple-snmp-engines-at-once.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/async-running-multiple-snmp-engines-at-once.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/agent/ntforg/async-running-multiple-snmp-engines-at-once.py>` script. + + +See also: :doc:`library reference </docs/contents>`. diff --git a/docs/source/examples/hlapi/asyncore/agent/ntforg/common-notifications.rst b/docs/source/examples/hlapi/asyncore/agent/ntforg/common-notifications.rst new file mode 100644 index 0000000..b8048e1 --- /dev/null +++ b/docs/source/examples/hlapi/asyncore/agent/ntforg/common-notifications.rst @@ -0,0 +1,28 @@ +.. toctree:: + :maxdepth: 2 + +Common notifications +-------------------- + +.. include:: /../../examples/hlapi/asyncore/agent/ntforg/v2c-trap-via-notification-type.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/v2c-trap-via-notification-type.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/agent/ntforg/v2c-trap-via-notification-type.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/agent/ntforg/v3-inform.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/v3-inform.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/agent/ntforg/v3-inform.py>` script. + +See also: :doc:`library reference </docs/contents>`. diff --git a/docs/source/examples/hlapi/asyncore/agent/ntforg/evaluating-notification-type.rst b/docs/source/examples/hlapi/asyncore/agent/ntforg/evaluating-notification-type.rst new file mode 100644 index 0000000..e06b7ff --- /dev/null +++ b/docs/source/examples/hlapi/asyncore/agent/ntforg/evaluating-notification-type.rst @@ -0,0 +1,29 @@ +.. toctree:: + :maxdepth: 2 + +Evaluating NOTIFICATION-TYPE +---------------------------- + +.. include:: /../../examples/hlapi/asyncore/agent/ntforg/v2c-trap-via-notification-type.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/v2c-trap-via-notification-type.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/agent/ntforg/v2c-trap-via-notification-type.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/agent/ntforg/send-notification-with-additional-varbinds.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/send-notification-with-additional-varbinds.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/agent/ntforg/send-notification-with-additional-varbinds.py>` script. + + +See also: :doc:`library reference </docs/contents>`. diff --git a/docs/source/examples/hlapi/asyncore/agent/ntforg/snmp-v1-trap-variants.rst b/docs/source/examples/hlapi/asyncore/agent/ntforg/snmp-v1-trap-variants.rst new file mode 100644 index 0000000..7327867 --- /dev/null +++ b/docs/source/examples/hlapi/asyncore/agent/ntforg/snmp-v1-trap-variants.rst @@ -0,0 +1,29 @@ +.. toctree:: + :maxdepth: 2 + +SNMPv1 TRAP variants +-------------------- + +.. include:: /../../examples/hlapi/asyncore/agent/ntforg/custom-v1-trap.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/custom-v1-trap.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/agent/ntforg/custom-v1-trap.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/agent/ntforg/default-v1-trap.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/default-v1-trap.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/agent/ntforg/default-v1-trap.py>` script. + + +See also: :doc:`library reference </docs/contents>`. diff --git a/docs/source/examples/hlapi/asyncore/agent/ntforg/snmp-versions.rst b/docs/source/examples/hlapi/asyncore/agent/ntforg/snmp-versions.rst new file mode 100644 index 0000000..e861b49 --- /dev/null +++ b/docs/source/examples/hlapi/asyncore/agent/ntforg/snmp-versions.rst @@ -0,0 +1,40 @@ +.. toctree:: + :maxdepth: 2 + +Various SNMP versions +---------------------- + +.. include:: /../../examples/hlapi/asyncore/agent/ntforg/default-v1-trap.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/default-v1-trap.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/agent/ntforg/default-v1-trap.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/agent/ntforg/v2c-trap-via-notification-type.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/v2c-trap-via-notification-type.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/agent/ntforg/v2c-trap-via-notification-type.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/agent/ntforg/v3-trap.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/v3-trap.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/agent/ntforg/v3-trap.py>` script. + + +See also: :doc:`library reference </docs/contents>`. diff --git a/docs/source/examples/hlapi/asyncore/contents.rst b/docs/source/examples/hlapi/asyncore/contents.rst new file mode 100644 index 0000000..d510551 --- /dev/null +++ b/docs/source/examples/hlapi/asyncore/contents.rst @@ -0,0 +1,84 @@ + +High-level SNMP +=============== + +This chapter illustrates various uses of the high-level programming +interfaces to some of Standard SNMP Applicaitons, as defined in +`RFC3413 <https://tools.ietf.org/html/rfc3413>`_. +The so called high-level API (hlapi) is designed to be simple, concise and +suitable for the most frequent operations. For that matter only +Command Generator and Notification Originator Applications are currently +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 high-level API: + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/v1-get.py + :start-after: options: + :end-before: Functionally + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/v1-get.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/hlapi/asyncore/manager/cmdgen/pull-whole-mib.py + :start-after: options: + :end-before: Functionally + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/pull-whole-mib.py + :start-after: """# + :language: python + +More examples on Command Generator API usage follow. + +.. toctree:: + + /examples/hlapi/asyncore/manager/cmdgen/snmp-versions + /examples/hlapi/asyncore/manager/cmdgen/modifying-variables + /examples/hlapi/asyncore/manager/cmdgen/walking-operations + /examples/hlapi/asyncore/manager/cmdgen/table-operations + /examples/hlapi/asyncore/manager/cmdgen/mib-tweaks + /examples/hlapi/asyncore/manager/cmdgen/transport-tweaks + /examples/hlapi/asyncore/manager/cmdgen/asynchronous-operations + /examples/hlapi/asyncore/manager/cmdgen/advanced-topics + +Notification Originator Application +----------------------------------- + +Sending SNMP TRAP's and INFORM's is as easy with PySNMP library. +The following code sends SNMP TRAP: + +.. include:: /../../examples/hlapi/asyncore/agent/ntforg/default-v1-trap.py + :start-after: options: + :end-before: Functionally + +.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/default-v1-trap.py + :start-after: """# + :language: python + +More examples on Notification Originator API usage follow. + +.. toctree:: + + /examples/hlapi/asyncore/agent/ntforg/snmp-versions + /examples/hlapi/asyncore/agent/ntforg/common-notifications + /examples/hlapi/asyncore/agent/ntforg/snmp-v1-trap-variants + /examples/hlapi/asyncore/agent/ntforg/evaluating-notification-type + /examples/hlapi/asyncore/agent/ntforg/asynchronous-operations + /examples/hlapi/asyncore/agent/ntforg/advanced-topics + +More sophisticated or less popular SNMP operations can still be performed +with PySNMP through its Native API to Standard SNMP Applications. diff --git a/docs/source/examples/hlapi/asyncore/manager/cmdgen/advanced-topics.rst b/docs/source/examples/hlapi/asyncore/manager/cmdgen/advanced-topics.rst new file mode 100644 index 0000000..969d6ed --- /dev/null +++ b/docs/source/examples/hlapi/asyncore/manager/cmdgen/advanced-topics.rst @@ -0,0 +1,84 @@ +.. toctree:: + :maxdepth: 2 + +Advanced topics +--------------- + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/getbulk-limit-number-of-packets.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/getbulk-limit-number-of-packets.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/getbulk-limit-number-of-packets.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/multiple-get-calls.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/multiple-get-calls.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/multiple-get-calls.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/custom-contextengineid.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/custom-contextengineid.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/custom-contextengineid.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/custom-contextengineid-and-contextname.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/custom-contextengineid-and-contextname.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/custom-contextengineid-and-contextname.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/custom-v3-security-name.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/custom-v3-security-name.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/custom-v3-security-name.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/specific-v3-engine-id.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/specific-v3-engine-id.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/specific-v3-engine-id.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/query-agents-from-multuple-threads.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/query-agents-from-multuple-threads.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/query-agents-from-multuple-threads.py>` script. + + +See also: :doc:`library reference </docs/contents>`. diff --git a/docs/source/examples/hlapi/asyncore/manager/cmdgen/asynchronous-operations.rst b/docs/source/examples/hlapi/asyncore/manager/cmdgen/asynchronous-operations.rst new file mode 100644 index 0000000..0236a96 --- /dev/null +++ b/docs/source/examples/hlapi/asyncore/manager/cmdgen/asynchronous-operations.rst @@ -0,0 +1,39 @@ +.. toctree:: + :maxdepth: 2 + +Asynchronous operations +----------------------- + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/multiple-concurrent-async-queries.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/multiple-concurrent-async-queries.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/multiple-concurrent-async-queries.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/async-query-multiple-snmp-engines.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/async-query-multiple-snmp-engines.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/async-query-multiple-snmp-engines.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/async-pull-mibs-from-multiple-agents-at-once.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/async-pull-mibs-from-multiple-agents-at-once.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/async-pull-mibs-from-multiple-agents-at-once.py>` script. + +See also: :doc:`library reference </docs/contents>`. diff --git a/docs/source/examples/hlapi/asyncore/manager/cmdgen/mib-tweaks.rst b/docs/source/examples/hlapi/asyncore/manager/cmdgen/mib-tweaks.rst new file mode 100644 index 0000000..168eb69 --- /dev/null +++ b/docs/source/examples/hlapi/asyncore/manager/cmdgen/mib-tweaks.rst @@ -0,0 +1,48 @@ +.. toctree:: + :maxdepth: 2 + +MIB tweaks +---------- + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/waive-mib-lookup.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/waive-mib-lookup.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/waive-mib-lookup.py>` script. + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/preload-pysnmp-mibs.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/preload-pysnmp-mibs.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/preload-pysnmp-mibs.py>` script. + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/custom-asn1-mib-search-path.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/custom-asn1-mib-search-path.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/custom-asn1-mib-search-path.py>` script. + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/custom-pysnmp-mibs-search-path.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/custom-pysnmp-mibs-search-path.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/custom-pysnmp-mibs-search-path.py>` script. + + +See also: :doc:`library reference </docs/contents>`. diff --git a/docs/source/examples/hlapi/asyncore/manager/cmdgen/modifying-variables.rst b/docs/source/examples/hlapi/asyncore/manager/cmdgen/modifying-variables.rst new file mode 100644 index 0000000..0fdf8dc --- /dev/null +++ b/docs/source/examples/hlapi/asyncore/manager/cmdgen/modifying-variables.rst @@ -0,0 +1,30 @@ + +.. toctree:: + :maxdepth: 2 + +Modifying values +---------------- + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/coerce-set-value-to-mib-spec.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/coerce-set-value-to-mib-spec.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/coerce-set-value-to-mib-spec.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/set-multiple-scalar-values.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/set-multiple-scalar-values.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/set-multiple-scalar-values.py>` script. + + +See also: :doc:`library-reference </docs/contents>`. diff --git a/docs/source/examples/hlapi/asyncore/manager/cmdgen/snmp-versions.rst b/docs/source/examples/hlapi/asyncore/manager/cmdgen/snmp-versions.rst new file mode 100644 index 0000000..ad786db --- /dev/null +++ b/docs/source/examples/hlapi/asyncore/manager/cmdgen/snmp-versions.rst @@ -0,0 +1,72 @@ +.. toctree:: + :maxdepth: 2 + +Various SNMP versions +---------------------- + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/v1-get.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/v1-get.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/v1-get.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/v2c-get.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/v2c-get.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/v2c-get.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/usm-md5-des.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/usm-md5-des.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/usm-md5-des.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/usm-md5-none.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/usm-md5-none.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/usm-md5-none.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/usm-none-none.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/usm-none-none.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/usm-none-none.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/usm-sha-aes128.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/usm-sha-aes128.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/usm-sha-aes128.py>` script. + +See also: :doc:`library reference </docs/contents>`. diff --git a/docs/source/examples/hlapi/asyncore/manager/cmdgen/table-operations.rst b/docs/source/examples/hlapi/asyncore/manager/cmdgen/table-operations.rst new file mode 100644 index 0000000..9ea83c0 --- /dev/null +++ b/docs/source/examples/hlapi/asyncore/manager/cmdgen/table-operations.rst @@ -0,0 +1,50 @@ +.. toctree:: + :maxdepth: 2 + +Table operations +---------------- + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/get-table-object-by-index.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/get-table-object-by-index.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/get-table-object-by-index.py>` script. + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/get-table-object-by-multiple-indices.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/get-table-object-by-multiple-indices.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/get-table-object-by-multiple-indices.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/getbulk-fetch-scalar-and-table-variables.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/getbulk-fetch-scalar-and-table-variables.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/getbulk-fetch-scalar-and-table-variables.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/pull-whole-snmp-table.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/pull-whole-snmp-table.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/pull-whole-snmp-table.py>` script. + + +See also: :doc:`library reference </docs/contents>`. diff --git a/docs/source/examples/hlapi/asyncore/manager/cmdgen/transport-tweaks.rst b/docs/source/examples/hlapi/asyncore/manager/cmdgen/transport-tweaks.rst new file mode 100644 index 0000000..e5f754c --- /dev/null +++ b/docs/source/examples/hlapi/asyncore/manager/cmdgen/transport-tweaks.rst @@ -0,0 +1,29 @@ +.. toctree:: + :maxdepth: 2 + +Transport tweaks +---------------- + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/custom-timeout-and-retries.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/custom-timeout-and-retries.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/custom-timeout-and-retries.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/fetch-variables-over-ipv6.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/fetch-variables-over-ipv6.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/fetch-variables-over-ipv6.py>` script. + + +See also: :doc:`library reference </docs/contents>`. diff --git a/docs/source/examples/hlapi/asyncore/manager/cmdgen/walking-operations.rst b/docs/source/examples/hlapi/asyncore/manager/cmdgen/walking-operations.rst new file mode 100644 index 0000000..1d5b315 --- /dev/null +++ b/docs/source/examples/hlapi/asyncore/manager/cmdgen/walking-operations.rst @@ -0,0 +1,51 @@ +.. toctree:: + :maxdepth: 2 + +Walking operations +------------------ + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/getnext-multiple-oids-to-eom.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/getnext-multiple-oids-to-eom.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/getnext-multiple-oids-to-eom.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/pull-whole-mib.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/pull-whole-mib.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/pull-whole-mib.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/getbulk-limit-number-of-variables.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/getbulk-limit-number-of-variables.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/getbulk-limit-number-of-variables.py>` script. + + +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/getnext-limit-number-of-variables.py + :start-after: """ + :end-before: """# + +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/getnext-limit-number-of-variables.py + :start-after: """# + :language: python + +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/getnext-limit-number-of-variables.py>` script. + + +See also: :doc:`library reference </docs/contents>`. diff --git a/docs/source/examples/v3arch/asyncore/contents.rst b/docs/source/examples/v3arch/asyncore/contents.rst index 3b1295b..d5cdc9b 100644 --- a/docs/source/examples/v3arch/asyncore/contents.rst +++ b/docs/source/examples/v3arch/asyncore/contents.rst @@ -3,7 +3,7 @@ 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 +high-level (hlapi) API, your next step would be to use SNMPv3 engine services through one of the Standard SNMP Applications (`RFC3413 <https://tools.ietf.org/html/rfc3413>`_). |