doc/man-pages/pod1/vos_status.pod

   1 =head1 NAME
   2
   3 vos_status - Reports a Volume Server's status
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<vos status> S<<< B<-server> <I<machine name>> >>>
  11     S<<< [B<-cell> <I<cell name>>] >>>
  12     [B<-noauth>] [B<-localauth>]
  13     [B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
  14
  15 B<vos st> S<<< B<-s> <I<machine name>> >>>
  16     S<<< [B<-c> <I<cell name>>] >>>
  17     [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>] [B<-h>]
  18
  19 =for html
  20 </div>
  21
  22 =head1 DESCRIPTION
  23
  24 The B<vos status> command reports on what the Volume Server on a certain
  25 file server machine is doing at the moment the command is issued. If there
  26 is no activity, the following message appears:
  27
  28    No active transactions on <machine_name>
  29
  30 This command is useful mainly if there is concern that the Volume Server
  31 is not performing requested actions.
  32
  33 =head1 OPTIONS
  34
  35 =over 4
  36
  37 =item B<-server> <I<server name>>
  38
  39 Identifies the file server machine running the Volume Server for which to
  40 display status information. Provide the machine's IP address or its host
  41 name (either fully qualified or using an unambiguous abbreviation). For
  42 details, see L<vos(1)>.
  43
  44 =item B<-cell> <I<cell name>>
  45
  46 Names the cell in which to run the command. Do not combine this argument
  47 with the B<-localauth> flag. For more details, see L<vos(1)>.
  48
  49 =item B<-noauth>
  50
  51 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
  52 combine this flag with the B<-localauth> flag. For more details, see
  53 L<vos(1)>.
  54
  55 =item B<-localauth>
  56
  57 Constructs a server ticket using a key from the local
  58 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
  59 to the Volume Server and Volume Location Server during mutual
  60 authentication. Do not combine this flag with the B<-cell> argument or
  61 B<-noauth> flag. For more details, see L<vos(1)>.
  62
  63 =item B<-verbose>
  64
  65 Produces on the standard output stream a detailed trace of the command's
  66 execution. If this argument is omitted, only warnings and error messages
  67 appear.
  68
  69 =item B<-encrypt>
  70
  71 Encrypts the command so that the operation's results are not transmitted
  72 across the network in clear text. This option is available in OpenAFS
  73 versions 1.4.11 or later and 1.5.60 or later.
  74
  75 =item B<-noresolve>
  76
  77 Shows all servers as IP addresses instead of the DNS name. This is very
  78 useful when the server address is registered as 127.0.0.1 or when dealing
  79 with multi-homed servers. This option is available in OpenAFS
  80 versions 1.4.8 or later and 1.5.35 or later.
  81
  82 =item B<-help>
  83
  84 Prints the online help for this command. All other valid options are
  85 ignored.
  86
  87 =back
  88
  89 =head1 OUTPUT
  90
  91 There are two possible types of output.
  92
  93 The following message indicates that the Volume Server is not currently
  94 performing any actions.
  95
  96    No active transactions on I<machine name>
  97
  98 The other possible output is a set of information which is probably more
  99 useful to programmers than to system administrators. A full understanding
 100 of all the fields requires familiarity with the code for the Volume
 101 Server, as many of the fields report ID numbers and flag values that the
 102 Volume Server sets for internal use.
 103
 104 Among the fields of possible interest to an administrator are:
 105
 106 =over 4
 107
 108 =item *
 109
 110 C<created> on the first line, which indicates the time at which this
 111 transaction started
 112
 113 =item *
 114
 115 C<attachFlags> on the second line, where a value of C<offline> indicates
 116 that the volume is not available for other read or write operations during
 117 this transaction
 118
 119 =item *
 120
 121 C<volume> on the third line, which specifies the affected volume's ID
 122 number
 123
 124 =item *
 125
 126 C<partition> on the third line, which indicates where the affected volume
 127 resides (at the beginning of the transaction if this is a move)
 128
 129 =item *
 130
 131 C<procedure> on the third line, which indicates the internal subprocedure
 132 being executed
 133
 134 =back
 135
 136 A fourth line can appear during certain transactions, and includes the
 137 following fields:
 138
 139 =over 4
 140
 141 =item *
 142
 143 C<packetRead> tracks whether information is being read into the
 144 volume. Its absolute value is not informative, but the way it changes
 145 shows whether the B<vos restore> command is executing properly.  As the
 146 B<vos status> command is issued repeatedly during a restore, C<readNext>
 147 increases monotonically to indicate that information is being read into
 148 the volume.
 149
 150 =item *
 151
 152 C<packetSend> tracks whether information is being sent out of the
 153 volume. Its absolute value is not informative, but the way it changes
 154 shows whether the B<vos dump> command is executing properly. As the B<vos
 155 status> command is issued repeatedly during a dump, C<transmitNext>
 156 increases monotonically to indicate that information is being transferred
 157 from the volume into the dump file.
 158
 159 =back
 160
 161 The C<lastReceiveTime> and C<lastSendTime> are for internal use.
 162
 163 =head1 EXAMPLES
 164
 165 The following example illustrates the kind of output that sometimes
 166 appears when the Volume Server on C<fs1.abc.com> is executing a dump at
 167 the time this command is issued.
 168
 169    % vos status fs1.abc.com
 170    --------------------------------------------
 171    transaction: 575  created: Tue Jan 2 8:34:56 1990
 172    attachFlags: offline
 173    volume: 536871080 partition: /vicepb procedure: Dump
 174    packetRead: 2 lastReceiveTime: 113313 packetSend: 24588
 175        lastSendTime: 113317
 176    --------------------------------------------
 177
 178 =head1 PRIVILEGE REQUIRED
 179
 180 None
 181
 182 =head1 SEE ALSO
 183
 184 L<vos(1)>
 185
 186 =head1 COPYRIGHT
 187
 188 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 189
 190 This documentation is covered by the IBM Public License Version 1.0.  It was
 191 converted from HTML to POD by software written by Chas Williams and Russ
 192 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.