Initial IBM OpenAFS 1.0 tree
[openafs.git] / src / WINNT / doc / install / Documentation / en_US / html / CmdRef / auarf266.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3//EN">
2 <HTML><HEAD>
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3190/auarf000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 5 Nov 1999 at 13:58:29                -->
7 <META HTTP-EQUIV="updated" CONTENT="Fri, 05 Nov 1999 13:58:29">
8 <META HTTP-EQUIV="review" CONTENT="Sun, 05 Nov 2000 13:58:29">
9 <META HTTP-EQUIV="expires" CONTENT="Mon, 05 Nov 2001 13:58: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="auarf265.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="auarf267.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_LISTVOL" HREF="auarf002.htm#ToC_280">vos listvol</A></H2>
19 <A NAME="IDX5729"></A>
20 <A NAME="IDX5730"></A>
21 <A NAME="IDX5731"></A>
22 <A NAME="IDX5732"></A>
23 <A NAME="IDX5733"></A>
24 <A NAME="IDX5734"></A>
25 <A NAME="IDX5735"></A>
26 <A NAME="IDX5736"></A>
27 <A NAME="IDX5737"></A>
28 <A NAME="IDX5738"></A>
29 <A NAME="IDX5739"></A>
30 <P><STRONG>Purpose</STRONG>
31 <P>Displays information from a volume header
32 <P><STRONG>Synopsis</STRONG>
33 <PRE><B>vos listvol -server</B> &lt;<VAR>machine&nbsp;name</VAR>>  [<B>-partition</B> &lt;<VAR>partition&nbsp;name</VAR>>]
34             [<B>-fast</B>]  [<B>-long</B>]  [<B>-quiet</B>]  [<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 listvo -s</B> &lt;<VAR>machine&nbsp;name</VAR>>  [<B>-p</B> &lt;<VAR>partition&nbsp;name</VAR>>]  [<B>-f</B>]  [<B>-lon</B>]  
38            [<B>-q</B>]  [<B>-e</B>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-n</B>]  [<B>-loc</B>]  [<B>-v</B>]  [<B>-h</B>]
39 </PRE>
40 <P><STRONG>Description</STRONG>
41 <P>The <B>vos listvol</B> command formats and displays the following
42 information from the volume header of each specified volume&#58; volume
43 name, volume ID, volume type, size, and status at the server. The
44 actual information displayed depends on the combination of arguments supplied
45 when the command is issued. To display volume header information for
46 various numbers of volumes, combine the command&#39;s arguments as
47 indicated&#58;
48 <UL>
49 <P><LI>For every volume on a file server machine, specify the machine&#39;s name
50 with the <B>-server</B> argument.
51 <P><LI>For every volume at a particular site, combine the <B>-server</B>
52 argument with the <B>-partition</B> argument.
53 </UL>
54 <P>To display the Volume Location Database (VLDB) entry for one or more
55 volumes, use the <B>vos listvldb</B> command. To display both the
56 VLDB entry and the volume header for a single volume, use the <B>vos
57 examine</B> command.
58 <P><STRONG>Options</STRONG>
59 <DL>
60 <P><DT><B>-server
61 </B><DD>Identifies the file server machine that houses volumes for which to
62 display the header. Provide the machine&#39;s IP address or its host
63 name (either fully qualified or using an unambiguous abbreviation). For
64 details, see the introductory reference page for the <B>vos</B> command
65 suite. 
66 <P>This argument can be combined with the <B>-partition</B> argument, as
67 well as the <B>-fast</B>, <B>-long</B>, or <B>-extended</B>
68 flag.
69 <P><DT><B>-partition
70 </B><DD>Identifies the partition (on the file server machine specified by the
71 <B>-server</B> argument) that houses volumes for which to display the
72 header. Provide the partition&#39;s complete name with preceding slash
73 (for example, <B>/vicepa</B>) or use one of the three acceptable
74 abbreviated forms. For details, see the introductory reference page for
75 the <B>vos</B> command suite.
76 <P><DT><B>-fast
77 </B><DD>Displays only the volume ID numbers of volumes stored at the site
78 specified by the <B>-server</B>, and optionally <B>-partition</B>,
79 argument. Do not combine this flag with the <B>-extended</B>
80 flag.
81 <P><DT><B>-long
82 </B><DD>Displays more detailed information about each volume stored at the site
83 specified by the <B>-server</B>, and optionally <B>-partition</B>,
84 argument. The information includes the volume IDs of all three volume
85 types associated with the volume, and the read/write volume&#39;s quota,
86 creation date and update date.
87 <P><DT><B>-quiet
88 </B><DD>Suppresses the lines that summarize the number of volumes listed and their
89 status, which otherwise appear at the beginning and end of the output when the
90 output includes more than one volume.
91 <P><DT><B>-extended
92 </B><DD>Displays extensive statistics about access patterns for each volume stored
93 at the site specified by the <B>-server</B>, and optionally
94 <B>-partition</B>, argument. The statistics include the number of
95 reads and writes to files in the volume, and how recently files and
96 directories have been updated by their owners or other users. Do not
97 combine this flag with the <B>-fast</B> flag.
98 <P><DT><B>-cell
99 </B><DD>Names the cell in which to run the command. Do not combine this
100 argument with the <B>-localauth</B> flag. For more details, see the
101 introductory <B>vos</B> reference page.
102 <P><DT><B>-noauth
103 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
104 issuer. Do not combine this flag with the <B>-localauth</B>
105 flag. For more details, see the introductory <B>vos</B> reference
106 page.
107 <P><DT><B>-localauth
108 </B><DD>Constructs a server ticket using a key from the local
109 <B>/usr/afs/etc/KeyFile</B> file. The <B>vos</B> command
110 interpreter presents it to the Volume Server and Volume Location Server during
111 mutual authentication. Do not combine this flag with the
112 <B>-cell</B> argument or <B>-noauth</B> flag. For more details,
113 see the introductory <B>vos</B> reference page.
114 <P><DT><B>-verbose
115 </B><DD>Produces on the standard output stream a detailed trace of the
116 command&#39;s execution. If this argument is omitted, only warnings
117 and error messages appear.
118 <P><DT><B>-help
119 </B><DD>Prints the online help for this command. All other valid options
120 are ignored.
121 </DL>
122 <P><STRONG>Output</STRONG>
123 <P>The output is ordered alphabetically by volume name and by default provides
124 the following information on a single line for each volume&#58;
125 <UL>
126 <P><LI>Name
127 <P><LI>Volume ID number
128 <A NAME="IDX5740"></A>
129 <P><LI>Type (the flag is <TT>RW</TT> for read/write, <TT>RO</TT> for
130 read-only, <TT>BK</TT> for backup)
131 <P><LI>Size in kilobytes (<TT>1024</TT> equals a megabyte)
132 <P><LI>Number of files in the volume, if the <B>-extended</B> flag is
133 provided
134 <A NAME="IDX5741"></A>
135 <P><LI>Status on the file server machine, which is one of the following&#58;
136 <DL>
137 <A NAME="IDX5742"></A>
138 <P><DT><B><TT>On-line</TT>
139 </B><DD>The volume is completely accessible to Cache Managers.
140 <A NAME="IDX5743"></A>
141 <P><DT><B><TT>Off-line</TT>
142 </B><DD>The volume is not accessible to Cache Managers, but does not seem to be
143 corrupted. This status appears while a volume is being dumped, for
144 example.
145 <A NAME="IDX5744"></A>
146 <P><DT><B><TT>Off-line**needs salvage**</TT>
147 </B><DD>The volume is not accessible to Cache Managers, because it seems to be
148 corrupted. Use the <B>bos salvage</B> or <B>salvager</B>
149 command to repair the corruption.
150 </DL>
151 </UL>
152 <P>If the following message appears instead of the previously listed
153 information, it indicates that a volume is not accessible to Cache Managers or
154 the <B>vos</B> command interpreter, for example because a clone is being
155 created.
156 <PRE>   **** Volume <VAR>volume_ID</VAR> is busy ****
157 </PRE>
158 <P>If the following message appears instead of the previously listed
159 information, it indicates that the File Server is unable to attach the volume,
160 perhaps because it is seriously corrupted. The <B>FileLog</B> and
161 <B>VolserLog</B> log files in the <B>/usr/afs/logs</B> directory on
162 the file server machine possibly provide additional information; use the
163 <B>bos getlog</B> command to display them.
164 <PRE>   **** Could not attach volume <VAR>volume_ID</VAR> ****
165 </PRE>
166 <P>The information about individual volumes is bracketed by summary
167 lines. The first line of output specifies the number of volumes in the
168 listing. The last line of output summarizes the number of volumes that
169 are online, offline, and busy. These lines do not appear if the
170 <B>-quiet</B> flag is used.
171 <P>If the <B>-fast</B> flag is added, the output displays only the volume
172 ID number of each volume, arranged in increasing numerical order. The
173 final line (which summarizes the number of online, offline, and busy volumes)
174 is omitted.
175 <P>If the <B>-long</B> flag is included, the output for each volume
176 includes all of the information in the default listing plus the
177 following. Each item in this list corresponds to a separate line of
178 output&#58;
179 <UL>
180 <P><LI>The file server machine and partition that house the volume, as determined
181 by the command interpreter as the command runs, rather than derived from the
182 VLDB or the volume header.
183 <A NAME="IDX5745"></A>
184 <A NAME="IDX5746"></A>
185 <A NAME="IDX5747"></A>
186 <A NAME="IDX5748"></A>
187 <A NAME="IDX5749"></A>
188 <A NAME="IDX5750"></A>
189 <A NAME="IDX5751"></A>
190 <A NAME="IDX5752"></A>
191 <P><LI>The volume ID numbers associated with the various versions of the
192 volume&#58; read/write (<TT>RWrite</TT>), read-only (<TT>ROnly</TT>),
193 backup (<TT>Backup</TT>), and ReleaseClone (<TT>RClone</TT>). One
194 of them matches the volume ID number that appears on the first line of the
195 volume&#39;s output. If the value in the <TT>RWrite</TT>,
196 <TT>ROnly</TT>, or <TT>Backup</TT> field is <TT>0</TT> (zero), there is
197 no volume of that type. If there is currently no ReleaseClone, the
198 <TT>RClone</TT> field does not appear at all.
199 <A NAME="IDX5753"></A>
200 <A NAME="IDX5754"></A>
201 <P><LI>The maximum space quota allotted to the read/write copy of the volume,
202 expressed in kilobyte blocks in the <TT>MaxQuota</TT> field.
203 <A NAME="IDX5755"></A>
204 <A NAME="IDX5756"></A>
205 <P><LI>The date and time the volume was created, in the <TT>Creation</TT>
206 field. If the volume has been restored with the <B>backup
207 diskrestore</B>, <B>backup volrestore</B>, or <B>vos restore</B>
208 command, this is the restore time.
209 <A NAME="IDX5757"></A>
210 <A NAME="IDX5758"></A>
211 <P><LI>The date and time when the contents of the volume last changed, in the
212 <TT>Last Update</TT> field. For read-only and backup volumes, it
213 matches the timestamp in the <TT>Creation</TT> field.
214 <A NAME="IDX5759"></A>
215 <A NAME="IDX5760"></A>
216 <P><LI>The number of times the volume has been accessed for a fetch or store
217 operation since the later of the two following times&#58; 
218 <UL>
219 <P><LI>12&#58;00 a.m. on the day the command is issued
220 <P><LI>The last time the volume changed location
221 </UL>
222 </UL>
223 <P>If the <B>-extended</B> flag is included, the output for each volume
224 includes all of the information reported with the <B>-long</B> flag, plus
225 two tables of statistics&#58;
226 <UL>
227 <P><LI>The table labeled <TT>Raw Read/Write Stats</TT> table summarizes the
228 number of times the volume has been accessed for reading or writing.
229 <P><LI>The table labeled <TT>Writes Affecting Authorship</TT> table contains
230 information on writes made to files and directories in the specified
231 volume.
232 </UL>
233 <P><STRONG>Examples</STRONG>
234 <P>The following example shows the output for the <B>/vicepb</B> partition
235 on the file server machine <B>fs2.abc.com</B> when no flags
236 are provided&#58;
237 <PRE>   % <B>vos listvol -server fs2.abc.com -partition b</B>
238    Total number of volumes on server fs2.abc.com   \
239                                        partition /vicepb &#58; 66
240    sys                  1969534847 RW       1582 K On-line
241    sys.backup           1969535105 BK       1582 K On-line
242          .                   .     .         .   .    .
243          .                   .     .         .   .    .
244    user.pat             1969534536 RW      17518 K On-line
245    user.pat.backup      1969534538 BK      17537 K On-line
246    Total volumes onLine 66 ; Total volumes offLine 0 ;  Total busy 0
247    
248 </PRE>
249 <P>The following example shows the output when the <B>-fast</B> flag is
250 added&#58;
251 <PRE>   % <B>vos listvol -server fs2.abc.com -partition b -fast</B>
252    Total number of volumes on server fs2.abc.com   \
253                                        partition /vicepb &#58; 66
254     1969516782
255     1969516784
256         .
257         .
258     1969535796
259     
260 </PRE>
261 <P>The following example shows two volumes from the output that appears when
262 the <B>-long</B> flag is added&#58;
263 <PRE>   % <B>vos listvol -server fs2.abc.com -partition b -long</B>
264    Total number of volumes on server fs2.abc.com \
265                                        partition /vicepb&#58; 66
266          .                   .      .         .   .    .
267          .                   .      .         .   .    .
268    user.pat             1969534536 RW      17518 K On-line
269         fs2.abc.com /vicepb
270         RWrite 1969534536 ROnly 0        Backup 1969534538 
271         MaxQuota      20000 K
272         Creation    Mon Jun 12 09&#58;02&#58;25 1989
273         Last Update Thu May 20 17&#58;39&#58;34 1999
274         1573 accesses in the past day (i.e., vnode references)
275    user.pat.backup      1969534538 BK      17537 K On-line
276         fs2.abc.com /vicepb
277         RWrite 1969534536 ROnly 0        Backup 1969534538 
278         MaxQuota      20000 K
279         Creation    Tue Jun 13 04&#58;37&#58;59 1989
280         Last Update Wed May 19 06&#58;37&#58;59 1999
281         0 accesses in the past day (i.e., vnode references)
282           .                   .      .         .   .    .
283           .                   .      .         .   .    .
284    Total volumes onLine 66 ; Total volumes offLine 0 ; \
285                                                 Total busy 0
286    
287 </PRE>
288 <P><STRONG>Privilege Required</STRONG>
289 <P>None
290 <P><STRONG>Related Information</STRONG>
291 <P><A HREF="auarf072.htm#HDRBK_DISKRESTORE">backup diskrestore</A>
292 <P><A HREF="auarf091.htm#HDRBK_VOLRESTORE">backup volrestore</A>
293 <P><A HREF="auarf102.htm#HDRBOS_GETLOG">bos getlog</A>
294 <P><A HREF="auarf114.htm#HDRBOS_SALVAGE">bos salvage</A>
295 <P><A HREF="auarf232.htm#HDRSALVAGER">salvager</A>
296 <P><A HREF="auarf252.htm#HDRVOS_INTRO">vos</A>
297 <P><A HREF="auarf261.htm#HDRVOS_EXAMINE">vos examine</A>
298 <P><A HREF="auarf265.htm#HDRVOS_LISTVLDB">vos listvldb</A>
299 <P><A HREF="auarf274.htm#HDRVOS_RESTORE">vos restore</A>
300 <P>
301 <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="auarf265.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="auarf267.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> 
302 <!-- Begin Footer Records  ========================================== -->
303 <P><HR><B> 
304 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
305 </B> 
306 <!-- End Footer Records  ============================================ -->
307 <A NAME="Bot_Of_Page"></A>
308 </BODY></HTML>