1Munin::Node::Configure:U:sPelrugCionn(t3r)ibuted Perl DoMcuunmienn:t:aNtoidoen::Configure::Plugin(3)
2
3
4

NAME

6       Munin::Node::Configure::Plugin - Class representing a plugin, along
7       with its installed and suggested services.
8

SYNOPSIS

10         my $plugin = Munin::Node::Configure::Plugin->new();
11

METHODS

13       new(%args)
14           Constructor.
15
16           Required arguments are 'name' and 'path', which should be the
17           basename and full path of the plugin, respectively.
18
19       is_wildcard()
20           Returns true if the plugin is a wildcard.  In the case of SNMP
21           plugins, only double-wild plugins will return true (ie.
22           'snmp__memory' would return false, but 'snmp__if_' would return
23           true).
24
25       in_family(@families)
26           Returns true if plugin's family is in @families, false otherwise.
27
28       is_installed()
29           Returns 'yes' if one or more links to this plugin exist in the
30           service directory, 'no' otherwise.
31
32       suggestion_string()
33           Returns a string detailing whether or not autoconf considers that
34           the plugin should be installed.  The string may also report the
35           reason why the plugin declined to be installed, or the list of
36           suggestions it provided, if this information is available.
37
38       installed_services_string()
39           Returns a string detailing which wildcards are installed for this
40           plugin.
41
42       services_to_add()
43       services_to_remove()
44           Return a list of service names that should be added or removed for
45           this plugin.
46
47       add_instance($name)
48           Associates a link from the service directory with this plugin.
49
50       add_suggestions(@suggestions)
51           Adds @suggestions to the list of suggested wildcards for this
52           plugin.  They are not validated.
53
54       read_magic_markers()
55           Sets the family and capabilities from the magic markers embedded in
56           the plugin's executable, as specified by
57           http://munin.projects.linpro.no/wiki/ConcisePlugins#Magicmarkers
58
59       parse_autoconf_response(@response)
60           Parses and validates the autoconf response from the plugin, in the
61           format specified by
62           http://munin.projects.linpro.no/wiki/ConcisePlugins#autoconf
63
64           Invalid input will cause an error to be logged against the plugin.
65
66       parse_suggest_response(@response)
67           Validates the suggestions from the plugin.
68
69           Invalid suggestions will cause an error to be logged against the
70           plugin.
71
72       parse_snmpconf_response(@response)
73           Parses and validates the snmpconf response from the plugin, in the
74           format specified by
75           http://munin.projects.linpro.no/wiki/ConcisePlugins#suggest
76
77           Invalid or inconsistent input will cause an error to be logged
78           against the plugin.
79
80       log_error($message)
81           Logs an error for later retrieval.  The error will also be
82           displayed if debugging output is enabled.
83
84
85
86perl v5.12.2                      2010-12-05 Munin::Node::Configure::Plugin(3)
Impressum