025e3ab38fc0e48f5de4c5ef73f706d5158425c1
[openafs.git] / doc / man-pages / pod / backup_delvolset.pod
1 =head1 NAME
2
3 backup delvolset - Deletes one or more volume sets from the Backup Database
4
5 =head1 SYNOPSIS
6
7 backup delvolset B<-name> I<volume set name> [I<volume set name> ...]
8 [B<-localauth>]  [B<-cell> I<cell name>]  [B<-help>]
9
10 backup delvols B<-n> I<volume set name> [I<volume set name> ...]  [B<-l>]  [B<-c> I<cell name>]  [B<-h>]
11
12 =head1 DESCRIPTION
13
14 The C<backup delvolset> command deletes each volume set named by the
15 B<-name> argument, and the volume entries each contains, from the Backup
16 Database. The C<backup listvolsets> command lists the volume sets (and
17 their volume entries) currently defined in the Backup Database.
18
19 =head1 OPTIONS
20
21 =over 4
22
23 =item B<-name> I<volume set name> [I<volume set name> ...]
24
25 Names each volume set to delete.
26
27 =item B<-localauth>
28
29 Constructs a server ticket using a key from the local
30 B</usr/afs/etc/KeyFile> file. The C<backup> command interpreter
31 presents it to the Backup Server, Volume Server and VL Server
32 during mutual authentication. Do not combine this flag with the
33 B<-cell> argument. For more details, see the introductory L<backup(1)> reference page.
34
35 =item B<-cell> I<cell name>
36
37 Names the cell in which to run the command. Do not combine this
38 argument with the B<-localauth> flag. For more details, see the
39 introductory L<backup(1)> reference page.
40
41 =item B<-help>
42
43 Prints the online help for this command. All other valid
44 options are ignored.
45
46 =back
47
48 =head1 EXAMPLES
49
50 The following command deletes the volume set called user and all
51 volume entries in it:
52
53    backup delvolset user
54
55 =head1 PRIVILEGE REQUIRED
56
57 The issuer must be listed in the B</usr/afs/etc/UserList> file on every
58 machine where the Backup Server is running, or must be logged onto a
59 server machine as the local superuser B<root> if the B<-localauth> flag is
60 included.
61
62 =head1 CAVEATS
63
64 Deleting a temporary volume set is possible only within the
65 interactive session in which it was created. Exiting the interactive
66 session also destroys the temporary volume set automatically.
67
68 =head1 COPYRIGHT
69
70 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
71
72 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
73 Stanford Linear Accelerator Center, a department of Stanford University.
74
75 =head1 SEE ALSO
76
77 L<backup(1)>,
78 L<backup_addvolentry(1)>,
79 L<backup_addvolset(1)>,
80 L<backup_delvolentry(1)>,
81 L<backup_listvolsets(1)>
82
83 =cut