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