doc/man-pages/pod/backup_addvolset.pod

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