diff options
author | elie <elie> | 2015-09-21 06:32:31 +0000 |
---|---|---|
committer | elie <elie> | 2015-09-21 06:32:31 +0000 |
commit | a0d0d36ca6a0f0852cea4242de559f957f5c0e35 (patch) | |
tree | be8ea1450aca797606b955bdc38397f835f3dd87 /docs/source/examples/hlapi | |
parent | c8b8797cacf4a1e0756f04f9c2eedeff59f42a72 (diff) | |
download | pysnmp-git-a0d0d36ca6a0f0852cea4242de559f957f5c0e35.tar.gz |
more adjustments followed layout changes
Diffstat (limited to 'docs/source/examples/hlapi')
6 files changed, 87 insertions, 87 deletions
diff --git a/docs/source/examples/hlapi/asyncore/agent/ntforg/advanced-topics.rst b/docs/source/examples/hlapi/asyncore/agent/ntforg/advanced-topics.rst index 93fa2dca..06eb06bd 100644 --- a/docs/source/examples/hlapi/asyncore/agent/ntforg/advanced-topics.rst +++ b/docs/source/examples/hlapi/asyncore/agent/ntforg/advanced-topics.rst @@ -4,25 +4,25 @@ Advanced topic -------------- -.. include:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/custom-contextname.py +.. include:: /../../examples/hlapi/asyncore/agent/ntforg/custom-contextname.py :start-after: """ :end-before: """# -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/custom-contextname.py +.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/custom-contextname.py :start-after: """# :language: python -:download:`Download</../../examples/v3arch/asyncore/oneliner/agent/ntforg/custom-contextname.py>` script. +:download:`Download</../../examples/hlapi/asyncore/agent/ntforg/custom-contextname.py>` script. -.. include:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/custom-contextengineid.py +.. include:: /../../examples/hlapi/asyncore/agent/ntforg/custom-contextengineid.py :start-after: """ :end-before: """# -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/custom-contextengineid.py +.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/custom-contextengineid.py :start-after: """# :language: python -:download:`Download</../../examples/v3arch/asyncore/oneliner/agent/ntforg/custom-contextengineid.py>` script. +: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/common-notifications.rst b/docs/source/examples/hlapi/asyncore/agent/ntforg/common-notifications.rst index 9042e835..b8048e17 100644 --- a/docs/source/examples/hlapi/asyncore/agent/ntforg/common-notifications.rst +++ b/docs/source/examples/hlapi/asyncore/agent/ntforg/common-notifications.rst @@ -4,25 +4,25 @@ Common notifications -------------------- -.. include:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/v2c-trap-via-notification-type.py +.. include:: /../../examples/hlapi/asyncore/agent/ntforg/v2c-trap-via-notification-type.py :start-after: """ :end-before: """# -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/v2c-trap-via-notification-type.py +.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/v2c-trap-via-notification-type.py :start-after: """# :language: python -:download:`Download</../../examples/v3arch/asyncore/oneliner/agent/ntforg/v2c-trap-via-notification-type.py>` script. +:download:`Download</../../examples/hlapi/asyncore/agent/ntforg/v2c-trap-via-notification-type.py>` script. -.. include:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/v3-inform.py +.. include:: /../../examples/hlapi/asyncore/agent/ntforg/v3-inform.py :start-after: """ :end-before: """# -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/v3-inform.py +.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/v3-inform.py :start-after: """# :language: python -:download:`Download</../../examples/v3arch/asyncore/oneliner/agent/ntforg/v3-inform.py>` script. +: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/contents.rst b/docs/source/examples/hlapi/asyncore/contents.rst index f0e75af5..d5105514 100644 --- a/docs/source/examples/hlapi/asyncore/contents.rst +++ b/docs/source/examples/hlapi/asyncore/contents.rst @@ -5,7 +5,7 @@ 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 "oneliner" API is designed to be simple, concise and +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. @@ -20,13 +20,13 @@ 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: +Here's a quick example on a simple SNMP GET by high-level API: -.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/v1-get.py +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/v1-get.py :start-after: options: :end-before: Functionally -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/v1-get.py +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/v1-get.py :start-after: """# :language: python @@ -34,11 +34,11 @@ To make use of SNMPv3 and USM, the following code performs a series of SNMP GETNEXT operations effectively fetching a table of SNMP variables from SNMP Agent: -.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/pull-whole-mib.py +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/pull-whole-mib.py :start-after: options: :end-before: Functionally -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/pull-whole-mib.py +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/pull-whole-mib.py :start-after: """# :language: python @@ -46,26 +46,26 @@ 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 + /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's oneliner -library. The following code sends SNMP TRAP: +Sending SNMP TRAP's and INFORM's is as easy with PySNMP library. +The following code sends SNMP TRAP: -.. include:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/default-v1-trap.py +.. include:: /../../examples/hlapi/asyncore/agent/ntforg/default-v1-trap.py :start-after: options: :end-before: Functionally -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/agent/ntforg/default-v1-trap.py +.. literalinclude:: /../../examples/hlapi/asyncore/agent/ntforg/default-v1-trap.py :start-after: """# :language: python @@ -73,12 +73,12 @@ 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 + /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 index 3aef044f..969d6ed6 100644 --- a/docs/source/examples/hlapi/asyncore/manager/cmdgen/advanced-topics.rst +++ b/docs/source/examples/hlapi/asyncore/manager/cmdgen/advanced-topics.rst @@ -4,81 +4,81 @@ Advanced topics --------------- -.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getbulk-limit-number-of-packets.py +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/getbulk-limit-number-of-packets.py :start-after: """ :end-before: """# -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getbulk-limit-number-of-packets.py +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/getbulk-limit-number-of-packets.py :start-after: """# :language: python -:download:`Download</../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getbulk-limit-number-of-packets.py>` script. +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/getbulk-limit-number-of-packets.py>` script. -.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/multiple-get-calls.py +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/multiple-get-calls.py :start-after: """ :end-before: """# -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/multiple-get-calls.py +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/multiple-get-calls.py :start-after: """# :language: python -:download:`Download</../../examples/v3arch/asyncore/oneliner/manager/cmdgen/multiple-get-calls.py>` script. +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/multiple-get-calls.py>` script. -.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/custom-contextengineid.py +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/custom-contextengineid.py :start-after: """ :end-before: """# -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/custom-contextengineid.py +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/custom-contextengineid.py :start-after: """# :language: python -:download:`Download</../../examples/v3arch/asyncore/oneliner/manager/cmdgen/custom-contextengineid.py>` script. +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/custom-contextengineid.py>` script. -.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/custom-contextengineid-and-contextname.py +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/custom-contextengineid-and-contextname.py :start-after: """ :end-before: """# -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/custom-contextengineid-and-contextname.py +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/custom-contextengineid-and-contextname.py :start-after: """# :language: python -:download:`Download</../../examples/v3arch/asyncore/oneliner/manager/cmdgen/custom-contextengineid-and-contextname.py>` script. +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/custom-contextengineid-and-contextname.py>` script. -.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/custom-v3-security-name.py +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/custom-v3-security-name.py :start-after: """ :end-before: """# -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/custom-v3-security-name.py +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/custom-v3-security-name.py :start-after: """# :language: python -:download:`Download</../../examples/v3arch/asyncore/oneliner/manager/cmdgen/custom-v3-security-name.py>` script. +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/custom-v3-security-name.py>` script. -.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/specific-v3-engine-id.py +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/specific-v3-engine-id.py :start-after: """ :end-before: """# -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/specific-v3-engine-id.py +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/specific-v3-engine-id.py :start-after: """# :language: python -:download:`Download</../../examples/v3arch/asyncore/oneliner/manager/cmdgen/specific-v3-engine-id.py>` script. +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/specific-v3-engine-id.py>` script. -.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/query-agents-from-multuple-threads.py +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/query-agents-from-multuple-threads.py :start-after: """ :end-before: """# -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/query-agents-from-multuple-threads.py +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/query-agents-from-multuple-threads.py :start-after: """# :language: python -:download:`Download</../../examples/v3arch/asyncore/oneliner/manager/cmdgen/query-agents-from-multuple-threads.py>` script. +: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/snmp-versions.rst b/docs/source/examples/hlapi/asyncore/manager/cmdgen/snmp-versions.rst index 787c66ea..ad786db3 100644 --- a/docs/source/examples/hlapi/asyncore/manager/cmdgen/snmp-versions.rst +++ b/docs/source/examples/hlapi/asyncore/manager/cmdgen/snmp-versions.rst @@ -4,69 +4,69 @@ Various SNMP versions ---------------------- -.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/v1-get.py +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/v1-get.py :start-after: """ :end-before: """# -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/v1-get.py +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/v1-get.py :start-after: """# :language: python -:download:`Download</../../examples/v3arch/asyncore/oneliner/manager/cmdgen/v1-get.py>` script. +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/v1-get.py>` script. -.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/v2c-get.py +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/v2c-get.py :start-after: """ :end-before: """# -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/v2c-get.py +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/v2c-get.py :start-after: """# :language: python -:download:`Download</../../examples/v3arch/asyncore/oneliner/manager/cmdgen/v2c-get.py>` script. +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/v2c-get.py>` script. -.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/usm-md5-des.py +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/usm-md5-des.py :start-after: """ :end-before: """# -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/usm-md5-des.py +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/usm-md5-des.py :start-after: """# :language: python -:download:`Download</../../examples/v3arch/asyncore/oneliner/manager/cmdgen/usm-md5-des.py>` script. +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/usm-md5-des.py>` script. -.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/usm-md5-none.py +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/usm-md5-none.py :start-after: """ :end-before: """# -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/usm-md5-none.py +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/usm-md5-none.py :start-after: """# :language: python -:download:`Download</../../examples/v3arch/asyncore/oneliner/manager/cmdgen/usm-md5-none.py>` script. +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/usm-md5-none.py>` script. -.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/usm-none-none.py +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/usm-none-none.py :start-after: """ :end-before: """# -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/usm-none-none.py +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/usm-none-none.py :start-after: """# :language: python -:download:`Download</../../examples/v3arch/asyncore/oneliner/manager/cmdgen/usm-none-none.py>` script. +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/usm-none-none.py>` script. -.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/usm-sha-aes128.py +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/usm-sha-aes128.py :start-after: """ :end-before: """# -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/usm-sha-aes128.py +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/usm-sha-aes128.py :start-after: """# :language: python -:download:`Download</../../examples/v3arch/asyncore/oneliner/manager/cmdgen/usm-sha-aes128.py>` script. +: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/walking-operations.rst b/docs/source/examples/hlapi/asyncore/manager/cmdgen/walking-operations.rst index f5aa3f1f..1d5b3159 100644 --- a/docs/source/examples/hlapi/asyncore/manager/cmdgen/walking-operations.rst +++ b/docs/source/examples/hlapi/asyncore/manager/cmdgen/walking-operations.rst @@ -4,48 +4,48 @@ Walking operations ------------------ -.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getnext-multiple-oids-to-eom.py +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/getnext-multiple-oids-to-eom.py :start-after: """ :end-before: """# -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getnext-multiple-oids-to-eom.py +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/getnext-multiple-oids-to-eom.py :start-after: """# :language: python -:download:`Download</../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getnext-multiple-oids-to-eom.py>` script. +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/getnext-multiple-oids-to-eom.py>` script. -.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/pull-whole-mib.py +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/pull-whole-mib.py :start-after: """ :end-before: """# -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/pull-whole-mib.py +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/pull-whole-mib.py :start-after: """# :language: python -:download:`Download</../../examples/v3arch/asyncore/oneliner/manager/cmdgen/pull-whole-mib.py>` script. +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/pull-whole-mib.py>` script. -.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getbulk-limit-number-of-variables.py +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/getbulk-limit-number-of-variables.py :start-after: """ :end-before: """# -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getbulk-limit-number-of-variables.py +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/getbulk-limit-number-of-variables.py :start-after: """# :language: python -:download:`Download</../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getbulk-limit-number-of-variables.py>` script. +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/getbulk-limit-number-of-variables.py>` script. -.. include:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getnext-limit-number-of-variables.py +.. include:: /../../examples/hlapi/asyncore/manager/cmdgen/getnext-limit-number-of-variables.py :start-after: """ :end-before: """# -.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getnext-limit-number-of-variables.py +.. literalinclude:: /../../examples/hlapi/asyncore/manager/cmdgen/getnext-limit-number-of-variables.py :start-after: """# :language: python -:download:`Download</../../examples/v3arch/asyncore/oneliner/manager/cmdgen/getnext-limit-number-of-variables.py>` script. +:download:`Download</../../examples/hlapi/asyncore/manager/cmdgen/getnext-limit-number-of-variables.py>` script. See also: :doc:`library reference </docs/contents>`. |