.\" -*- 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 "BOS_EXEC 8"
.TH BOS_EXEC 8 2024-03-20 OpenAFS "AFS Command Reference"
.\" 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
bos_exec \- Executes a command on a remote server machine
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBbos exec\fR \fB\-server\fR\ <\fImachine\ name\fR> \fB\-cmd\fR\ <\fIcommand\ to\ execute\fR>
    [\fB\-cell\fR\ <\fIcell\ name\fR>] [\fB\-noauth\fR] [\fB\-localauth\fR] [\fB\-help\fR]
.PP
\&\fBbos e\fR \fB\-s\fR\ <\fImachine\ name\fR> \fB\-cm\fR\ <\fIcommand\ to\ execute\fR>
    [\fB\-ce\fR\ <\fIcell\ name\fR>] [\fB\-n\fR] [\fB\-l\fR] [\fB\-h\fR]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBbos exec\fR command executes the indicated command on the file server
machine named by the \fB\-server\fR argument. Its intended use is to reboot
the machine, using the \fI/sbin/reboot\fR command or equivalent.
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-server\fR <\fImachine name\fR>" 4
.IX Item "-server <machine name>"
Indicates the server machine on which to execute the command.  Identify
the machine by IP address or its host name (either fully-qualified or
abbreviated unambiguously). For details, see \fBbos\fR\|(8).
.IP "\fB\-cmd\fR <\fIcommand to execute\fR>" 4
.IX Item "-cmd <command to execute>"
Specifies the complete local disk pathname of the command to execute (for
example, \fI/sbin/reboot\fR). Surround this argument with double quotes
(\f(CW""\fR) if the command contains one or more spaces.
.IP "\fB\-cell\fR <\fIcell name\fR>" 4
.IX Item "-cell <cell name>"
Names the cell in which to run the command. Do not combine this argument
with the \fB\-localauth\fR flag. For more details, see \fBbos\fR\|(8).
.IP \fB\-noauth\fR 4
.IX Item "-noauth"
Assigns the unprivileged identity \f(CW\*(C`anonymous\*(C'\fR to the issuer. Do not
combine this flag with the \fB\-localauth\fR flag. For more details, see
\&\fBbos\fR\|(8).
.IP \fB\-localauth\fR 4
.IX Item "-localauth"
Constructs a server ticket using a key from the local
\&\fI/etc/openafs/server/KeyFile\fR file. The \fBbos\fR command interpreter presents the
ticket to the BOS Server during mutual authentication. Do not combine this
flag with the \fB\-cell\fR or \fB\-noauth\fR options. For more details, see
\&\fBbos\fR\|(8).
.IP \fB\-help\fR 4
.IX Item "-help"
Prints the online help for this command. All other valid options are
ignored.
.SH EXAMPLES
.IX Header "EXAMPLES"
The following command reboots the machine \f(CW\*(C`fs2.example.com\*(C'\fR. The issuer has
previously issued the \fBbos shutdown\fR command to shutdown all processes
cleanly.
.PP
.Vb 1
\&   % bos exec \-server fs2.example.com \-cmd /sbin/shutdown \-r now
.Ve
.SH "PRIVILEGE REQUIRED"
.IX Header "PRIVILEGE REQUIRED"
The issuer must be listed in the \fI/etc/openafs/server/UserList\fR file on the
machine named by the \fB\-server\fR argument, or must be logged onto a server
machine as the local superuser \f(CW\*(C`root\*(C'\fR if the \fB\-localauth\fR flag is
included.
.PP
The \fBbos exec\fR command is not available on servers running in restricted
mode.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBbos\fR\|(8)
.SH COPYRIGHT
.IX Header "COPYRIGHT"
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
.PP
This documentation is covered by the IBM Public License Version 1.0.  It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.