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