.\" .\" Copyright (c) 2001-2003 .\" Fraunhofer Institute for Open Communication Systems (FhG Fokus). .\" All rights reserved. .\" .\" Author: Harti Brandt .\" .\" Redistribution of this software and documentation and use in source and .\" binary forms, with or without modification, are permitted provided that .\" the following conditions are met: .\" .\" 1. Redistributions of source code or documentation must retain the above .\" copyright notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 3. Neither the name of the Institute nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE AND DOCUMENTATION IS PROVIDED BY FRAUNHOFER FOKUS .\" AND ITS CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND .\" FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL .\" FRAUNHOFER FOKUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT .\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, .\" OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF .\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING .\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" .\" $Begemot: bsnmp/snmpd/bsnmpd.1,v 1.1 2003/12/03 10:08:33 hbb Exp $ .\" .Dd August 15, 2002 .Dt SNMPD 1 .Os .Sh NAME .Nm snmpd .Nd "simple and extendable SNMP daemon" .Sh SYNOPSIS .Nm .Op Fl dh .Op Fl c Ar file .Op Fl D Ar options .Op Fl I Ar paths .Op Fl l Ar prefix .Op Fl m Ar variable Ns Op = Ns Ar value .Op Fl p Ar file .Sh DESCRIPTION The .Nm daemon servers the internet SNMP (Simple Network Managment Protocol). It is intended to server only the absolute basic MIBs and implement all other MIBs through loadable modules. In this way the .Nm can be used in unexpected ways. .Pp The options are as follows: .Bl -tag -width ".It Fl D Ar options" .It Fl d This option is used for debugging .Nm and causes it not to daemonize itself. .It Fl h This option prints a short usage message. .It Fl c Ar file Use .Ar file as configuration file instead of the standard one. .It Fl D Ar options Debugging options are specified with a .Fl o flag followed by a comma separated string of options. The following options are available. .Bl -tag -width ".It Cm trace Ns Cm = Ns Cm level" .It Cm dump This option causes all sent and received PDUs to be dumped to the terminal. .It Cm events This causes the debugging level of the event library (see .Xr eventlib 3 ) to be set to 10. .It Cm trace Ns Cm = Ns Cm level This option causes the snmp library trace flag to be set to the specified value. The value can be specified in the usual C-syntax for numbers. .El .It Fl I Ar paths This option specifies a colon separated list of directories to search for configuration include files. The default is .Pa /etc:/usr/etc/:/usr/local/etc . These paths are only searched for include specified within <> parantheses. .It Fl l Ar prefix The .Ar prefix is used as the default basename for the pid and the configuration files. .It Fl m Ar variable Ns Op = Ns Ar value Define a configuration variable. .It Fl p Ar file Specify an alternate pid file instead of the default one. .El .Sh CONFIGURATION The .Nm reads its configuration from either the default or the user specified configuration file. The configuration file consists of the following types of lines: .Bl -bullet -offset indent .It variable assignments .It section separators .It include directives .It MIB variable assignments .El .Pp If a line is too long it can be continued on the next line by ending it with a backslash. Empty lines and lines who's first non-blank character is a .Dq # sign are ignored. .Pp All MIB variable assignments of the entire configuration (including nested configuration files) are handled as one transaction, i.e. as if they arrived in a single SET PDU. Any failure during the initial configuration read causes .Nm to exit. A failure during the configuration read caused by a module load causes the loading of the module to fail. .Pp The configuration is red during initialisation of .Nm , when a module is loaded and when .Nm receives a SIGHUP. .Ss VARIABLE ASSIGNMENTS Variable assignments can take one of two forms: .Bd -unfilled -offset indent variable := string variable ?= string .Ed .Pp The string reaches from the first non-blank character after the equal sign until the first new line or .Dq # character. In the first case the string is assigned to the variable unconditionally, in the second case the variable is only assigned if it does not exist yet. .Pp Variable names must begin with a letter or underscore and contain only letters, digits or underscores. .Ss SECTION SEPARATORS The configuration consists of named sections. The MIB variable assignments in the section named .Dq snmpd are executed only during initial setup or when .Nm receives a SIGHUP. All other sections are executed when either a module with the same name as the section is loaded or .Nm receives a SIGHUP and that module is already loaded. The default section at the start of the configuration is .Dq snmpd . One can switch to another section with the syntax .Bd -unfilled -offset indent %secname .Ed .Pp Where .Ar secname is the name of the section. The same .Ar secname can be used in more than one place in the configuration. All of these parts are collected into one section. .Ss INCLUDE DIRECTIVES Another configuration file can be included into the current one with the include directive that takes one of two forms: .Bd -unfilled -offset indent \&.include "file" \&.include <"file"> .Ed .Pp The first form causes the file to be searched in the current directory, the second form causes the file to be searched in the directories specified in the system include path. Nesting depths is only restricted by available memory. .Ss MIB VARIABLE ASSIGNMENTS A MIB variable is assigned with the syntax .Bd -unfilled -offset indent oid [ suboids ] = value .Ed .Pp .Va oid is the name of the variable to be set. Only the last component of the entire name is used here. If the variable is a scalar, the index (.0) is automatically appended and need not to be specified. If the variable is a table column, the index ( .Va suboids ) must be specified. The index consist of elements each seperated from the previous one by a dot. Elements may be either numbers, strings or hostnames enclosed in [] brackets. If the element is a number it is appended to the current oid. If the element is a string, its length and the .Tn ASCII code of each of its characters are appended to the current oid. If the element is a hostname, the IP address of the host is looked up and the four elements of the IP address are appended to the oid. .Pp For example a oid of .Bd -unfilled -offset indent myvariable.27.foooll.[localhost]."&^!" .Ed .Pp results in the oid .Bd -unfilled -offset indent myvariable.27.6.102.111.111.111.108.108.127.0.0.1.38.94.33 .Ed .Pp The value of the assignment may be either empty, a string or a number. If a string starts with a letter or an underscore and consists only of letters, digits, underscores and minus signs, it can be written without quotes. In all other cases the string must be enclosed in double quotes. .Sh SUBSTITUTIONS A variable substitution is written as .Bd -unfilled -offset indent $(variable) .Ed .Pp where .Ar variable is the name of the variable to substitute. Using an undefined variable is considered an error. .Sh FILES .Bl -tag -width ".It Pa /var/run/ Ns Ao Ar prefix Ac Ns \&.pid" -compact .It Pa /etc/ Ns Ao Ar prefix Ac Ns \&.config Default configuration file, where the default .Aq prefix is .Dq snmpd . .It Pa /var/run/ Ns Ao Ar prefix Ac Ns \&.pid Default pid file. .It Pa /etc:/usr/etc/:/usr/local/etc This is the default search path for system include files. .It Pa /usr/local/share/snmp/mibs/FOKUS-MIB.txt .It Pa /usr/local/share/snmp/mibs/BEGEMOT-MIB.txt .It Pa /usr/local/share/snmp/mibs/BEGEMOT-SNMPD.txt The definitions for the MIBs implemented in the daemon. .El .Sh SEE ALSO .Xr gensnmptree 1 .Sh STANDARDS The .Nm conforms to the applicable IETF RFCs. .Sh AUTHORS .An Hartmut Brandt Aq brandt@fokus.gmd.de .Sh BUGS Sure.