81f3a5143d7c0d351ffe6264816b9d559a410730
[openafs.git] / doc / man-pages / pod8 / backup_restoredb.pod
1 =head1 NAME
2
3 backup restoredb - Restores a saved copy of the Backup Database
4
5 =head1 SYNOPSIS
6
7 B<backup restoredb> [B<-portoffset> <I<TC port offset>>] [B<-localauth>]
8     [B<-cell> <I<cell name>>] [B<-help>]
9
10 B<backup res> [B<-p> <I<TC port offset>>] [B<-l>] [B<-c> <I<cell name>>]
11     [B<-h>]
12
13 =head1 DESCRIPTION
14
15 The B<backup restoredb> command restores to the Backup Server machine's
16 local disk a version of the Backup Database previously written to tape by
17 using the B<backup savedb> command.
18
19 (If the C<FILE YES> instruction appears in the
20 F</usr/afs/backup/CFG_I<device_name>> file associated with the specified
21 port offset, then the B<backup restoredb> command restores data from the
22 backup data file listed for that port offset in the Tape Coordinator's
23 F</usr/afs/backup/tapeconfig> file, instead of from tape. For the sake of
24 clarity, the following text refers to tapes only, but the Backup System
25 handles backup data files in much the same way.)
26
27 The most common reason to run this command is to replace a corrupted or
28 otherwise damaged Backup Database; use the B<backup dbverify> command to
29 determine the database's status. The command can also be used to restore
30 records that were removed from the database when the B<-archive> argument
31 was included on a previous B<backup savedb> command.
32
33 The command completely overwrites the existing Backup Database records for
34 volume sets, Tape Coordinators, and the dump hierarchy with the
35 corresponding information from the saved version. It does not overwrite
36 existing dump records, but instead interleaves the records from the copy
37 being restored. If both the existing database (on the Backup Server
38 machine's disk) and the copy being restored include a record about the
39 same dump, the Backup System retains the one in the existing database.
40
41 The Tape Coordinator's default response to this command is to access the
42 first tape it needs by invoking the C<MOUNT> instruction in the local
43 F</usr/afs/backup/CFG_I<device_name>> file, or by prompting the backup
44 operator to insert the tape if there is no C<MOUNT> instruction. However,
45 if the C<AUTOQUERY NO> instruction appears in the F<CFG_I<device_name>>
46 file, or if the issuer of the B<butc> command included the B<-noautoquery>
47 flag, the Tape Coordinator instead expects the tape to be in the device
48 already. If it is not, or is the wrong tape, the Tape Coordinator invokes
49 the C<MOUNT> instruction or prompts the operator. It also invokes the
50 C<MOUNT> instruction or prompts for any additional tapes needed to
51 complete the restore operation; the backup operator must arrange to
52 provide them.
53
54 =head1 CAUTIONS
55
56 If the database is corrupted, do not attempt to restore a saved database
57 on top of it. Instead, use the instructions for repairing a corrupted
58 database in the I<IBM AFS Administration Guide> chapter about performing
59 backup operations.
60
61 =head1 OPTIONS
62
63 =over 4
64
65 =item B<-portoffset> <I<TC port offset>>
66
67 Specifies the port offset number of the Tape Coordinator handling the
68 tapes for this operation.
69
70 =item B<-localauth>
71
72 Constructs a server ticket using a key from the local
73 F</usr/afs/etc/KeyFile> file. The B<backup> command interpreter presents
74 it to the Backup Server, Volume Server and VL Server during mutual
75 authentication. Do not combine this flag with the B<-cell> argument. For
76 more details, see L<backup(8)>.
77
78 =item B<-cell> <I<cell name>>
79
80 Names the cell in which to run the command. Do not combine this argument
81 with the B<-localauth> flag. For more details, see L<backup(8)>.
82
83 =item B<-help>
84
85 Prints the online help for this command. All other valid options are
86 ignored.
87
88 =back
89
90 =head1 EXAMPLES
91
92 The following example shows the Backup Database being restored from the
93 Tape Coordinator with port offset 0:
94
95    % backup restoredb
96
97 =head1 PRIVILEGE REQUIRED
98
99 The issuer must be listed in the F</usr/afs/etc/UserList> file on every
100 machine where the Backup Server is running, or must be logged onto a
101 server machine as the local superuser C<root> if the B<-localauth> flag is
102 included.
103
104 =head1 SEE ALSO
105
106 L<butc(5)>,
107 L<backup(8)>,
108 L<backup_dbverify(8)>,
109 L<backup_savedb(8)>,
110 L<butc(8)>
111
112 I<IBM AFS Administration Guide>
113
114 =head1 COPYRIGHT
115
116 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
117
118 This documentation is covered by the IBM Public License Version 1.0.  It was
119 converted from HTML to POD by software written by Chas Williams and Russ
120 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.