summaryrefslogtreecommitdiff
path: root/examples/v3arch/twisted/agent/ntforg/inform-v2c.py
blob: 95ba561325aae17acc6b68f4ce3fdcda4fea3445 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
#
# 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'
#
from twisted.internet import reactor
from pysnmp.entity import engine, config
from pysnmp.carrier.twisted.dgram import udp
from pysnmp.entity.rfc3413 import context
from pysnmp.entity.rfc3413.twisted import ntforg
from pysnmp.proto import rfc1902

# Create SNMP engine instance
snmpEngine = engine.SnmpEngine()

# SecurityName <-> CommunityName mapping (+ transport binding)
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)

# Transport setup

#
# Setup transport endpoint and bind it with security settings yielding
# a target name. Since Notifications could be sent to multiple Managers
# at once, more than one target entry may be configured (and tagged).
#

# UDP/IPv4
config.addTransport(
    snmpEngine,
    udp.domainName,
    udp.UdpTwistedTransport().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', 'inform'
)

# 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))

# Create Notification Originator App instance. 
ntfOrg = ntforg.NotificationOriginator()
 
# Error/confirmation receiver
def cbFun(response, *args):
    snmpEngine, errorIndication, errorStatus, errorIndex, varBinds = response
    print('Notification status - %s' % (
        errorIndication and errorIndication or 'delivered'
      )
    )
    # Optionally stop Twisted reactor
    reactor.stop()

# Create default SNMP context where contextEngineId == SnmpEngineId
snmpContext = context.SnmpContext(snmpEngine)

# Prepare request to be sent yielding Twisted deferred object
df = ntfOrg.sendVarBinds(
    snmpEngine,
    # Notification targets
    'my-notification',
    # SNMP Context
    snmpContext,
    # contextName
    '',
    # notification name (SNMPv2-MIB::coldStart)
    (1,3,6,1,6,3,1,1,5,1),
    # notification objects instance index
    None,
    # additional var-binds: [ (oid, value), ... ]
    [ ((1,3,6,1,2,1,1,1,0), rfc1902.OctetString('Example Notificator')),
      ((1,3,6,1,2,1,1,5,0), rfc1902.OctetString('Notificator Example')) ]
)

# Register error/response receiver function at deferred
df.addCallback(cbFun)

print('Notification is scheduled to be sent')

# Run Twisted main loop
reactor.run()