openafs/doc/man-pages/pod1/vos_remsite.pod
Ken Dreyer 1cc8feb6fc doc: replace hostnames with IETF example hostnames
There were several different real and made-up hostnames and company names used
throughout our documentation examples.

The IETF has reserved "example.com" and other "example" TLDs for use in
examples (RFC 2606). Replace almost all references to ABC Corporation, DEF
Corporation, and State University, as well as "abc.com", "bigcell.com",
"def.com", "def.gov", "ghi.com", "ghi.gov", "jkl.com", "mit.edu",
"stanford.edu", "state.edu", "stateu.edu", "uncc.edu", and "xyz.com".
Standardize on "Example Corporation", "Example Network", "Example
Organization" (example.com, example.net, and example.org).

The Scout documentation in the Admin Guide contains PNG images that contain
the old cell names, so I left those references until the images can be
replaced.

Change-Id: I4e44815b2d2ffe204810b7fd850842248f67c367
Reviewed-on: http://gerrit.openafs.org/6697
Reviewed-by: Jeffrey Altman <jaltman@secure-endpoints.com>
Tested-by: Jeffrey Altman <jaltman@secure-endpoints.com>
2012-02-17 20:51:58 -08:00

145 lines
4.6 KiB
Plaintext

=head1 NAME
vos_remsite - Removes a read-only site definition from a VLDB entry
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<vos remsite> S<<< B<-server> <I<machine name>> >>>
S<<< B<-partition> <I<partition name>> >>>
S<<< B<-id> <I<volume name or ID>> >>>
S<<< [B<-cell> <I<cell name>>] >>>
[B<-noauth>] [B<-localauth>]
[B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
B<vos rems> S<<< B<-s> <I<machine name>> >>>
S<<< B<-p> <I<partition name>> >>>
S<<< B<-i> <I<volume name or ID>> >>>
S<<< [B<-c> <I<cell name>>] >>>
[B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>] [B<-h>]
=for html
</div>
=head1 DESCRIPTION
The B<vos remsite> command removes the read-only replication site
specified by the B<-machine> and B<-partition> arguments from the Volume
Location Database (VLDB) entry for the indicated volume, which is
read/write.
This command is useful for removing read-only sites that were mistakenly
created with the B<vos addsite> command, before the B<vos release> command
actually releases them. If a read-only copy already exists at the site, it
is not affected. However, if this read-only site was the last site housing
any version of the volume, then the entire VLDB entry is removed, even if
a copy of the read-only version still actually exists at the site. The VL
Server does not correct the discrepancy until the B<vos syncserv> and
B<vos syncvldb> commands are run.
=head1 CAUTIONS
Do not use this command as the standard way to remove a read-only volume,
because it can create a discrepancy between the VLDB and the volumes on
file server machines. Use the B<vos remove> command instead.
=head1 OPTIONS
=over 4
=item B<-server> <I<server name>>
Specifies the file server machine portion of the site definition to
remove. Provide the machine's IP address or its host name (either fully
qualified or using an unambiguous abbreviation). For details, see
L<vos(1)>.
=item B<-partition> <I<partition name>>
Specifies the partition name portion of the site definition to
remove. Provide the partition's complete name with preceding slash (for
example, C</vicepa>) or use one of the three acceptable abbreviated
forms. For details, see L<vos(1)>.
=item B<-id> <I<volume name or id>>
Specifies either the complete name or volume ID number of the read/write
volume to remove.
=item B<-cell> <I<cell name>>
Names the cell in which to run the command. Do not combine this argument
with the B<-localauth> flag. For more details, see L<vos(1)>.
=item B<-noauth>
Assigns the unprivileged identity C<anonymous> to the issuer. Do not
combine this flag with the B<-localauth> flag. For more details, see
L<vos(1)>.
=item B<-localauth>
Constructs a server ticket using a key from the local
F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
to the Volume Server and Volume Location Server during mutual
authentication. Do not combine this flag with the B<-cell> argument or
B<-noauth> flag. For more details, see L<vos(1)>.
=item B<-verbose>
Produces on the standard output stream a detailed trace of the command's
execution. If this argument is omitted, only warnings and error messages
appear.
=item B<-encrypt>
Encrypts the command so that the operation's results are not transmitted
across the network in clear text. This option is available in OpenAFS
versions 1.4.11 or later and 1.5.60 or later.
=item B<-noresolve>
Shows all servers as IP addresses instead of the DNS name. This is very
useful when the server address is registered as 127.0.0.1 or when dealing
with multi-homed servers. This option is available in OpenAFS
versions 1.4.8 or later and 1.5.35 or later.
=item B<-help>
Prints the online help for this command. All other valid options are
ignored.
=back
=head1 EXAMPLES
The following command removes the mistakenly defined read-only site
F</viceph> on the file server machine C<fs5.example.com> from the VLDB entry
for the volume C<root.cell>.
% vos remsite -server fs5.example.com -partition h -id root.cell
=head1 PRIVILEGE REQUIRED
The issuer must be listed in the F</usr/afs/etc/UserList> file on the
machine specified with the B<-server> argument and on each database server
machine. If the B<-localauth> flag is included, the issuer must instead be
logged on to a server machine as the local superuser C<root>.
=head1 SEE ALSO
L<vos(1)>,
L<vos_delentry(1)>,
L<vos_remove(1)>,
L<vos_zap(1)>
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
This documentation is covered by the IBM Public License Version 1.0. It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.