OpenBSD manual page server

NAME

snmpd.conf — Simple Network Management Protocol daemon configuration file

DESCRIPTION

snmpd.conf is the configuration file for the snmpd(8) daemon.

SECTIONS

The snmpd.conf file is divided into three main sections:

Macros

User-defined variables may be defined and used later, simplifying the configuration file.

Global Configuration

Global runtime settings for snmpd(8).

OID Configuration

Custom configuration of SNMP object identifiers and values.

The current line can be extended over multiple lines using a backslash (‘\’). Comments can be put anywhere in the file using a hash mark (‘#’), and extend to the end of the current line. Care should be taken when commenting out multi-line text: the comment is effective until the end of the entire block.

Additional configuration files can be included with the include keyword, for example:

include "/etc/snmpd.conf.local"

MACROS

Macros can be defined that will later be expanded in context. Macro names must start with a letter, and may contain letters, digits and underscores. Macro names may not be reserved words (for example, community, system, or oid). Macros are not expanded inside quotes.

For example:

ext_addr="192.168.0.1"
listen on $ext_addr

GLOBAL CONFIGURATION

The following options can be set globally:

listen on address

Specify the local address snmpd(8) should listen on for incoming SNMP messages.

read-only community string

Specify the name of the read-only community. The default value is public.

read-write community string

Specify the name of the read-write community. The default value is private.

filter-routes (yes|no)

If set to yes, ask the kernel to filter route update messages on the routing socket. Routing table information will not be available, but CPU use will be reduced during bulk updates. The default is no.

system contact string

Specify the name or description of the system contact, typically a name or an e-mail address. The default value is root@hostname using the hostname of the local machine.

system description string

Specify a description of the local system. The default value is the operating system identification as printed by the uname(1) command using the -a flag:

OpenBSD myhost.example.com 4.2 GENERIC#595 i386

system location string

Specify the string describing the location of the local system, typically a physical location. The default value is an empty string.

system name string

Specify the name of the local system, typically a fully-qualified domain name. The default value is the hostname of the local system.

system oid oid-string

Specify the authoritative identification of the local system. The default value is 1.3.6.1.4.1.30155.23.1 (iso.org.dod.internet.private.enterprises.openbsd.23.1) identifying a common OpenBSD system.

system services number

Specify a magic value which indicates the set of services that the local system may provide. Refer to the sysServices description in the SNMP MIB for details.

trap community string

Specify the name of the trap community. The default value is public.

trap receiver string [oid oid-string] [community string]

Specify the address or FQDN of a remote trap receiver for outgoing traps sent by snmpd(8). This option may be specified multiple times. The daemon will send outgoing traps using the revised SNMPv2 format and the configured trap community. The default community is specified by the global trap community option.

OID CONFIGURATION

It is possible to specify user-defined OIDs in the configuration file:

oid oid-string name name [read-only | read-write] [type] value

Return the specified value to the client for this OID. The read-write option may allow the client to override it, and the type is either string or integer.

FILES

/etc/snmpd.conf

Default location of the configuration file.

EXAMPLES

The following example will tell snmpd(8) to listen on localhost, override the default system OID, set the magic services value and provides some custom OID values:

listen on 127.0.0.1

system oid 1.3.6.1.4.1.30155.23.2
system services 74

oid 1.3.6.1.4.1.30155.42.1 name myName read-only string "humppa"
oid 1.3.6.1.4.1.30155.42.2 name myStatus read-only integer 1

SEE ALSO

snmpctl(8), snmpd(8)

HISTORY

The snmpd.conf file format first appeared in OpenBSD 4.3.

AUTHORS

The snmpd(8) program was written by Reyk Floeter ⟨reyk@vantronix.net⟩.