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