Document KeyFileExt(5)
[openafs.git] / doc / man-pages / pod8 / bos_restart.pod
1 =head1 NAME
2
3 bos_restart - Restarts a server process
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<bos restart> S<<< B<-server> <I<machine name>> >>> S<<< [B<-instance> <I<instances>>+] >>>
11     [B<-bosserver>] [B<-all>] S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>]
12     [B<-localauth>] [B<-help>]
13
14 B<bos res> S<<< B<-s> <I<machine name>> >>> S<<< [B<-i> <I<instances>>+] >>> [B<-b>]
15     [B<-a>] S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-h>]
16
17 =for html
18 </div>
19
20 =head1 DESCRIPTION
21
22 The B<bos restart> command stops and immediately restarts server processes
23 on the server machine named by the B<-server> argument. Indicate which
24 process or processes to restart by providing one of the following
25 arguments:
26
27 =over 4
28
29 =item *
30
31 The B<-instance> argument names each AFS server process to stop and
32 restart immediately, regardless of its status flag in the
33 F</usr/afs/local/BosConfig> file. Do not include B<bosserver> in the list
34 of processes; use the B<-bosserver> flag instead.
35
36 =item *
37
38 The B<-bosserver> flag stops all AFS server processes running on the
39 machine, including the BOS Server. A new BOS Server starts immediately,
40 and it starts a new instance of each process that is marked with the
41 C<Run> status flag in the F<BosConfig> file.
42
43 =item *
44
45 The B<-all> flag stops all AFS server processes running on the machine,
46 except the BOS Server, and immediately restarts the processes that are
47 marked with the C<Run> status flag in the F<BosConfig> file.
48
49 =back
50
51 This command does not change a process's status flag in the F<BosConfig>
52 file.
53
54 =head1 OPTIONS
55
56 =over 4
57
58 =item B<-server> <I<machine name>>
59
60 Indicates the server machine on which to restart each process.  Identify
61 the machine by IP address or its host name (either fully-qualified or
62 abbreviated unambiguously). For details, see L<bos(8)>.
63
64 =item B<-instance> <I<instances>>+
65
66 Names each process to stop and then restart immediately regardless of its
67 status flag setting. Use the process name assigned with the B<-instance>
68 argument to the B<bos create> command. The output from the B<bos status>
69 command lists the names. Provide this flag or one of the B<-bosserver> or
70 B<-all> options, but do not combine them.
71
72 =item B<-bosserver>
73
74 Stops all AFS server processes running on the machine, including the BOS
75 Server. A new BOS Server instance immediately starts, and starts all
76 processes marked with the C<Run> status flag in the F<BosConfig>
77 file. Provide this flag or one of the B<-instance> or B<-all> options, but
78 do not combine them.
79
80 =item B<-all>
81
82 Stops all AFS server processes running on the machine other than the BOS
83 Server, and immediately restarts the processes marked with the B<Run>
84 status flag in the F<BosConfig> file. Provide this flag or one of the
85 B<-instance> or B<-bosserver> options, but do not combine them.
86
87 =item B<-cell> <I<cell name>>
88
89 Names the cell in which to run the command. Do not combine this argument
90 with the B<-localauth> flag. For more details, see L<bos(8)>.
91
92 =item B<-noauth>
93
94 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
95 combine this flag with the B<-localauth> flag. For more details, see
96 L<bos(8)>.
97
98 =item B<-localauth>
99
100 Constructs a server ticket using a key from the local
101 F</usr/afs/etc/KeyFile> or F</usr/afs/etc/KeyFileExt> file.
102 The B<bos> command interpreter presents the
103 ticket to the BOS Server during mutual authentication. Do not combine this
104 flag with the B<-cell> or B<-noauth> options. For more details, see
105 L<bos(8)>.
106
107 =item B<-help>
108
109 Prints the online help for this command. All other valid options are
110 ignored.
111
112 =back
113
114 =head1 EXAMPLES
115
116 The following command stops and restarts all processes running on the
117 machine C<fs3.example.com>, including the BOS Server.
118
119    % bos restart -server fs3.example.com -bosserver
120
121 The following command stops and restarts all processes running on the
122 machine C<fs5.example.com>, excluding the BOS Server.
123
124    % bos restart -server fs5.example.com -all
125
126 The following command stops and restarts the Protection Server and Volume
127 Location (VL) Server processes on the machine C<db3.example.com>:
128
129    % bos restart -server db3.example.com -instance ptserver vlserver
130
131 =head1 PRIVILEGE REQUIRED
132
133 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
134 machine named by the B<-server> argument, or must be logged onto a server
135 machine as the local superuser C<root> if the B<-localauth> flag is
136 included.
137
138 =head1 SEE ALSO
139
140 L<BosConfig(5)>,
141 L<KeyFile(5)>,
142 L<KeyFileExt(5)>,
143 L<UserList(5)>,
144 L<bos(8)>,
145 L<bos_create(8)>,
146 L<bos_status(8)>
147
148 =head1 COPYRIGHT
149
150 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
151
152 This documentation is covered by the IBM Public License Version 1.0.  It was
153 converted from HTML to POD by software written by Chas Williams and Russ
154 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.