.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" 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 .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" 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::Plugin 3pm" .TH Munin::Node::Configure::Plugin 3pm "2022-02-10" "perl v5.34.0" "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::Plugin \- Class representing a plugin, along with its installed and suggested services. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& my $plugin = Munin::Node::Configure::Plugin\->new(); .Ve .SH "METHODS" .IX Header "METHODS" .IP "\fBnew(%args)\fR" 4 .IX Item "new(%args)" Constructor. .Sp Required arguments are 'name' and 'path', which should be the basename and full path of the plugin, respectively. .IP "\fB\fBis_wildcard()\fB\fR" 4 .IX Item "is_wildcard()" Returns true if the plugin is a wildcard. In the case of \s-1SNMP\s0 plugins, only double-wild plugins will return true (ie. 'snmp_\|_memory' would return false, but 'snmp_\|_if_' would return true). .IP "\fB\fBis_snmp()\fB\fR" 4 .IX Item "is_snmp()" Returns true if the plugin is an \s-1SNMP\s0 plugin. .IP "\fBin_family(@families)\fR" 4 .IX Item "in_family(@families)" Returns true if plugin's family is in \f(CW@families\fR, false otherwise. .IP "\fB\fBis_installed()\fB\fR" 4 .IX Item "is_installed()" Returns 'yes' if one or more links to this plugin exist in the service directory, 'no' otherwise. .IP "\fB\fBsuggestion_string()\fB\fR" 4 .IX Item "suggestion_string()" Returns a string detailing whether or not autoconf considers that the plugin should be installed. The string may also report the reason why the plugin declined to be installed, or the list of suggestions it provided, if this information is available. .IP "\fB\fBinstalled_services_string()\fB\fR" 4 .IX Item "installed_services_string()" Returns a string detailing which wildcards are installed for this plugin. .IP "\fB\fBservices_to_add()\fB\fR" 4 .IX Item "services_to_add()" .PD 0 .IP "\fB\fBservices_to_remove()\fB\fR" 4 .IX Item "services_to_remove()" .PD Return a list of service names that should be added or removed for this plugin. .IP "\fBadd_instance($name)\fR" 4 .IX Item "add_instance($name)" Associates a link from the service directory with this plugin. .IP "\fBadd_suggestions(@suggestions)\fR" 4 .IX Item "add_suggestions(@suggestions)" Adds \f(CW@suggestions\fR to the list of suggested wildcards for this plugin. They are not validated. .IP "\fB\fBread_magic_markers()\fB\fR" 4 .IX Item "read_magic_markers()" Sets the family and capabilities from the magic markers embedded in the plugin's executable, as specified by .IP "\fBparse_autoconf_response(@response)\fR" 4 .IX Item "parse_autoconf_response(@response)" Parses and validates the autoconf response from the plugin, in the format specified by .Sp Invalid input will cause an error to be logged against the plugin. .IP "\fBparse_suggest_response(@response)\fR" 4 .IX Item "parse_suggest_response(@response)" Validates the suggestions from the plugin. .Sp Invalid suggestions will cause an error to be logged against the plugin. .IP "\fBparse_snmpconf_response(@response)\fR" 4 .IX Item "parse_snmpconf_response(@response)" Parses and validates the snmpconf response from the plugin, in the format specified by .Sp Invalid or inconsistent input will cause an error to be logged against the plugin. .IP "\fBlog_error($message)\fR" 4 .IX Item "log_error($message)" Logs an error for later retrieval. The error will also be displayed if debugging output is enabled.