=head1 NAME
-backup volsetrestore - Restores all volumes in a volume set
+backup_volsetrestore - Restores all volumes in a volume set
=head1 SYNOPSIS
-B<backup volsetrestore> [B<-name> <I<volume set name>>]
- [B<-file> <I<file name>>] [B<-portoffset> <I<TC port offset>>+]
- [B<-extension> <I<new volume name extension>>] [B<-n>]
- [B<-localauth>] [B<-cell> <I<cell name>>] [B<-help>]
+=for html
+<div class="synopsis">
-B<backup vols> [B<-na> <I<volume set name>>] [B<-f> <I<file name>>]
- [B<-p> <I<TC port offset>>+] [B<-e> <I<new volume name extension>>]
- [B<-n>] [B<-l>] [B<-c> <I<cell name>>] [B<-h>]
+B<backup volsetrestore> S<<< [B<-name> <I<volume set name>>] >>>
+ S<<< [B<-file> <I<file name>>] >>>
+ S<<< [B<-portoffset> <I<TC port offset>>+] >>>
+ S<<< [B<-extension> <I<new volume name extension>>] >>> [B<-dryrun>]
+ [B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
+
+B<backup vols> S<<< [B<-na> <I<volume set name>>] >>>
+ S<<< [B<-f> <I<file name>>] >>>
+ S<<< [B<-p> <I<TC port offset>>+] >>>
+ S<<< [B<-e> <I<new volume name extension>>] >>>
+ [B<-dryrun>] [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
+
+=for html
+</div>
=head1 DESCRIPTION
tape types, use the B<backup volrestore> command to restore individual
volumes, or use this command after defining new volume sets that group
together volumes that were dumped to compatible tape types. For further
-discussion, see the I<IBM AFS Administration Guide>.
+discussion, see the I<OpenAFS Administration Guide>.
By default, the Backup System overwrites the contents of an existing
volume with the restored data. To create a new volume to house the
not affect the existing volume in any way. However, if a volume with the
specified extension also already exists, the command overwrites it.
-The B<-n> flag produces a list of the volumes to be restored if the B<-n>
-flag were not included, without actually restoring any volumes. See
-L<OUTPUT> for a detailed description of the output, and suggestions on how
-to combine it most effectively with the B<-file> and B<-name> arguments.
+The B<-dryrun> flag produces a list of the volumes to be restored if the
+B<-dryrun> flag were not included, without actually restoring any volumes.
+See L</OUTPUT> for a detailed description of the output, and suggestions
+on how to combine it most effectively with the B<-file> and B<-name>
+arguments.
The execution time for a B<backup volsetrestore> command depends on the
number of volumes to be restored and the amount of data in them, but it
<machine> <partition> <volume> [<comments> ...]
-where
+where
=over 4
for all dumps. If C<0> is just one of the values in the list, provide it
explicitly in the appropriate order.
-=item B<-n>
+=item B<-dryrun>
Displays a list of the volumes to be restored if the flag were not
-included, without actually restoring them. L<OUTPUT> details the format of
+included, without actually restoring them. L</OUTPUT> details the format of
the output. When combined with the B<-name> argument, its output is easily
edited for use as input to the B<-file> argument on a subsequent B<backup
volsetrestore> command.
=head1 OUTPUT
-If the B<-n> flag is not provided, the command displays a unique task ID
-number for the operation, in two places:
+If the B<-dryrun> flag is not provided, the command displays a unique
+task ID number for the operation, in two places:
=over 4
in interactive mode. The Backup System does not assign either type of ID
number until the restoration process actually begins.
-When the B<-n> flag is included, no task ID or job ID numbers are reported
-because none are assigned. Instead, the output begins with a count of the
-number of volumes to be restored, followed by a line for each dump of a
-volume. For each volume, the line representing the most recent full dump
-appears first, and lines for any subsequent incremental dumps follow,
-ordered by dump level. The lines for a given volume do not necessarily
-appear all together, however.
+When the B<-dryrun> flag is included, no task ID or job ID numbers are
+reported because none are assigned. Instead, the output begins with a
+count of the number of volumes to be restored, followed by a line for
+each dump of a volume. For each volume, the line representing the most
+recent full dump appears first, and lines for any subsequent incremental
+dumps follow, ordered by dump level. The lines for a given volume do not
+necessarily appear all together, however.
The format of each line is as follows (the output is shown here on two
lines only for legibility reasons):
=back
One way to generate a file for use as input to the B<-file> argument is to
-combine the B<-name> and B<-n> options, directing the output to a
-file. The I<IBM AFS Administration Guide> section on using the Backup
+combine the B<-name> and B<-dryrun> options, directing the output to a
+file. The I<OpenAFS Administration Guide> section on using the Backup
System to restore data explains how to edit the file as necessary before
using it as input to the B<-file> argument.
git://git.openafs.org / openafs.git / blobdiff