added button GIF's to the HTML docs
[openafs.git] / doc / html / AdminReference / auarf261.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="auarf260.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="auarf262.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_EXAMINE" HREF="auarf002.htm#ToC_275">vos examine</A></H2>
19 <A NAME="IDX5653"></A>
20 <A NAME="IDX5654"></A>
21 <A NAME="IDX5655"></A>
22 <A NAME="IDX5656"></A>
23 <A NAME="IDX5657"></A>
24 <A NAME="IDX5658"></A>
25 <A NAME="IDX5659"></A>
26 <A NAME="IDX5660"></A>
27 <A NAME="IDX5661"></A>
28 <A NAME="IDX5662"></A>
29 <A NAME="IDX5663"></A>
30 <P><STRONG>Purpose</STRONG>
31 <P>Displays information from the volume header and VLDB entry for a
32 volume.
33 <P><STRONG>Synopsis</STRONG>
34 <PRE><B>vos examine -id</B> &lt;<VAR>volume&nbsp;name&nbsp;or&nbsp;ID</VAR>>  [<B>-extended</B>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  
35             [<B>-noauth</B>]  [<B>-localauth</B>]  [<B>-verbose</B>]  [<B>-help</B>]
36    
37 <B>vos e -i</B> &lt;<VAR>volume&nbsp;name&nbsp;or&nbsp;ID</VAR>>  [<B>-e</B>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-n</B>]  [<B>-l</B>]  [<B>-v</B>]  [<B>-h</B>]
38     
39 <B>vos volinfo -i</B> &lt;<VAR>volume&nbsp;name&nbsp;or&nbsp;ID</VAR>>  [<B>-e</B>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  
40             [<B>-n</B>]  [<B>-l</B>]  [<B>-v</B>]  [<B>-h</B>]
41    
42 <B>vos v -i</B> &lt;<VAR>volume&nbsp;name&nbsp;or&nbsp;ID</VAR>>  [<B>-e</B>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-n</B>]  [<B>-l</B>]  [<B>-v</B>]  [<B>-h</B>]
43    
44 </PRE>
45 <P><STRONG>Description</STRONG>
46 <P>The <B>vos examine</B> command formats and displays information from
47 the Volume Location Database (VLDB) entry and the volume header of the volume
48 specified by the <B>-id</B> argument.
49 <P>To display the volume header only, use the <B>vos listvol</B>
50 command. To display information from the VLDB only, use the <B>vos
51 listvldb</B> command.
52 <P><STRONG>Options</STRONG>
53 <DL>
54 <P><DT><B>-id
55 </B><DD>Specifies either the complete name or volume ID number of the volume,
56 which can be read/write, read-only, or backup.
57 <P><DT><B>-extended
58 </B><DD>Display statistics about read and write operations on files and
59 directories in the volume.
60 <P><DT><B>-cell
61 </B><DD>Names the cell in which to run the command. Do not combine this
62 argument with the <B>-localauth</B> flag. For more details, see the
63 introductory <B>vos</B> reference page.
64 <P><DT><B>-noauth
65 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
66 issuer. Do not combine this flag with the <B>-localauth</B>
67 flag. For more details, see the introductory <B>vos</B> reference
68 page.
69 <P><DT><B>-localauth
70 </B><DD>Constructs a server ticket using a key from the local
71 <B>/usr/afs/etc/KeyFile</B> file. The <B>vos</B> command
72 interpreter presents it to the Volume Server and Volume Location Server during
73 mutual authentication. Do not combine this flag with the
74 <B>-cell</B> argument or <B>-noauth</B> flag. For more details,
75 see the introductory <B>vos</B> reference page.
76 <P><DT><B>-verbose
77 </B><DD>Produces on the standard output stream a detailed trace of the
78 command's execution. If this argument is omitted, only warnings
79 and error messages appear.
80 <P><DT><B>-help
81 </B><DD>Prints the online help for this command. All other valid options
82 are ignored.
83 </DL>
84 <P><STRONG>Output</STRONG>
85 <P>The first seven lines of the output show information from the volume header
86 and the remaining lines come from the VLDB. Each item in the following
87 list corresponds to a line of output derived from the volume header.
88 <UL>
89 <P><LI>Basic information about the specified volume (displayed on a single
90 line): 
91 <UL>
92 <P><LI>Name
93 <P><LI>Volume ID number
94 <A NAME="IDX5664"></A>
95 <P><LI>Type (the flag is <TT>RW</TT> for read/write, <TT>RO</TT> for
96 read-only, <TT>BK</TT> for backup)
97 <P><LI>Size in kilobytes (<TT>1024</TT> equals a megabyte)
98 <P><LI>Number of files in the volume, if the <B>-extended</B> flag is
99 provided
100 <A NAME="IDX5665"></A>
101 <P><LI>Status on the file server machine, which is one of the following:
102 <DL>
103 <A NAME="IDX5666"></A>
104 <P><DT><B><TT>On-line</TT>
105 </B><DD>The volume is completely accessible to Cache Managers.
106 <A NAME="IDX5667"></A>
107 <P><DT><B><TT>Off-line</TT>
108 </B><DD>The volume is not accessible to Cache Managers, but does not seem to be
109 corrupted. This status appears while a volume is being dumped, for
110 example.
111 <A NAME="IDX5668"></A>
112 <P><DT><B><TT>Off-line**needs salvage**</TT>
113 </B><DD>The volume is not accessible to Cache Managers, because it seems to be
114 corrupted. Use the <B>bos salvage</B> or <B>salvager</B>
115 command to repair the corruption.
116 </DL>
117 </UL>
118 <P><LI>The file server machine and partition that house the volume, as determined
119 by the command interpreter as the command runs, rather than derived from the
120 VLDB or the volume header.
121 <A NAME="IDX5669"></A>
122 <A NAME="IDX5670"></A>
123 <A NAME="IDX5671"></A>
124 <A NAME="IDX5672"></A>
125 <A NAME="IDX5673"></A>
126 <A NAME="IDX5674"></A>
127 <A NAME="IDX5675"></A>
128 <A NAME="IDX5676"></A>
129 <P><LI>The volume ID numbers associated with the various versions of the
130 volume: read/write (<TT>RWrite</TT>), read-only (<TT>ROnly</TT>),
131 backup (<TT>Backup</TT>), and ReleaseClone (<TT>RClone</TT>). One
132 of them matches the volume ID number that appears on the first line of the
133 volume's output. If the value in the <TT>RWrite</TT>,
134 <TT>ROnly</TT>, or <TT>Backup</TT> field is <TT>0</TT> (zero), there is
135 no volume of that type. If there is currently no ReleaseClone, the
136 <TT>RClone</TT> field does not appear at all.
137 <A NAME="IDX5677"></A>
138 <A NAME="IDX5678"></A>
139 <P><LI>The maximum space quota allotted to the read/write copy of the volume,
140 expressed in kilobyte blocks in the <TT>MaxQuota</TT> field.
141 <A NAME="IDX5679"></A>
142 <A NAME="IDX5680"></A>
143 <P><LI>The date and time the volume was created, in the <TT>Creation</TT>
144 field. If the volume has been restored with the <B>backup
145 diskrestore</B>, <B>backup volrestore</B>, or <B>vos restore</B>
146 command, this is the restore time.
147 <A NAME="IDX5681"></A>
148 <A NAME="IDX5682"></A>
149 <P><LI>The date and time when the contents of the volume last changed, in the
150 <TT>Last Update</TT> field. For read-only and backup volumes, it
151 matches the timestamp in the <TT>Creation</TT> field.
152 <A NAME="IDX5683"></A>
153 <A NAME="IDX5684"></A>
154 <P><LI>The number of times the volume has been accessed for a fetch or store
155 operation since the later of the two following times: 
156 <UL>
157 <P><LI>12:00 a.m. on the day the command is issued
158 <P><LI>The last time the volume changed location
159 </UL>
160 </UL>
161 <P>When the <B>-extended</B> flag is included, two tables appear
162 next:
163 <UL>
164 <P><LI>The table labeled <TT>Raw Read/Write Stats</TT> contains information on
165 the number of reads (fetches) and writes (stores) made on the specified
166 volume.
167 <P><LI>The table labeled <TT>Writes Affecting Authorship</TT> contains
168 information on writes made to files and directories in the specified
169 volume.
170 </UL>
171 <P>If the following message appears instead of the previously listed
172 information, it indicates that a volume is not accessible to Cache Managers or
173 the <B>vos</B> command interpreter, for example because a clone is being
174 created.
175 <PRE>   **** Volume <VAR>volume_ID</VAR> is busy ****
176 </PRE>
177 <P>If the following message appears instead of the previously listed
178 information, it indicates that the File Server is unable to attach the volume,
179 perhaps because it is seriously corrupted. The <B>FileLog</B> and
180 <B>VolserLog</B> log files in the <B>/usr/afs/logs</B> directory on
181 the file server machine possibly provide additional information; use the
182 <B>bos getlog</B> command to display them.
183 <PRE>   **** Could not attach volume <VAR>volume_ID</VAR> ****
184 </PRE>
185 <P>Following a blank line, information from the VLDB entry appears.
186 Each item in this list corresponds to a separate line in the output:
187 <UL>
188 <P><LI>The base (read/write) volume name. The read-only and backup
189 versions have the same name with a <B>.readonly</B> and
190 <B>.backup</B> extension, respectively.
191 <P><LI>The volume ID numbers allocated to the versions of the volume that
192 actually exist, in fields labeled <TT>RWrite</TT> for the read/write,
193 <TT>ROnly</TT> for the read-only, <TT>Backup</TT> for the backup, and
194 <TT>RClone</TT> for the ReleaseClone. (If a field does not appear,
195 the corresponding version of the volume does not exist.) The appearance
196 of the <TT>RClone</TT> field normally indicates that a release operation did
197 not complete successfully; the <TT>Old release</TT> and <TT>New
198 release</TT> flags often also appear on one or more of the site definition
199 lines described just following.
200 <A NAME="IDX5685"></A>
201 <A NAME="IDX5686"></A>
202 <P><LI>The number of sites that house a read/write or read-only copy of the
203 volume, following the string <TT>number of sites -></TT>.
204 <A NAME="IDX5687"></A>
205 <A NAME="IDX5688"></A>
206 <A NAME="IDX5689"></A>
207 <A NAME="IDX5690"></A>
208 <A NAME="IDX5691"></A>
209 <P><LI>A line for each site that houses a read/write or read-only copy of the
210 volume, specifying the file server machine, partition, and type of volume
211 (<TT>RW</TT> for read/write or <TT>RO</TT> for read-only). If a
212 backup version exists, it is understood to share the read/write site.
213 Several flags can appear with a site definition: 
214 <DL>
215 <A NAME="IDX5692"></A>
216 <P><DT><B><TT>Not released</TT>
217 </B><DD>Indicates that the <B>vos release</B> command has not been issued
218 since the <B>vos addsite</B> command was used to define the read-only
219 site.
220 <A NAME="IDX5693"></A>
221 <P><DT><B><TT>Old release</TT>
222 </B><DD>Indicates that a <B>vos release</B> command did not complete
223 successfully, leaving the previous, obsolete version of the volume at this
224 site.
225 <A NAME="IDX5694"></A>
226 <P><DT><B><TT>New release</TT>
227 </B><DD>Indicates that a <B>vos release</B> command did not complete
228 successfully, but that this site did receive the correct new version of the
229 volume.
230 </DL>
231 <P><LI>If the VLDB entry is locked, the string <TT>Volume is currently
232 LOCKED</TT>.
233 </UL>
234 <P>For further discussion of the <TT>New release</TT> and <TT>Old
235 release</TT> flags, see the reference page for the <B>vos release</B>
236 command.
237 <P><STRONG>Examples</STRONG>
238 <P>The following example shows output for the ABC Corporation volume called
239 <B>usr</B> with two read-only replication sites (this volume is mounted at
240 the <B>/afs/abc.com/usr</B> directory). For the sake of
241 illustration, the output shows the volume as locked.
242 <PRE>   % <B>vos examine usr</B>
243    usr                           536870981 RW   3459 K On-line
244         fs2.abc.com /vicepb
245         RWrite 5360870981   ROnly 536870982   Backup 536870983
246         MaxQuota      40000 K
247         Creation    Mon Jun 12 15:22:06 1989
248         Last Update Fri Jun 16 09:34:35 1989
249         5719 accesses in the past day (i.e., vnode references)
250         RWrite: 5360870981   ROnly: 536870982   Backup: 536870983
251         number of sites -> 3
252            server fs1.abc.com partition /vicepa RO Site 
253            server fs3.abc.com partition /vicepa RO Site 
254            server fs2.abc.com partition /vicepb RW Site 
255         Volume is currently LOCKED  
256    
257 </PRE>
258 <P>The following example shows the output for the volume
259 <B>user.terry</B> using the <B>-extended</B> flag. The
260 volume has no read-only replication sites.
261 <PRE>   %<B> vos examine -id user.terry -extended</B>
262    user.terry         354287190 RW    2302 K used 119 files On-line
263        fs4.abc.com /vicepc
264        RWrite 354287190 ROnly          0 Backup 354287192
265        MaxQuota       5000 K
266        Creation    Wed Nov 25 17:38:57 1992
267        Last Update Tue Dec 15 10:46:20 1992
268        598 accesses in the past day (i.e., vnode references)
269                          Raw Read/Write Stats
270              |-------------------------------------------|
271              |    Same Network     |    Diff Network     |
272              |----------|----------|----------|----------|
273              |  Total   |   Auth   |   Total  |   Auth   |
274              |----------|----------|----------|----------|
275    Reads     |       55 |       55 |       38 |       38 |
276    Writes    |       95 |       95 |        0 |        0 |
277              |-------------------------------------------|
278                       Writes Affecting Authorship
279              |-------------------------------------------|
280              |   File Authorship   | Directory Authorship|
281              |----------|----------|----------|----------|
282              |   Same   |   Diff   |    Same  |   Diff   |
283              |----------|----------|----------|----------|
284    0-60 sec  |       38 |        0 |       21 |        1 |
285    1-10 min  |        2 |        0 |        7 |        0 |
286    10min-1hr |        0 |        0 |        1 |        0 |
287    1hr-1day  |        1 |        0 |        5 |        1 |
288    1day-1wk  |        0 |        0 |        0 |        0 |
289    > 1wk     |        0 |        0 |        0 |        0 |
290              |-------------------------------------------|
291        RWrite: 354287190    Backup: 354287192
292        number of sites -> 1
293           server fs4.abc.com partition /vicepc RW Site
294    
295 </PRE>
296 <P><STRONG>Privilege Required</STRONG>
297 <P>None
298 <P><STRONG>Related Information</STRONG>
299 <P><A HREF="auarf072.htm#HDRBK_DISKRESTORE">backup diskrestore</A>
300 <P><A HREF="auarf091.htm#HDRBK_VOLRESTORE">backup volrestore</A>
301 <P><A HREF="auarf102.htm#HDRBOS_GETLOG">bos getlog</A>
302 <P><A HREF="auarf114.htm#HDRBOS_SALVAGE">bos salvage</A>
303 <P><A HREF="auarf232.htm#HDRSALVAGER">salvager</A>
304 <P><A HREF="auarf252.htm#HDRVOS_INTRO">vos</A>
305 <P><A HREF="auarf266.htm#HDRVOS_LISTVOL">vos listvol</A>
306 <P><A HREF="auarf265.htm#HDRVOS_LISTVLDB">vos listvldb</A>
307 <P><A HREF="auarf270.htm#HDRVOS_RELEASE">vos release</A>
308 <P><A HREF="auarf274.htm#HDRVOS_RESTORE">vos restore</A>
309 <P>
310 <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="auarf260.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="auarf262.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> 
311 <!-- Begin Footer Records  ========================================== -->
312 <P><HR><B> 
313 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
314 </B> 
315 <!-- End Footer Records  ============================================ -->
316 <A NAME="Bot_Of_Page"></A>
317 </BODY></HTML>