1SNMPTRAPD.CONF(5) Net-SNMP SNMPTRAPD.CONF(5)
2
6 snmptrapd.conf - configuration file for the Net-SNMP notification
7 receiver
8
10 The Net-SNMP notification receiver (trap daemon) uses one or more con‐
11 figuration files to control its operation and how incoming traps (and
12 INFORM requests) should be processed. This file (snmptrapd.conf) can
13 be located in one of several locations, as described in the snmp_con‐
14 fig(5) manual page.
15
17 Previously, snmptrapd would accept all incoming notifications, and log
18 them automatically (even if no explicit configuration was provided).
19 Starting with release 5.3, access control checks will be applied to
20 incoming notifications. If snmptrapd is run without a suitable configu‐
21 ration file (or equivalent access control settings), then such traps
22 WILL NOT be processed. See the section ACCESS CONTROL for more
23 details.
24 As with the agent configuration, the snmptrapd.conf directives can be
26 divided into four distinct groups.
27
29 snmpTrapdAddr [<transport-specifier>:]<transport-address>[,...]
30 defines a list of listening addresses, on which to receive
31 incoming SNMP notifications. See the section LISTENING
32 ADDRESSES in the snmpd(8) manual page for more information about
33 the format of listening addresses.
34 The default behaviour is to listen on UDP port 162 on all IPv4
36 interfaces.
37 doNotRetainNotificationLogs yes
39 disables support for the NOTIFICATION-LOG-MIB. Normally the
40 snmptrapd program keeps a record of the traps received, which
41 can be retrieved by querying the nlmLogTable and nlmLogvari‐
42 ableTable tables. This directive can be used to suppress this
43 behaviour.
44 See the snmptrapd(8) manual page and the NOTIFICATION-LOG-MIB
46 for details.
47 doNotLogTraps yes
49 disables the logging of notifications altogether. This is use‐
50 ful if the snmptrapd application should only run traphandle
51 hooks and should not log traps to any location.
52 doNotFork yes
54 do not fork from the calling shell.
55 pidFile PATH
57 defines a file in which to store the process ID of the notifica‐
58 tion receiver. By default, this ID is not saved.
59
61 Starting with release 5.3, it is necessary to explicitly specify who is
62 authorised to send traps and informs to the notification receiver (and
63 what types of processing these are allowed to trigger). This uses an
64 extension of the VACM model, used in the main SNMP agent.
65 There are currently three types of processing that can be specified:
67 log log the details of the notification - either in a speci‐
69 fied file, to standard output (or stderr), or via syslog
70 (or similar).
71 execute
73 pass the details of the trap to a specified handler pro‐
74 gram, including embedded perl.
75 net forward the trap to another notification receiver.
77 In the following directives, TYPES will be a (comma-separated) list of
79 one or more of these tokens. Most commonly, this will typically be
80 log,execute,net to cover any style of processing for a particular cate‐
81 gory of notification. But it is perfectly possible (even desirable) to
82 limit certain notification sources to selected processing only.
83 authCommunity TYPES COMMUNITY [SOURCE [OID | -v VIEW ]]
85 authorises traps (and SNMPv2c INFORM requests) with the speci‐
86 fied community to trigger the types of processing listed. By
87 default, this will allow any notification using this community
88 to be processed. The SOURCE field can be used to specify that
89 the configuration should only apply to notifications received
90 from particular sources - see snmpd.conf(5) for more details.
91 authUser TYPES [-s MODEL] USER [LEVEL [OID | -v VIEW ]]
93 authorises SNMPv3 notifications with the specified user to trig‐
94 ger the types of processing listed. By default, this will
95 accept authenticated requests. (authNoPriv or authPriv). The
96 LEVEL field can be used to allow unauthenticated notifications
97 (noauth), or to require encryption (priv), just as for the SNMP
98 agent.
99 With both of these directives, the OID (or -v VIEW) field can be
101 used to retrict this configuration to the processing of particu‐
102 lar notifications.
103 Note: Unlike the VACM processing described in RFC 3415, this
105 view is only matched against the snmpTrapOID value of the
106 incoming notification. It is not applied to the payload
107 varbinds held within that notification.
108 authGroup TYPES [-s MODEL] GROUP [LEVEL [OID | -v VIEW ]]
110 authAccess TYPES [-s MODEL] GROUP VIEW [LEVEL [CONTEXT]]
112 setAccess GROUP CONTEXT MODEL LEVEL PREFIX VIEW TYPES
114 authorise notifications in the specified GROUP (configured using
115 the group directive) to trigger the types of processing listed.
116 See snmpd.conf(5) for more details.
117 createUser username (MD5|SHA) authpassphrase [DES|AES]
119 See the snmpd.conf(5) manual page for a description of how to
120 create SNMPv3 users. This is roughly the same, but the file
121 name changes to snmptrapd.conf from snmpd.conf.
122 disableAuthorization yes
124 will disable the above access control checks, and revert to the
125 previous behaviour of accepting all incoming notifications.
126
128 format1 FORMAT
129 format2 FORMAT
131 specify the format used to display SNMPv1 TRAPs and SNMPv2 noti‐
132 fications respectively. Note that SNMPv2c and SNMPv3 both use
133 the same SNMPv2 PDU format.
134 See snmptrapd(8) for the layout characters available.
136 ignoreAuthFailure yes
138 instructs the receiver to ignore authenticationFailure traps.
139 Note: This currently only affects the logging of such notifica‐
141 tions. authenticationFailure traps will still be passed
142 to trap handler scripts, and forwarded to other notifica‐
143 tion receivers. This behaviour should not be relied on,
144 as it is likely to change in future versions.
145 logOption string
147 specifies where notifications should be logged - to standard
148 output, standard error, a specified file or via syslog. See the
149 section LOGGING OPTIONS in the snmpcmd(1) manual page for
150 details.
151 outputOption string
153 specifies various characteristics of how OIDs and other values
154 should be displayed. See the section OUTPUT OPTIONS in the snm‐
155 pcmd(1) manual page for details.
156
158 There are two configuration variables that work together to control
159 when queued traps are logged to the MySQL database. A non-zero value
160 must be specified for sqlSaveInterval to enable MySQL logging.
161 sqlMaxQueue max
163 specifies the maximum number of traps to queue before a forced
164 flush to the MySQL database.
165 sqlSaveInterval seconds
167 specified the number of seconds between periodic queue flushes.
168 A value of 0 for will disable MySQL logging.
169
171 As well as logging incoming notifications, they can also be forwarded
172 on to another notification receiver, or passed to an external program
173 for specialised processing.
174 traphandle OID|default PROGRAM [ARGS ...]
176 invokes the specified program (with the given arguments) when‐
177 ever a notification is received that matches the OID token. For
178 SNMPv2c and SNMPv3 notifications, this token will be compared
179 against the snmpTrapOID value taken from the notification. For
180 SNMPv1 traps, the generic and specific trap values and the
181 enterprise OID will be converted into the equivalent OID (fol‐
182 lowing RFC 2576).
183 Typically, the OID token will be the name (or numeric OID) of a
185 NOTIFICATION-TYPE object, and the specified program will be
186 invoked for notifications that match this OID exactly. However
187 this token also supports a simple form of wildcard suffixing.
188 By appending the character notification based within subtree
189 rooted at the specified OID. For example, an OID token of
190 .1.3.6.1.4.1* would match any enterprise specific notification
191 (including the specified OID itself). An OID token of
192 .1.3.6.1.4.1.* would would work in much the same way, but would
193 not match this exact OID - just notifications that lay strictly
194 below this root. Note that this syntax does not support full
195 regular expressions or wildcards - an OID token of the form
196 oid.*.subids is not valid.
197 If the OID field is the token default then the program will be
199 invoked for any notification not matching another (OID specific)
200 traphandle entry.
201 Details of the notification are fed to the program via its standard
203 input. Note that this will always use the SNMPv2-style notification
204 format, with SNMPv1 traps being converted as per RFC 2576, before being
205 passed to the program. The input format is as follows, one entry per
206 line:
207 HOSTNAME
209 The name of the host that sent the notification, as
210 determined by gethostbyaddr(3).
211 IPADDRESS
213 The IP address of the host that sent the notification.
214 VARBINDS
216 A list of variable bindings describing the contents of
217 the notification, one per line. The first token on each
218 line (up until a space) is the OID of the varind, and the
219 remainder of the line is its value. The format of both
220 of these are controlled by the outputOption directive (or
221 similar configuration).
222 The first OID should always be SNMPv2-MIB::sysUpTime.0,
224 and the second should be SNMPv2-MIB::snmpTrapOID.0. The
225 remaining lines will contain the payload varbind list.
226 For SNMPv1 traps, the final OID will be
227 SNMPv2-MIB::snmpTrapEnterprise.0.
228 Example:
230 A traptoemail script has been included in the Net-SNMP
231 package that can be used within a traphandle directive:
232 traphandle default /usr/bin/perl /usr/bin/traptoemail -s
234 mysmtp.somewhere.com -f admin@somewhere.com me@some‐
235 where.com
236 forward OID|default DESTINATION
238 forwards notifications that match the specified OID to another
239 receiver listening on DESTINATION. The interpretation of OID
240 (and default) is the same as for the traphandle directive).
241 See the section LISTENING ADDRESSES in the snmpd(8) manual page
243 for more information about the format of listening addresses.
244
246 o The daemon blocks while executing the traphandle commands.
247 (This should be fixed in the future with an appropriate signal
248 catch and wait() combination).
249 o All directives listed with a value of "yes" actually accept a
251 range of boolean values. These will accept any of 1, yes or
252 true to enable the corresponding behaviour, or any of 0, no or
253 false to disable it. The default in each case is for the fea‐
254 ture to be turned off, so these directives are typically only
255 used to enable the appropriate behaviour.
256
258 /etc/snmp/snmptrapd.conf
259
261 snmp_config(5), snmptrapd(8), syslog(8), variables(5), snmpd.conf(5),
262 read_config(3).
2634th Berkeley Distribution 29 Jun 2005 SNMPTRAPD.CONF(5)