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