doc/man-pages/pod8/backup_diskrestore.pod

   1 =head1 NAME
   2
   3 backup diskrestore - Restores the entire contents of a partition
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<backup diskrestore> S<<< B<-server> <I<machine to restore>> >>>
  11     S<<< B<-partition> <I<partition to restore>> >>>
  12     S<<< [B<-portoffset> <I<TC port offset>>+] >>>
  13     S<<< [B<-newserver> <I<destination machine>>] >>>
  14     S<<< [B<-newpartition> <I<destination partition>>] >>>
  15     S<<< [B<-extension> <I<new volume name extension>>] >>>
  16     [B<-n>] [B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
  17
  18 B<backup di> S<<< B<-s> <I<machine to restore>> >>> S<<< B<-pa> <I<partition to restore>> >>>
  19     S<<< [B<-po> <I<TC port offset>>+] >>> S<<< [B<-news> <I<destination machine>>] >>>
  20     S<<< [B<-newp> <I<destination partition>>] >>>
  21     S<<< [B<-e> <I<new volume name extension>>] >>> [B<-n>] [B<-l>]
  22     S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
  23
  24 =for html
  25 </div>
  26
  27 =head1 DESCRIPTION
  28
  29 The B<backup diskrestore> command restores all of the volumes for which
  30 the Volume Location Database (VLDB) lists a read/write site on the
  31 partition specified with the B<-server> and B<-partition> arguments. It is
  32 useful if a disk or machine failure corrupts or destroys the data on an
  33 entire partition. (To restore any read-only or backup volumes that resided
  34 on the partition, use the B<vos release> and B<vos backup> commands,
  35 respectively, after restoring the read/write version.)
  36
  37 If restoring only selected volumes to a single site, it is usually more
  38 efficient to use the B<backup volrestore> command. To restore multiple
  39 volumes to many different sites, use the B<backup volsetrestore> command.
  40
  41 (If the C<FILE YES> instruction appears in the
  42 F</usr/afs/backup/CFG_I<device_name>> file on the Tape Coordinator machine
  43 associated with the specified port offset, then the Backup System restores
  44 data from the backup data file listed for that port offset in the Tape
  45 Coordinator's F</usr/afs/backup/tapeconfig> file, instead of from
  46 tape. For the sake of clarity, the following text refers to tapes only,
  47 but the Backup System handles backup data files in much the same way.)
  48
  49 The Backup System determines whether the read/write or backup version of
  50 each volume was dumped more recently, and restores the dumps of that
  51 version, starting with the most recent full dump. It resets the creation
  52 timestamp of each restored volume to the date and time at which it begins
  53 restoring the volume (the creation timestamp appears in the C<Creation>
  54 field of the output from the B<vos examine> and B<vos listvol> commands).
  55
  56 If all of the full and incremental dumps of all relevant volumes were not
  57 written on compatible tape devices, use the B<-portoffset> argument to
  58 list multiple port offset numbers in the order in which the tapes are
  59 needed (first list the port offset for the full dump, second the port
  60 offset for the level 1 incremental dump, and so on). This implies that the
  61 full dumps of all relevant volumes must have been written to a type of
  62 tape that the first Tape Coordinator can read, the level 1 incremental
  63 dumps to a type of tape the second Tape Coordinator can read, and so
  64 on. If dumps are on multiple incompatible tape types, use the B<backup
  65 volrestore> command to restore individual volumes, or the B<backup
  66 volsetrestore> command after defining groups of volumes that were dumped
  67 to compatible tape types. For further discussion, see the I<IBM AFS
  68 Administration Guide>.
  69
  70 By default, the Backup System restores the contents of the specified
  71 partition to that same partition. To restore the contents to an alternate
  72 site, combine the following options as indicated. The Backup System
  73 removes each volume from the original site, if it still exists, and
  74 records the change of site in the VLDB.
  75
  76 =over 4
  77
  78 =item *
  79
  80 To restore to a different partition on the same file server machine,
  81 provide the B<-newpartition> argument.
  82
  83 =item *
  84
  85 To restore to the partition with the same name on a different file server
  86 machine, provide the B<-newserver> argument.
  87
  88 =item *
  89
  90 To restore to a completely different site, combine the B<-newserver> and
  91 B<-newpartition> arguments.
  92
  93 =back
  94
  95 By default, the Backup System overwrites the contents of existing volumes
  96 with the restored data. To create a new volume to house the restored data
  97 instead, use the B<-extension> argument. The Backup System creates the new
  98 volume at the site designated by the B<-newserver> and B<-newpartition>
  99 arguments if they are used or the B<-server> and B<-partition> arguments
 100 otherwise. It derives the volume name by adding the extension to the
 101 read/write base name listed in the VLDB, and creates a new VLDB entry. The
 102 command does not affect the existing volume in any way. However, if a
 103 volume with the specified extension also already exists, the command
 104 overwrites it.
 105
 106 To print out a list of the tapes containing the needed dumps, without
 107 actually performing the restore operation, include the B<-n> flag along
 108 with the other options to be used on the actual command.
 109
 110 The Tape Coordinator's default response to this command is to access the
 111 first tape it needs by invoking the C<MOUNT> instruction in the local
 112 F<CFG_I<device_name>> file, or by prompting the backup operator to insert
 113 the tape if there is no C<MOUNT> instruction. However, if the C<AUTOQUERY
 114 NO> instruction appears in the F<CFG_I<device_name>> file, or if the
 115 issuer of the B<butc> command included the B<-noautoquery> flag, the Tape
 116 Coordinator instead expects the tape to be in the device already.  If it
 117 is not, or is the wrong tape, the Tape Coordinator invokes the C<MOUNT>
 118 instruction or prompts the operator. It also invokes the C<MOUNT>
 119 instruction or prompts for any additional tapes needed to complete the
 120 restore operation; the backup operator must arrange to provide them.
 121
 122 =head1 CAUTIONS
 123
 124 If issuing this command to recover data after a disk crash or other
 125 damage, be sure not to issue the B<vos syncserv> command first. Doing so
 126 destroys the VLDB record of the volumes that resided on the partition.
 127
 128 =head1 OPTIONS
 129
 130 =over 4
 131
 132 =item B<-server> <I<machine to restore>>
 133
 134 Names the file server machine that the VLDB lists as the site of the
 135 volumes that need to be restored.
 136
 137 =item B<-partition> <I<partition to restore>>
 138
 139 Names the partition that the VLDB lists as the site of the volumes that
 140 need to be restored.
 141
 142 =item B<-portoffset> <I<TC port offset>>+
 143
 144 Specifies one or more port offset numbers (up to a maximum of 128), each
 145 corresponding to a Tape Coordinator to use in the operation. If there is
 146 more than one value, the Backup System uses the first one when restoring
 147 the full dump of each volume, the second one when restoring the level 1
 148 incremental dump of each volume, and so on. It uses the final value in the
 149 list when restoring dumps at the corresponding depth in the dump hierarchy
 150 and at all lower levels.
 151
 152 Provide this argument unless the default value of 0 (zero) is appropriate
 153 for all dumps. If C<0> is just one of the values in the list, provide it
 154 explicitly in the appropriate order.
 155
 156 =item B<-newserver> <I<destination machine>>
 157
 158 Names an alternate file server machine to which to restore the volumes. If
 159 this argument is omitted, the volumes are restored to the file server
 160 machine named by the B<-server> argument.
 161
 162 =item B<-newpartition> <I<destination partition>>
 163
 164 Names an alternate partition to which to restore the data. If this
 165 argument is omitted, the volumes are restored to the partition named by
 166 the B<-partition> argument.
 167
 168 =item B<-extension> <I<new volume name extension>>
 169
 170 Creates a new volume for each volume being restored, to house the restored
 171 data. The Backup System derives the new volume's name by appending the
 172 specified string to the read/write base name listed in the VLDB, and
 173 creates a new VLDB volume entry. The Backup System preserves the contents
 174 of the volumes on the partition, if any still exist. Any string other than
 175 C<.readonly> or C<.backup> is acceptable, but the combination of the base
 176 name and extension cannot exceed 22 characters in length. To use a period
 177 to separate the extension from the name, specify it as the first character
 178 of the string (as in C<.rst>, for example).
 179
 180 =item B<-n>
 181
 182 Displays a list of the tapes necessary to perform the requested restore,
 183 without actually performing the operation.
 184
 185 =item B<-localauth>
 186
 187 Constructs a server ticket using a key from the local
 188 F</usr/afs/etc/KeyFile> file. The B<backup> command interpreter presents
 189 it to the Backup Server, Volume Server and VL Server during mutual
 190 authentication. Do not combine this flag with the B<-cell> argument. For
 191 more details, see L<backup(8)>.
 192
 193 =item B<-cell> <I<cell name>>
 194
 195 Names the cell in which to run the command. Do not combine this argument
 196 with the B<-localauth> flag. For more details, see L<backup(8)>.
 197
 198 =item B<-help>
 199
 200 Prints the online help for this command. All other valid options are
 201 ignored.
 202
 203 =back
 204
 205 =head1 OUTPUT
 206
 207 If a tape error occurs during the restore operation, the Tape Coordinator
 208 displays the following messages:
 209
 210    Restore operation on volume I<name> failed due to tape error
 211    Do you want to continue (y/n)?
 212
 213 where I<name> is the name of the volume that was being restored when the
 214 tape error occurred. Enter the value B<y> to continue the operation
 215 without restoring the indicated volume or the value C<n> to terminate the
 216 operation. In the latter case, the operator can then attempt to determine
 217 the cause of the tape error.
 218
 219 If the issuer includes the B<-n> flag with the command, the following
 220 string appears at the head of the list of the tapes necessary to perform
 221 the restore operation:
 222
 223    Tapes needed:
 224
 225 =head1 EXAMPLES
 226
 227 The following command restores the volumes for which the VLDB lists a
 228 read/write site on the F</vicepd> partition of the machine
 229 C<fs5.abc.com>. The Tape Coordinator associated with port offset 3
 230 performs the operation.
 231
 232    % backup diskrestore -server fs5.abc.com -partition /vicepd -portoffset 3
 233
 234 The following command restores the volumes for which the VLDB lists a
 235 read/write site on the F</vicepb> partition of the machine C<fs1.abc.com>
 236 to a new site: the F</vicepa> partition on the machine C<fs3.abc.com>. The
 237 Tape Coordinator associated with port offset 0 performs the
 238 operation. (The command appears here on two lines only for legibility.)
 239
 240    % backup diskrestore  -server fs1.abc.com -partition /vicepb   \
 241                          -newserver fs3.abc.com -newpartition /vicepa
 242
 243 The following command lists the tapes required to restore the volumes for
 244 which the VLDB lists a read/write site on the F</vicepm> partition of the
 245 machine C<fs4.abc.com>:
 246
 247    % backup diskrestore -server fs4.abc.com -partition /vicepm -n
 248    Tapes needed:
 249    user.sunday1.1
 250    user.sunday1.2
 251    user.monday1.1
 252    user.tuesday1.1
 253    user.wednesday1.1
 254
 255 =head1 PRIVILEGE REQUIRED
 256
 257 The issuer must be listed in the F</usr/afs/etc/UserList> file on every
 258 machine where the Backup Server or Volume Location (VL) Server is running,
 259 and on every file server machine that houses an affected volume. If the
 260 B<-localauth> flag is included, the issuer must instead be logged on to a
 261 server machine as the local superuser C<root>.
 262
 263 =head1 SEE ALSO
 264
 265 L<butc(5)>,
 266 L<backup(8)>,
 267 L<backup_dump(8)>,
 268 L<backup_volrestore(8)>,
 269 L<backup_volsetrestore(8)>,
 270 L<butc(8)>,
 271 L<vos_backup(1)>,
 272 L<vos_examine(1)>,
 273 L<vos_listvol(1)>,
 274 L<vos_release(1)>
 275
 276 =head1 COPYRIGHT
 277
 278 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 279
 280 This documentation is covered by the IBM Public License Version 1.0.  It was
 281 converted from HTML to POD by software written by Chas Williams and Russ
 282 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.