man-page-more-fs-commands-20090517
[openafs.git] / doc / man-pages / pod1 / fs_checkvolumes.pod
1 =head1 NAME
2
3 fs_checkvolumes - Forces the Cache Manager to update volume information
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fs checkvolumes> [B<-help>]
11
12 B<fs checkv> [B<-h>]
13
14 =for html
15 </div>
16
17 =head1 DESCRIPTION
18
19 The B<fs checkvolumes> command discards the table of mappings between
20 volume names and volume ID numbers that the Cache Manager stores in memory
21 and uses when fetching data from volumes. The next time an application
22 requests AFS data, the Cache Manager must contact the Volume Location (VL)
23 Server for volume location information, and then an appropriate file
24 server machine for the actual data.
25
26 The Cache Manager updates the table of mappings periodically (by default,
27 hourly), but this command is useful if the issuer knows that a volume's
28 name has changed, or that new read-only replicas of a volume have been
29 released, because issuing it forces the Cache Manager to reference the
30 changed volume.
31
32 =head1 OPTIONS
33
34 =over 4
35
36 =item B<-help>
37
38 Prints the online help for this command. All other valid options are
39 ignored.
40
41 =back
42
43 =head1 OUTPUT
44
45 The following message confirms that the command ran successfully.
46
47    All volumeID/name mappings checked.
48
49 =head1 PRIVILEGE REQUIRED
50
51 None
52
53 =head1 COPYRIGHT
54
55 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
56
57 This documentation is covered by the IBM Public License Version 1.0.  It was
58 converted from HTML to POD by software written by Chas Williams and Russ
59 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.