summaryrefslogtreecommitdiff
path: root/examples/v3arch/agent/ntforg/trap-v2c-with-objects.py
blob: e4ac2e01d095522d71b5945340afb0ffe89af6f8 (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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
#
# Notification Originator
#
# Send SNMP TRAP notification using the following options:
#
# * SNMPv2c
# * with community name 'public'
# * over IPv4/UDP
# * send TRAP notification
# * to a Manager at 127.0.0.1:162
# * with TRAP ID ACCOUNTING-CONTROL-MIB::acctngFileFull as MIB symbol
#
# The ACCOUNTING-CONTROL-MIB::acctngFileFull NOTIFICATION-TYPE implies
# including three other var-binds into the TRAP describing the incident
# occurred. These var-binds are: 
# ACCOUNTING-CONTROL-MIB::acctngFileMaximumSize.0
# ACCOUNTING-CONTROL-MIB::acctngFileNameSuffix.0
# ACCOUNTING-CONTROL-MIB::acctngFileName.0
#
# To run this example make sure to have ACCOUNTING-CONTROL-MIB.py in
# search path.
#
from pysnmp.entity import engine, config
from pysnmp.carrier.asynsock.dgram import udp
from pysnmp.entity.rfc3413 import ntforg, context
from pysnmp.proto.api import v2c

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

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

#
# Here we fill in some values for Managed Objects Instances (invoked
# later while building TRAP message) by NOTIFICATION-TYPE macro evaluation.
# In real Agent app, these values should already be initialized during
# Agent runtime.
#

mibInstrumCtl = snmpContext.getMibInstrum('')
( MibScalarInstance, ) = mibInstrumCtl.mibBuilder.importSymbols(
                             'SNMPv2-SMI',
                             'MibScalarInstance'
                         )
( acctngFileFull,
  acctngFileMaximumSize,
  acctngFileNameSuffix,
  acctngFileName ) = mibInstrumCtl.mibBuilder.importSymbols(
                         'ACCOUNTING-CONTROL-MIB',
                         'acctngFileFull',
                         'acctngFileMaximumSize',
                         'acctngFileNameSuffix',
                         'acctngFileName'
                     )

mibInstrumCtl.mibBuilder.exportSymbols(
  '__ACCOUNTING-CONTROL-MIB',
  MibScalarInstance(acctngFileMaximumSize.name, (0,), acctngFileMaximumSize.syntax.clone(123)),
  MibScalarInstance(acctngFileNameSuffix.name, (0,), acctngFileNameSuffix.syntax.clone('.log')),
  MibScalarInstance(acctngFileName.name, (0,), acctngFileName.syntax.clone('mylogfile')),
)

#
# End of Agent's Managed Object Instances initialization
#

# 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 endpoints and bind it with security settings yielding
# a target name:

# UDP/IPv4
config.addTransport(
    snmpEngine,
    udp.domainName,
    udp.UdpSocketTransport().openClientMode()
)
config.addTargetAddr(
    snmpEngine, 'my-nms-1',
    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 (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',
    # SNMP Context
    snmpContext,
    # contextName
    '',
    # notification name
    ('ACCOUNTING-CONTROL-MIB', 'acctngFileFull'),
    # MIB scalar/table instances of NOTIFICATION-TYPE objects
    (0,)
)

print('Notification is scheduled to be sent')

# Run I/O dispatcher which would send pending message and process response
snmpEngine.transportDispatcher.runDispatcher()