doc/man-pages/pod8/backup_addvolset.pod

   1 =head1 NAME
   2
   3 backup_addvolset - Creates a new (empty) volume set
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<backup addvolset> S<<< B<-name> <I<volume set name>> >>> [B<-temporary>]
  11     [B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
  12
  13 B<backup addvols> S<<< B<-n> <I<volume set name>> >>> [B<-t>] [B<-l>]
  14     S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
  15
  16 =for html
  17 </div>
  18
  19 =head1 DESCRIPTION
  20
  21 The B<backup addvolset> command creates a new volume set, by default
  22 adding it to the Backup Database. It is best that the volume set's name
  23 indicate the volume set's contents; for example, define the volume entries
  24 in the C<user> volume set to match all user volumes. The volume set name
  25 must be unique within the Backup Database of the local cell.
  26
  27 After issuing this command, issue the B<backup addvolentry> command to
  28 define the volume entries in the volume set.
  29
  30 Sometimes it is convenient to create volume sets without recording them
  31 permanently in the Backup Database, for example when using the B<backup
  32 volsetrestore> command to restore a group of volumes that were not
  33 necessarily backed up together. To create a I<temporary> volume set,
  34 include the B<-temporary> flag. A temporary volume set exists only during
  35 the lifetime of the current interactive session, so the flag is effective
  36 only when used during an interactive session (opened by issuing the
  37 B<backup interactive> command). If it is included when the command is
  38 issued at the regular command shell prompt, the command appears to
  39 succeed, but the volume set is not created. As noted, a temporary volume
  40 set ceases to exist when the current interactive session ends, or use the
  41 B<backup delvolset> command to delete it before that.
  42
  43 One advantage of temporary volume sets is that the B<backup addvolset>
  44 command, and any B<backup addvolentry> commands subsequently used to add
  45 volume entries to it, complete more quickly than for regular volume sets,
  46 because no records are created in the Backup Database.
  47
  48 =head1 OPTIONS
  49
  50 =over 4
  51
  52 =item B<-name> <I<volume set name>>
  53
  54 Names the new volume set. The name can include up to 31 of any character
  55 other than the period. Avoid other metacharacters as well.
  56
  57 =item B<-temporary>
  58
  59 Creates a volume set that exists only within the context of the current
  60 interactive session. It is not added to the Backup Database.
  61
  62 =item B<-localauth>
  63
  64 Constructs a server ticket using a key from the local
  65 F</usr/afs/etc/KeyFile> file. The B<backup> command interpreter presents
  66 it to the Backup Server, Volume Server and VL Server during mutual
  67 authentication. Do not combine this flag with the B<-cell> argument. For
  68 more details, see L<backup(8)>.
  69
  70 =item B<-cell> <I<cell name>>
  71
  72 Names the cell in which to run the command. Do not combine this argument
  73 with the B<-localauth> flag. For more details, see L<backup(8)>.
  74
  75 =item B<-help>
  76
  77 Prints the online help for this command. All other valid options are
  78 ignored.
  79
  80 =back
  81
  82 =head1 EXAMPLES
  83
  84 The following command creates a volume set called C<sys>:
  85
  86    % backup addvolset sys
  87
  88 =head1 PRIVILEGE REQUIRED
  89
  90 The issuer must be listed in the F</usr/afs/etc/UserList> file on every
  91 machine where the Backup Server is running, or must be logged onto a
  92 server machine as the local superuser C<root> if the B<-localauth> flag is
  93 included.
  94
  95 =head1 SEE ALSO
  96
  97 L<backup(8)>,
  98 L<backup_addvolentry(8)>,
  99 L<backup_delvolentry(8)>,
 100 L<backup_delvolset(8)>,
 101 L<backup_listvolsets(8)>,
 102 L<backup_volsetrestore(8)>
 103
 104 =head1 COPYRIGHT
 105
 106 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 107
 108 This documentation is covered by the IBM Public License Version 1.0.  It was
 109 converted from HTML to POD by software written by Chas Williams and Russ
 110 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.