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