.\" 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::Commands::Sysctl 3pm"
.TH Rex::Commands::Sysctl 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::Commands::Sysctl \- Manipulate sysctl
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
With this module you can set and get sysctl parameters.
.PP
Version <= 1.0: All these functions will not be reported.
.PP
All these functions are not idempotent.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Rex::Commands::Sysctl;
\& 
\& my $data = sysctl "net.ipv4.tcp_keepalive_time";
\& sysctl "net.ipv4.tcp_keepalive_time" => 1800;
.Ve
.SH "EXPORTED FUNCTIONS"
.IX Header "EXPORTED FUNCTIONS"
.ie n .SS "sysctl($key [, $val [, %options]])"
.el .SS "sysctl($key [, \f(CW$val\fP [, \f(CW%options\fP]])"
.IX Subsection "sysctl($key [, $val [, %options]])"
This function will read the sysctl key \f(CW$key\fR.
.PP
If \f(CW$val\fR is given, then this function will set the sysctl key \f(CW$key\fR.
.PP
.Vb 5
\& task "tune", "server01", sub {
\&   if( sysctl("net.ipv4.ip_forward") == 0 ) {
\&     sysctl "net.ipv4.ip_forward" => 1;
\&   }
\& };
.Ve
.PP
If both \f(CW$val\fR and ensure option are used, the sysctl key is modified and the value may persist in /etc/sysctl.conf depending if ensure option is \*(L"present\*(R" or \*(L"absent\*(R".
.PP
With ensure => \*(L"present\*(R", if the key already exists in the file, it will be updated to the new value.
.PP
.Vb 3
\& task "forwarding", "server01", sub {
\&   sysctl "net.ipv4.ip_forward" => 1, ensure => "present";
\& }
.Ve