doc/xml/AdminReference/sect1/vos_status.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="vos_status1">
   3   <refmeta>
   4     <refentrytitle>vos status</refentrytitle>
   5     <manvolnum>1</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>vos status</refname>
   9     <refpurpose>Reports a Volume Server's status</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">vos status</emphasis> <emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt; [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;]
  14         [<emphasis role="bold">-noauth</emphasis>] [<emphasis role="bold">-localauth</emphasis>] [<emphasis role="bold">-verbose</emphasis>] [<emphasis role="bold">-help</emphasis>]</para>
  15
  16     <para><emphasis role="bold">vos st</emphasis> <emphasis role="bold">-s</emphasis> &lt;<emphasis>machine name</emphasis>&gt; [<emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-n</emphasis>] [<emphasis role="bold">-l</emphasis>]
  17         [<emphasis role="bold">-v</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>
  18
  19   </refsect1>
  20   <refsect1>
  21     <title>Description</title>
  22     <para>The <emphasis role="bold">vos status</emphasis> command reports on what the Volume Server on a certain
  23     file server machine is doing at the moment the command is issued. If there
  24     is no activity, the following message appears:</para>
  25
  26 <programlisting>
  27    No active transactions on &amp;lt;machine_name&amp;gt;
  28
  29 </programlisting>
  30       <para>This command is useful mainly if there is concern that the Volume Server
  31       is not performing requested actions.</para>
  32
  33     </refsect1>
  34     <refsect1>
  35       <title>Options</title>
  36       <variablelist>
  37         <varlistentry>
  38           <term><emphasis role="bold">-server</emphasis> &lt;<emphasis>server name</emphasis>&gt;</term>
  39           <listitem>
  40             <para>Identifies the file server machine running the Volume Server for which to
  41             display status information. Provide the machine's IP address or its host
  42             name (either fully qualified or using an unambiguous abbreviation). For
  43             details, see <link linkend="vos1">vos(1)</link>.</para>
  44
  45           </listitem>
  46         </varlistentry>
  47         <varlistentry>
  48           <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
  49           <listitem>
  50             <para>Names the cell in which to run the command. Do not combine this argument
  51             with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="vos1">vos(1)</link>.</para>
  52
  53           </listitem>
  54         </varlistentry>
  55         <varlistentry>
  56           <term><emphasis role="bold">-noauth</emphasis></term>
  57           <listitem>
  58             <para>Assigns the unprivileged identity <computeroutput>anonymous</computeroutput> to the issuer. Do not
  59             combine this flag with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see
  60             <link linkend="vos1">vos(1)</link>.</para>
  61
  62           </listitem>
  63         </varlistentry>
  64         <varlistentry>
  65           <term><emphasis role="bold">-localauth</emphasis></term>
  66           <listitem>
  67             <para>Constructs a server ticket using a key from the local
  68             <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">vos</emphasis> command interpreter presents it
  69             to the Volume Server and Volume Location Server during mutual
  70             authentication. Do not combine this flag with the <emphasis role="bold">-cell</emphasis> argument or
  71             <emphasis role="bold">-noauth</emphasis> flag. For more details, see <link linkend="vos1">vos(1)</link>.</para>
  72
  73           </listitem>
  74         </varlistentry>
  75         <varlistentry>
  76           <term><emphasis role="bold">-verbose</emphasis></term>
  77           <listitem>
  78             <para>Produces on the standard output stream a detailed trace of the command's
  79             execution. If this argument is omitted, only warnings and error messages
  80             appear.</para>
  81
  82           </listitem>
  83         </varlistentry>
  84         <varlistentry>
  85           <term><emphasis role="bold">-help</emphasis></term>
  86           <listitem>
  87             <para>Prints the online help for this command. All other valid options are
  88             ignored.</para>
  89
  90           </listitem>
  91         </varlistentry>
  92       </variablelist>
  93     </refsect1>
  94     <refsect1>
  95       <title>Output</title>
  96       <para>There are two possible types of output.</para>
  97
  98       <para>The following message indicates that the Volume Server is not currently
  99       performing any actions.</para>
 100
 101 <programlisting>
 102    No active transactions on I&amp;lt;machine name&amp;gt;
 103
 104 </programlisting>
 105         <para>The other possible output is a set of information which is probably more
 106         useful to programmers than to system administrators. A full understanding
 107         of all the fields requires familiarity with the code for the Volume
 108         Server, as many of the fields report ID numbers and flag values that the
 109         Volume Server sets for internal use.</para>
 110
 111         <para>Among the fields of possible interest to an administrator are:</para>
 112
 113         <itemizedlist>
 114           <listitem>
 115             <para><computeroutput>created</computeroutput> on the first line, which indicates the time at which this
 116             transaction started</para>
 117
 118           </listitem>
 119           <listitem>
 120             <para><computeroutput>attachFlags</computeroutput> on the second line, where a value of <computeroutput>offline</computeroutput> indicates
 121             that the volume is not available for other read or write operations during
 122             this transaction</para>
 123
 124           </listitem>
 125           <listitem>
 126             <para><computeroutput>volume</computeroutput> on the third line, which specifies the affected volume's ID
 127             number</para>
 128
 129           </listitem>
 130           <listitem>
 131             <para><computeroutput>partition</computeroutput> on the third line, which indicates where the affected volume
 132             resides (at the beginning of the transaction if this is a move)</para>
 133
 134           </listitem>
 135           <listitem>
 136             <para><computeroutput>procedure</computeroutput> on the third line, which indicates the internal subprocedure
 137             being executed</para>
 138
 139           </listitem>
 140         </itemizedlist>
 141         <para>A fourth line can appear during certain transactions, and includes the
 142         following fields:</para>
 143
 144         <itemizedlist>
 145           <listitem>
 146             <para><computeroutput>packetRead</computeroutput> tracks whether information is being read into the
 147             volume. Its absolute value is not informative, but the way it changes
 148             shows whether the <emphasis role="bold">vos restore</emphasis> command is executing properly.  As the
 149             <emphasis role="bold">vos status</emphasis> command is issued repeatedly during a restore, <computeroutput>readNext</computeroutput>
 150             increases monotonically to indicate that information is being read into
 151             the volume.</para>
 152
 153           </listitem>
 154           <listitem>
 155             <para><computeroutput>packetSend</computeroutput> tracks whether information is being sent out of the
 156             volume. Its absolute value is not informative, but the way it changes
 157             shows whether the <emphasis role="bold">vos dump</emphasis> command is executing properly. As the <emphasis role="bold">vos
 158             status</emphasis> command is issued repeatedly during a dump, <computeroutput>transmitNext</computeroutput>
 159             increases monotonically to indicate that information is being transferred
 160             from the volume into the dump file.</para>
 161
 162           </listitem>
 163         </itemizedlist>
 164         <para>The <computeroutput>lastReceiveTime</computeroutput> and <computeroutput>lastSendTime</computeroutput> are for internal use.</para>
 165
 166       </refsect1>
 167       <refsect1>
 168         <title>Examples</title>
 169         <para>The following example illustrates the kind of output that sometimes
 170         appears when the Volume Server on <computeroutput>fs1.abc.com</computeroutput> is executing a dump at
 171         the time this command is issued.</para>
 172
 173 <programlisting>
 174    % vos status fs1.abc.com
 175    --------------------------------------------
 176    transaction: 575  created: Tue Jan 2 8:34:56 1990
 177    attachFlags: offline
 178    volume: 536871080 partition: /vicepb procedure: Dump
 179    packetRead: 2 lastReceiveTime: 113313 packetSend: 24588
 180        lastSendTime: 113317
 181    --------------------------------------------
 182
 183 </programlisting>
 184         </refsect1>
 185         <refsect1>
 186           <title>Privilege Required</title>
 187           <para>None</para>
 188
 189         </refsect1>
 190         <refsect1>
 191           <title>See Also</title>
 192           <para><link linkend="vos1">vos(1)</link></para>
 193
 194         </refsect1>
 195         <refsect1>
 196           <title>Copyright</title>
 197           <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 198
 199           <para>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.</para>
 202
 203         </refsect1>
 204       </refentry>