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