pod-man-pages-20051015
[openafs.git] / doc / man-pages / pod / bos_exec.pod
1 =head1 NAME
2
3 bos exec - Executes a command on a remote server machine
4
5 =head1 SYNOPSIS
6
7 bos exec B<-server> I<machine name>  B<-cmd> I<command to execute>
8 [B<-cell> I<cell name>]  [B<-noauth>]  [B<-localauth>]  [B<-help>]
9
10 bos e B<-s> I<machine name>  B<-cm> I<command to execute>  [B<-ce> I<cell name>]
11 [B<-n>]  [B<-l>]  [B<-h>]
12
13 =head1 DESCRIPTION
14
15 The C<bos exec> command executes the indicated command on the file server
16 machine named by the B<-server> argument. Its intended use is to reboot
17 the machine, using the B</etc/reboot> command or equivalent.
18
19 =head1 OPTIONS
20
21 =over 4
22
23 =item B<-server> I<machine name>
24
25 Indicates the server machine on which to execute the command.
26 Identify the machine by IP address or its host name (either
27 fully-qualified or abbreviated unambiguously). For details, see
28 the introductory reference page for the C<bos> command suite.
29
30 =item B<-cmd> I<command to execute>
31
32 Specifies the complete local disk pathname of the command to
33 execute (for example, B</etc/reboot>). Surround this argument with
34 double quotes ("") if the command contains one or more spaces.
35
36 =item B<-cell> I<cell name>
37
38 Names the cell in which to run the command. Do not combine this
39 argument with the B<-localauth> flag. For more details, see the
40 introductory L<bos(1)> reference page.
41
42 =item B<-noauth>
43
44 Assigns the unprivileged identity B<anonymous> to the issuer. Do
45 not combine this flag with the B<-localauth> flag. For more
46 details, see the introductory L<bos(1)> reference page.
47
48 =item B<-localauth>
49
50 Constructs a server ticket using a key from the local
51 B</usr/afs/etc/KeyFile> file. The C<bos> command interpreter presents
52 the ticket to the BOS Server during mutual authentication. Do
53 not combine this flag with the B<-cell> or B<-noauth> options. For
54 more details, see the introductory L<bos(1)> reference page.
55
56 =item B<-help>
57
58 Prints the online help for this command. All other valid
59 options are ignored.
60
61 =back
62
63 =head1 EXAMPLES
64
65 The following command reboots the machine B<fs2.abc.com>. The issuer has
66 previously issued the C<bos shutdown> command to shutdown all processes
67 cleanly.
68
69    bos exec -server fs2.abc.com -cmd /sbin/shutdown -r now
70
71 =head1 PRIVILEGE REQUIRED
72
73 The issuer must be listed in the B</usr/afs/etc/UserList> file on the
74 machine named by the B<-server> argument, or must be logged onto a server
75 machine as the local superuser B<root> if the B<-localauth> flag is
76 included.
77
78 =head1 COPYRIGHT
79
80 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
81
82 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
83 and Elizabeth Cassell <e_a_c@mailsnare.net>, 2004,
84 Stanford Linear Accelerator Center, a department of Stanford University.
85
86 =head1 SEE ALSO
87
88 L<bos(1)>
89
90 =cut