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