.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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::OS 3pm"
.TH Munin::Node::OS 3pm "2021-07-28" "perl v5.32.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"
Munin::Node::OS \- OS related utility methods for the Munin node.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& use Munin::Node::OS;
\& my $uid  = Munin::Node::OS\->get_uid(\*(Aqfoo\*(Aq);
\& my $host = Munin::Node::OS\->get_fq_hostname();
.Ve
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBget_uid\fR" 4
.IX Item "get_uid"
.Vb 1
\& $uid = $class\->get_uid($user)
.Ve
.Sp
Returns the user \s-1ID.\s0 \f(CW$user\fR might either be a user name or a user
\&\s-1ID.\s0 Returns undef if the user doesn't exist.
.IP "\fBget_gid\fR" 4
.IX Item "get_gid"
.Vb 1
\& $gid = $class\->get_gid($group)
.Ve
.Sp
Returns the group \s-1ID.\s0 \f(CW$group\fR might either be a group name or a group
\&\s-1ID.\s0 Returns undef if the group doesn't exist.
.IP "\fBget_fq_hostname\fR" 4
.IX Item "get_fq_hostname"
.Vb 1
\& $host = $class\->get_fq_hostname()
.Ve
.Sp
Returns the fully qualified host name of the machine.
.IP "\fBcheck_perms_if_paranoid\fR" 4
.IX Item "check_perms_if_paranoid"
.Vb 1
\& $bool = $class\->check_perms_if_paranoid($target);
.Ve
.Sp
If paranoia is enabled, returns false unless \f(CW$target\fR is owned by root,
and has safe permissions.  If \f(CW$target\fR is a file, also checks the
directory it inhabits.
.IP "\fBrun_as_child\fR" 4
.IX Item "run_as_child"
.Vb 1
\&  $result = run_as_child($timeout, $coderef, @arguments);
.Ve
.Sp
Creates a child process to run \f(CW$code\fR and waits for up to
\&\f(CW$timeout\fR seconds for it to complete.  Returns a hashref
containing the following keys:
.RS 4
.ie n .IP """stdout"", ""stderr""" 4
.el .IP "\f(CWstdout\fR, \f(CWstderr\fR" 4
.IX Item "stdout, stderr"
Array references containing the output of these filehandles;
.ie n .IP """retval""" 4
.el .IP "\f(CWretval\fR" 4
.IX Item "retval"
The result of \fBwait()\fR;
.ie n .IP """timed_out""" 4
.el .IP "\f(CWtimed_out\fR" 4
.IX Item "timed_out"
True if the child had to be interrupted.
.RE
.RS 4
.Sp
System errors will cause it to carp.
.RE
.IP "\fBreap_child_group\fR" 4
.IX Item "reap_child_group"
.Vb 1
\& $class\->reap_child_group($pid);
.Ve
.Sp
Sends \s-1SIGHUP\s0 and \s-1SIGKILL\s0 to the process group identified by \f(CW$pid\fR.
.Sp
Sleeps for 2 seconds between \s-1SIGHUP\s0 and \s-1SIGKILL.\s0
.IP "\fBpossible_to_signal_process\fR" 4
.IX Item "possible_to_signal_process"
.Vb 1
\& my $bool = $class\->possible_to_signal_process($pid)
.Ve
.Sp
Check whether it's possible to send a signal to \f(CW$pid\fR (that means, to
be brief, that the process is owned by the same user, or we are the
super-user).  This is a useful way to check that a child process is
alive (even if only as a zombie) and hasn't changed its \s-1UID.\s0
.IP "\fBset_effective_user_id\fR" 4
.IX Item "set_effective_user_id"
.Vb 6
\& eval {
\&     $class\->set_effective_user_id($uid);
\& };
\& if ($@) {
\&     # Failed to set EUID
\& }
.Ve
.Sp
The name says it all ...
.IP "\fBset_effective_group_id\fR" 4
.IX Item "set_effective_group_id"
See documentation for \fBset_effective_user_id()\fR
.IP "\fBset_real_user_id\fR" 4
.IX Item "set_real_user_id"
See documentation for \fBset_effective_user_id()\fR
.IP "\fBset_real_group_id\fR" 4
.IX Item "set_real_group_id"
See documentation for \fBset_effective_user_id()\fR
.IP "\fBset_umask\fR" 4
.IX Item "set_umask"
Set umask so that files created by plugins are group writable
Only call right before exec-ing a plugin.