pod-updates-20060227
[openafs.git] / doc / man-pages / pod8 / bos_status.pod
1 =head1 NAME
2
3 bos status - Displays the status of server processes
4
5 =head1 SYNOPSIS
6
7 B<bos status -server> <I<machine name>>  [-instance <I<server process name>>+]
8 [B<-long>]  [B<-cell> <I<cell name>>]  [B<-noauth>]  [B<-localauth>]  [B<-help>]
9
10 B<bos stat -s> <I<machine name>>  [-i <I<server process name>>+]
11 [B<-lon>]  [B<-c> <I<cell name>>]  [B<-n>]  [B<-loc>]  [B<-h>]
12
13 =head1 DESCRIPTION
14
15 The bos status command reports the status of processes on the
16 server machine named by the B<-server> argument, either
17
18 =over 4
19
20 =item *
21
22 All of the AFS server processes listed in the
23 F</usr/afs/local/BosConfig> file
24
25 =item *
26
27 Only these processes named by the -instance argument
28
29 =back
30
31 =head1 OPTIONS
32
33 =over 4
34
35 =item B<-server> <I<machine name>>
36
37 Indicates the server machine for which to report server process
38 status. Identify the machine by IP address or its host name (either
39 fully-qualified or abbreviated unambiguously). For details, see L<bos(8)>.
40
41 =item -instance
42
43 Names each process for which to report status. Use the process name
44 assigned with the B<-instance> argument to the B<bos>
45 command. The output from the B<bos status> command lists the
46 names.
47
48 =item -long
49
50 Produces more detailed status information.
51
52 =item B<-cell> <I<cell name>>
53
54 Names the cell in which to run the command. Do not combine this
55 argument with the B<-localauth> flag. For more details, see L<bos(8)>.
56
57 =item B<-noauth>
58
59 Assigns the unprivileged identity C<anonymous> to the
60 issuer. Do not combine this flag with the B<-localauth>
61 flag. For more details, see L<bos(8)>.
62
63 =item B<-localauth>
64
65 Constructs a server ticket using a key from the local
66 F</usr/afs/etc/KeyFile> file. The B<bos> command
67 interpreter presents the ticket to the BOS Server during mutual
68 authentication. Do not combine this flag with the B<-cell> or
69 B<-noauth> options. For more details, see L<bos(8)>.
70
71 =item B<-help>
72
73 Prints the online help for this command. All other valid options
74 are ignored.
75
76 =back
77
78 =head1 OUTPUT
79
80 The output for a process includes at least one line, which reports one of
81 the following as the process's current status:
82
83 =over 4
84
85 =item *
86
87 C<currently running normally>. The process's status
88 flag in the B<BosConfig> file is C<Run>. For
89 B<cron> entries, this message indicates only that the command is
90 scheduled to run, not necessarily that it was executing when the B<bos
91 status> command was issued.
92
93 =item *
94
95 C<disabled>. The process is not running, and its
96 B<BosConfig> status flag is C<NotRun>.
97
98 =item *
99
100 C<temporarily disabled>. The process is not running
101 although its status flag in the B<BosConfig> file is
102 C<Run>. Either an administrator used the B<bos
103 shutdown> command to stop it, or the
104
105 =item *
106
107 BOS Server stopped trying to restart it after numerous failed
108 attempts. In the second case, the auxiliary message is C<stopped for
109 too many errors>.
110
111 =item *
112
113 C<temporarily enabled>. The process is running although its
114 status flag in the B<BosConfig> file is C<NotRun>. An
115 administrator has used the B<bos startup> command to start it.
116
117 =back
118
119 If one of the following special circumstances applies to the process, the
120 indicated message appears in its entry:
121
122 =over 4
123
124 =item *
125
126 C<has core file>. The process failed and created a core
127 file in the F</usr/afs/logs> directory. If the BOS Server was
128 able to restart the process after the failure, the primary status is
129 C<currently running normally>.
130
131 =item *
132
133 C<stopped for too many  errors>. The reason for the primary
134 status C<temporarily  disabled> is that the BOS Server's attempts
135 to restart the process all failed.
136
137 =back
138
139 The entry for the fs process always includes a second line to
140 report the process's C<Auxiliary status>, which is one of the
141 following:
142
143 =over 4
144
145 =item *
146
147 C<file server running>. The File Server and Volume Server
148 components of the File Server process are running normally.
149
150 =item *
151
152 C<salvaging file system>. The Salvager is running, so the
153 File Server and Volume Server are temporarily disabled. The BOS Server
154 restarts them as soon as the Salvager is finished.
155
156 =back
157
158 The entry for a cron process includes an C<Auxiliary
159 status> that reports when the command will next execute.
160
161 If the -long flag is used, each entry includes the following
162 additional information:
163
164 =over 4
165
166 =item *
167
168 The process's type (C<simple>, C<fs>, or
169 C<cron>).
170
171 =item *
172
173 The day and time the process last started or restarted.
174
175 =item *
176
177 The number of C<proc starts>, which is how many times the BOS
178 Server has started or restarted the process since it started itself.
179
180 =item *
181
182 The C<Last exit> time when the process (or one of the component
183 processes in the B<fs> process) last terminated. This line does
184 not appear if the process has not terminated since the BOS Server
185 started.
186
187 =item *
188
189 The C<Last error exit> time when the process (or one of the
190 component processes in the B<fs> process) last failed due to an
191 error. A further explanation such as C<due to shutdown request>
192 sometimes appears. This line does not appear if the process has not
193 failed since the BOS Server started.
194
195 =item *
196
197 Each command that the BOS Server invokes to start the process, as
198 specified by the B<-cmd> argument to the B<bos create>
199 command.
200
201 =item *
202
203 The pathname of the notifier program that the BOS Server invokes when the
204 process terminates (if any), as specified by the B<-notifier> argument
205 to the B<bos create> command.
206
207 =back
208
209 If the -long flag is provided and the BOS Server discovers that
210 the mode bits on files and subdirectories in the local F</usr/afs>
211 directory differ from the expected values, it prints the following warning
212 message:
213
214    Bosserver reports inappropriate access on server directories
215
216 The following chart summarizes the expected mode bit settings. A
217 question mark indicates that the BOS Server does not check that bit.
218
219 =head1 EXAMPLES
220
221 The following example command displays the status of processes on the
222 machine B<fs3.abc.com>:
223
224    % bos status fs3.abc.com
225    Instance buserver, currently running normally.
226    Instance kaserver, currently running normally.
227    Instance ptserver, currently running normally.
228    Instance vlserver, currently running normally.
229    Instance fs, has core file, currently running normally.
230        Auxiliary status is: file server running.
231    Instance upserver, currently running normally.
232    Instance runntp, currently running normally.
233
234 The following example command displays a detailed status report for the
235 B<fs> and B<ptserver> processes on the machine
236 B<fs1.abc.com>.
237
238    % bos status -server fs1.abc.com -instance fs ptserver -long
239    Instance fs, (type is fs), currently running normally.
240       Auxiliary status is: file server running.
241       Process last started at Wed Jan 7 5:34:49 1998 (3 proc starts)
242       Last exit at Wed Jan 7 5:34:49 1998
243       Last error exit at Wed Jan 7 5:34:49 1998, due to shutdown
244           request
245       Command 1 is '/usr/afs/bin/fileserver'
246       Command 2 is '/usr/afs/bin/volserver'
247       Command 3 is '/usr/afs/bin/salvager'
248    Instance ptserver, (type is simple) currently running normally.
249       Process last started at Tue Jan 6 8:29:19 1998 (1 proc starts)
250       Command 1 is '/usr/afs/bin/ptserver'
251
252 =head1 PRIVILEGE REQUIRED
253
254 None
255
256 =head1 SEE ALSO
257
258 L<BosConfig(5)>,
259 L<KeyFile(5)>,
260 L<bos(8)>,
261 L<bos_create(8)>,
262 L<bos_shutdown(8)>,
263 L<bos_startup(8)>,
264 L<bos_status(8)>
265
266 =head1 COPYRIGHT
267
268 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
269
270 This documentation is covered by the IBM Public License Version 1.0.  It was
271 converted from HTML to POD by software written by Chas Williams and Russ
272 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.