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