Merge 1.8.0~pre4 packaging into master
[pkg-k5-afs_openafs.git] / doc / man-pages / pod8 / bos_exec.pod
blob83c89bb4d2e3aeb4eb77203b752d05dc4c14fe35
1 =head1 NAME
3 bos_exec - Executes a command on a remote server machine
5 =head1 SYNOPSIS
7 =for html
8 <div class="synopsis">
10 B<bos exec> S<<< B<-server> <I<machine name>> >>> S<<< B<-cmd> <I<command to execute>> >>>
11     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-help>]
13 B<bos e> S<<< B<-s> <I<machine name>> >>> S<<< B<-cm> <I<command to execute>> >>>
14     S<<< [B<-ce> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-h>]
16 =for html
17 </div>
19 =head1 DESCRIPTION
21 The B<bos exec> command executes the indicated command on the file server
22 machine named by the B<-server> argument. Its intended use is to reboot
23 the machine, using the F</sbin/reboot> command or equivalent.
25 =head1 OPTIONS
27 =over 4
29 =item B<-server> <I<machine name>>
31 Indicates the server machine on which to execute the command.  Identify
32 the machine by IP address or its host name (either fully-qualified or
33 abbreviated unambiguously). For details, see L<bos(8)>.
35 =item B<-cmd> <I<command to execute>>
37 Specifies the complete local disk pathname of the command to execute (for
38 example, F</sbin/reboot>). Surround this argument with double quotes
39 (C<"">) if the command contains one or more spaces.
41 =item B<-cell> <I<cell name>>
43 Names the cell in which to run the command. Do not combine this argument
44 with the B<-localauth> flag. For more details, see L<bos(8)>.
46 =item B<-noauth>
48 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
49 combine this flag with the B<-localauth> flag. For more details, see
50 L<bos(8)>.
52 =item B<-localauth>
54 Constructs a server ticket using a key from the local
55 F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
56 ticket to the BOS Server during mutual authentication. Do not combine this
57 flag with the B<-cell> or B<-noauth> options. For more details, see
58 L<bos(8)>.
60 =item B<-help>
62 Prints the online help for this command. All other valid options are
63 ignored.
65 =back
67 =head1 EXAMPLES
69 The following command reboots the machine C<fs2.example.com>. The issuer has
70 previously issued the B<bos shutdown> command to shutdown all processes
71 cleanly.
73    % bos exec -server fs2.example.com -cmd /sbin/shutdown -r now
75 =head1 PRIVILEGE REQUIRED
77 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
78 machine named by the B<-server> argument, or must be logged onto a server
79 machine as the local superuser C<root> if the B<-localauth> flag is
80 included.
82 The B<bos exec> command is not available on servers running in restricted
83 mode.
85 =head1 SEE ALSO
87 L<bos(8)>
89 =head1 COPYRIGHT
91 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
93 This documentation is covered by the IBM Public License Version 1.0.  It was
94 converted from HTML to POD by software written by Chas Williams and Russ
95 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.