summaryrefslogtreecommitdiff
path: root/examples/v3arch/twisted
diff options
context:
space:
mode:
Diffstat (limited to 'examples/v3arch/twisted')
-rw-r--r--examples/v3arch/twisted/agent/cmdrsp/v1-read-and-write-communities.py36
-rw-r--r--examples/v3arch/twisted/agent/cmdrsp/v2c-custom-scalar-mib-objects.py36
-rw-r--r--examples/v3arch/twisted/agent/cmdrsp/v2c-multiple-interfaces.py36
-rw-r--r--examples/v3arch/twisted/agent/cmdrsp/v3-multiple-users.py43
-rw-r--r--examples/v3arch/twisted/agent/ntforg/inform-v2c.py38
-rw-r--r--examples/v3arch/twisted/agent/ntforg/inform-v3.py34
-rw-r--r--examples/v3arch/twisted/agent/ntforg/trap-v1.py42
-rw-r--r--examples/v3arch/twisted/agent/ntforg/trap-v2c-multiple-targets.py48
-rw-r--r--examples/v3arch/twisted/agent/ntforg/trap-v3.py34
-rw-r--r--examples/v3arch/twisted/manager/cmdgen/get-v1.py31
-rw-r--r--examples/v3arch/twisted/manager/cmdgen/get-v2c-custom-timeout.py32
-rw-r--r--examples/v3arch/twisted/manager/cmdgen/get-v3-custom-context.py36
-rw-r--r--examples/v3arch/twisted/manager/cmdgen/get-v3.py30
-rw-r--r--examples/v3arch/twisted/manager/cmdgen/getbulk-v2c.py34
-rw-r--r--examples/v3arch/twisted/manager/cmdgen/getbulk-v3.py34
-rw-r--r--examples/v3arch/twisted/manager/cmdgen/getnext-v1.py32
-rw-r--r--examples/v3arch/twisted/manager/cmdgen/getnext-v2c-from-specific-address.py34
-rw-r--r--examples/v3arch/twisted/manager/cmdgen/getnext-v3-pull-subtree.py32
-rw-r--r--examples/v3arch/twisted/manager/cmdgen/set-v1.py30
-rw-r--r--examples/v3arch/twisted/manager/cmdgen/set-v2c.py30
-rw-r--r--examples/v3arch/twisted/manager/cmdgen/set-v3.py30
-rw-r--r--examples/v3arch/twisted/manager/ntfrcv/v2c-multiple-interfaces.py39
-rw-r--r--examples/v3arch/twisted/manager/ntfrcv/v3-multiple-users.py44
23 files changed, 446 insertions, 369 deletions
diff --git a/examples/v3arch/twisted/agent/cmdrsp/v1-read-and-write-communities.py b/examples/v3arch/twisted/agent/cmdrsp/v1-read-and-write-communities.py
index d346244..da6cc5f 100644
--- a/examples/v3arch/twisted/agent/cmdrsp/v1-read-and-write-communities.py
+++ b/examples/v3arch/twisted/agent/cmdrsp/v1-read-and-write-communities.py
@@ -1,20 +1,22 @@
-#
-# Command Responder
-#
-# Listen and respond to SNMP GET/SET/GETNEXT queries with
-# the following options:
-#
-# * SNMPv1
-# * with SNMP community "public" (read access) or "private" (write access)
-# * allow access to SNMPv2-MIB objects (1.3.6.1.2.1)
-# * over IPv4/UDP, listening at 127.0.0.1:161
-# * using Twisted fraework for network transport
-#
-# The following Net-SNMP's commands will GET/SET a value at this Agent:
-#
-# $ snmpget -v1 -c public 127.0.0.1 SNMPv2-MIB::sysLocation.0
-# $ snmpset -v1 -c private 127.0.0.1 SNMPv2-MIB::sysLocation.0 s "far away"
-#
+"""
+Multiple SNMP communities
++++++++++++++++++++++++++
+
+Listen and respond to SNMP GET/SET/GETNEXT queries with
+the following options:
+
+* SNMPv1
+* with SNMP community "public" (read access) or "private" (write access)
+* allow access to SNMPv2-MIB objects (1.3.6.1.2.1)
+* over IPv4/UDP, listening at 127.0.0.1:161
+* using Twisted fraework for network transport
+
+The following Net-SNMP commands will GET/SET a value at this Agent:
+
+| $ snmpget -v1 -c public 127.0.0.1 SNMPv2-MIB::sysLocation.0
+| $ snmpset -v1 -c private 127.0.0.1 SNMPv2-MIB::sysLocation.0 s "far away"
+
+"""#
from twisted.internet import reactor
from pysnmp.entity import engine, config
from pysnmp.entity.rfc3413 import cmdrsp, context
diff --git a/examples/v3arch/twisted/agent/cmdrsp/v2c-custom-scalar-mib-objects.py b/examples/v3arch/twisted/agent/cmdrsp/v2c-custom-scalar-mib-objects.py
index 091bb75..565419d 100644
--- a/examples/v3arch/twisted/agent/cmdrsp/v2c-custom-scalar-mib-objects.py
+++ b/examples/v3arch/twisted/agent/cmdrsp/v2c-custom-scalar-mib-objects.py
@@ -1,20 +1,22 @@
-#
-# Command Responder
-#
-# Listen and respond to SNMP GET/SET/GETNEXT/GETBULK queries with
-# the following options:
-#
-# * SNMPv2c
-# * with SNMP community "public"
-# * serving custom Managed Object Instance defined within this script
-# * allow read access only to the subtree where the custom MIB object resides
-# * over IPv4/UDP, listening at 127.0.0.1:161
-# * using Twisted fraework for network transport
-#
-# Either of the following Net-SNMP's commands will walk this Agent:
-#
-# $ snmpwalk -v2c -c public 127.0.0.1 .1.3.6
-#
+"""
+Implementing scalar MIB objects
++++++++++++++++++++++++++++++++
+
+Listen and respond to SNMP GET/SET/GETNEXT/GETBULK queries with
+the following options:
+
+* SNMPv2c
+* with SNMP community "public"
+* serving custom Managed Object Instance defined within this script
+* allow read access only to the subtree where the custom MIB object resides
+* over IPv4/UDP, listening at 127.0.0.1:161
+* using Twisted fraework for network transport
+
+Either of the following Net-SNMP commands will walk this Agent:
+
+| $ snmpwalk -v2c -c public 127.0.0.1 .1.3.6
+
+"""#
import sys
from twisted.internet import reactor
from pysnmp.entity import engine, config
diff --git a/examples/v3arch/twisted/agent/cmdrsp/v2c-multiple-interfaces.py b/examples/v3arch/twisted/agent/cmdrsp/v2c-multiple-interfaces.py
index 4f8b29d..a9e3e00 100644
--- a/examples/v3arch/twisted/agent/cmdrsp/v2c-multiple-interfaces.py
+++ b/examples/v3arch/twisted/agent/cmdrsp/v2c-multiple-interfaces.py
@@ -1,20 +1,22 @@
-#
-# Command Responder
-#
-# Listen and respond to SNMP GET/SET/GETNEXT/GETBULK queries with
-# the following options:
-#
-# * SNMPv2c
-# * with SNMP community "public"
-# * allow access to SNMPv2-MIB objects (1.3.6.1.2.1)
-# * over IPv4/UDP, listening at 127.0.0.1:161 and 127.0.0.2:161 interfaces
-# * using Twisted framework for network transport
-#
-# Either of the following Net-SNMP's commands will walk this Agent:
-#
-# $ snmpwalk -v2c -c public 127.0.0.1 .1.3.6
-# $ snmpwalk -v2c -c public 127.0.0.2 .1.3.6
-#
+"""
+Listen on multiple network interfaces
++++++++++++++++++++++++++++++++++++++
+
+Listen and respond to SNMP GET/SET/GETNEXT/GETBULK queries with
+the following options:
+
+* SNMPv2c
+* with SNMP community "public"
+* allow access to SNMPv2-MIB objects (1.3.6.1.2.1)
+* over IPv4/UDP, listening at 127.0.0.1:161 and 127.0.0.2:161 interfaces
+* using Twisted framework for network transport
+
+Either of the following Net-SNMP commands will walk this Agent:
+
+| $ snmpwalk -v2c -c public 127.0.0.1 .1.3.6
+| $ snmpwalk -v2c -c public 127.0.0.2 .1.3.6
+
+"""#
from twisted.internet import reactor
from pysnmp.entity import engine, config
from pysnmp.entity.rfc3413 import cmdrsp, context
diff --git a/examples/v3arch/twisted/agent/cmdrsp/v3-multiple-users.py b/examples/v3arch/twisted/agent/cmdrsp/v3-multiple-users.py
index 36d9d36..91fd955 100644
--- a/examples/v3arch/twisted/agent/cmdrsp/v3-multiple-users.py
+++ b/examples/v3arch/twisted/agent/cmdrsp/v3-multiple-users.py
@@ -1,23 +1,26 @@
-#
-# Command Responder
-#
-# Listen and respond to SNMP GET/SET/GETNEXT/GETBULK queries with
-# the following options:
-#
-# * SNMPv3
-# * with USM user 'usr-md5-des', auth: MD5, priv DES or
-# with USM user 'usr-sha-none', auth: SHA, no privacy
-# with USM user 'usr-sha-aes128', auth: SHA, priv AES
-# * allow access to SNMPv2-MIB objects (1.3.6.1.2.1)
-# * over IPv4/UDP, listening at 127.0.0.1:161
-# * using Twisted framework for network transport
-#
-# Either of the following Net-SNMP's commands will walk this Agent:
-#
-# $ snmpwalk -v3 -u usr-md5-des -l authPriv -A authkey1 -X privkey1 localhost .1.3.6
-# $ snmpwalk -v3 -u usr-sha-none -l authNoPriv -a SHA -A authkey1 localhost .1.3.6
-# $ snmpwalk -v3 -u usr-sha-aes128 -l authPriv -a SHA -A authkey1 -x AES -X privkey1 localhost .1.3.6
-#
+"""
+Multiple SNMP USM users
++++++++++++++++++++++++
+
+Listen and respond to SNMP GET/SET/GETNEXT/GETBULK queries with
+the following options:
+
+* SNMPv3
+* with USM user:
+ * 'usr-md5-des', auth: MD5, priv DES or
+ * 'usr-sha-none', auth: SHA, no privacy
+ * 'usr-sha-aes128', auth: SHA, priv AES
+* allow access to SNMPv2-MIB objects (1.3.6.1.2.1)
+* over IPv4/UDP, listening at 127.0.0.1:161
+* using Twisted framework for network transport
+
+Either of the following Net-SNMP commands will walk this Agent:
+
+| $ snmpwalk -v3 -u usr-md5-des -l authPriv -A authkey1 -X privkey1 localhost .1.3.6
+| $ snmpwalk -v3 -u usr-sha-none -l authNoPriv -a SHA -A authkey1 localhost .1.3.6
+| $ snmpwalk -v3 -u usr-sha-aes128 -l authPriv -a SHA -A authkey1 -x AES -X privkey1 localhost .1.3.6
+
+"""#
from twisted.internet import reactor
from pysnmp.entity import engine, config
from pysnmp.entity.rfc3413 import cmdrsp, context
diff --git a/examples/v3arch/twisted/agent/ntforg/inform-v2c.py b/examples/v3arch/twisted/agent/ntforg/inform-v2c.py
index 95ba561..77245fe 100644
--- a/examples/v3arch/twisted/agent/ntforg/inform-v2c.py
+++ b/examples/v3arch/twisted/agent/ntforg/inform-v2c.py
@@ -1,19 +1,25 @@
-#
-# Notification Originator
-#
-# Send SNMP INFORM notification using the following options:
-#
-# * SNMPv2c
-# * with community name 'public'
-# * over IPv4/UDP
-# * using Twisted framework for network transport
-# * send INFORM notification
-# * to a Manager at 127.0.0.1:162
-# * with TRAP ID 'coldStart' specified as an OID
-# * include managed objects information:
-# 1.3.6.1.2.1.1.1.0 = 'Example Notificator'
-# 1.3.6.1.2.1.1.5.0 = 'Notificator Example'
-#
+"""
+SNMPv2c INFORM
+++++++++++++++
+
+Send SNMP INFORM notification using the following options:
+
+* SNMPv2c
+* with community name 'public'
+* over IPv4/UDP
+* using Twisted framework for network transport
+* send INFORM notification
+* to a Manager at 127.0.0.1:162
+* with TRAP ID 'coldStart' specified as an OID
+* include managed objects information:
+ * 1.3.6.1.2.1.1.1.0 = 'Example Notificator'
+ * 1.3.6.1.2.1.1.5.0 = 'Notificator Example'
+
+Functionally similar to:
+
+| $ snmpinform -v2c -c public 127.0.0.2 0 1.3.6.1.6.3.1.1.5.1 1.3.6.1.2.1.1.1.0 s 'Example notification' 1.3.6.1.2.1.1.5.0 s 'Notificator Example'
+
+"""#
from twisted.internet import reactor
from pysnmp.entity import engine, config
from pysnmp.carrier.twisted.dgram import udp
diff --git a/examples/v3arch/twisted/agent/ntforg/inform-v3.py b/examples/v3arch/twisted/agent/ntforg/inform-v3.py
index 376da6e..4473326 100644
--- a/examples/v3arch/twisted/agent/ntforg/inform-v3.py
+++ b/examples/v3arch/twisted/agent/ntforg/inform-v3.py
@@ -1,17 +1,23 @@
-#
-# Notification Originator
-#
-# Send SNMP INFORM notification using the following options:
-#
-# * SNMPv3
-# * with user 'usr-md5-none', auth: MD5, priv NONE
-# * over IPv4/UDP
-# * using Twisted framework for network transport
-# * to a Manager at 127.0.0.1:162
-# * send INFORM notification
-# * with TRAP ID 'warmStart' specified as an OID
-# * include managed object information 1.3.6.1.2.1.1.5.0 = 'system name'
-#
+"""
+SNMPv3 INFORM
++++++++++++++
+
+Send SNMP INFORM notification using the following options:
+
+* SNMPv3
+* with user 'usr-md5-none', auth: MD5, priv NONE
+* over IPv4/UDP
+* using Twisted framework for network transport
+* to a Manager at 127.0.0.1:162
+* send INFORM notification
+* with TRAP ID 'warmStart' specified as an OID
+* include managed object information 1.3.6.1.2.1.1.5.0 = 'system name'
+
+Functionally similar to:
+
+| $ snmpinform -v3 -l authPriv -u usr-md5-none -A authkey1 127.0.0.1 0 1.3.6.1.6.3.1.1.5.2 1.3.6.1.2.1.1.5.0 s 'system name'
+
+"""#
from twisted.internet import reactor
from pysnmp.entity import engine, config
from pysnmp.carrier.twisted.dgram import udp
diff --git a/examples/v3arch/twisted/agent/ntforg/trap-v1.py b/examples/v3arch/twisted/agent/ntforg/trap-v1.py
index 6863e0d..587314a 100644
--- a/examples/v3arch/twisted/agent/ntforg/trap-v1.py
+++ b/examples/v3arch/twisted/agent/ntforg/trap-v1.py
@@ -1,21 +1,27 @@
-#
-# Notification Originator
-#
-# Send SNMP notification using the following options:
-#
-# * SNMPv1
-# * with community name 'public'
-# * over IPv4/UDP
-# * using Twisted framework for network transport
-# * to a Manager at 127.0.0.1:162
-# * send TRAP notification
-# * with TRAP ID 'coldStart' specified as an OID
-# * include managed objects information:
-# * overriding Uptime value with 12345
-# * overriding Agent Address with '127.0.0.1'
-# * overriding Enterprise OID with 1.3.6.1.4.1.20408.4.1.1.2
-# * include managed object information '1.3.6.1.2.1.1.1.0' = 'my system'
-#
+"""
+SNMPv1 TRAP
++++++++++++
+
+Send SNMP notification using the following options:
+
+* SNMPv1
+* with community name 'public'
+* over IPv4/UDP
+* using Twisted framework for network transport
+* to a Manager at 127.0.0.1:162
+* send TRAP notification
+* with TRAP ID 'coldStart' specified as an OID
+* include managed objects information:
+* overriding Uptime value with 12345
+* overriding Agent Address with '127.0.0.1'
+* overriding Enterprise OID with 1.3.6.1.4.1.20408.4.1.1.2
+* include managed object information '1.3.6.1.2.1.1.1.0' = 'my system'
+
+Functionally similar to:
+
+| $ snmptrap -v1 -c public 127.0.0.1 1.3.6.1.4.1.20408.4.1.1.2 127.0.0.1 6 432 12345 1.3.6.1.2.1.1.1.0 s 'my system'
+
+"""#
from twisted.internet import reactor
from pysnmp.entity import engine, config
from pysnmp.carrier.twisted.dgram import udp
diff --git a/examples/v3arch/twisted/agent/ntforg/trap-v2c-multiple-targets.py b/examples/v3arch/twisted/agent/ntforg/trap-v2c-multiple-targets.py
index c63dc37..f1e95bf 100644
--- a/examples/v3arch/twisted/agent/ntforg/trap-v2c-multiple-targets.py
+++ b/examples/v3arch/twisted/agent/ntforg/trap-v2c-multiple-targets.py
@@ -1,20 +1,34 @@
-#
-# Notification Originator
-#
-# Send SNMP TRAP notifications to multiple Managers using the
-# following options:
-#
-# * SNMPv2c
-# * with community name 'public'
-# * over IPv4/UDP
-# * using Twisted framework for network transport
-# * send TRAP notification
-# * to multiple Managers at 127.0.0.1:162, 127.0.0.2:162
-# * with TRAP ID 'coldStart' specified as an OID
-# * include managed objects information:
-# 1.3.6.1.2.1.1.1.0 = 'Example Notificator'
-# 1.3.6.1.2.1.1.5.0 = 'Notificator Example'
-#
+"""
+Notification to multiple addresses
+++++++++++++++++++++++++++++++++++
+
+Send SNMP TRAP notifications to multiple Managers using the
+following options:
+
+* SNMPv2c
+* with community name 'public'
+* over IPv4/UDP
+* using Twisted framework for network transport
+* send TRAP notification
+* to multiple Managers at 127.0.0.1:162, 127.0.0.2:162 and 127.0.0.3:162
+* with TRAP ID 'coldStart' specified as an OID
+* include managed objects information:
+ * 1.3.6.1.2.1.1.1.0 = 'Example Notificator'
+ * 1.3.6.1.2.1.1.5.0 = 'Notificator Example'
+
+Functionally similar to:
+
+| $ snmptrap -v2c -c public 127.0.0.1 0 1.3.6.1.6.3.1.1.5.1 1.3.6.1.2.1.1.1.0 s 'Example notification' 1.3.6.1.2.1.1.5.0 s 'Notificator Example'
+
+and
+
+| $ snmptrap -v2c -c public 127.0.0.2 0 1.3.6.1.6.3.1.1.5.1 1.3.6.1.2.1.1.1.0 s 'Example notification' 1.3.6.1.2.1.1.5.0 s 'Notificator Example'
+
+and
+
+| $ snmptrap -v2c -c public 127.0.0.3 0 1.3.6.1.6.3.1.1.5.1 1.3.6.1.2.1.1.1.0 s 'Example notification' 1.3.6.1.2.1.1.5.0 s 'Notificator Example'
+
+"""#
from twisted.internet import reactor
from pysnmp.entity import engine, config
from pysnmp.carrier.twisted.dgram import udp
diff --git a/examples/v3arch/twisted/agent/ntforg/trap-v3.py b/examples/v3arch/twisted/agent/ntforg/trap-v3.py
index c38e474..133f723 100644
--- a/examples/v3arch/twisted/agent/ntforg/trap-v3.py
+++ b/examples/v3arch/twisted/agent/ntforg/trap-v3.py
@@ -1,17 +1,23 @@
-#
-# Notification Originator
-#
-# Send SNMP TRAP notification using the following options:
-#
-# * SNMPv3
-# * with user 'usr-md5-des', auth: MD5, priv DES
-# * over IPv4/UDP
-# * using Twisted framework for network transport
-# * send TRAP notification
-# * to a Manager at 127.0.0.1:162
-# * with TRAP ID 'warmStart' specified as an OID
-# * include managed object information 1.3.6.1.2.1.1.5.0 = 'system name'
-#
+"""
+SNMPv3 TRAP
++++++++++++
+
+Send SNMP TRAP notification using the following options:
+
+* SNMPv3
+* with user 'usr-md5-des', auth: MD5, priv DES
+* over IPv4/UDP
+* using Twisted framework for network transport
+* send TRAP notification
+* to a Manager at 127.0.0.1:162
+* with TRAP ID 'warmStart' specified as an OID
+* include managed object information 1.3.6.1.2.1.1.5.0 = 'system name'
+
+Functionally similar to:
+
+| $ snmptrap -v3 -l authPriv -u usr-md5-des -A authkey1 -X privkey1 -e 8000000001020304 0 1.3.6.1.6.3.1.1.5.1 1.3.6.1.2.1.1.5.0 s 'my system'
+
+"""#
from twisted.internet import reactor
from pysnmp.entity import engine, config
from pysnmp.carrier.twisted.dgram import udp
diff --git a/examples/v3arch/twisted/manager/cmdgen/get-v1.py b/examples/v3arch/twisted/manager/cmdgen/get-v1.py
index 38428c6..2939f41 100644
--- a/examples/v3arch/twisted/manager/cmdgen/get-v1.py
+++ b/examples/v3arch/twisted/manager/cmdgen/get-v1.py
@@ -1,17 +1,20 @@
-#
-# GET Command Generator
-#
-# Send a SNMP GET request
-# with SNMPv1, community 'public'
-# using Twisted framework for network transport
-# over IPv4/UDP
-# to an Agent at 195.218.195.228:161
-# for an OID in tuple form
-#
-# This script performs similar to the following Net-SNMP command:
-#
-# $ snmpget -v1 -c public -ObentU 195.218.195.228 1.3.6.1.2.1.1.1.0
-#
+"""
+SNMPv1 GET
+++++++++++
+
+Send SNMP GET request with the following options:
+
+* with SNMPv1, community 'public'
+* using Twisted framework for network transport
+* over IPv4/UDP
+* to an Agent at 195.218.195.228:161
+* for an OID in tuple form
+
+This script performs similar to the following Net-SNMP command:
+
+| $ snmpget -v1 -c public -ObentU 195.218.195.228 1.3.6.1.2.1.1.1.0
+
+"""#
from twisted.internet import reactor, defer
from pysnmp.entity import engine, config
from pysnmp.entity.rfc3413.twisted import cmdgen
diff --git a/examples/v3arch/twisted/manager/cmdgen/get-v2c-custom-timeout.py b/examples/v3arch/twisted/manager/cmdgen/get-v2c-custom-timeout.py
index 246a1b9..e83e5e8 100644
--- a/examples/v3arch/twisted/manager/cmdgen/get-v2c-custom-timeout.py
+++ b/examples/v3arch/twisted/manager/cmdgen/get-v2c-custom-timeout.py
@@ -1,18 +1,20 @@
-#
-# GET Command Generator
-#
-# Send a SNMP GET request
-# with SNMPv2c, community 'public'
-# using Twisted framework for network transport
-# over IPv4/UDP
-# to an Agent at 195.218.195.228:161
-# wait 3 seconds for response, retry 5 times (plus one initial attempt)
-# for an OID in tuple form
-#
-# This script performs similar to the following Net-SNMP command:
-#
-# $ snmpget -v2c -c public -ObentU -r 5 -t 1 195.218.195.228 1.3.6.1.2.1.1.1.0
-#
+"""
+Fetch scalar value with timeout
++++++++++++++++++++++++++++++++
+
+Send a SNMP GET request
+* with SNMPv2c, community 'public'
+* using Twisted framework for network transport
+* over IPv4/UDP
+* to an Agent at 195.218.195.228:161
+* wait 3 seconds for response, retry 5 times (plus one initial attempt)
+* for an OID in tuple form
+
+This script performs similar to the following Net-SNMP command:
+
+| $ snmpget -v2c -c public -ObentU -r 5 -t 1 195.218.195.228 1.3.6.1.2.1.1.1.0
+
+"""#
from twisted.internet import reactor, defer
from pysnmp.entity import engine, config
from pysnmp.entity.rfc3413.twisted import cmdgen
diff --git a/examples/v3arch/twisted/manager/cmdgen/get-v3-custom-context.py b/examples/v3arch/twisted/manager/cmdgen/get-v3-custom-context.py
index e85babe..527125f 100644
--- a/examples/v3arch/twisted/manager/cmdgen/get-v3-custom-context.py
+++ b/examples/v3arch/twisted/manager/cmdgen/get-v3-custom-context.py
@@ -1,20 +1,22 @@
-#
-# GET Command Generator
-#
-# Send a SNMP GET request
-# with SNMPv3 with user 'usr-md5-none', SHA auth and no privacy protocols
-# for MIB instance identified by
-# contextEngineId: 0x80004fb805636c6f75644dab22cc
-# contextName: da761cfc8c94d3aceef4f60f049105ba
-# using Twisted framework for network transport
-# over IPv4/UDP
-# to an Agent at 195.218.195.228:161
-# for an OID in tuple form
-#
-# This script performs similar to the following Net-SNMP command:
-#
-# $ snmpget -v3 -l authNoPriv -u usr-md5-none -A authkey1 -E 80004fb805636c6f75644dab22cc -n da761cfc8c94d3aceef4f60f049105ba -ObentU 195.218.195.228:161 1.3.6.1.2.1.1.1.0
-#
+"""
+Custom ContextEngineId and ContextName
+++++++++++++++++++++++++++++++++++++++
+
+Send a SNMP GET request
+* with SNMPv3 with user 'usr-md5-none', SHA auth and no privacy protocols
+* for MIB instance identified by
+* contextEngineId: 0x80004fb805636c6f75644dab22cc
+* contextName: da761cfc8c94d3aceef4f60f049105ba
+* using Twisted framework for network transport
+* over IPv4/UDP
+* to an Agent at 195.218.195.228:161
+* for an OID in tuple form
+
+This script performs similar to the following Net-SNMP command:
+
+| $ snmpget -v3 -l authNoPriv -u usr-md5-none -A authkey1 -E 80004fb805636c6f75644dab22cc -n da761cfc8c94d3aceef4f60f049105ba -ObentU 195.218.195.228:161 1.3.6.1.2.1.1.1.0
+
+"""#
from twisted.internet import reactor, defer
from pysnmp.entity import engine, config
from pysnmp.entity.rfc3413.twisted import cmdgen
diff --git a/examples/v3arch/twisted/manager/cmdgen/get-v3.py b/examples/v3arch/twisted/manager/cmdgen/get-v3.py
index 0e3ab3e..d0a568d 100644
--- a/examples/v3arch/twisted/manager/cmdgen/get-v3.py
+++ b/examples/v3arch/twisted/manager/cmdgen/get-v3.py
@@ -1,17 +1,19 @@
-#
-# GET Command Generator
-#
-# Send a SNMP GET request
-# with SNMPv3 with user 'usr-sha-aes', SHA auth and AES128 privacy protocols
-# using Twisted framework for network transport
-# over IPv4/UDP
-# to an Agent at 195.218.195.228:161
-# for an OID in tuple form
-#
-# This script performs similar to the following Net-SNMP command:
-#
-# $ snmpget -v3 -l authPriv -u usr-sha-aes -a SHA -A authkey1 -x AES -X privkey1 -ObentU 195.218.195.228:161 1.3.6.1.2.1.1.1.0
-#
+"""
+SNMPv3, auth: SHA, privacy: AES
++++++++++++++++++++++++++++++++
+
+Send a SNMP GET request
+* with SNMPv3 with user 'usr-sha-aes', SHA auth and AES128 privacy protocols
+* using Twisted framework for network transport
+* over IPv4/UDP
+* to an Agent at 195.218.195.228:161
+* for an OID in tuple form
+
+This script performs similar to the following Net-SNMP command:
+
+| $ snmpget -v3 -l authPriv -u usr-sha-aes -a SHA -A authkey1 -x AES -X privkey1 -ObentU 195.218.195.228:161 1.3.6.1.2.1.1.1.0
+
+"""#
from twisted.internet import reactor, defer
from pysnmp.entity import engine, config
from pysnmp.entity.rfc3413.twisted import cmdgen
diff --git a/examples/v3arch/twisted/manager/cmdgen/getbulk-v2c.py b/examples/v3arch/twisted/manager/cmdgen/getbulk-v2c.py
index d5733aa..7adf6fe 100644
--- a/examples/v3arch/twisted/manager/cmdgen/getbulk-v2c.py
+++ b/examples/v3arch/twisted/manager/cmdgen/getbulk-v2c.py
@@ -1,19 +1,21 @@
-#
-# GETBULK Command Generator
-#
-# Send a series of SNMP GETBULK requests
-# with SNMPv2c, community 'public'
-# using Twisted framework for network transport
-# over IPv4/UDP
-# to an Agent at 195.218.195.228:161
-# with values non-repeaters = 0, max-repetitions = 25
-# for two OIDs in tuple form
-# stop on end-of-mib condition for both OIDs
-#
-# This script performs similar to the following Net-SNMP command:
-#
-# $ snmpbulkwalk -v2c -c public -C n0 -C r25 -ObentU 195.218.195.228 1.3.6.1.2.1.1 1.3.6.1.4.1.1
-#
+"""
+Bulk walk MIB (SNMPv2c)
++++++++++++++++++++++++
+
+Send a series of SNMP GETBULK requests
+* with SNMPv2c, community 'public'
+* using Twisted framework for network transport
+* over IPv4/UDP
+* to an Agent at 195.218.195.228:161
+* with values non-repeaters = 0, max-repetitions = 25
+* for two OIDs in tuple form
+* stop on end-of-mib condition for both OIDs
+
+This script performs similar to the following Net-SNMP command:
+
+| $ snmpbulkwalk -v2c -c public -C n0 -C r25 -ObentU 195.218.195.228 1.3.6.1.2.1.1 1.3.6.1.4.1.1
+
+"""#
from twisted.internet import reactor, defer
from pysnmp.entity import engine, config
from pysnmp.entity.rfc3413.twisted import cmdgen
diff --git a/examples/v3arch/twisted/manager/cmdgen/getbulk-v3.py b/examples/v3arch/twisted/manager/cmdgen/getbulk-v3.py
index 2b734a1..04aa188 100644
--- a/examples/v3arch/twisted/manager/cmdgen/getbulk-v3.py
+++ b/examples/v3arch/twisted/manager/cmdgen/getbulk-v3.py
@@ -1,19 +1,21 @@
-#
-# GETBULK Command Generator
-#
-# Send a series of SNMP GETBULK requests
-# with SNMPv3 with user 'usr-md5-des', MD5 auth and DES privacy protocols
-# over IPv4/UDP
-# using Twisted framework for network transport
-# to an Agent at 195.218.195.228:161
-# with values non-repeaters = 1, max-repetitions = 25
-# for two OIDs in tuple form (first OID is non-repeating)
-# stop on end-of-mib condition for both OIDs
-#
-# This script performs similar to the following Net-SNMP command:
-#
-# $ snmpbulkwalk -v3 -l authPriv -u usr-md5-des -A authkey1 -X privkey1 -C n1 -C r25 -ObentU 195.218.195.228 1.3.6.1.2.1.1 1.3.6.1.4.1.1
-#
+"""
+Walk and Bulk walk OIDs
++++++++++++++++++++++++
+
+Send a series of SNMP GETBULK requests
+* with SNMPv3 with user 'usr-md5-des', MD5 auth and DES privacy protocols
+* over IPv4/UDP
+* using Twisted framework for network transport
+* to an Agent at 195.218.195.228:161
+* with values non-repeaters = 1, max-repetitions = 25
+* for two OIDs in tuple form (first OID is non-repeating)
+* stop on end-of-mib condition for both OIDs
+
+This script performs similar to the following Net-SNMP command:
+
+| $ snmpbulkwalk -v3 -l authPriv -u usr-md5-des -A authkey1 -X privkey1 -C n1 -C r25 -ObentU 195.218.195.228 1.3.6.1.2.1.1 1.3.6.1.4.1.1
+
+"""#
from twisted.internet import reactor, defer
from pysnmp.entity import engine, config
from pysnmp.entity.rfc3413.twisted import cmdgen
diff --git a/examples/v3arch/twisted/manager/cmdgen/getnext-v1.py b/examples/v3arch/twisted/manager/cmdgen/getnext-v1.py
index dede0ab..b7f4bb8 100644
--- a/examples/v3arch/twisted/manager/cmdgen/getnext-v1.py
+++ b/examples/v3arch/twisted/manager/cmdgen/getnext-v1.py
@@ -1,18 +1,20 @@
-#
-# GETNEXT Command Generator
-#
-# Send a series of SNMP GETNEXT requests
-# with SNMPv1, community 'public'
-# using Twisted framework for network transport
-# over IPv4/UDP
-# to an Agent at 195.218.195.228:161
-# for two OIDs in tuple form
-# stop on end-of-mib condition for both OIDs
-#
-# This script performs similar to the following Net-SNMP command:
-#
-# $ snmpwalk -v1 -c public -ObentU 195.218.195.228 1.3.6.1.2.1.1 1.3.6.1.4.1.1
-#
+"""
+Walk MIB (SNMPv1)
++++++++++++++++++
+
+Send a series of SNMP GETNEXT requests
+* with SNMPv1, community 'public'
+* using Twisted framework for network transport
+* over IPv4/UDP
+* to an Agent at 195.218.195.228:161
+* for two OIDs in tuple form
+* stop on end-of-mib condition for both OIDs
+
+This script performs similar to the following Net-SNMP command:
+
+| $ snmpwalk -v1 -c public -ObentU 195.218.195.228 1.3.6.1.2.1.1 1.3.6.1.4.1.1
+
+"""#
from twisted.internet import reactor, defer
from pysnmp.entity import engine, config
from pysnmp.entity.rfc3413.twisted import cmdgen
diff --git a/examples/v3arch/twisted/manager/cmdgen/getnext-v2c-from-specific-address.py b/examples/v3arch/twisted/manager/cmdgen/getnext-v2c-from-specific-address.py
index c27b643..902bd29 100644
--- a/examples/v3arch/twisted/manager/cmdgen/getnext-v2c-from-specific-address.py
+++ b/examples/v3arch/twisted/manager/cmdgen/getnext-v2c-from-specific-address.py
@@ -1,19 +1,21 @@
-#
-# GETNEXT Command Generator
-#
-# Send a series of SNMP GETNEXT requests
-# with SNMPv2c, community 'public'
-# using Twisted framework for network transport
-# over IPv4/UDP
-# to an Agent at 195.218.195.228:161
-# sending packets from any local interface (0.0.0.0), local port 61024
-# for two OIDs in tuple form
-# stop on end-of-mib condition for both OIDs
-#
-# This script performs similar to the following Net-SNMP command:
-#
-# $ snmpwalk -v2c -c public -ObentU 195.218.195.228 1.3.6.1.2.1.1 1.3.6.1.4.1.1
-#
+"""
+Send packets from specific local interface
+++++++++++++++++++++++++++++++++++++++++++
+
+Send a series of SNMP GETNEXT requests
+* with SNMPv2c, community 'public'
+* using Twisted framework for network transport
+* over IPv4/UDP
+* to an Agent at 195.218.195.228:161
+* sending packets from any local interface (0.0.0.0), local port 61024
+* for two OIDs in tuple form
+* stop on end-of-mib condition for both OIDs
+
+This script performs similar to the following Net-SNMP command:
+
+| $ snmpwalk -v2c -c public -ObentU 195.218.195.228 1.3.6.1.2.1.1 1.3.6.1.4.1.1
+
+"""#
from twisted.internet import reactor, defer
from pysnmp.entity import engine, config
from pysnmp.entity.rfc3413.twisted import cmdgen
diff --git a/examples/v3arch/twisted/manager/cmdgen/getnext-v3-pull-subtree.py b/examples/v3arch/twisted/manager/cmdgen/getnext-v3-pull-subtree.py
index bff697e..d8e8612 100644
--- a/examples/v3arch/twisted/manager/cmdgen/getnext-v3-pull-subtree.py
+++ b/examples/v3arch/twisted/manager/cmdgen/getnext-v3-pull-subtree.py
@@ -1,18 +1,20 @@
-#
-# GETNEXT Command Generator
-#
-# Send a series of SNMP GETNEXT requests
-# with SNMPv3 with user 'usr-none-none', no auth and no privacy protocols
-# over IPv4/UDP
-# using Twisted framework for network transport
-# to an Agent at 195.218.195.228:161
-# for an OID in string form
-# stop whenever received OID goes out of initial prefix (it may be a table)
-#
-# This script performs similar to the following Net-SNMP command:
-#
-# $ snmpwalk -v3 -l noAuthNoPriv -u usr-none-none -ObentU 195.218.195.228:161 1.3.6.1.2.1.1
-#
+"""
+Pull MIB subtree (SNMPv3)
++++++++++++++++++++++++++
+
+Send a series of SNMP GETNEXT requests
+* with SNMPv3 with user 'usr-none-none', no auth and no privacy protocols
+* over IPv4/UDP
+* using Twisted framework for network transport
+* to an Agent at 195.218.195.228:161
+* for an OID in string form
+* stop whenever received OID goes out of initial prefix (it may be a table)
+
+This script performs similar to the following Net-SNMP command:
+
+| $ snmpwalk -v3 -l noAuthNoPriv -u usr-none-none -ObentU 195.218.195.228:161 1.3.6.1.2.1.1
+
+"""#
from twisted.internet import reactor, defer
from pysnmp.entity import engine, config
from pysnmp.entity.rfc3413.twisted import cmdgen
diff --git a/examples/v3arch/twisted/manager/cmdgen/set-v1.py b/examples/v3arch/twisted/manager/cmdgen/set-v1.py
index c372104..fee0ed2 100644
--- a/examples/v3arch/twisted/manager/cmdgen/set-v1.py
+++ b/examples/v3arch/twisted/manager/cmdgen/set-v1.py
@@ -1,17 +1,19 @@
-#
-# SET Command Generator
-#
-# Send a SNMP SET request
-# with SNMPv1, community 'private'
-# using Twisted framework for network transport
-# over IPv4/UDP
-# to an Agent at 195.218.195.228:161
-# for OIDs in tuple form and an integer and string-typed values
-#
-# This script performs similar to the following Net-SNMP command:
-#
-# $ snmpset -v1 -c private -ObentU 195.218.195.228:161 1.3.6.1.2.1.1.9.1.3.1 s 'my value' 1.3.6.1.2.1.1.9.1.4.1 t 123
-#
+"""
+SET string and integer scalars (SNMPv1)
++++++++++++++++++++++++++++++++++++++++
+
+Send a SNMP SET request
+* with SNMPv1, community 'private'
+* using Twisted framework for network transport
+* over IPv4/UDP
+* to an Agent at 195.218.195.228:161
+* for OIDs in tuple form and an integer and string-typed values
+
+This script performs similar to the following Net-SNMP command:
+
+| $ snmpset -v1 -c private -ObentU 195.218.195.228:161 1.3.6.1.2.1.1.9.1.3.1 s 'my value' 1.3.6.1.2.1.1.9.1.4.1 t 123
+
+"""#
from twisted.internet import reactor, defer
from pysnmp.entity import engine, config
from pysnmp.entity.rfc3413.twisted import cmdgen
diff --git a/examples/v3arch/twisted/manager/cmdgen/set-v2c.py b/examples/v3arch/twisted/manager/cmdgen/set-v2c.py
index 5fd91f1..e27b6e6 100644
--- a/examples/v3arch/twisted/manager/cmdgen/set-v2c.py
+++ b/examples/v3arch/twisted/manager/cmdgen/set-v2c.py
@@ -1,17 +1,19 @@
-#
-# SET Command Generator
-#
-# Send a SNMP SET request
-# with SNMPv2c, community 'private'
-# using Twisted framework for network transport
-# over IPv4/UDP
-# to an Agent at 195.218.195.228:161
-# for OIDs in tuple form and an integer-typed value
-#
-# This script performs similar to the following Net-SNMP command:
-#
-# $ snmpset -v2c -c private -ObentU 195.218.195.228:161 1.3.6.1.2.1.1.9.1.4.1 t 123
-#
+"""
+SET integer scalar (SNMPv2c)
+++++++++++++++++++++++++++++
+
+Send a SNMP SET request
+* with SNMPv2c, community 'private'
+* using Twisted framework for network transport
+* over IPv4/UDP
+* to an Agent at 195.218.195.228:161
+* for OIDs in tuple form and an integer-typed value
+
+This script performs similar to the following Net-SNMP command:
+
+| $ snmpset -v2c -c private -ObentU 195.218.195.228:161 1.3.6.1.2.1.1.9.1.4.1 t 123
+
+"""#
from twisted.internet import reactor, defer
from pysnmp.entity import engine, config
from pysnmp.entity.rfc3413.twisted import cmdgen
diff --git a/examples/v3arch/twisted/manager/cmdgen/set-v3.py b/examples/v3arch/twisted/manager/cmdgen/set-v3.py
index 1fb7ce8..e787927 100644
--- a/examples/v3arch/twisted/manager/cmdgen/set-v3.py
+++ b/examples/v3arch/twisted/manager/cmdgen/set-v3.py
@@ -1,17 +1,19 @@
-#
-# SET Command Generator
-#
-# Send a SNMP SET request
-# with SNMPv3 with user 'usr-sha-none', SHA auth and no privacy protocols
-# using Twisted framework for network transport
-# over IPv4/UDP
-# to an Agent at 195.218.195.228:161
-# for an OID in tuple form and a string-typed value
-#
-# This script performs similar to the following Net-SNMP command:
-#
-# $ snmpset -v3 -l authNoPriv -u usr-sha-none -a SHA -A authkey1 -ObentU 195.218.195.228:161 1.3.6.1.2.1.1.9.1.3.1 s 'my new value'
-#
+"""
+SET string scalar (SNMPv3)
+++++++++++++++++++++++++++
+
+Send a SNMP SET request
+* with SNMPv3 with user 'usr-sha-none', SHA auth and no privacy protocols
+* using Twisted framework for network transport
+* over IPv4/UDP
+* to an Agent at 195.218.195.228:161
+* for an OID in tuple form and a string-typed value
+
+This script performs similar to the following Net-SNMP command:
+
+| $ snmpset -v3 -l authNoPriv -u usr-sha-none -a SHA -A authkey1 -ObentU 195.218.195.228:161 1.3.6.1.2.1.1.9.1.3.1 s 'my new value'
+
+"""#
from twisted.internet import reactor, defer
from pysnmp.entity import engine, config
from pysnmp.entity.rfc3413.twisted import cmdgen
diff --git a/examples/v3arch/twisted/manager/ntfrcv/v2c-multiple-interfaces.py b/examples/v3arch/twisted/manager/ntfrcv/v2c-multiple-interfaces.py
index 4f9b68f..b7edf7d 100644
--- a/examples/v3arch/twisted/manager/ntfrcv/v2c-multiple-interfaces.py
+++ b/examples/v3arch/twisted/manager/ntfrcv/v2c-multiple-interfaces.py
@@ -1,21 +1,24 @@
-#
-# Notification Receiver
-#
-# Receive SNMP TRAP/INFORM messages with the following options:
-#
-# * SNMPv1/SNMPv2c
-# * with SNMP community "public"
-# * over IPv4/UDP, listening at 127.0.0.1:162
-# over IPv4/UDP, listening at 127.0.0.1:2162
-# * using Twisted framework for network transport
-# * print received data on stdout
-#
-# Either of the following Net-SNMP's commands will send notifications to this
-# receiver:
-#
-# $ snmptrap -v2c -c public 127.0.0.1:162 123 1.3.6.1.6.3.1.1.5.1 1.3.6.1.2.1.1.5.0 s test
-# $ snmpinform -v2c -c public 127.0.0.1:2162 123 1.3.6.1.6.3.1.1.5.1
-#
+"""
+Serving multiple network interfaces
++++++++++++++++++++++++++++++++++++
+
+Receive SNMP TRAP/INFORM messages with the following options:
+
+* SNMPv1/SNMPv2c
+* with SNMP community "public"
+* listen on two local network interfaces:
+ * IPv4/UDP, listening at 127.0.0.1:162
+ * IPv4/UDP, listening at 127.0.0.1:2162
+* using Twisted framework for network transport
+* print received data on stdout
+
+Either of the following Net-SNMP commands will send notifications to this
+receiver:
+
+| $ snmptrap -v2c -c public 127.0.0.1:162 123 1.3.6.1.6.3.1.1.5.1 1.3.6.1.2.1.1.5.0 s test
+| $ snmpinform -v2c -c public 127.0.0.1:2162 123 1.3.6.1.6.3.1.1.5.1
+
+"""#
from twisted.internet import reactor
from pysnmp.entity import engine, config
from pysnmp.carrier.twisted.dgram import udp
diff --git a/examples/v3arch/twisted/manager/ntfrcv/v3-multiple-users.py b/examples/v3arch/twisted/manager/ntfrcv/v3-multiple-users.py
index 1192427..a82bd3d 100644
--- a/examples/v3arch/twisted/manager/ntfrcv/v3-multiple-users.py
+++ b/examples/v3arch/twisted/manager/ntfrcv/v3-multiple-users.py
@@ -1,24 +1,26 @@
-#
-# Notification Receiver
-#
-# Receive SNMP TRAP/INFORM messages with the following options:
-#
-# * SNMPv3
-# * with USM users:
-# 'usr-md5-des', auth: MD5, priv DES, ContextEngineId: 8000000001020304
-# 'usr-md5-none', auth: MD5, priv NONE, ContextEngineId: 8000000001020304
-# 'usr-sha-aes128', auth: SHA, priv AES, ContextEngineId: 8000000001020304
-# * over IPv4/UDP, listening at 127.0.0.1:162
-# * using Twisted framework for network transport
-# * print received data on stdout
-#
-# Either of the following Net-SNMP's commands will send notifications to this
-# receiver:
-#
-# $ snmptrap -v3 -u usr-md5-des -l authPriv -A authkey1 -X privkey1 -e 8000000001020304 127.0.0.1 123 1.3.6.1.6.3.1.1.5.1
-# $ snmptrap -v3 -u usr-md5-none -l authNoPriv -A authkey1 -e 8000000001020304 127.0.0.1 123 1.3.6.1.6.3.1.1.5.1
-# $ snmpinform -v3 -u usr-sha-aes128 -l authPriv -a SHA -A authkey1 -x AES -X privkey1 127.0.0.1 123 1.3.6.1.6.3.1.1.5.1
-#
+"""
+Multiple SNMP USM users
++++++++++++++++++++++++
+
+Receive SNMP TRAP/INFORM messages with the following options:
+
+* SNMPv3
+* with USM users:
+ * 'usr-md5-des', auth: MD5, priv DES, ContextEngineId: 8000000001020304
+ * 'usr-md5-none', auth: MD5, priv NONE, ContextEngineId: 8000000001020304
+ * 'usr-sha-aes128', auth: SHA, priv AES, ContextEngineId: 8000000001020304
+* over IPv4/UDP, listening at 127.0.0.1:162
+* using Twisted framework for network transport
+* print received data on stdout
+
+Either of the following Net-SNMP commands will send notifications to this
+receiver:
+
+| $ snmptrap -v3 -u usr-md5-des -l authPriv -A authkey1 -X privkey1 -e 8000000001020304 127.0.0.1 123 1.3.6.1.6.3.1.1.5.1
+| $ snmptrap -v3 -u usr-md5-none -l authNoPriv -A authkey1 -e 8000000001020304 127.0.0.1 123 1.3.6.1.6.3.1.1.5.1
+| $ snmpinform -v3 -u usr-sha-aes128 -l authPriv -a SHA -A authkey1 -x AES -X privkey1 127.0.0.1 123 1.3.6.1.6.3.1.1.5.1
+
+"""#
from twisted.internet import reactor
from pysnmp.entity import engine, config
from pysnmp.carrier.twisted.dgram import udp