proper markup and fixes

2 files changed, 198 insertions, 0 deletions

diff --git a/examples/v3arch/asyncore/agent/ntforg/send-trap-to-multiple-managers.py b/examples/v3arch/asyncore/agent/ntforg/send-trap-to-multiple-managers.py
new file mode 100644
index 0000000..0f35669
--- /dev/null
+++ b/examples/v3arch/asyncore/agent/ntforg/send-trap-to-multiple-managers.py
@@ -0,0 +1,109 @@
+"""
+Notification to multiple SNMP managers
+++++++++++++++++++++++++++++++++++++++
+
+Send SNMP TRAP notifications to multiple Managers using the
+following options:
+
+* SNMPv2c
+* with community name 'public'
+* over IPv4/UDP
+* 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'
+
+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 pysnmp.entity import engine, config
+from pysnmp.carrier.asyncore.dgram import udp
+from pysnmp.entity.rfc3413 import ntforg
+from pysnmp.proto.api import v2c
+
+# Create SNMP engine instance
+snmpEngine = engine.SnmpEngine()
+
+# SecurityName <-> CommunityName mapping
+config.addV1System(snmpEngine, 'my-area', 'public', transportTag='all-my-managers')
+
+# Specify security settings per SecurityName (SNMPv2c -> 1)
+config.addTargetParams(snmpEngine, 'my-creds', 'my-area', 'noAuthNoPriv', 1)
+
+# Setup transport endpoint and bind it with security settings yielding
+# a target name
+config.addTransport(
+    snmpEngine,
+    udp.domainName,
+    udp.UdpSocketTransport().openClientMode()
+)
+# First target
+config.addTargetAddr(
+    snmpEngine, 'my-nms-1',
+    udp.domainName, ('127.0.0.1', 162),
+    'my-creds',
+    tagList='all-my-managers'
+)
+# Second target
+config.addTargetAddr(
+    snmpEngine, 'my-nms-2',
+    udp.domainName, ('127.0.0.2', 162),
+    'my-creds',
+    tagList='all-my-managers'
+)
+# Third target
+config.addTargetAddr(
+    snmpEngine, 'my-nms-3',
+    udp.domainName, ('127.0.0.3', 162),
+    'my-creds',
+    tagList='all-my-managers'
+)
+
+# Specify what kind of notification should be sent (TRAP or INFORM)
+# to what targets (chosen by tag) and with what credentials.
+config.addNotificationTarget(
+    snmpEngine, 'my-notification', 'my-creds', 'all-my-managers', 'trap'
+)
+
+# Allow NOTIFY access to Agent's MIB by this SNMP model (2), securityLevel
+# and SecurityName
+config.addContext(snmpEngine, '')
+config.addVacmUser(snmpEngine, 2, 'my-area', 'noAuthNoPriv', (), (), (1,3,6))
+
+# *** SNMP engine configuration is complete by this line ***
+
+# Create Notification Originator App instance. 
+ntfOrg = ntforg.NotificationOriginator()
+ 
+# Build and submit notification message to dispatcher
+ntfOrg.sendVarBinds(
+    snmpEngine,
+    # Notification targets
+    'my-notification',  # notification targets
+    None, '',           # contextEngineId, contextName
+    # var-binds
+    [
+        # SNMPv2-SMI::snmpTrapOID.0 = SNMPv2-MIB::coldStart
+        ((1,3,6,1,6,3,1,1,4,1,0), v2c.ObjectIdentifier((1,3,6,1,6,3,1,1,5,1))),
+        # additional var-binds: ( (oid, value), ... )
+        ((1,3,6,1,2,1,1,1,0), v2c.OctetString('Example Notificator')),
+        ((1,3,6,1,2,1,1,5,0), v2c.OctetString('Notificator Example'))
+    ]
+)
+
+print('Notifications are scheduled to be sent')
+
+# Run I/O dispatcher which would send pending message and process response
+snmpEngine.transportDispatcher.runDispatcher()
diff --git a/examples/v3arch/asyncore/agent/ntforg/v3-trap.py b/examples/v3arch/asyncore/agent/ntforg/v3-trap.py
new file mode 100644
index 0000000..a97a975
--- /dev/null
+++ b/examples/v3arch/asyncore/agent/ntforg/v3-trap.py
@@ -0,0 +1,89 @@
+"""
+SNMPv3 TRAP, auth: MD5, privacy: DES
+++++++++++++++++++++++++++++++++++++
+
+Send SNMP TRAP notification using the following options:
+
+* SNMPv3
+* with user 'usr-md5-des', auth: MD5, priv DES
+* over IPv4/UDP
+* 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 pysnmp.entity import engine, config
+from pysnmp.carrier.asyncore.dgram import udp
+from pysnmp.entity.rfc3413 import ntforg
+from pysnmp.proto.api import v2c
+
+# Create SNMP engine instance with specific (and locally unique)
+# SnmpEngineId -- it must also be known to the receiving party
+# and configured at its VACM users table.
+snmpEngine = engine.SnmpEngine(
+    snmpEngineID=v2c.OctetString(hexValue='8000000001020304')
+)
+
+# Add USM user
+config.addV3User(
+    snmpEngine, 'usr-md5-des',
+    config.usmHMACMD5AuthProtocol, 'authkey1',
+    config.usmDESPrivProtocol, 'privkey1'
+)
+config.addTargetParams(snmpEngine, 'my-creds', 'usr-md5-des', 'authPriv')
+
+# Setup transport endpoint and bind it with security settings yielding
+# a target name
+config.addTransport(
+    snmpEngine,
+    udp.domainName,
+    udp.UdpSocketTransport().openClientMode()
+)
+config.addTargetAddr(
+    snmpEngine, 'my-nms',
+    udp.domainName, ('127.0.0.1', 162),
+    'my-creds',
+    tagList='all-my-managers'
+)
+
+# Specify what kind of notification should be sent (TRAP or INFORM),
+# to what targets (chosen by tag) and what filter should apply to
+# the set of targets (selected by tag)
+config.addNotificationTarget(
+    snmpEngine, 'my-notification', 'my-filter', 'all-my-managers', 'trap'
+)
+
+# Allow NOTIFY access to Agent's MIB by this SNMP model (3), securityLevel
+# and SecurityName
+config.addContext(snmpEngine, '')
+config.addVacmUser(snmpEngine, 3, 'usr-md5-des', 'authPriv', (), (), (1,3,6))
+
+# *** SNMP engine configuration is complete by this line ***
+
+# Create Notification Originator App instance. 
+ntfOrg = ntforg.NotificationOriginator()
+
+# Build and submit notification message to dispatcher
+ntfOrg.sendVarBinds(
+    snmpEngine,
+    # Notification targets
+    'my-notification',  # notification targets
+    None, '',           # contextEngineId, contextName
+    # var-binds
+    [
+        # SNMPv2-SMI::snmpTrapOID.0 = SNMPv2-MIB::coldStart
+        ((1,3,6,1,6,3,1,1,4,1,0), v2c.ObjectIdentifier((1,3,6,1,6,3,1,1,5,1))),
+        # additional var-binds: ( (oid, value), ... )
+        ((1,3,6,1,2,1,1,5,0), v2c.OctetString('Notificator Example'))
+    ]
+)
+
+print('Notification is scheduled to be sent')
+
+# Run I/O dispatcher which would send pending message and process response
+snmpEngine.transportDispatcher.runDispatcher()