Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod8 / bos_exec.pod
CommitLineData
805e021f
CE
1=head1 NAME
2
3bos_exec - Executes a command on a remote server machine
4
5=head1 SYNOPSIS
6
7=for html
8<div class="synopsis">
9
10B<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>]
12
13B<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>]
15
16=for html
17</div>
18
19=head1 DESCRIPTION
20
21The B<bos exec> command executes the indicated command on the file server
22machine named by the B<-server> argument. Its intended use is to reboot
23the machine, using the F</sbin/reboot> command or equivalent.
24
25=head1 OPTIONS
26
27=over 4
28
29=item B<-server> <I<machine name>>
30
31Indicates the server machine on which to execute the command. Identify
32the machine by IP address or its host name (either fully-qualified or
33abbreviated unambiguously). For details, see L<bos(8)>.
34
35=item B<-cmd> <I<command to execute>>
36
37Specifies the complete local disk pathname of the command to execute (for
38example, F</sbin/reboot>). Surround this argument with double quotes
39(C<"">) if the command contains one or more spaces.
40
41=item B<-cell> <I<cell name>>
42
43Names the cell in which to run the command. Do not combine this argument
44with the B<-localauth> flag. For more details, see L<bos(8)>.
45
46=item B<-noauth>
47
48Assigns the unprivileged identity C<anonymous> to the issuer. Do not
49combine this flag with the B<-localauth> flag. For more details, see
50L<bos(8)>.
51
52=item B<-localauth>
53
54Constructs a server ticket using a key from the local
55F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
56ticket to the BOS Server during mutual authentication. Do not combine this
57flag with the B<-cell> or B<-noauth> options. For more details, see
58L<bos(8)>.
59
60=item B<-help>
61
62Prints the online help for this command. All other valid options are
63ignored.
64
65=back
66
67=head1 EXAMPLES
68
69The following command reboots the machine C<fs2.example.com>. The issuer has
70previously issued the B<bos shutdown> command to shutdown all processes
71cleanly.
72
73 % bos exec -server fs2.example.com -cmd /sbin/shutdown -r now
74
75=head1 PRIVILEGE REQUIRED
76
77The issuer must be listed in the F</usr/afs/etc/UserList> file on the
78machine named by the B<-server> argument, or must be logged onto a server
79machine as the local superuser C<root> if the B<-localauth> flag is
80included.
81
82The B<bos exec> command is not available on servers running in restricted
83mode.
84
85=head1 SEE ALSO
86
87L<bos(8)>
88
89=head1 COPYRIGHT
90
91IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
92
93This documentation is covered by the IBM Public License Version 1.0. It was
94converted from HTML to POD by software written by Chas Williams and Russ
95Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.