doc: Make all vos pages =include common options
[openafs.git] / doc / man-pages / pod1 / vos_remsite.pod.in
1 =head1 NAME
2
3 vos_remsite - Removes a read-only site definition from a VLDB entry
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vos remsite> S<<< B<-server> <I<machine name>> >>>
11     S<<< B<-partition> <I<partition name>> >>>
12     S<<< B<-id> <I<volume name or ID>> >>>
13     S<<< [B<-cell> <I<cell name>>] >>>
14     [B<-noauth>] [B<-localauth>]
15     [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
16     S<<< [B<-config> <I<config directory>>] >>>
17     [B<-help>]
18
19 B<vos rems> S<<< B<-s> <I<machine name>> >>>
20     S<<< B<-p> <I<partition name>> >>>
21     S<<< B<-i> <I<volume name or ID>> >>>
22     S<<< [B<-c> <I<cell name>>] >>>
23     [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
24     S<<< [B<-co> <I<config directory>>] >>>
25     [B<-h>]
26
27 =for html
28 </div>
29
30 =head1 DESCRIPTION
31
32 The B<vos remsite> command removes the read-only replication site
33 specified by the B<-machine> and B<-partition> arguments from the Volume
34 Location Database (VLDB) entry for the indicated volume, which is
35 read/write.
36
37 This command is useful for removing read-only sites that were mistakenly
38 created with the B<vos addsite> command, before the B<vos release> command
39 actually releases them. If a read-only copy already exists at the site, it
40 is not affected. However, if this read-only site was the last site housing
41 any version of the volume, then the entire VLDB entry is removed, even if
42 a copy of the read-only version still actually exists at the site. The VL
43 Server does not correct the discrepancy until the B<vos syncserv> and
44 B<vos syncvldb> commands are run.
45
46 =head1 CAUTIONS
47
48 Do not use this command as the standard way to remove a read-only volume,
49 because it can create a discrepancy between the VLDB and the volumes on
50 file server machines. Use the B<vos remove> command instead.
51
52 =head1 OPTIONS
53
54 =over 4
55
56 =item B<-server> <I<server name>>
57
58 Specifies the file server machine portion of the site definition to
59 remove. Provide the machine's IP address or its host name (either fully
60 qualified or using an unambiguous abbreviation). For details, see
61 L<vos(1)>.
62
63 =item B<-partition> <I<partition name>>
64
65 Specifies the partition name portion of the site definition to
66 remove. Provide the partition's complete name with preceding slash (for
67 example, C</vicepa>) or use one of the three acceptable abbreviated
68 forms. For details, see L<vos(1)>.
69
70 =item B<-id> <I<volume name or id>>
71
72 Specifies either the complete name or volume ID number of the read/write
73 volume to remove.
74
75 =include fragments/vos-common.pod
76
77 =back
78
79 =head1 EXAMPLES
80
81 The following command removes the mistakenly defined read-only site
82 F</viceph> on the file server machine C<fs5.example.com> from the VLDB entry
83 for the volume C<root.cell>.
84
85    % vos remsite -server fs5.example.com -partition h -id root.cell
86
87 =head1 PRIVILEGE REQUIRED
88
89 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
90 machine specified with the B<-server> argument and on each database server
91 machine. If the B<-localauth> flag is included, the issuer must instead be
92 logged on to a server machine as the local superuser C<root>.
93
94 =head1 SEE ALSO
95
96 L<vos(1)>,
97 L<vos_delentry(1)>,
98 L<vos_remove(1)>,
99 L<vos_zap(1)>
100
101 =head1 COPYRIGHT
102
103 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
104
105 This documentation is covered by the IBM Public License Version 1.0.  It was
106 converted from HTML to POD by software written by Chas Williams and Russ
107 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.