1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry id="vos_status1">
4 <refentrytitle>vos status</refentrytitle>
5 <manvolnum>1</manvolnum>
8 <refname>vos status</refname>
9 <refpurpose>Reports a Volume Server's status</refpurpose>
12 <title>Synopsis</title>
13 <para><emphasis role="bold">vos status</emphasis> <emphasis role="bold">-server</emphasis> <<emphasis>machine name</emphasis>> [<emphasis role="bold">-cell</emphasis> <<emphasis>cell name</emphasis>>]
14 [<emphasis role="bold">-noauth</emphasis>] [<emphasis role="bold">-localauth</emphasis>] [<emphasis role="bold">-verbose</emphasis>] [<emphasis role="bold">-help</emphasis>]</para>
16 <para><emphasis role="bold">vos st</emphasis> <emphasis role="bold">-s</emphasis> <<emphasis>machine name</emphasis>> [<emphasis role="bold">-c</emphasis> <<emphasis>cell name</emphasis>>] [<emphasis role="bold">-n</emphasis>] [<emphasis role="bold">-l</emphasis>]
17 [<emphasis role="bold">-v</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>
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>
27 No active transactions on &lt;machine_name&gt;
30 <para>This command is useful mainly if there is concern that the Volume Server
31 is not performing requested actions.</para>
35 <title>Options</title>
38 <term><emphasis role="bold">-server</emphasis> <<emphasis>server name</emphasis>></term>
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>
48 <term><emphasis role="bold">-cell</emphasis> <<emphasis>cell name</emphasis>></term>
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>
56 <term><emphasis role="bold">-noauth</emphasis></term>
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>
65 <term><emphasis role="bold">-localauth</emphasis></term>
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>
76 <term><emphasis role="bold">-verbose</emphasis></term>
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
85 <term><emphasis role="bold">-help</emphasis></term>
87 <para>Prints the online help for this command. All other valid options are
96 <para>There are two possible types of output.</para>
98 <para>The following message indicates that the Volume Server is not currently
99 performing any actions.</para>
102 No active transactions on I&lt;machine name&gt;
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>
111 <para>Among the fields of possible interest to an administrator are:</para>
115 <para><computeroutput>created</computeroutput> on the first line, which indicates the time at which this
116 transaction started</para>
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>
126 <para><computeroutput>volume</computeroutput> on the third line, which specifies the affected volume's ID
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>
136 <para><computeroutput>procedure</computeroutput> on the third line, which indicates the internal subprocedure
137 being executed</para>
141 <para>A fourth line can appear during certain transactions, and includes the
142 following fields:</para>
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
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>
164 <para>The <computeroutput>lastReceiveTime</computeroutput> and <computeroutput>lastSendTime</computeroutput> are for internal use.</para>
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>
174 % vos status fs1.abc.com
175 --------------------------------------------
176 transaction: 575 created: Tue Jan 2 8:34:56 1990
178 volume: 536871080 partition: /vicepb procedure: Dump
179 packetRead: 2 lastReceiveTime: 113313 packetSend: 24588
181 --------------------------------------------
186 <title>Privilege Required</title>
191 <title>See Also</title>
192 <para><link linkend="vos1">vos(1)</link></para>
196 <title>Copyright</title>
197 <para>IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.</para>
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>