doc: fix some broken link specifications
[openafs.git] / doc / man-pages / pod1 / vos_zap.pod.in
1 =head1 NAME
2
3 vos_zap - Removes a volume from its site without writing to the VLDB
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vos zap> S<<< B<-server> <I<machine name>> >>>
11     S<<< B<-partition> <I<partition name>> >>>
12     S<<< B<-id> <I<volume ID>> >>>
13     [B<-force>] [B<-backup>]
14     S<<< [B<-cell> <I<cell name>>] >>>
15     [B<-noauth>] [B<-localauth>]
16     [B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
17
18 B<vos z> S<<< B<-s> <I<machine name>> >>>
19     S<<< B<-p> <I<partition name>> >>>
20     S<<< B<-i> <I<volume ID>> >>>
21     [B<-f>] [B<-b>] S<<< [B<-c> <I<cell name>>] >>>
22     [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>] [B<-h>]
23
24 =for html
25 </div>
26
27 =head1 DESCRIPTION
28
29 The B<vos zap> command removes the volume with the specified I<volume ID>
30 from the site defined by the B<-server> and B<-partition> arguments,
31 without attempting to change the corresponding Volume Location Database
32 (VLDB) entry. If removing the volume can possibly result in incorrect data
33 in the VLDB, a warning message is displayed.
34
35 The B<-force> flag removes a volume even if it cannot be "attached"
36 (brought online), which can happen either because the volume is extremely
37 damaged or because the Salvager functioned abnormally. Without this flag,
38 this command cannot remove volumes that are not attachable. See also
39 L</CAUTIONS>.
40
41 To remove the specified read/write volume's backup version at the same
42 time, include the B<-backup> flag.
43
44 =head1 CAUTIONS
45
46 Do not use this command as the standard way to remove a volume, as it is
47 likely to put the VLDB out of sync with the volumes on servers. Use the
48 B<vos remove> command instead.
49
50 This command is useful in situations where it is important to delete the
51 volume, but for some reason the VLDB is unreachable -- for example,
52 because the Volume Location Server is unavailable. The issuer can remove
53 the VLDB entry later with the B<vos remove> or B<vos delentry> command, or
54 it is removed automatically when the B<vos syncserv> and B<vos syncvldb>
55 commands run.
56
57 To remove a read-only site defined in the VLDB by mistake, before a copy
58 actually exists at the site, use the B<vos remsite> command. To remove an
59 entire VLDB entry without affecting volumes at their sites, use the B<vos
60 delentry> command.
61
62 Do not use the B<-force> flag if the volume is online, but only when
63 attempts to remove the volume with the B<vos remove> or the B<vos zap>
64 command have failed, or the volume definitely cannot be attached. After
65 using the B<-force> flag, make sure that the volume's VLDB entry is also
66 removed (issue the B<vos delentry> command if necessary).
67
68 Adding the B<-force> flag makes the command take considerably longer --
69 about as long as a salvage of the relevant partition -- since the Volume
70 Server examines all inodes on the partition for traces of the volume.
71
72 =head1 OPTIONS
73
74 =over 4
75
76 =item B<-server> <I<server name>>
77
78 Identifies the file server machine from which to remove the volume.
79 Provide the machine's IP address or its host name (either fully qualified
80 or using an unambiguous abbreviation). For details, see L<vos(1)>.
81
82 =item B<-partition> <I<partition name>>
83
84 Identifies the partition (on the file server machine specified by the
85 B<-server> argument) from which to remove the volume. Provide the
86 partition's complete name with preceding slash (for example, C</vicepa>)
87 or use one of the three acceptable abbreviated forms. For details, see
88 L<vos(1)>.
89
90 =item B<-id> <I<volume ID>>
91
92 Specifies the volume ID number of the volume to remove, which can be of
93 any of the three types. The volume name is not acceptable.
94
95 =item B<-force>
96
97 Removes the volume even though it cannot be attached (brought online). Use
98 only after the failure of previous attempts to remove the volume by using
99 the B<vos remove> command or the B<vos zap> command without this flag.
100
101 =item B<-backup>
102
103 Removes the backup version of the read/write volume specified by the
104 B<-id> argument. Do not use this flag if the B<-id> argument identifies a
105 read-only or backup volume.
106
107 =include fragments/vos-common.pod
108
109 =back
110
111 =head1 EXAMPLES
112
113 The following example removes the volume with volume ID 536870988 from the
114 F</vicepf> partition of the file server machine C<fs6.abc.com>, without
115 noting the change in the VLDB.
116
117    % vos zap -server fs6.abc.com -partition f -id 536870988
118
119 =head1 PRIVILEGE REQUIRED
120
121 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
122 machine specified with the B<-server> argument and on each database server
123 machine. If the B<-localauth> flag is included, the issuer must instead be
124 logged on to a server machine as the local superuser C<root>.
125
126 =head1 SEE ALSO
127
128 L<vos(1)>,
129 L<vos_delentry(1)>,
130 L<vos_remove(1)>,
131 L<vos_remsite(1)>
132
133 =head1 COPYRIGHT
134
135 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
136
137 This documentation is covered by the IBM Public License Version 1.0.  It was
138 converted from HTML to POD by software written by Chas Williams and Russ
139 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.