mini-snmpd —
a minimal implementation of an SNMP daemon
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,
--trap
ADDR
]
[-t,
--timeout
SEC
]
[-u,
--drop-privs
USER
]
[-v,
--version
]
[-V,
--vendor
OID
] |
mini-snmpd is a program that serves basic
system parameters to clients using the Simple Network Management Protocol
(SNMP) version 1 or 2c. The list of supported MIBs and objects is in the file
MIBS.md, shipped with the distribution.
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/.
-4,
--use-ipv4- Use only IPv4. The default is dual-stack, serving both IPv4 and IPv6.
-6,
--use-ipv6- Use only IPv6. The default is dual-stack, serving both IPv4 and 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. If omitted, the
PRETTY_NAME from
os-release(5)
is used, if available, otherwise empty.
-f,
--file
FILE- Configuration file, default:
/etc/mini-snmpd.conf
-h,
--help- Show summary of command line options and exit.
-i,
--interfaces
IFNAME[,IFNAME]- List of network interfaces to monitor for IF-MIB. The default is to
monitor all interfaces, with the loopback interface first, on
ifIndex 1. Separate multiple interface names
with comma or semicolon, not colon! A name
with a trailing + is a prefix wildcard,
iptables style, matched against the interfaces present at start-up: e.g.
eth+ matches eth0, eth1, ..., and a lone
+ matches all of them.
-I,
--listen
IFNAME- Network interface to bind to, default is listen on all interfaces. This
option is only available on Linux, it uses the Linux-specific
SO_BINDTODEVICE socket option.
-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,
--trap
ADDR[:port
]- Send SNMPv2c notifications (traps) to the given sink, default port 162,
using the community from
-c. Repeat the
option for more than one sink. IPv6 sinks use the
[addr]:port form. Emitted on cold start,
link up/down, and authentication failure; the authentication-failure trap
is rate-limited.
-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, project info, 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
mini-snmpd responds to the following signals:
- TERM
- Tell
mini-snmpd to exit gracefully
- INT
- Same as TERM
- HUP
- Reload: re-read the configuration file over the command-line options and
rebuild the MIB. A setting present in the file overrides the matching
command-line option; removing it and reloading again restores the
command-line value. The listening sockets are left untouched, so the
daemon can reload after dropping privileges. Built without libConfuse,
mini-snmpd has no file to read and only
rebuilds the MIB.
- /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
mini-snmpd.conf(5)
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".
mini-snmpd was originally written by Robert
Ernst ⟨mailto:robert.ernst@aon.at⟩. It is currently maintained
by Joachim Wiberg ⟨mailto:troglobit@gmail.com⟩ at GitHub.