man-page-fs-updates-20070817
[openafs.git] / doc / man-pages / pod8 / backup_dbverify.pod
1 =head1 NAME
2
3 backup dbverify - Checks the integrity of the Backup Database
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<backup dbverify> [B<-detail>] [B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>>
11     [B<-help>]
12
13 B<backup db> [B<-d>] [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
14
15 =for html
16 </div>
17
18 =head1 DESCRIPTION
19
20 The B<backup dbverify> command checks the integrity of the Backup
21 Database. The command's output indicates whether the Backup Database is
22 damaged (data is corrupted) or not. If the Backup Database is undamaged,
23 it is safe to continue using it. If it is corrupted, discontinue any
24 backup operations until it is repaired.
25
26 =head1 CAUTIONS
27
28 While this command runs, no other backup operation can access the Backup
29 Database; the other commands do not run until this command
30 completes. Avoid issuing this command when other backup operations are
31 likely to run. The B<backup savedb> command repairs some types of
32 corruption.
33
34 =head1 OPTIONS
35
36 =over 4
37
38 =item B<-detail>
39
40 Reports the number of orphaned blocks found, any inconsistencies, and the
41 name of the server machine running the Backup Server that is checking its
42 copy of the database.
43
44 =item B<-localauth>
45
46 Constructs a server ticket using a key from the local
47 F</usr/afs/etc/KeyFile> file. The B<backup> command interpreter presents
48 it to the Backup Server, Volume Server and VL Server during mutual
49 authentication. Do not combine this flag with the B<-cell> argument. For
50 more details, see L<backup(8)>.
51
52 =item B<-cell> <I<cell name>>
53
54 Names the cell in which to run the command. Do not combine this argument
55 with the B<-localauth> flag. For more details, see L<backup(8)>.
56
57 =item B<-help>
58
59 Prints the online help for this command. All other valid options are
60 ignored.
61
62 =back
63
64 =head1 OUTPUT
65
66 The command displays one of the following two messages:
67
68 =over 4
69
70 =item Database OK
71
72 The database is undamaged and can be used.
73
74 =item Database not OK
75
76 The database is damaged. You can use the backup savedb command to repair
77 many kinds of corruption as it creates a backup copy.  For more detailed
78 instructions, see the I<IBM AFS Administration Guide> chapter about
79 performing backup operations.
80
81 =back
82
83 The B<-detail> flag provides additional information:
84
85 =over 4
86
87 =item *
88
89 The number of I<orphan blocks> found. These are ranges of memory that the
90 Backup Server preallocated in the database but cannot use. Orphan blocks
91 do not interfere with database access, but do waste disk space. To free
92 the unusable space, dump the database to tape by using the B<backup
93 savedb> command, and then restore it by using the B<backup restoredb>
94 command.
95
96 =item *
97
98 Any inconsistencies in the database, such as invalid hostnames for Tape
99 Coordinator machines.
100
101 =item *
102
103 The name of the database server machine on which the Backup Database was
104 checked, designated as the C<Database checker>. For a detailed trace of
105 the verification operation, see the F</usr/afs/logs/BackupLog> file on the
106 indicated machine. You can use the B<bos getlog> command to display it.
107
108 =back
109
110 =head1 EXAMPLES
111
112 The following command confirms that the Backup Database is undamaged:
113
114    % backup dbverify
115    Database OK
116
117 The following command confirms that the Backup Database is undamaged and
118 that it has no orphan blocks or invalid Tape Coordinator entries. The
119 Backup Server running on the machine C<db1.abc.com> checked its copy of
120 the Database.
121
122    % backup dbverify -detail
123    Database OK
124    Orphan blocks 0
125    Database checker was db1.abc.com
126
127 =head1 PRIVILEGE REQUIRED
128
129 The issuer must be listed in the F</usr/afs/etc/UserList> file on every
130 machine where the Backup Server is running, or must be logged onto a
131 server machine as the local superuser C<root> if the B<-localauth> flag is
132 included.
133
134 =head1 SEE ALSO
135
136 L<BackupLog(5)>,
137 L<backup(8)>,
138 L<backup_restoredb(8)>,
139 L<backup_savedb(8)>,
140 L<bos_getlog(8)>
141
142 =head1 COPYRIGHT
143
144 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
145
146 This documentation is covered by the IBM Public License Version 1.0.  It was
147 converted from HTML to POD by software written by Chas Williams and Russ
148 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.