man-page-name-underscore-20071111
[openafs.git] / doc / man-pages / pod1 / vos_remsite.pod
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>> >>> S<<< B<-id> <I<volume name or ID>> >>>
12     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-verbose>]
13     [B<-help>]
14
15 B<vos rems> S<<< B<-s> <I<machine name>> >>> S<<< B<-p> <I<partition name>> >>>
16     S<<< B<-i> <I<volume name or ID>> >>> S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>]
17     [B<-v>] [B<-h>]
18
19 =for html
20 </div>
21
22 =head1 DESCRIPTION
23
24 The B<vos remsite> command removes the read-only replication site
25 specified by the B<-machine> and B<-partition> arguments from the Volume
26 Location Database (VLDB) entry for the indicated volume, which is
27 read/write.
28
29 This command is useful for removing read-only sites that were mistakenly
30 created with the B<vos addsite> command, before the B<vos release> command
31 actually releases them. If a read-only copy already exists at the site, it
32 is not affected. However, if this read-only site was the last site housing
33 any version of the volume, then the entire VLDB entry is removed, even if
34 a copy of the read-only version still actually exists at the site. The VL
35 Server does not correct the discrepancy until the B<vos syncserv> and
36 B<vos syncvldb> commands are run.
37
38 =head1 CAUTIONS
39
40 Do not use this command as the standard way to remove a read-only volume,
41 because it can create a discrepancy between the VLDB and the volumes on
42 file server machines. Use the B<vos remove> command instead.
43
44 =head1 OPTIONS
45
46 =over 4
47
48 =item B<-server> <I<server name>>
49
50 Specifies the file server machine portion of the site definition to
51 remove. Provide the machine's IP address or its host name (either fully
52 qualified or using an unambiguous abbreviation). For details, see
53 L<vos(1)>.
54
55 =item B<-partition> <I<partition name>>
56
57 Specifies the partition name portion of the site definition to
58 remove. Provide the partition's complete name with preceding slash (for
59 example, C</vicepa>) or use one of the three acceptable abbreviated
60 forms. For details, see L<vos(1)>.
61
62 =item B<-id> <I<volume name or id>>
63
64 Specifies either the complete name or volume ID number of the read/write
65 volume to remove.
66
67 =item B<-cell> <I<cell name>>
68
69 Names the cell in which to run the command. Do not combine this argument
70 with the B<-localauth> flag. For more details, see L<vos(1)>.
71
72 =item B<-noauth>
73
74 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
75 combine this flag with the B<-localauth> flag. For more details, see
76 L<vos(1)>.
77
78 =item B<-localauth>
79
80 Constructs a server ticket using a key from the local
81 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
82 to the Volume Server and Volume Location Server during mutual
83 authentication. Do not combine this flag with the B<-cell> argument or
84 B<-noauth> flag. For more details, see L<vos(1)>.
85
86 =item B<-verbose>
87
88 Produces on the standard output stream a detailed trace of the command's
89 execution. If this argument is omitted, only warnings and error messages
90 appear.
91
92 =item B<-help>
93
94 Prints the online help for this command. All other valid options are
95 ignored.
96
97 =back
98
99 =head1 EXAMPLES
100
101 The following command removes the mistakenly defined read-only site
102 F</viceph> on the file server machine C<fs5.abc.com> from the VLDB entry
103 for the volume C<root.cell>.
104
105    % vos remsite -server fs5.abc.com -partition h -id root.cell
106
107 =head1 PRIVILEGE REQUIRED
108
109 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
110 machine specified with the B<-server> argument and on each database server
111 machine. If the B<-localauth> flag is included, the issuer must instead be
112 logged on to a server machine as the local superuser C<root>.
113
114 =head1 SEE ALSO
115
116 L<vos(1)>,
117 L<vos_delentry(1)>,
118 L<vos_remove(1)>,
119 L<vos_zap(1)>
120
121 =head1 COPYRIGHT
122
123 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
124
125 This documentation is covered by the IBM Public License Version 1.0.  It was
126 converted from HTML to POD by software written by Chas Williams and Russ
127 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.