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