.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\" ========================================================================
.\"
.IX Title "Munin::Master::Group 3pm"
.TH Munin::Master::Group 3pm 2024-02-28 "perl v5.38.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::Master::Group \- Holds information on host groups.
.PP
Groups can be nested.
.SH METHODS
.IX Header "METHODS"
.IP \fBnew\fR 4
.IX Item "new"
.Vb 1
\&  my $group = Munin::Master::Group\->new($name, $parent);
.Ve
.Sp
Constructor.  \f(CW$name\fR is the name of the group.
.IP \fBadd_attributes\fR 4
.IX Item "add_attributes"
.Vb 1
\&  $group\->add_attributes(\e%attrs);
.Ve
.Sp
Sets attributes \f(CW%attrs\fR for the group.  Valid attributes are:
.RS 4
.IP node_order 4
.IX Item "node_order"
Override the order of the hosts within the group.
.IP local_address 4
.IX Item "local_address"
The local address the update process should bind to when contacting the nodes
in this group.
.IP contacts 4
.IX Item "contacts"
The contacts for this group.  See <http://munin\-monitoring.org/wiki/HowToContact>.
.RE
.RS 4
.Sp
An exception will be thrown if invalid attributes are provided.
.Sp
(Full details here: <http://munin\-monitoring.org/wiki/munin.conf#Groupleveldirectives>.)
.RE
.IP \fBadd_host\fR 4
.IX Item "add_host"
.Vb 1
\&  $group\->add_host($host);
.Ve
.Sp
Adds host \f(CW$host\fR to the group.
.IP \fBgive_attributes_to_hosts\fR 4
.IX Item "give_attributes_to_hosts"
.Vb 1
\&  $group\->give_attributes_to_hosts();
.Ve
.Sp
Propagates the attributes of \f(CW$group\fR to all hosts in the group.  (This does
\&\fBnot\fR apply to hosts belonging to sub-groups.)
.IP \fBget_all_hosts\fR 4
.IX Item "get_all_hosts"
.Vb 1
\&  my @hosts = $group\->get_all_hosts();
.Ve
.Sp
Returns the list of all hosts associated with this group, including those
belonging to any sub-groups.