diff options
author | elie <elie> | 2015-09-21 06:32:31 +0000 |
---|---|---|
committer | elie <elie> | 2015-09-21 06:32:31 +0000 |
commit | 66b54b016bec3312059f0add5dcc8535d2a1a6c6 (patch) | |
tree | bb2972af4148112bd56aa9444ca858f83f0bb976 /docs/source/docs | |
parent | 8ede39948b4f6037012552bab20da2ff8376d715 (diff) | |
download | pysnmp-66b54b016bec3312059f0add5dcc8535d2a1a6c6.tar.gz |
more adjustments followed layout changes
Diffstat (limited to 'docs/source/docs')
11 files changed, 122 insertions, 15 deletions
diff --git a/docs/source/docs/contents.rst b/docs/source/docs/contents.rst index ddde9cf..1e6dc2f 100644 --- a/docs/source/docs/contents.rst +++ b/docs/source/docs/contents.rst @@ -13,7 +13,7 @@ it will let you perform SNMP GET/SET/WALK operations by pasting code snippets from this web-site right into your Python interactive session. .. toctree:: - /docs/v3arch/asyncore/oneliner/contents + /docs/hlapi/contents At the basic level, PySNMP offers a complete set of Standard SNMP Applications to give you maximum flexibility with integration of SNMP @@ -29,18 +29,6 @@ PySNMP offers native bindings to some of these framework. .. /docs/v3arch/trollius/contents .. /docs/v3arch/twisted/contents -All programming interfaces mentioned above revolve around the notion -of SNMP Engine: - -.. toctree:: - /docs/v3arch/snmp-engine - -SNMP represents the information is manages in form of values belonging to -a set of types. - -.. toctree:: - /docs/snmp-data-types - At the other end of the complexity spectrum, PySNMP offers packet-level ASN.1 data structures that let you build, parse and analyze SNMP messages travelling over network. This extremely low-level programming interface is diff --git a/docs/source/docs/hlapi/asyncore/agent/ntforg/async-notification-originator.rst b/docs/source/docs/hlapi/asyncore/agent/ntforg/async-notification-originator.rst new file mode 100644 index 0000000..15fb19e --- /dev/null +++ b/docs/source/docs/hlapi/asyncore/agent/ntforg/async-notification-originator.rst @@ -0,0 +1,8 @@ +.. toctree:: + :maxdepth: 2 + +Asynchronous Notification Originator +==================================== + +.. autoclass:: pysnmp.hlapi.asyncore.AsyncNotificationOriginator + :members: diff --git a/docs/source/docs/hlapi/asyncore/agent/ntforg/notification.rst b/docs/source/docs/hlapi/asyncore/agent/ntforg/notification.rst new file mode 100644 index 0000000..e9d55cf --- /dev/null +++ b/docs/source/docs/hlapi/asyncore/agent/ntforg/notification.rst @@ -0,0 +1,8 @@ + +TRAP/INFORM notification +======================== + +.. toctree:: + :maxdepth: 2 + +.. autofunction:: pysnmp.hlapi.asyncore.sendNotification diff --git a/docs/source/docs/hlapi/asyncore/manager/cmdgen/async-command-generator.rst b/docs/source/docs/hlapi/asyncore/manager/cmdgen/async-command-generator.rst new file mode 100644 index 0000000..f8584a7 --- /dev/null +++ b/docs/source/docs/hlapi/asyncore/manager/cmdgen/async-command-generator.rst @@ -0,0 +1,9 @@ + +Asynchronous Command Generator +============================== + +.. toctree:: + :maxdepth: 2 + +.. autoclass:: pysnmp.hlapi.asyncore.AsyncCommandGenerator + :members: diff --git a/docs/source/docs/hlapi/asyncore/manager/cmdgen/bulkcmd.rst b/docs/source/docs/hlapi/asyncore/manager/cmdgen/bulkcmd.rst new file mode 100644 index 0000000..59bee11 --- /dev/null +++ b/docs/source/docs/hlapi/asyncore/manager/cmdgen/bulkcmd.rst @@ -0,0 +1,8 @@ + +GETBULK command +=============== + +.. toctree:: + :maxdepth: 2 + +.. autofunction:: pysnmp.hlapi.asyncore.bulkCmd diff --git a/docs/source/docs/hlapi/asyncore/manager/cmdgen/getcmd.rst b/docs/source/docs/hlapi/asyncore/manager/cmdgen/getcmd.rst new file mode 100644 index 0000000..c224491 --- /dev/null +++ b/docs/source/docs/hlapi/asyncore/manager/cmdgen/getcmd.rst @@ -0,0 +1,8 @@ + +GET command +=========== + +.. toctree:: + :maxdepth: 2 + +.. autofunction:: pysnmp.hlapi.asyncore.getCmd diff --git a/docs/source/docs/hlapi/asyncore/manager/cmdgen/nextcmd.rst b/docs/source/docs/hlapi/asyncore/manager/cmdgen/nextcmd.rst new file mode 100644 index 0000000..1a8856a --- /dev/null +++ b/docs/source/docs/hlapi/asyncore/manager/cmdgen/nextcmd.rst @@ -0,0 +1,8 @@ + +GETNEXT command +=============== + +.. toctree:: + :maxdepth: 2 + +.. autofunction:: pysnmp.hlapi.asyncore.nextCmd diff --git a/docs/source/docs/hlapi/asyncore/manager/cmdgen/setcmd.rst b/docs/source/docs/hlapi/asyncore/manager/cmdgen/setcmd.rst new file mode 100644 index 0000000..92f6c91 --- /dev/null +++ b/docs/source/docs/hlapi/asyncore/manager/cmdgen/setcmd.rst @@ -0,0 +1,8 @@ + +SET command +=========== + +.. toctree:: + :maxdepth: 2 + +.. autofunction:: pysnmp.hlapi.asyncore.setCmd diff --git a/docs/source/docs/hlapi/security-configuration.rst b/docs/source/docs/hlapi/security-configuration.rst new file mode 100644 index 0000000..a5b812c --- /dev/null +++ b/docs/source/docs/hlapi/security-configuration.rst @@ -0,0 +1,39 @@ + +Security Parameters +=================== + +Calls to high-level Applications API consume Security Parameters +configuration object on input. The shortcut classes described in +this section convey configuration information to SNMP engine's +Local Configuration Datastore (:RFC:`2271#section-3.4.2`). +Once committed to LCD, SNMP engine saves its configuration for +the lifetime of SNMP engine object. + +Security Parameters object is Security Model specific. +:py:class:`~pysnmp.hlapi.UsmUserData` class +serves SNMPv3 User-Based Security Model configuration, while +:py:class:`~pysnmp.hlapi.CommunityData` +class is used for Community-Based Security Model of SNMPv1/SNMPv2c. + +.. toctree:: + :maxdepth: 2 + +.. autoclass:: pysnmp.hlapi.CommunityData(communityIndex, communityName=None, mpModel=1, contextEngineId=None, contextName='', tag='') + +.. autoclass:: pysnmp.hlapi.UsmUserData(userName, authKey=None, privKey=None, authProtocol=usmNoAuthProtocol, privProtocol=usmNoPrivProtocol, securityEngineId=None) + +Identification of Authentication and Privacy Protocols is done +via constant OIDs: + +.. autodata:: pysnmp.hlapi.usmNoAuthProtocol +.. autodata:: pysnmp.hlapi.usmHMACMD5AuthProtocol +.. autodata:: pysnmp.hlapi.usmHMACSHAAuthProtocol + +.. autodata:: pysnmp.hlapi.usmNoPrivProtocol +.. autodata:: pysnmp.hlapi.usmDESPrivProtocol +.. autodata:: pysnmp.hlapi.usm3DESEDEPrivProtocol +.. autodata:: pysnmp.hlapi.usmAesCfb128Protocol +.. autodata:: pysnmp.hlapi.usmAesCfb192Protocol +.. autodata:: pysnmp.hlapi.usmAesCfb256Protocol + + diff --git a/docs/source/docs/hlapi/snmp-context.rst b/docs/source/docs/hlapi/snmp-context.rst new file mode 100644 index 0000000..d29484e --- /dev/null +++ b/docs/source/docs/hlapi/snmp-context.rst @@ -0,0 +1,23 @@ + +SNMP Context +============ + +Calls to high-level Applications API consume SNMP Context +configuration object on input. The shortcut class described in +this section convey this MIB instance identification information +to SNMP PDU for further communication to peer SNMP engine +(:RFC:`3411#section-4.1`). + +.. note:: + + SNMP context is only defined within SNMPv3 framework. For SNMPv1/v2c + architecture integration :RFC:`2576#section-5.1` introduces + interoperability aid which is available through + :py:class:`~pysnmp.hlapi.CommunityData`. + + +.. toctree:: + :maxdepth: 2 + +.. autoclass:: pysnmp.hlapi.ContextData + diff --git a/docs/source/docs/v3arch/snmp-engine.rst b/docs/source/docs/v3arch/snmp-engine.rst index 339d618..f72c737 100644 --- a/docs/source/docs/v3arch/snmp-engine.rst +++ b/docs/source/docs/v3arch/snmp-engine.rst @@ -3,11 +3,11 @@ SNMP Engine =========== SNMP Engine is a central, stateful object used by all SNMP v3 -substsems. Calls to oneliner Applications API also consume SNMP +substsems. Calls to high-level Applications API also consume SNMP Engine object on input. .. toctree:: :maxdepth: 2 -.. autoclass:: pysnmp.entity.engine.SnmpEngine(snmpEngineID=None) +.. autoclass:: pysnmp.hlapi.asyncore.SnmpEngine(snmpEngineID=None) |