.\" Automatically generated by Pod::Man 4.10 (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
..
.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 "Rex::Group::Lookup::YAML 3pm"
.TH Rex::Group::Lookup::YAML 3pm "2020-09-18" "perl v5.28.1" "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"
Rex::Group::Lookup::YAML \- read hostnames and groups from a YAML file
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
With this module you can define hostgroups out of an yaml file.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& use Rex::Group::Lookup::YAML;
\& groups_yaml "file.yml";
.Ve
.SH "EXPORTED FUNCTIONS"
.IX Header "EXPORTED FUNCTIONS"
.ie n .SS "groups_yaml($file, create_all_group => $boolean )"
.el .SS "groups_yaml($file, create_all_group => \f(CW$boolean\fP )"
.IX Subsection "groups_yaml($file, create_all_group => $boolean )"
With this function you can read groups from yaml files. The optional \f(CW\*(C`create_all_group\*(C'\fR option can be passed. 
If it is set to \f(CW\*(C`true\*(C'\fR, the group \fIall\fR, including all hosts, will also be created.
.PP
.Vb 9
\&  # in my_groups.yml
\&  webserver:
\&   \- fe01
\&   \- fe02
\&   \- f03
\&  backends:
\&   \- be01
\&   \- be02
\&   \- f03
\&   
\&  # in Rexfile
\&
\&  groups_yaml(\*(Aqmy_groups.yml\*(Aq);
\& 
\&  # or
\&  groups_yaml(\*(Aqmy_groups.yml\*(Aq, create_all_group => TRUE);
.Ve