[hcoop/debian/openafs.git] / doc / man-pages / pod8 / backup_restoredb.pod

=head1 NAME

backup_restoredb - Restores a saved copy of the Backup Database

=head1 SYNOPSIS

=for html
<div class="synopsis">

B<backup restoredb> S<<< [B<-portoffset> <I<TC port offset>>] >>>
    [B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]

B<backup res> S<<< [B<-p> <I<TC port offset>>] >>>
    [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]

=for html
</div>

=head1 DESCRIPTION

The B<backup restoredb> command restores to the Backup Server machine's
local disk a version of the Backup Database previously written to tape by
using the B<backup savedb> command.

(If the C<FILE YES> instruction appears in the
F</usr/afs/backup/CFG_I<device_name>> file associated with the specified
port offset, then the B<backup restoredb> command restores data from the
backup data file listed for that port offset in the Tape Coordinator's
F</usr/afs/backup/tapeconfig> file, instead of from tape. For the sake of
clarity, the following text refers to tapes only, but the Backup System
handles backup data files in much the same way.)

The most common reason to run this command is to replace a corrupted or
otherwise damaged Backup Database; use the B<backup dbverify> command to
determine the database's status. The command can also be used to restore
records that were removed from the database when the B<-archive> argument
was included on a previous B<backup savedb> command.

The command completely overwrites the existing Backup Database records for
volume sets, Tape Coordinators, and the dump hierarchy with the
corresponding information from the saved version. It does not overwrite
existing dump records, but instead interleaves the records from the copy
being restored. If both the existing database (on the Backup Server
machine's disk) and the copy being restored include a record about the
same dump, the Backup System retains the one in the existing database.

The Tape Coordinator's default response to this command is to access the
first tape it needs by invoking the C<MOUNT> instruction in the local
F</usr/afs/backup/CFG_I<device_name>> file, or by prompting the backup
operator to insert the tape if there is no C<MOUNT> instruction. However,
if the C<AUTOQUERY NO> instruction appears in the F<CFG_I<device_name>>
file, or if the issuer of the B<butc> command included the B<-noautoquery>
flag, the Tape Coordinator instead expects the tape to be in the device
already. If it is not, or is the wrong tape, the Tape Coordinator invokes
the C<MOUNT> instruction or prompts the operator. It also invokes the
C<MOUNT> instruction or prompts for any additional tapes needed to
complete the restore operation; the backup operator must arrange to
provide them.

=head1 CAUTIONS

If the database is corrupted, do not attempt to restore a saved database
on top of it. Instead, use the instructions for repairing a corrupted
database in the I<OpenAFS Administration Guide> chapter about performing
backup operations.

=head1 OPTIONS

=over 4

=item B<-portoffset> <I<TC port offset>>

Specifies the port offset number of the Tape Coordinator handling the
tapes for this operation.

=item B<-localauth>

Constructs a server ticket using a key from the local
F</usr/afs/etc/KeyFile> file. The B<backup> command interpreter presents
it to the Backup Server, Volume Server and VL Server during mutual
authentication. Do not combine this flag with the B<-cell> argument. For
more details, see L<backup(8)>.

=item B<-cell> <I<cell name>>

Names the cell in which to run the command. Do not combine this argument
with the B<-localauth> flag. For more details, see L<backup(8)>.

=item B<-help>

Prints the online help for this command. All other valid options are
ignored.

=back

=head1 EXAMPLES

The following example shows the Backup Database being restored from the
Tape Coordinator with port offset 0:

   % backup restoredb

=head1 PRIVILEGE REQUIRED

The issuer must be listed in the F</usr/afs/etc/UserList> file on every
machine where the Backup Server is running, or must be logged onto a
server machine as the local superuser C<root> if the B<-localauth> flag is
included.

=head1 SEE ALSO

L<butc(5)>,
L<backup(8)>,
L<backup_dbverify(8)>,
L<backup_savedb(8)>,
L<butc(8)>

The I<OpenAFS Administration Guide> at
L<http://docs.openafs.org/AdminGuide/>.

=head1 COPYRIGHT

IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.

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