diff options
Diffstat (limited to 'docs/source/docs/v3arch')
15 files changed, 257 insertions, 0 deletions
diff --git a/docs/source/docs/v3arch/asyncore/contents.rst b/docs/source/docs/v3arch/asyncore/contents.rst new file mode 100644 index 0000000..b385865 --- /dev/null +++ b/docs/source/docs/v3arch/asyncore/contents.rst @@ -0,0 +1,2 @@ +Standard SNMP Apps with Asyncore +================================ diff --git a/docs/source/docs/v3arch/asyncore/oneliner/agent/ntforg/contents.rst b/docs/source/docs/v3arch/asyncore/oneliner/agent/ntforg/contents.rst new file mode 100644 index 0000000..80966d7 --- /dev/null +++ b/docs/source/docs/v3arch/asyncore/oneliner/agent/ntforg/contents.rst @@ -0,0 +1,12 @@ + +Synchronous Notification Originator +=================================== + +Functions dscribed in this section return generators that perform +blocking SNMP queries. See :RFC:`3413#section-3.2` for more information +on the Notification Originator Applications. + +.. toctree:: + :maxdepth: 2 + + /docs/v3arch/asyncore/oneliner/agent/ntforg/notification diff --git a/docs/source/docs/v3arch/asyncore/oneliner/agent/ntforg/notification.rst b/docs/source/docs/v3arch/asyncore/oneliner/agent/ntforg/notification.rst new file mode 100644 index 0000000..b6061ad --- /dev/null +++ b/docs/source/docs/v3arch/asyncore/oneliner/agent/ntforg/notification.rst @@ -0,0 +1,8 @@ + +Notification Originator +======================= + +.. toctree:: + :maxdepth: 2 + +.. autofunction:: pysnmp.entity.rfc3413.oneliner.ntforg.sendNotification diff --git a/docs/source/docs/v3arch/asyncore/oneliner/contents.rst b/docs/source/docs/v3arch/asyncore/oneliner/contents.rst new file mode 100644 index 0000000..5bd2df3 --- /dev/null +++ b/docs/source/docs/v3arch/asyncore/oneliner/contents.rst @@ -0,0 +1,95 @@ + +High-level SNMP +=============== + +There are a handful of most basic SNMP Applications defined by RFC3413 and +called Standard Applications. Those implementing Manager side of the system +(:RFC:`3411#section-3.1.3.1`) are Command Generator (initiating GET, SET, +GETNEXT, GETBULK operations) and Notification Receiver (handling arrived +notifications). On Agent side (:RFC:`3411#section-3.1.3.2`) there are +Command Responder (handling GET, SET, GETNEXT, GETBULK operations) and +Notification Originator (issuing TRAP and INFORM notifications). In +PySNMP Standard Applications are implemented on top of SNMPv3 framework. + +There're two kinds of high-level programming interfaces to Standard SNMP +Applications: synchronous and asynchronous. They are similar in terms of +call signatures but differ in behaviour. Synchronous calls block the whole +application till requested operation is finished. Asynchronous interface +breaks its synchronous version apart - at first required data are prepared +and put on the outgoing queue. The the application is free to deal with +other tasks till pending message is sent out (by I/O dispacher) and +response is arrived. At that point a previously supplied callback function +will be invoked and response data will be passed along. + +.. toctree:: + :maxdepth: 2 + + /docs/v3arch/asyncore/oneliner/manager/cmdgen/contents + /docs/v3arch/asyncore/oneliner/agent/ntforg/contents + +The asynchronous version is best suited for massively parallel SNMP +messaging possibly handling other I/O activities in the same time. The +synchronous version is advised to employ for singular and blocking +operations as well as for rapid prototyping. + +.. toctree:: + :maxdepth: 2 + + /docs/v3arch/asyncore/oneliner/manager/cmdgen/async.rst + /docs/v3arch/asyncore/oneliner/agent/ntforg/async.rst + +SNMP security configuration is conveyed to SNMP engine via +:py:class:`~pysnmp.entity.rfc3413.oneliner.auth.CommunityName` +and :py:class:`~pysnmp.entity.rfc3413.oneliner.auth.UsmUserData` +classes: + +.. toctree:: + :maxdepth: 2 + + /docs/v3arch/asyncore/oneliner/security-configuration + +Type of network transport SNMP engine uses along with transport +options is summarized by +:py:class:`~pysnmp.entity.rfc3413.oneliner.target.UdpTransportTarget` +and +:py:class:`~pysnmp.entity.rfc3413.oneliner.target.Udp6TransportTarget` +container classes: + +.. toctree:: + :maxdepth: 2 + + /docs/v3arch/asyncore/oneliner/transport-configuration + +SNMP engine may serve several instances of the same MIB within +possibly multiple SNMP entities. SNMP context is a method to +unambiguously identify a collection of MIB variables behind +SNMP engine. +See :RFC:`3411#section-3.3.1` for details. + +.. toctree:: + :maxdepth: 2 + + /docs/v3arch/asyncore/oneliner/snmp-context + +MIB variables represent a collection of managed objects, +residing in MIBs. Command Generator applications refer +to MIB variables and their values using +:py:class:`~pysnmp.smi.rfc1902.ObjectType` and +:py:class:`~pysnmp.smi.rfc1902.ObjectIdentity` classes. + +.. toctree:: + :maxdepth: 2 + + /docs/smi/mib-variables + +SNMP Notifications are enumerated and imply including certain +set of MIB variables. +Notification Originator applications refer to MIBs for MIB notifications +that are represented by +:py:class:`~pysnmp.smi.rfc1902.NotificationType` class instances. + +.. toctree:: + :maxdepth: 2 + + /docs/smi/mib-notification-types + diff --git a/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/bulkcmd.rst b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/bulkcmd.rst new file mode 100644 index 0000000..5882ca3 --- /dev/null +++ b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/bulkcmd.rst @@ -0,0 +1,8 @@ + +GETBULK Command Generator +========================= + +.. toctree:: + :maxdepth: 2 + +.. autofunction:: pysnmp.entity.rfc3413.oneliner.cmdgen.bulkCmd diff --git a/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/contents.rst b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/contents.rst new file mode 100644 index 0000000..a72c8da --- /dev/null +++ b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/contents.rst @@ -0,0 +1,15 @@ + +Synchronous Command Generator +============================= + +Functions dscribed in this section return generators that perform +blocking SNMP queries. See :RFC:`3413#section-3.1` for more information +on the Command Generator Applications. + +.. toctree:: + :maxdepth: 2 + + /docs/v3arch/asyncore/oneliner/manager/cmdgen/getcmd + /docs/v3arch/asyncore/oneliner/manager/cmdgen/setcmd + /docs/v3arch/asyncore/oneliner/manager/cmdgen/nextcmd + /docs/v3arch/asyncore/oneliner/manager/cmdgen/bulkcmd diff --git a/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/getcmd.rst b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/getcmd.rst new file mode 100644 index 0000000..cf97515 --- /dev/null +++ b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/getcmd.rst @@ -0,0 +1,8 @@ + +GET Command Generator +===================== + +.. toctree:: + :maxdepth: 2 + +.. autofunction:: pysnmp.entity.rfc3413.oneliner.cmdgen.getCmd diff --git a/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/nextcmd.rst b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/nextcmd.rst new file mode 100644 index 0000000..626ff48 --- /dev/null +++ b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/nextcmd.rst @@ -0,0 +1,8 @@ + +GETNEXT Command Generator +========================= + +.. toctree:: + :maxdepth: 2 + +.. autofunction:: pysnmp.entity.rfc3413.oneliner.cmdgen.nextCmd diff --git a/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/setcmd.rst b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/setcmd.rst new file mode 100644 index 0000000..e458c9f --- /dev/null +++ b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/setcmd.rst @@ -0,0 +1,8 @@ + +SET Command Generator +===================== + +.. toctree:: + :maxdepth: 2 + +.. autofunction:: pysnmp.entity.rfc3413.oneliner.cmdgen.setCmd diff --git a/docs/source/docs/v3arch/asyncore/oneliner/security-configuration.rst b/docs/source/docs/v3arch/asyncore/oneliner/security-configuration.rst new file mode 100644 index 0000000..86bee25 --- /dev/null +++ b/docs/source/docs/v3arch/asyncore/oneliner/security-configuration.rst @@ -0,0 +1,39 @@ + +Security Parameters +=================== + +Calls to oneliner 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.entity.rfc3413.oneliner.auth.UsmUserData` class +serves SNMPv3 User-Based Security Model configuration, while +:py:class:`~pysnmp.entity.rfc3413.oneliner.auth.CommunityData` +class is used for Community-Based Security Model of SNMPv1/SNMPv2c. + +.. toctree:: + :maxdepth: 2 + +.. autoclass:: pysnmp.entity.rfc3413.oneliner.auth.CommunityData(communityIndex, communityName=None, mpModel=1, contextEngineId=None, contextName='', tag='') + +.. autoclass:: pysnmp.entity.rfc3413.oneliner.auth.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.entity.rfc3413.oneliner.auth.usmNoAuthProtocol +.. autodata:: pysnmp.entity.rfc3413.oneliner.auth.usmHMACMD5AuthProtocol +.. autodata:: pysnmp.entity.rfc3413.oneliner.auth.usmHMACSHAAuthProtocol + +.. autodata:: pysnmp.entity.rfc3413.oneliner.auth.usmNoPrivProtocol +.. autodata:: pysnmp.entity.rfc3413.oneliner.auth.usmDESPrivProtocol +.. autodata:: pysnmp.entity.rfc3413.oneliner.auth.usm3DESEDEPrivProtocol +.. autodata:: pysnmp.entity.rfc3413.oneliner.auth.usmAesCfb128Protocol +.. autodata:: pysnmp.entity.rfc3413.oneliner.auth.usmAesCfb192Protocol +.. autodata:: pysnmp.entity.rfc3413.oneliner.auth.usmAesCfb256Protocol + + diff --git a/docs/source/docs/v3arch/asyncore/oneliner/snmp-context.rst b/docs/source/docs/v3arch/asyncore/oneliner/snmp-context.rst new file mode 100644 index 0000000..04fb5f1 --- /dev/null +++ b/docs/source/docs/v3arch/asyncore/oneliner/snmp-context.rst @@ -0,0 +1,23 @@ + +SNMP Context +============ + +Calls to oneliner 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.entity.rfc3413.oneliner.auth.CommunityData`. + + +.. toctree:: + :maxdepth: 2 + +.. autoclass:: pysnmp.entity.rfc3413.oneliner.ctx.ContextData + diff --git a/docs/source/docs/v3arch/asyncore/oneliner/transport-configuration.rst b/docs/source/docs/v3arch/asyncore/oneliner/transport-configuration.rst new file mode 100644 index 0000000..3aff429 --- /dev/null +++ b/docs/source/docs/v3arch/asyncore/oneliner/transport-configuration.rst @@ -0,0 +1,25 @@ + +Transport configuration +======================= + +Calls to oneliner Applications API consume Transport configuration +object on input. The following shortcut classes convey configuration +information to SNMP engine's Local Configuration Datastore +(:RFC:`2271#section-3.4.2`) as well as to underlying socket API. Once committed +to LCD, SNMP engine saves its configuration for the lifetime of SNMP +engine object. + +Transport configuration is specific to Transport domain - +:py:class:`~pysnmp.entity.rfc3413.oneliner.target.UdpTransportTarget` +class represents remote network endpoint of a UDP-over-IPv4 transport, +whereas +:py:class:`~pysnmp.entity.rfc3413.oneliner.target.Udp6TransportTarget` +is specific to UDP-over-IPv6 communication. + +.. toctree:: + :maxdepth: 2 + +.. autoclass:: pysnmp.entity.rfc3413.oneliner.target.UdpTransportTarget + +.. autoclass:: pysnmp.entity.rfc3413.oneliner.target.Udp6TransportTarget + diff --git a/docs/source/docs/v3arch/asynio/contents.rst b/docs/source/docs/v3arch/asynio/contents.rst new file mode 100644 index 0000000..4a416e0 --- /dev/null +++ b/docs/source/docs/v3arch/asynio/contents.rst @@ -0,0 +1,2 @@ +Standard SNMP Apps with Asyncio +=============================== diff --git a/docs/source/docs/v3arch/trollius/contents.rst b/docs/source/docs/v3arch/trollius/contents.rst new file mode 100644 index 0000000..a7e650b --- /dev/null +++ b/docs/source/docs/v3arch/trollius/contents.rst @@ -0,0 +1,2 @@ +Standard SNMP Apps with Trollius +================================ diff --git a/docs/source/docs/v3arch/twisted/contents.rst b/docs/source/docs/v3arch/twisted/contents.rst new file mode 100644 index 0000000..885aac3 --- /dev/null +++ b/docs/source/docs/v3arch/twisted/contents.rst @@ -0,0 +1,2 @@ +Standard SNMP Apps with Twisted +=============================== |