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