pod-updates-20060227
[openafs.git] / doc / man-pages / pod1 / vos_listvol.pod
1 =head1 NAME
2
3 vos listvol - Displays information from a volume header
4
5 =head1 SYNOPSIS
6
7 B<vos listvol> B<-server> <I<machine name>>
8     [B<-partition> <I<partition name>>] [B<-fast>] [B<-long>] [B<-quiet>]
9     [B<-extended>] [B<-cell> <I<cell name>>] [B<-noauth>] [B<-localauth>]
10     [B<-verbose>] [B<-help>]
11
12 B<vos listvo> B<-s> <I<machine name>> [B<-p> <I<partition name>>] [B<-f>]
13     [-lon] [B<-q>] [B<-e>] [B<-c> <I<cell name>>] [B<-n>] [B<-loc>]
14     [B<-v>] [B<-h>]
15
16 =head1 DESCRIPTION
17
18 The B<vos listvol> command formats and displays the following information
19 from the volume header of each specified volume: volume name, volume ID,
20 volume type, size, and status at the server. The actual information
21 displayed depends on the combination of arguments supplied when the
22 command is issued. To display volume header information for various
23 numbers of volumes, combine the command's arguments as indicated:
24
25 =over 4
26
27 =item *
28
29 For every volume on a file server machine, specify the machine's name with
30 the B<-server> argument.
31
32 =item *
33
34 For every volume at a particular site, combine the B<-server> argument
35 with the B<-partition> argument.
36
37 =back
38
39 To display the Volume Location Database (VLDB) entry for one or more
40 volumes, use the B<vos listvldb> command. To display both the VLDB entry
41 and the volume header for a single volume, use the B<vos examine> command.
42
43 =head1 OPTIONS
44
45 =over 4
46
47 =item B<-server> <I<server name>>
48
49 Identifies the file server machine that houses volumes for which to
50 display the header. Provide the machine's IP address or its host name
51 (either fully qualified or using an unambiguous abbreviation). For
52 details, see L<vos(1)>.
53
54 This argument can be combined with the B<-partition> argument, as well as
55 the B<-fast>, B<-long>, or B<-extended> flag.
56
57 =item B<-partition> <I<partition name>>
58
59 Identifies the partition (on the file server machine specified by the
60 B<-server> argument) that houses volumes for which to display the
61 header. Provide the partition's complete name with preceding slash (for
62 example, F</vicepa>) or use one of the three acceptable abbreviated
63 forms. For details, see L<vos(1)>.
64
65 =item B<-fast>
66
67 Displays only the volume ID numbers of volumes stored at the site
68 specified by the B<-server>, and optionally B<-partition>, argument. Do
69 not combine this flag with the B<-extended> flag.
70
71 =item B<-long>
72
73 Displays more detailed information about each volume stored at the site
74 specified by the B<-server>, and optionally B<-partition>, argument. The
75 information includes the volume IDs of all three volume types associated
76 with the volume, and the read/write volume's quota, creation date and
77 update date.
78
79 =item B<-quiet>
80
81 Suppresses the lines that summarize the number of volumes listed and their
82 status, which otherwise appear at the beginning and end of the output when
83 the output includes more than one volume.
84
85 =item B<-extended>
86
87 Displays extensive statistics about access patterns for each volume stored
88 at the site specified by the B<-server>, and optionally B<-partition>,
89 argument. The statistics include the number of reads and writes to files
90 in the volume, and how recently files and directories have been updated by
91 their owners or other users. Do not combine this flag with the B<-fast>
92 flag.
93
94 =item B<-cell> <I<cell name>>
95
96 Names the cell in which to run the command. Do not combine this argument
97 with the B<-localauth> flag. For more details, see L<vos(1)>.
98
99 =item B<-noauth>
100
101 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
102 combine this flag with the B<-localauth> flag. For more details, see
103 L<vos(1)>.
104
105 =item B<-localauth>
106
107 Constructs a server ticket using a key from the local
108 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
109 to the Volume Server and Volume Location Server during mutual
110 authentication. Do not combine this flag with the B<-cell> argument or
111 B<-noauth> flag. For more details, see L<vos(1)>.
112
113 =item B<-verbose>
114
115 Produces on the standard output stream a detailed trace of the command's
116 execution. If this argument is omitted, only warnings and error messages
117 appear.
118
119 =item B<-help>
120
121 Prints the online help for this command. All other valid options are
122 ignored.
123
124 =back
125
126 =head1 OUTPUT
127
128 The output is ordered alphabetically by volume name and by default
129 provides the following information on a single line for each volume:
130
131 =over 4
132
133 =item *
134
135 Name
136
137 =item *
138
139 Volume ID number
140
141 =item *
142
143 Type (the flag is C<RW> for read/write, C<RO> for read-only, C<BK> for
144 backup)
145
146 =item *
147
148 Size in kilobytes (C<1024> equals a megabyte)
149
150 =item *
151
152 Number of files in the volume, if the B<-extended> flag is provided
153
154 =item *
155
156 Status on the file server machine, which is one of the following:
157
158 =over 4
159
160 =item On-line
161
162 The volume is completely accessible to Cache Managers.
163
164 =item Off-line
165
166 The volume is not accessible to Cache Managers, but does not seem to be
167 corrupted. This status appears while a volume is being dumped, for
168 example.
169
170 =item Off-line**needs salvage**
171
172 The volume is not accessible to Cache Managers, because it seems to be
173 corrupted. Use the B<bos salvage> or B<salvager> command to repair the
174 corruption.
175
176 =back
177
178 =back
179
180 If the following message appears instead of the previously listed
181 information, it indicates that a volume is not accessible to Cache
182 Managers or the B<vos> command interpreter, for example because a clone is
183 being created.
184
185    **** Volume <volume_ID> is busy ****
186
187 If the following message appears instead of the previously listed
188 information, it indicates that the File Server is unable to attach the
189 volume, perhaps because it is seriously corrupted. The F<FileLog> and
190 F<VolserLog> log files in the F</usr/afs/logs> directory on the file
191 server machine possibly provide additional information; use the B<bos
192 getlog> command to display them.
193
194    **** Could not attach volume <volume_ID> ****
195
196 The information about individual volumes is bracketed by summary
197 lines. The first line of output specifies the number of volumes in the
198 listing. The last line of output summarizes the number of volumes that are
199 online, offline, and busy. These lines do not appear if the B<-quiet> flag
200 is used.
201
202 If the B<-fast> flag is added, the output displays only the volume ID
203 number of each volume, arranged in increasing numerical order. The final
204 line (which summarizes the number of online, offline, and busy volumes) is
205 omitted.
206
207 If the B<-long> flag is included, the output for each volume includes all
208 of the information in the default listing plus the following. Each item in
209 this list corresponds to a separate line of output:
210
211 =over 4
212
213 =item *
214
215 The file server machine and partition that house the volume, as determined
216 by the command interpreter as the command runs, rather than derived from the
217 VLDB or the volume header.
218
219 =item *
220
221 The volume ID numbers associated with the various versions of the volume:
222 read/write (C<RWrite>), read-only (C<ROnly>), backup (C<Backup>), and
223 ReleaseClone (C<RClone>). One of them matches the volume ID number that
224 appears on the first line of the volume's output. If the value in the
225 C<RWrite>, C<ROnly>, or C<Backup> field is C<0> (zero), there is no volume
226 of that type. If there is currently no ReleaseClone, the C<RClone> field
227 does not appear at all.
228
229 =item *
230
231 The maximum space quota allotted to the read/write copy of the volume,
232 expressed in kilobyte blocks in the C<MaxQuota> field.
233
234 =item *
235
236 The date and time the volume was created, in the C<Creation> field. If the
237 volume has been restored with the B<backup diskrestore>, B<backup
238 volrestore>, or B<vos restore> command, this is the restore time.
239
240 =item *
241
242 The date and time when the contents of the volume last changed, in the
243 C<Last Update> field. For read-only and backup volumes, it matches the
244 timestamp in the C<Creation> field.
245
246 =item *
247
248 The number of times the volume has been accessed for a fetch or store
249 operation since the later of the two following times:
250
251 =over 4
252
253 =item *
254
255 12:00 a.m. on the day the command is issued
256
257 =item *
258
259 The last time the volume changed location
260
261 =back
262
263 =back
264
265 If the B<-extended> flag is included, the output for each volume includes
266 all of the information reported with the B<-long> flag, plus two tables of
267 statistics:
268
269 =over 4
270
271 =item *
272
273 The table labeled C<Raw Read/Write Stats> table summarizes the number of
274 times the volume has been accessed for reading or writing.
275
276 =item *
277
278 The table labeled C<Writes Affecting Authorship> table contains
279 information on writes made to files and directories in the specified
280 volume.
281
282 =back
283
284 =head1 EXAMPLES
285
286 The following example shows the output for the F</vicepb> partition on the
287 file server machine C<fs2.abc.com> when no flags are provided:
288
289    % vos listvol -server fs2.abc.com -partition b
290    Total number of volumes on server fs2.abc.com partition /vicepb : 66
291    sys                  1969534847 RW       1582 K On-line
292    sys.backup           1969535105 BK       1582 K On-line
293          .                   .     .         .   .    .
294          .                   .     .         .   .    .
295    user.pat             1969534536 RW      17518 K On-line
296    user.pat.backup      1969534538 BK      17537 K On-line
297    Total volumes onLine 66 ; Total volumes offLine 0 ;  Total busy 0
298
299 The following example shows the output when the B<-fast> flag is added:
300
301    % vos listvol -server fs2.abc.com -partition b -fast
302    Total number of volumes on server fs2.abc.com partition /vicepb : 66
303     1969516782
304     1969516784
305         .
306         .
307     1969535796
308
309 The following example shows two volumes from the output that appears when
310 the B<-long> flag is added:
311
312    % vos listvol -server fs2.abc.com -partition b -long
313    Total number of volumes on server fs2.abc.com partition /vicepb: 66
314          .                   .      .         .   .    .
315          .                   .      .         .   .    .
316    user.pat             1969534536 RW      17518 K On-line
317         fs2.abc.com /vicepb
318         RWrite 1969534536 ROnly 0        Backup 1969534538
319         MaxQuota      20000 K
320         Creation    Mon Jun 12 09:02:25 1989
321         Last Update Thu May 20 17:39:34 1999
322         1573 accesses in the past day (i.e., vnode references)
323    user.pat.backup      1969534538 BK      17537 K On-line
324         fs2.abc.com /vicepb
325         RWrite 1969534536 ROnly 0        Backup 1969534538
326         MaxQuota      20000 K
327         Creation    Tue Jun 13 04:37:59 1989
328         Last Update Wed May 19 06:37:59 1999
329         0 accesses in the past day (i.e., vnode references)
330           .                   .      .         .   .    .
331           .                   .      .         .   .    .
332    Total volumes onLine 66 ; Total volumes offLine 0 ; Total busy 0
333
334 =head1 PRIVILEGE REQUIRED
335
336 None
337
338 =head1 SEE ALSO
339
340 L<backup_diskrestore(8)>,
341 L<backup_volrestore(8)>,
342 L<bos_getlog(8)>,
343 L<bos_salvage(8)>,
344 L<salvager(8)>,
345 L<vos(1)>,
346 L<vos_examine(1)>,
347 L<vos_listvldb(1)>,
348 L<vos_restore(1)>
349
350 =head1 COPYRIGHT
351
352 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
353
354 This documentation is covered by the IBM Public License Version 1.0.  It was
355 converted from HTML to POD by software written by Chas Williams and Russ
356 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.