admin-doc-sysname-20040713
[openafs.git] / doc / html / AdminReference / auarf275.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
2 <HTML><HEAD>
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
10 </HEAD><BODY>
11 <!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
12 <BODY bgcolor="ffffff"> 
13 <!-- End Header Records  ============================================ -->
14 <A NAME="Top_Of_Page"></A>
15 <H1>Administration Reference</H1>
16 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf274.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf276.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
17 <P>
18 <H2><A NAME="HDRVOS_STATUS" HREF="auarf002.htm#ToC_289">vos status</A></H2>
19 <A NAME="IDX5833"></A>
20 <A NAME="IDX5834"></A>
21 <A NAME="IDX5835"></A>
22 <A NAME="IDX5836"></A>
23 <A NAME="IDX5837"></A>
24 <P><STRONG>Purpose</STRONG>
25 <P>Reports a Volume Server's status
26 <P><STRONG>Synopsis</STRONG>
27 <PRE><B>vos status -server</B> &lt;<VAR>machine&nbsp;name</VAR>>  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-noauth</B>]
28            [<B>-localauth</B>]  [<B>-verbose</B>]  [<B>-help</B>]
29     
30 <B>vos st -s</B> &lt;<VAR>machine&nbsp;name</VAR>>  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-n</B>]  [<B>-l</B>]  [<B>-v</B>]  [<B>-h</B>]
31 </PRE>
32 <P><STRONG>Description</STRONG>
33 <P>The <B>vos status</B> command reports on what the Volume Server on a
34 certain file server machine is doing at the moment the command is
35 issued. If there is no activity, the following message appears:
36 <PRE>   No active transactions on <VAR>machine_name</VAR>
37    
38 </PRE>
39 <P>This command is useful mainly if there is concern that the Volume Server is
40 not performing requested actions.
41 <P><STRONG>Options</STRONG>
42 <DL>
43 <P><DT><B><B>-server</B>
44 </B><DD>Identifies the file server machine running the Volume Server for which to
45 display status information. Provide the machine's IP address or
46 its host name (either fully qualified or using an unambiguous
47 abbreviation). For details, see the introductory reference page for the
48 <B>vos</B> command suite.
49 <P><DT><B>-cell
50 </B><DD>Names the cell in which to run the command. Do not combine this
51 argument with the <B>-localauth</B> flag. For more details, see the
52 introductory <B>vos</B> reference page.
53 <P><DT><B>-noauth
54 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
55 issuer. Do not combine this flag with the <B>-localauth</B>
56 flag. For more details, see the introductory <B>vos</B> reference
57 page.
58 <P><DT><B>-localauth
59 </B><DD>Constructs a server ticket using a key from the local
60 <B>/usr/afs/etc/KeyFile</B> file. The <B>vos</B> command
61 interpreter presents it to the Volume Server and Volume Location Server during
62 mutual authentication. Do not combine this flag with the
63 <B>-cell</B> argument or <B>-noauth</B> flag. For more details,
64 see the introductory <B>vos</B> reference page.
65 <P><DT><B>-verbose
66 </B><DD>Produces on the standard output stream a detailed trace of the
67 command's execution. If this argument is omitted, only warnings
68 and error messages appear.
69 <P><DT><B>-help
70 </B><DD>Prints the online help for this command. All other valid options
71 are ignored.
72 </DL>
73 <P><STRONG>Output</STRONG>
74 <P>There are two possible types of output.
75 <P>The following message indicates that the Volume Server is not currently
76 performing any actions.
77 <PRE>   No active transactions on <VAR>machine&nbsp;name</VAR>
78    
79 </PRE>
80 <P>The other possible output is a set of information which is probably more
81 useful to programmers than to system administrators. A full
82 understanding of all the fields requires familiarity with the code for the
83 Volume Server, as many of the fields report ID numbers and flag values that
84 the Volume Server sets for internal use.
85 <P>Among the fields of possible interest to an administrator are:
86 <UL>
87 <P><LI><TT>created</TT> on the first line, which indicates the time at which
88 this transaction started
89 <P><LI><TT>attachFlags</TT> on the second line, where a value of
90 <TT>offline</TT> indicates that the volume is not available for other read
91 or write operations during this transaction
92 <P><LI><TT>volume</TT> on the third line, which specifies the affected
93 volume's ID number
94 <P><LI><TT>partition</TT> on the third line, which indicates where the affected
95 volume resides (at the beginning of the transaction if this is a move)
96 <P><LI><TT>procedure</TT> on the third line, which indicates the internal
97 subprocedure being executed
98 </UL>
99 <P>A fourth line can appear during certain transactions, and includes the
100 following fields:
101 <UL>
102 <P><LI><TT>packetRead</TT> tracks whether information is being read into the
103 volume. Its absolute value is not informative, but the way it changes
104 shows whether the <B>vos restore</B> command is executing properly.
105 As the <B>vos status</B> command is issued repeatedly during a restore,
106 <TT>readNext</TT> increases monotonically to indicate that information is
107 being read into the volume.
108 <P><LI><TT>packetSend</TT> tracks whether information is being sent out of the
109 volume. Its absolute value is not informative, but the way it changes
110 shows whether the <B>vos dump</B> command is executing properly. As
111 the <B>vos status</B> command is issued repeatedly during a dump,
112 <TT>transmitNext</TT> increases monotonically to indicate that information
113 is being transferred from the volume into the dump file.
114 </UL>
115 <P>The <TT>lastReceiveTime</TT> and <TT>lastSendTime</TT> are for internal
116 use.
117 <P><STRONG>Examples</STRONG>
118 <P>The following example illustrates the kind of output that sometimes appears
119 when the Volume Server on <B>fs1.abc.com</B> is executing a
120 dump at the time this command is issued.
121 <PRE>   % <B>vos status fs1.abc.com</B>
122    --------------------------------------------
123    transaction: 575  created: Tue Jan 2 8:34:56 1990
124    attachFlags: offline
125    volume: 536871080 partition: /vicepb procedure: Dump
126    packetRead: 2 lastReceiveTime: 113313 packetSend: 24588
127        lastSendTime: 113317
128    --------------------------------------------
129    
130 </PRE>
131 <P><STRONG>Privilege Required</STRONG>
132 <P>None
133 <P><STRONG>Related Information</STRONG>
134 <P><A HREF="auarf252.htm#HDRVOS_INTRO">vos</A>
135 <P>
136 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf274.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf276.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
137 <!-- Begin Footer Records  ========================================== -->
138 <P><HR><B> 
139 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
140 </B> 
141 <!-- End Footer Records  ============================================ -->
142 <A NAME="Bot_Of_Page"></A>
143 </BODY></HTML>