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