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