openafs/doc/man-pages/pod1/vos_syncserv.pod
Russ Allbery 03b9fcc883 man1-editing-pass-20051209
Complete an initial editing and cleanup pass for all section one man pages.
Fix various conversion problems, formatting inconsistencies, and obvious
problems.  Please note that no editing for content has yet been done; this
is solely editing for formatting and correct conversion to POD.

Also, add some additional section five man pages that were omitted from the
first conversion run due to unusual file names, and globally replace
CAVEATS with CAUTIONS in the man pages to match the original section name.

The section one man pages should now be in reasonable shape and ready for
additional review and further updates, although there are probably still
remaining obvious problems.

====================
This delta was composed from multiple commits as part of the CVS->Git migration.
The checkin message with each commit was inconsistent.
The following are the additional commit messages.
====================

This file got the wrong name when it was originally committed.  Fix.
2005-12-09 14:48:56 +00:00

110 lines
3.7 KiB
Plaintext

=head1 NAME
vos syncserv - Verifies VLDB entries that mention a specified site
=head1 SYNOPSIS
B<vos syncserv> B<-server> <I<machine name>>
[B<-partition> <I<partition name>>] [B<-cell> <I<cell name>>]
[B<-noauth>] [B<-localauth>] [B<-verbose>] [B<-help>]
B<vos syncs> B<-s> <I<machine name>> [B<-p> <I<partition name>>]
[B<-c> <I<cell name>>] [B<-n>] [B<-l>] [B<-v>] [B<-h>]
=head1 DESCRIPTION
The B<vos syncserv> command verifies that each volume mentioned in a VLDB
entry actually exists at the site indicated in the entry. It checks all
VLDB entries that mention a read/write, read-only, or backup site either
on any partition on the file server machine specified by the B<-server>
argument, or on the one partition specified by the B<-server> and
B<-partition> arguments. Note that the command can end up inspecting sites
other than those specified by the B<-server> and B<-partition> arguments,
if there are versions of the volume at sites other than the one specified.
The command alters any incorrect information in the VLDB, unless there is
an irreconcilable conflict with other VLDB entries. In that case, it
writes a message to the standard error stream instead. The command never
removes volumes from file server machines.
To achieve complete VLDB consistency, first run the B<vos syncvldb>
command on all file server machines in the cell, then run this command on
all file server machines in the cell.
=head1 OPTIONS
=over 4
=item B<-server> <I<server name>>
Identifies the file server machine mentioned in each VLDB entry to
check. 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>>
Identifies the partition mentioned in each VLDB entry to check. 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<-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<-help>
Prints the online help for this command. All other valid options are
ignored.
=back
=head1 EXAMPLES
The following example verifies the VLDB entries in which a site definition
mentions the file server machine C<fs3.abc.com>.
% vos syncserv -server fs3.abc.com
=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_syncvldb(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.