doc/man-pages/pod8/backup_savedb.pod

   1 =head1 NAME
   2
   3 backup savedb - Creates a saved copy of the Backup Database
   4
   5 =head1 SYNOPSIS
   6
   7 B<backup savedb> [B<-portoffset> <I<TC port offset>>]
   8     [B<-archive> <I<date time>>+] [B<-localauth>]
   9     [B<-cell> <I<cell name>>] [B<-help>]
  10
  11 B<backup sa> [B<-p> <I<TC port offset>>] [B<-a> <I<date time>>+]
  12     [B<-l>] [B<-c> <I<cell name>>] [B<-h>]
  13
  14 =head1 DESCRIPTION
  15
  16 The B<backup savedb> command creates a backup copy of the entire Backup
  17 Database and writes it to the tape in the device controlled by the Tape
  18 Coordinator indicated with the B<-portoffset> argument. If the database is
  19 damaged (as reported by the B<backup dbverify> command), this command
  20 repairs as much of the corruption as possible as it creates the saved
  21 copy. The Backup Server creates a dump record for the saved database in
  22 the Backup Database (but in the disk version of the database only, not in
  23 the version written to tape).
  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 savedb> command dumps the database copy to
  28 the backup data file listed for that port offset in the Tape Coordinator's
  29 F</usr/afs/backup/tapeconfig> file, instead of to 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 If the B<-archive> flag is provided, after writing the saved copy of the
  34 database the Backup System truncates the copy of the database on disk by
  35 deleting volume dump records with timestamps prior to the specified date
  36 and time (it does not delete the dump records created by previous B<backup
  37 savedb> commands, however).
  38
  39 If the tape to which the database copy is written has an AFS tape name, it
  40 must be C<Ubik_db_dump.1> or C<< <NULL> >>. Any permanent name is
  41 acceptable.
  42
  43 The Tape Coordinator's default response to this command is to access the
  44 first tape by invoking the C<MOUNT> instruction in the local
  45 F</usr/afs/backup/CFG_I<device_name>> file, or by prompting the backup
  46 operator to insert the tape if there is no C<MOUNT> instruction. However,
  47 if the C<AUTOQUERY NO> instruction appears in the F<CFG_I<device_name>>
  48 file, or if the issuer of the B<butc> command included the B<-noautoquery>
  49 flag, the Tape Coordinator instead expects the tape to be in the device
  50 already.  If it is not, the Tape Coordinator invokes the C<MOUNT>
  51 instruction or prompts the operator. It also invokes the C<MOUNT>
  52 instruction or prompts for any additional tapes needed to complete the
  53 operation; the backup operator must arrange to provide them.
  54
  55 =head1 OPTIONS
  56
  57 =over 4
  58
  59 =item B<-portoffset> <I<TC port offset>>
  60
  61 Specifies the port offset number of the Tape Coordinator handling the
  62 tapes for this operation.
  63
  64 =item B<-archive> <I<date time>>+
  65
  66 Specifies a date and time; volume dump records with earlier timestamps are
  67 deleted from the disk copy of the Backup Database after the Backup System
  68 dumps the database (a dump's timestamp appears in the C<created> field of
  69 the output from the B<backup dumpinfo> command). However, if a dump set
  70 contains any dump created after the specified date, none of the dump
  71 records associated with the dump set are deleted. Dump records for
  72 previous dumps of the database (created with the B<backup savedb> command)
  73 are never deleted; use the B<backup deletedump> command to remove them.
  74
  75 Provide one of two values:
  76
  77 =over 4
  78
  79 =item *
  80
  81 The string C<NOW> to indicate the current date and time, in which case the
  82 Backup System deletes all dump records except those for dumps of the
  83 Backup Database itself.
  84
  85 =item *
  86
  87 A date value in the format I<mm/dd/yyyy> [I<hh:MM>]. The month (I<mm>),
  88 day (I<dd>), and year (I<yyyy>) are required, and valid values for the
  89 year range from C<1970> to C<2037>; higher values are not valid because
  90 the latest possible date in the standard UNIX representation is in
  91 February 2038. The Backup System automatically reduces any later date to
  92 the maximum value.
  93
  94 The hour and minutes (I<hh:MM>) are optional, but if provided must be in
  95 24-hour format (for example, the value C<14:36> represents 2:36 p.m.). If
  96 omitted, the time defaults to 59 seconds after midnight (00:00:59
  97 hours). Similarly, the B<backup> command interpreter automatically adds 59
  98 seconds to any time value provided. In both cases, adding 59 seconds
  99 compensates for how the Backup Database and B<backup dumpinfo> command
 100 represent dump creation times in hours and minutes only. That is, the
 101 Database records a creation timestamp of C<20:55> for any dump created
 102 between 20:55:00 and 20:55:59. Automatically adding 59 seconds to a time
 103 thus includes the records for all dumps created during that minute.
 104
 105 =back
 106
 107 =item B<-localauth>
 108
 109 Constructs a server ticket using a key from the local
 110 F</usr/afs/etc/KeyFile> file. The B<backup> command interpreter presents
 111 it to the Backup Server, Volume Server and VL Server during mutual
 112 authentication. Do not combine this flag with the B<-cell> argument. For
 113 more details, see L<backup(8)>.
 114
 115 =item B<-cell> <I<cell name>>
 116
 117 Names the cell in which to run the command. Do not combine this argument
 118 with the B<-localauth> flag. For more details, see L<backup(8)>.
 119
 120 =item B<-help>
 121
 122 Prints the online help for this command. All other valid options are
 123 ignored.
 124
 125 =back
 126
 127 =head1 EXAMPLES
 128
 129 The following example writes a copy of the Backup Database to the tape
 130 device controlled by the Tape Coordinator with port offset 1:
 131
 132    % backup savedb -portoffset 1
 133
 134 =head1 PRIVILEGE REQUIRED
 135
 136 The issuer must be listed in the F</usr/afs/etc/UserList> file on every
 137 machine where the Backup Server is running, or must be logged onto a
 138 server machine as the local superuser C<root> if the B<-localauth> flag is
 139 included.
 140
 141 =head1 SEE ALSO
 142
 143 L<butc(5)>,
 144 L<backup(8)>,
 145 L<backup_dbverify(8)>,
 146 L<backup_restoredb(8)>,
 147 L<butc(8)>
 148
 149 =head1 COPYRIGHT
 150
 151 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 152
 153 This documentation is covered by the IBM Public License Version 1.0.  It was
 154 converted from HTML to POD by software written by Chas Williams and Russ
 155 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.