openafs/doc/man-pages/pod8/bos_exec.pod
Simon Wilkinson f085951d39 Turn on bos restricted code
Remove the #ifdef's around the bos restricted mode code. This makes
restricted mode available as part of the standard build, but a server
will not go into restricted mode unless the relevant command line
options are specified, or bos setrestricted is run.

Document bos_setrestricted and bos_getrestricted, and the new
'-restricted' command line option. Add a note to the man pages of
all of the commands whose behaviour is affected by restricted mode.

Add 'setr' and 'getr' aliases for setrestart and getrestart so that
these documented shortcuts continue to work (otherwise they'd be
ambiguous against setrestricted and getrestricted). Note that
setre, setres, and setrest will not work once this patch is applied.

Change-Id: Ie69d21493ea5f78757f0a3d478de43fdaabd3c31
Reviewed-on: http://gerrit.openafs.org/1028
Reviewed-by: Michael Meffie <mmeffie@sinenomine.net>
Reviewed-by: Andrew Deason <adeason@sinenomine.net>
Tested-by: Andrew Deason <adeason@sinenomine.net>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2009-12-31 04:54:52 -08:00

96 lines
2.7 KiB
Plaintext

=head1 NAME
bos_exec - Executes a command on a remote server machine
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<bos exec> S<<< B<-server> <I<machine name>> >>> S<<< B<-cmd> <I<command to execute>> >>>
S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-help>]
B<bos e> S<<< B<-s> <I<machine name>> >>> S<<< B<-cm> <I<command to execute>> >>>
S<<< [B<-ce> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-h>]
=for html
</div>
=head1 DESCRIPTION
The B<bos exec> command executes the indicated command on the file server
machine named by the B<-server> argument. Its intended use is to reboot
the machine, using the F</sbin/reboot> command or equivalent.
=head1 OPTIONS
=over 4
=item B<-server> <I<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 L<bos(8)>.
=item B<-cmd> <I<command to execute>>
Specifies the complete local disk pathname of the command to execute (for
example, F</sbin/reboot>). Surround this argument with double quotes
(C<"">) if the command contains one or more spaces.
=item B<-cell> <I<cell name>>
Names the cell in which to run the command. Do not combine this argument
with the B<-localauth> flag. For more details, see L<bos(8)>.
=item B<-noauth>
Assigns the unprivileged identity C<anonymous> to the issuer. Do not
combine this flag with the B<-localauth> flag. For more details, see
L<bos(8)>.
=item B<-localauth>
Constructs a server ticket using a key from the local
F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
ticket to the BOS Server during mutual authentication. Do not combine this
flag with the B<-cell> or B<-noauth> options. For more details, see
L<bos(8)>.
=item B<-help>
Prints the online help for this command. All other valid options are
ignored.
=back
=head1 EXAMPLES
The following command reboots the machine C<fs2.abc.com>. The issuer has
previously issued the B<bos shutdown> command to shutdown all processes
cleanly.
% bos exec -server fs2.abc.com -cmd /sbin/shutdown -r now
=head1 PRIVILEGE REQUIRED
The issuer must be listed in the F</usr/afs/etc/UserList> file on the
machine named by the B<-server> argument, or must be logged onto a server
machine as the local superuser C<root> if the B<-localauth> flag is
included.
The B<bos exec> command is not available on servers running in restricted
mode.
=head1 SEE ALSO
L<bos(8)>
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
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.