SNMPTRAPD.CONF(5)

NAME
snmptrapd.conf - configuration file for the Net-SNMP notification receiver

DESCRIPTION
snmptrapd.conf is the configuration file(s) which define how the Net-SNMP SNMP notification receiver (trap daemon) operates when it receives a notification. These files may contain any of the directives found in the DIRECTIVES section below. This file is not required for the daemon to operate, receive, or report traps. It is used solely as a method of providing extensibility to the trap daemon.

PLEASE READ FIRST
First, make sure you have read the snmp_config(5) manual page that describes how the Net-SNMP configuration files operate, where they are located and how they all work together.

DIRECTIVES

traphandle OID|default PROGRAM [ARGS ...]
    The traphandle configuration directive configures the snmptrapd program to launch an external program any time it receives a trap matching the OID token. If the OID token is the word default then any trap not matching any other trap handler will call this default one instead. The program is fed details about the trap to its standard input, in the following format, one entry per line:

    HOSTNAME
        The name of the host in question that sent the trap, as determined by gethostbyaddr(3).

    IPADDRESS
        The IP address of the host that sent the trap.

    VARBINDS
        A list of variable bindings that describe the trap and the variables enclosed in it. The first token on the line, up until the space, in the OID and the remainder of the line is its value. The first OID should be the system.sysUpTime.0 OID, and the second should be the ...snmpTrap.snmpTrapOID.0 OID. The remainder of the OIDs, with the possible exception of the last one, are the variable bindings contained within the trap. For SNMPv1 traps, the very last OID will be the ...snmpTrap.snmpTrapEnterprise OID and its value. Essentially, SNMPv1 traps have been converted to the SNMPv2 trap PDU type by the method described in the SNMPv1/SNMPv2/SNMPv3 coexistence document (RFC2576).

    Example:
        A traptoemail script has been included in the Net-SNMP package that can be used as a trap handle directive:

        traphandle default /usr/bin/perl /usr/local/bin/traptoemail -s mysmtp.somewhere.com -f admin@somewhere.com me@somewhere.com

snmptrapdaddr [<transport-specifier>:]<transport-address>[,...]
    Makes the agent listen on the specified comma-separated list of listening addresses instead of the default behaviour, which is to listen on UDP port 162 on all IPv4 interfaces. See the section LISTENING ADDRESSES in the snmpd(8) manual page for more information about the format of listening addresses.

dontRetainLogs true
    Turns off the support for the NOTIFICATION-LOG-MIB and thus doesn't retain logged traps. Normally the snmptrapd program keeps a certain number of traps around in memory so they can be retrieved via querying the nlmLogTable and nlmLogvariableTable tables. See the snmptrapd(8) manual page and the NOTIFICATION-LOG-MIB for details.

createUser username (MD5|SHA) authpassphrase [DES|AES]
    See the snmpd.conf(5) manual page for a description of how to create SNMPv3 users. It's roughly the same, but the file name changes to snmptrapd.conf from snmpd.conf.

format1 format
    The format used to print a SNMPv1 TRAP message. See snmptrapd(8) for the layout characters available.

format2 format
    The format used to print a SNMPv2 TRAP2 or INFORM message (note that the SNMPv3 protocol uses SNMPv2 style TRAPs and INFORMs).

forward OID|default DESTINATION
    Forwards traps received to DESTINATION if they match the notification type indicated by OID (or the word default forwards them all).

ignoreAuthFailure (1|yes|true|0|no|false)
    Whether or not ignore authenticationFailure traps.

doNotLogTraps (1|yes|true|0|no|false)
    Whether or not to log traps. This is useful if you want the snmptrapd application to only run traphandle hooks and not to log any traps to any location.

logOption string
    Specify where logging output should be directed (standard error or output, to a file or via syslog). See LOGGING OPTIONS in snmpcmd(1) for details.

outputOption string
    The same output formatting (-O) options as the other Net-SNMP commands. See the section OUTPUT OPTIONS in the snmpcmd(1) manual page.

printEventNumbers (1|yes|true|0|no|false)
    Whether or not to print event numbers (rising/falling alarm etc.).

doNotFork (1|yes|true|0|no|false)
    Whether or not to fork from the calling shell.

pidFile string
    What file to store the process id in

NOTES

o   The daemon blocks on the executing traphandle commands. (This should be fixed in the future with an appropriate signal catch and wait() combination).

FILES
/usr/local/etc/snmp/snmptrapd.conf

SEE ALSO
snmp_config(5), snmptrapd(8), syslog(8), variables(5), snmpd.conf(5), read_config(3).