.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "MUNIN-NODE-CONFIGURE 1p" .TH MUNIN-NODE-CONFIGURE 1p "2018-05-30" "perl v5.26.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" munin\-node\-configure \- View and modify which plugins are enabled. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& munin\-node\-configure [options] .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBmunin-node-configure\fR reports which plugins are enabled on the current node, and suggest changes to this list. .PP By default this program shows which plugins are activated on the system. .PP If you specify \f(CW\*(C`\-\-suggest\*(C'\fR, it will present a table of plugins that will probably work (according to the plugins' autoconf command). .PP If you specify \f(CW\*(C`\-\-snmp\*(C'\fR, followed by a list of hosts, it will present a table of \s-1SNMP\s0 plugins that they support. .PP If you additionally specify \f(CW\*(C`\-\-shell\*(C'\fR, shell commands to install those same plugins will be printed. These can be reviewed or piped directly into a shell to install the plugins. .SH "GENERAL OPTIONS" .IX Header "GENERAL OPTIONS" .IP "\fB\-\-help\fR" 4 .IX Item "--help" Show this help page. .IP "\fB\-\-version\fR" 4 .IX Item "--version" Show version information. .IP "\fB\-\-debug\fR" 4 .IX Item "--debug" Print debug information on the operations of \f(CW\*(C`munin\-node\-configure\*(C'\fR. This can be very verbose. .Sp All debugging output is printed to \s-1STDOUT,\s0 and each line is prefixed with '#'. Only errors are printed to \s-1STDERR.\s0 .IP "\fB\-\-pidebug\fR" 4 .IX Item "--pidebug" Plugin debug. Sets the environment variable \s-1MUNIN_DEBUG\s0 to 1 so that plugins may enable debugging. .IP "\fB\-\-config \fR" 4 .IX Item "--config " Override configuration file [/etc/munin/munin\-node.conf] .IP "\fB\-\-servicedir \fR" 4 .IX Item "--servicedir " Override plugin directory [/etc/munin/plugins/] .IP "\fB\-\-sconfdir \fR" 4 .IX Item "--sconfdir " Override plugin configuration directory [/etc/munin/plugin\-conf.d/] .IP "\fB\-\-libdir \fR" 4 .IX Item "--libdir " Override plugin library [/usr/share/munin/plugins/] .IP "\fB\-\-exitnoterror\fR" 4 .IX Item "--exitnoterror" Do not consider plugins that exit non-zero exit-value as error. .IP "\fB\-\-suggest\fR" 4 .IX Item "--suggest" Suggest plugins that might be added or removed, instead of those that are currently enabled. .SS "\s-1OUTPUT OPTIONS\s0" .IX Subsection "OUTPUT OPTIONS" By default, \f(CW\*(C`munin\-node\-configure\*(C'\fR will print out a table summarising the results. .IP "\fB\-\-shell\fR" 4 .IX Item "--shell" Instead of a table, print shell commands to install the new plugin suggestions. .Sp This implies \f(CW\*(C`\-\-suggest\*(C'\fR, unless \f(CW\*(C`\-\-snmp\*(C'\fR was also enabled. By default, it will not attempt to remove any plugins. .IP "\fB\-\-remove\-also\fR" 4 .IX Item "--remove-also" When \f(CW\*(C`\-\-shell\*(C'\fR is enabled, also provide commands to remove plugins that are no longer applicable from the service directory. .SS "\s-1PLUGIN SELECTION OPTIONS\s0" .IX Subsection "PLUGIN SELECTION OPTIONS" .IP "\fB\-\-families \fR" 4 .IX Item "--families " Override the list of families that will be used (auto, manual, contrib, snmpauto). Multiple families can be specified as a comma-separated list, by repeating the \f(CW\*(C`\-\-families\*(C'\fR option, or as a combination of the two. .Sp When listing installed plugins, the default families are 'auto', 'manual' and \&'contrib'. Only 'auto' plugins are checked for suggestions. \s-1SNMP\s0 probing is only performed on 'snmpauto' plugins. .IP "\fB\-\-newer \fR" 4 .IX Item "--newer " Only consider plugins added to the Munin core since . This option is useful when upgrading, since it can prevent plugins that have been manually removed from being reinstalled. This only applies to plugins in the 'auto' family. .SS "\s-1SNMP\s0 Options" .IX Subsection "SNMP Options" .IP "\fB\-\-snmp \fR" 4 .IX Item "--snmp " Probe the \s-1SNMP\s0 agents on the host or \s-1CIDR\s0 network (e.g. \*(L"192.168.1.0/24\*(R"), to see what plugins they support. This may take some time, especially if the many hosts are specified. .Sp This option can be specified multiple times, or as a comma-separated list, to include more than one host/CIDR. .IP "\fB\-\-snmpversion \fR" 4 .IX Item "--snmpversion " The \s-1SNMP\s0 version (1, 2c or 3) to use. ['2c'] .IP "\fB\-\-snmpport \fR" 4 .IX Item "--snmpport " The \s-1SNMP\s0 port to use [161] .IP "\fB\s-1SNMP\s0 1/2c authentication\fR" 4 .IX Item "SNMP 1/2c authentication" \&\s-1SNMP\s0 versions 1 and 2c use a \*(L"community string\*(R" for authentication. This is a shared password, sent in plaintext over the network. .IP "\fB\-\-snmpcommunity \fR" 4 .IX Item "--snmpcommunity " The community string for version 1 and 2c agents. ['public'] (If this works your device is probably very insecure and needs a security checkup). .IP "\fB\s-1SNMP 3\s0 authentication\fR" 4 .IX Item "SNMP 3 authentication" \&\s-1SNMP\s0 v3 has three security levels. Lowest is \f(CW\*(C`noAuthNoPriv\*(C'\fR, which provides neither authentication nor encryption. If a username and \f(CW\*(C`authpassword\*(C'\fR are given it goes up to \f(CW\*(C`authNoPriv\*(C'\fR, and the connection is authenticated. If \&\f(CW\*(C`privpassword\*(C'\fR is also given the security level becomes \f(CW\*(C`authPriv\*(C'\fR, and the connection is authenticated and encrypted. .Sp \&\fBNote\fR: Encryption can slow down slow or heavily loaded network devices. For most uses \f(CW\*(C`authNoPriv\*(C'\fR will be secure enough \*(-- the password is sent over the network encrypted in any case. .Sp ContextEngineIDs are not (yet) supported. .Sp For further reading on \s-1SNMP\s0 v3 security models please consult \s-1RFC3414\s0 and the documentation for Net::SNMP. .IP "\fB\-\-snmpusername \fR" 4 .IX Item "--snmpusername " Username. There is no default. .IP "\fB\-\-snmpauthpassword \fR" 4 .IX Item "--snmpauthpassword " Authentication password. Optional when encryption is also enabled, in which case defaults to the privacy password (\f(CW\*(C`\-\-snmpprivpassword\*(C'\fR). .IP "\fB\-\-snmpauthprotocol \fR" 4 .IX Item "--snmpauthprotocol " Authentication protocol. One of 'md5' or 'sha' (\s-1HMAC\-MD5\-96, RFC1321\s0 and \&\s-1SHA\-1/HMAC\-SHA\-96, NIST FIPS PIB 180, RFC2264\s0). ['md5'] .IP "\fB\-\-snmpprivpassword \fR" 4 .IX Item "--snmpprivpassword " Privacy password to enable encryption. There is no default. An empty ('') password is considered as no password and will not enable encryption. .Sp Privacy requires a privprotocol as well as an authprotocol and a authpassword, but all of these are defaulted (to 'des', 'md5', and the privpassword value, respectively) and may therefore be left unspecified. .IP "\fB\-\-snmpprivprotocol \fR" 4 .IX Item "--snmpprivprotocol " If the privpassword is set this setting controls what kind of encryption is used to achieve privacy in the session. Only the very weak 'des' encryption method is supported officially. ['des'] .Sp munin-node-configure also supports '3des' (\s-1CBC\-3DES\-EDE,\s0 aka Triple-DES, \s-1NIST FIPS 46\-3\s0) as specified in \s-1IETF\s0 draft\-reeder\-snmpv3\-usm\-3desede. Whether or not this works with any particular device, we do not know. .SH "FILES" .IX Header "FILES" .Vb 5 \& /etc/munin/munin\-node.conf \& /etc/munin/plugin\-conf.d/* \& /etc/munin/plugins/* \& /usr/share/munin/plugins/plugins.history \& /usr/share/munin/plugins/* .Ve .SH "VERSION" .IX Header "VERSION" This is munin-node-configure (munin-node) v2.0.37\-2. .PP \&\f(CW$Id\fR$ .SH "AUTHORS" .IX Header "AUTHORS" Jimmy Olsen, Nicolai Langfeldt, Matthew Boyle .SH "BUGS" .IX Header "BUGS" Please see . .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2003\-2006 Jimmy Olsen, Nicolai Langfeldt. .PP Copyright (C) 2009\-2010 Matthew Boyle .PP This is free software; see the source for copying conditions. There is \&\s-1NO\s0 warranty; not even for \s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0 .PP This program is released under the \s-1GNU\s0 General Public License