MINI-SNMPD(8) (smm)
MINI-SNMPD(8) System Manager's Manual (smm) MINI-SNMPD(8)

NAME

mini-snmpda minimal implementation of an SNMP daemon

SYNOPSIS

mini-snmpd [-4, --use-ipv4] [-6, --use-ipv6] [-a, --auth] [-c, --community STR] [-C, --contact NAME] [-d, --disks DIR] [-D, --description STR] [-f, --file FILE] [-h, --help] [-i, --interfaces IFNAME] [-I, --listen IFNAME] [-l, --loglevel LEVEL] [-L, --location STR] [-n, --foreground] [-p, --udp-port PORT] [-P, --tcp-port PORT] [-s, --syslog] [-t, --timeout SEC] [-u, --drop-privs USER] [-v, --version] [-V, --vendor OID]

DESCRIPTION

mini-snmpd is a program that serves basic system parameters to clients using the Simple Network Management Protocol (SNMP) version 1 or 2c.
By default mini-snmpd starts in the background, detaching from the controlling terminal, like a traditional UNIX daemon. Modern init systems may require services to run in the foreground, to that end the -n option in combination with the -s option to enable logging using syslog.
The default vendor OID is only a placeholder where you need to insert the PEN (private enterprise number) of your organization. If you do not have one you can get one assigned by the Internet Assigned Numbers Authority (IANA), free of charge. See their PEN application web page at http://pen.iana.org/.

OPTIONS

-4, --use-ipv4
Use IPv4, default
-6, --use-ipv6
Use IPv6
-a, --auth
Require client authentication, thus SNMP version 2c, default is off.
-c, --community STR
SNMP version 2c authentication, or community, string, default is "public". Remember to also enable --auth to activate authentication.
-C, --contact NAME
Contact address to device administrator, default is none.
-d, --disks DIR[,DIR,DIR]
The list of disk mount points to monitor, default is '/'. Separate multiple directories with a comma, colon, or a semicolon.
-D, --description STR
The description of the device, default is empty.
-f, --file FILE
Configuration file, default: /etc/mini-snmpd.conf
-h, --help
Show summary of command line options and exit.
-i, --interface IFNAME[,IFNAME]
List of network interfaces to monitor for IF-MIB, default is none. Separate multiple interface names with comma or semicolon, not colon!
-I, --listen IFNAME
Network interface to bind to, default is listen on all interfaces.
-l, --loglevel LEVEL
Set log level: none, err, info, notice, debug. Default: notice.
-L, --location STR
The location of the device, default is empty.
-n, --foreground
Run in foreground, do not detach from controlling terminal.
-p, --udp-port PORT
UDP port to listen to for incoming connections, default is 161.
-P, --tcp-port PORT
TCP port to listen to for incoming connections, default is 161.
-s, --syslog
Use syslog for logging, even if running in the foreground.
-t, --timeout SEC
Timeout for updating the MIB variables, default is 1 second.
-u, --drop-privs USER
Drop privileges after opening sockets to USER, default: no.
-v, --version
Show program version and exit.
-V, --vendor OID
The OID of the device vendor, this MUST be changed to your own organization's OID. Default is .1.3.6.1.4.1

SIGNALS

mini-snmpd responds to the following signals:
TERM
Tell mini-snmpd to exit gracefully
HUP
Same as TERM

FILES

/etc/mini-snmpd.conf
configuration file. See mini-snmpd.conf(5) for more information.
/etc/default/mini-snmpd
Sourced by systemd unit file, $DAEMON_OPTS is supported
/var/run/mini-snmpd.pid
default process ID file

SEE ALSO

mini-snmpd.conf(5)

EXAMPLE

mini-snmpd -a -c secret -D "My device" -d /cf -i lo,eth0
This command starts the program at the default port, using the community string "secret", the system description "My device" and provides disk statistics for the "/cf" (compact flash) mount point, with network interface statistics for the interfaces "lo" and "eth0".

AUTHORS

mini-snmpd was originally written by Robert Ernst ⟨mailto:robert.ernst@aon.at⟩. It is currently maintained by Joachim Nilsson ⟨mailto:troglobit@gmail.com⟩ at GitHub.
February 2, 2020 Debian