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