man-page-fileserver-update-20080311
[openafs.git] / doc / man-pages / pod8 / vldb_check.pod
1 =head1 NAME
2
3 vldb_check - Checks the integrity of the VLDB
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vldb_check> S<<< B<-database> <I<vldb file>> >>> [B<-uheader>] [B<-vheader>]
11     [B<-servers>] [B<-entries>] [B<-verbose>] [B<-help>]
12
13 B<vldb_check> S<<< B<-d> <I<vldb file>> >>> [B<-u>] [B<-vh>] [B<-s>] [B<-e>]
14     [B<-ve>] [B<-h>]
15
16 =for html
17 </div>
18
19 =head1 DESCRIPTION
20
21 The B<vldb_check> command checks the integrity of the Volume Location
22 Database (VLDB), reporting any errors or corruption it finds.  If there
23 are problems, do not issue any B<vos> commands until the database is
24 repaired.
25
26 =head1 CAUTIONS
27
28 The results can be unpredictable if the Volume Location (VL) Server makes
29 changes to the VLDB while this command is running. Use the B<bos shutdown>
30 command to shutdown the local B<vlserver> process before running this
31 command, or before creating a second copy of the F<vldb.DB0> file (with a
32 different name) on which to run the command.
33
34 =head1 OPTIONS
35
36 =over 4
37
38 =item B<-database> <I<vldb file>>
39
40 Names the VLDB (copy of the F<vldb.DB0> file) to check. If the current
41 working directory is not the location of the file, provide a pathname,
42 either full or relative to the current working directory.
43
44 =item B<-uheader>
45
46 Displays information which Ubik maintains in the database's header.
47
48 =item B<-pheader>
49
50 Displays information which the VL Server maintains in the database's
51 header.
52
53 =item B<-servers> <I<authentication servers>>+
54
55 Outputs the server entries from the VLDB, which list the IP addresses
56 registered for each file server machine in the cell.
57
58 =item B<-entries>
59
60 Outputs every volume entry in the database. The information includes the
61 volume's name and the volume ID number for each of its versions.
62
63 =item B<-verbose>
64
65 Reports additional information about the database, including the number of
66 entries for each type of volume.
67
68 =item B<-help>
69
70 Prints the online help for this command. All other valid options are
71 ignored.
72
73 =back
74
75 =head1 OUTPUT
76
77 If there are errors in the database, the output always reports them on the
78 standard error stream. If any options other than B<-database> or B<-help>
79 are provided, the output written to the standard output stream includes
80 additional information as described for each option in L<OPTIONS>.  The
81 output is intended for debugging purposes and is meaningful to someone
82 familiar with the internal structure of the VLDB.
83
84 =head1 PRIVILEGE REQUIRED
85
86 The issuer must be logged in as the local superuser C<root>.
87
88 =head1 SEE ALSO
89
90 L<vldb.DB0(5)>,
91 L<bos_shutdown(8)>,
92 L<vlserver(8)>
93
94 =head1 COPYRIGHT
95
96 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
97
98 This documentation is covered by the IBM Public License Version 1.0.  It was
99 converted from HTML to POD by software written by Chas Williams and Russ
100 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.