2 .\" Copyright (c) 2004-2005
4 .\" All rights reserved.
5 .\" Copyright (c) 2001-2003
6 .\" Fraunhofer Institute for Open Communication Systems (FhG Fokus).
7 .\" All rights reserved.
9 .\" Author: Harti Brandt <harti@FreeBSD.org>
11 .\" Redistribution and use in source and binary forms, with or without
12 .\" modification, are permitted provided that the following conditions
14 .\" 1. Redistributions of source code must retain the above copyright
15 .\" notice, this list of conditions and the following disclaimer.
16 .\" 2. Redistributions in binary form must reproduce the above copyright
17 .\" notice, this list of conditions and the following disclaimer in the
18 .\" documentation and/or other materials provided with the distribution.
20 .\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" $Begemot: bsnmp/snmpd/bsnmpd.1,v 1.12 2006/02/27 09:50:03 brandt_h Exp $
39 .Nd "simple and extensible SNMP daemon"
48 .Op Fl m Ar variable Ns Op = Ns Ar value
53 daemon serves the internet SNMP (Simple Network Management Protocol).
54 It is intended to serve only the absolute basic MIBs and implement all other
55 MIBs through loadable modules.
58 can be used in unexpected ways.
60 The options are as follows:
61 .Bl -tag -width ".It Fl D Ar options"
66 Print a short usage message.
70 as configuration file instead of the standard one.
72 Debugging options are specified with a
74 flag followed by a comma separated string of options.
75 The following options are available.
76 .Bl -tag -width ".It Cm trace Ns Cm = Ns Cm level"
78 Dump all sent and received PDUs to the terminal.
80 Set the debugging level of the event library (see
83 .It Cm trace Ns Cm = Ns Cm level
84 Set the snmp library trace flag to the specified
87 The value can be specified in the usual C-syntax for numbers.
89 Specify an alternate file where the agent's engine id and number of boots
92 Specify a colon separated list of directories to search for configuration
95 .Pa /etc:/usr/etc/:/usr/local/etc .
96 These paths are only searched for include specified within <> parentheses.
100 as the default basename for the pid and the configuration files.
101 .It Fl m Ar variable Ns Op = Ns Ar value
102 Define a configuration variable.
104 Specify an alternate pid file instead of the default one.
108 reads its configuration from either the default or the user specified
110 The configuration file consists of the following types of lines:
111 .Bl -bullet -offset indent
119 MIB variable assignments
122 If a line is too long it can be continued on the next line by ending it with
124 Empty lines and lines in which the first non-blank character is a
128 All MIB variable assignments of the entire configuration (including nested
129 configuration files) are handled as one transaction, i.e., as if they arrived
131 Any failure during the initial configuration read causes
134 A failure during the configuration read caused by a module load
135 causes the loading of the module to fail.
137 The configuration is read during initialization of
139 when a module is loaded and when
142 .Ss VARIABLE ASSIGNMENTS
143 Variable assignments can take one of two forms:
144 .Bd -unfilled -offset indent
149 The string reaches from the first non-blank character after the
150 equal sign until the first new line or
154 the string is assigned to the variable unconditionally, in the second case the
155 variable is only assigned if it does not exist yet.
157 Variable names must begin with a letter or underscore and contain only letters,
158 digits or underscores.
159 .Ss SECTION SEPARATORS
160 The configuration consists of named sections.
161 The MIB variable assignments in the section named
163 are executed only during initial setup or when
166 All other sections are executed when either a module
167 with the same name as the section is loaded or
169 receives a SIGHUP and that module is already loaded.
170 The default section at the start of the configuration is
172 One can switch to another section with the syntax
173 .Bd -unfilled -offset indent
179 is the name of the section.
182 can be used in more than one place in the configuration.
183 All of these parts are collected into one section.
184 .Ss INCLUDE DIRECTIVES
185 Another configuration file can be included into the current one with the
186 include directive that takes one of two forms:
187 .Bd -unfilled -offset indent
192 The first form causes the file to be searched in the current directory, the
193 second form causes the file to be searched in the directories specified in
194 the system include path.
195 Nesting depth is only restricted by available memory.
196 .Ss MIB VARIABLE ASSIGNMENTS
197 A MIB variable is assigned with the syntax
198 .Bd -unfilled -offset indent
199 oid [ suboids ] = value
203 is the name of the variable to be set.
204 Only the last component of the entire name is used here.
205 If the variable is a scalar, the index (.0) is automatically
206 appended and need not to be specified.
207 If the variable is a table column, the index
210 The index consist of elements each separated from the
211 previous one by a dot.
212 Elements may be either numbers, strings or hostnames
213 enclosed in [] brackets.
214 If the element is a number it is appended
216 If the element is a string, its length and the
218 code of each of its characters are appended to the current oid.
220 element is a hostname, the IP address of the host is looked up and the four
221 elements of the IP address are appended to the oid.
223 For example, an oid of
224 .Bd -unfilled -offset indent
225 myvariable.27.foooll.[localhost]."&^!"
229 .Bd -unfilled -offset indent
230 myvariable.27.6.102.111.111.111.108.108.127.0.0.1.38.94.33
233 The value of the assignment may be either empty, a string or a number.
234 If a string starts with a letter or an underscore and consists only of
235 letters, digits, underscores and minus signs, it can be written without
237 In all other cases the string must be enclosed in double quotes.
239 A variable substitution is written as
240 .Bd -unfilled -offset indent
246 is the name of the variable to substitute.
247 Using an undefined variable is considered an error.
249 .Bl -tag -width ".It Pa /var/run/ Ns Ao Ar prefix Ac Ns \&.pid" -compact
250 .It Pa /etc/ Ns Ao Ar prefix Ac Ns \&.config
251 Default configuration file, where the default
255 .It Pa /var/ Ns Ao Ar prefix Ac Ns \&.engine
256 Default engine id file.
257 .It Pa /var/run/ Ns Ao Ar prefix Ac Ns \&.pid
259 .It Pa /etc:/usr/etc/:/usr/local/etc
260 Default search path for system include files.
261 .It Pa @MIBSPATH@FOKUS-MIB.txt
262 .It Pa @MIBSPATH@BEGEMOT-MIB.txt
263 .It Pa @MIBSPATH@BEGEMOT-SNMPD.txt
264 Definitions for the MIBs implemented in the daemon.
265 .It Pa /etc/hosts.allow, /etc/hosts.deny
266 Access controls that should be enforced by TCP wrappers are defined here.
267 Further details are described in
276 conforms to the applicable IETF RFCs.
278 .An Hartmut Brandt Aq harti@FreeBSD.org