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