doc/man-pages/pod8/backup_listvolsets.pod

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