doc/man-pages/pod1/vos_status.pod.in

   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 =include fragments/vos-common.pod
  49
  50 =back
  51
  52 =head1 OUTPUT
  53
  54 There are two possible types of output.
  55
  56 The following message indicates that the Volume Server is not currently
  57 performing any actions.
  58
  59    No active transactions on I<machine name>
  60
  61 The other possible output is a set of information which is probably more
  62 useful to programmers than to system administrators. A full understanding
  63 of all the fields requires familiarity with the code for the Volume
  64 Server, as many of the fields report ID numbers and flag values that the
  65 Volume Server sets for internal use.
  66
  67 Among the fields of possible interest to an administrator are:
  68
  69 =over 4
  70
  71 =item *
  72
  73 C<created> on the first line, which indicates the time at which this
  74 transaction started
  75
  76 =item *
  77
  78 In OpenAFS 1.5.75 and later, C<lastActiveTime> on the second line, which
  79 indicates the last time an RPC interacted with this transaction
  80
  81 =item *
  82
  83 C<attachFlags> on the third line, where a value of C<offline> indicates
  84 that the volume is not available for other read or write operations during
  85 this transaction
  86
  87 =item *
  88
  89 C<volume> on the fourth line, which specifies the affected volume's ID
  90 number
  91
  92 =item *
  93
  94 C<partition> on the fourth line, which indicates where the affected volume
  95 resides (at the beginning of the transaction if this is a move)
  96
  97 =item *
  98
  99 C<procedure> on the fourth line, which indicates the internal subprocedure
 100 being executed
 101
 102 =back
 103
 104 A fifth line can appear during certain transactions, and includes the
 105 following fields:
 106
 107 =over 4
 108
 109 =item *
 110
 111 C<packetRead> tracks whether information is being read into the
 112 volume. Its absolute value is not informative, but the way it changes
 113 shows whether the B<vos restore> command is executing properly.  As the
 114 B<vos status> command is issued repeatedly during a restore, C<readNext>
 115 increases monotonically to indicate that information is being read into
 116 the volume.
 117
 118 =item *
 119
 120 C<packetSend> tracks whether information is being sent out of the
 121 volume. Its absolute value is not informative, but the way it changes
 122 shows whether the B<vos dump> command is executing properly. As the B<vos
 123 status> command is issued repeatedly during a dump, C<transmitNext>
 124 increases monotonically to indicate that information is being transferred
 125 from the volume into the dump file.
 126
 127 =back
 128
 129 The C<lastReceiveTime> and C<lastSendTime> are for internal use.
 130
 131 =head1 EXAMPLES
 132
 133 The following example illustrates the kind of output that sometimes
 134 appears when the Volume Server on C<fs1.example.com> is executing a dump at
 135 the time this command is issued.
 136
 137    % vos status fs1.example.com
 138    --------------------------------------------
 139    transaction: 575  created: Tue Jan 2 8:34:56 1990
 140    attachFlags: offline
 141    volume: 536871080 partition: /vicepb procedure: Dump
 142    packetRead: 2 lastReceiveTime: 113313 packetSend: 24588
 143        lastSendTime: 113317
 144    --------------------------------------------
 145
 146 =head1 PRIVILEGE REQUIRED
 147
 148 None
 149
 150 =head1 SEE ALSO
 151
 152 L<vos(1)>
 153
 154 =head1 COPYRIGHT
 155
 156 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 157
 158 This documentation is covered by the IBM Public License Version 1.0.  It was
 159 converted from HTML to POD by software written by Chas Williams and Russ
 160 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.