doc/man-pages/pod/backup_listvolsets.pod

   1 =head1 NAME
   2
   3 backup listvolsets - Lists volume set entries from the Backup Database
   4
   5 =head1 SYNOPSIS
   6
   7 backup listvolsets [B<-name> I<volume set name>]
   8 [B<-localauth>]  [B<-cell> I<cell name>]  [B<-help>]
   9
  10 backup listv [B<-n> I<volume set name>]  [B<-l>]  [B<-c> I<cell name>]  [B<-h>]
  11
  12 =head1 DESCRIPTION
  13
  14 The C<backup listvolsets> command displays the Backup Database records
  15 for either
  16
  17 =over
  18
  19 =item *
  20
  21 All volume sets and their volume entries, if the B<-name> argument is
  22 omitted
  23
  24 =item *
  25
  26 The volume set specified by the B<-name> argument, along with its
  27 volume entries
  28
  29 =back
  30
  31 =head1 OPTIONS
  32
  33 =over 4
  34
  35 =item B<-name> I<volume set name>
  36
  37 Names the volume set to display. If this argument is omitted,
  38 the output lists all volume sets defined in the Backup
  39 Database.
  40
  41 =item B<-localauth>
  42
  43 Constructs a server ticket using a key from the local
  44 B</usr/afs/etc/KeyFile> file. The C<backup> command interpreter
  45 presents it to the Backup Server, Volume Server and VL Server
  46 during mutual authentication. Do not combine this flag with the
  47 B<-cell> argument. For more details, see the introductory L<backup(1)>
  48 reference page.
  49
  50 =item B<-cell> I<cell name>
  51
  52 Names the cell in which to run the command. Do not combine this
  53 argument with the B<-localauth> flag. For more details, see the
  54 introductory L<backup(1)> reference page.
  55
  56 =item B<-help>
  57
  58 Prints the online help for this command. All other valid
  59 options are ignored.
  60
  61 =back
  62
  63 =head1 OUTPUT
  64
  65 The entry for each volume set begins with the Volume set header and
  66 the volume set's name. A temporary volume set's name is followed by
  67 the string C<(temporary)>. Each volume entry follows on a separate line,
  68 indicating the entry's index number and the server, partition, and
  69 volume names it matches. The output uses the metacharacter notation
  70 described on the L<backup_addvolentry(1)> reference page. Use the index
  71 number to identify volume entries when deleting them with the C<backup
  72 delvolentry> command.
  73
  74 =head1 EXAMPLES
  75
  76 The following example shows the volume entries in the three volume
  77 sets currently defined in the Backup Database:
  78
  79     backup listvolsets
  80    Volume set user:
  81        Entry   1: server .*, partition .*, volumes: user.*\.backup
  82    Volume set sun
  83        Entry   1: server .*, partition .*, volumes: sun4x_55\..*
  84        Entry   2: server .*, partition .*, volumes: sun4x_56\..*
  85    Volume set rs
  86        Entry   1: server .*, partition .*, volumes: rs_aix42\..*
  87
  88 =head1 PRIVILEGE REQUIRED
  89
  90 The issuer must be listed in the B</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 B<root> if the B<-localauth> flag is
  93 included.
  94
  95 =head1 COPYRIGHT
  96
  97 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
  98
  99 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
 100 and Elizabeth Cassell <e_a_c@mailsnare.net>, 2004,
 101 Stanford Linear Accelerator Center, a department of Stanford University.
 102
 103 =head1 SEE ALSO
 104
 105 L<backup(1)>,
 106 L<backup_addvolentry(1)>,
 107 L<backup_addvolset(1)>,
 108 L<backup_delvolentry(1)>,
 109 L<backup_delvolset(1)>
 110
 111 =cut