man-page-name-underscore-20071111
[openafs.git] / doc / man-pages / pod1 / vos_syncserv.pod
1 =head1 NAME
2
3 vos_syncserv - Verifies VLDB entries that mention a specified site
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vos syncserv> S<<< B<-server> <I<machine name>> >>>
11     S<<< [B<-partition> <I<partition name>>] >>> S<<< [B<-cell> <I<cell name>>] >>>
12     [B<-noauth>] [B<-localauth>] [B<-verbose>] [B<-help>]
13
14 B<vos syncs> S<<< B<-s> <I<machine name>> >>> S<<< [B<-p> <I<partition name>>] >>>
15     S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-v>] [B<-h>]
16
17 =for html
18 </div>
19
20 =head1 DESCRIPTION
21
22 The B<vos syncserv> command verifies that each volume mentioned in a VLDB
23 entry actually exists at the site indicated in the entry. It checks all
24 VLDB entries that mention a read/write, read-only, or backup site either
25 on any partition on the file server machine specified by the B<-server>
26 argument, or on the one partition specified by the B<-server> and
27 B<-partition> arguments. Note that the command can end up inspecting sites
28 other than those specified by the B<-server> and B<-partition> arguments,
29 if there are versions of the volume at sites other than the one specified.
30
31 The command alters any incorrect information in the VLDB, unless there is
32 an irreconcilable conflict with other VLDB entries. In that case, it
33 writes a message to the standard error stream instead. The command never
34 removes volumes from file server machines.
35
36 To achieve complete VLDB consistency, first run the B<vos syncvldb>
37 command on all file server machines in the cell, then run this command on
38 all file server machines in the cell.
39
40 =head1 OPTIONS
41
42 =over 4
43
44 =item B<-server> <I<server name>>
45
46 Identifies the file server machine mentioned in each VLDB entry to
47 check. Provide the machine's IP address or its host name (either fully
48 qualified or using an unambiguous abbreviation). For details, see
49 L<vos(1)>.
50
51 =item B<-partition> <I<partition name>>
52
53 Identifies the partition mentioned in each VLDB entry to check.  Provide
54 the partition's complete name with preceding slash (for example,
55 C</vicepa>) or use one of the three acceptable abbreviated forms. For
56 details, see L<vos(1)>.
57
58 =item B<-cell> <I<cell name>>
59
60 Names the cell in which to run the command. Do not combine this argument
61 with the B<-localauth> flag. For more details, see L<vos(1)>.
62
63 =item B<-noauth>
64
65 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
66 combine this flag with the B<-localauth> flag. For more details, see
67 L<vos(1)>.
68
69 =item B<-localauth>
70
71 Constructs a server ticket using a key from the local
72 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
73 to the Volume Server and Volume Location Server during mutual
74 authentication. Do not combine this flag with the B<-cell> argument or
75 B<-noauth> flag. For more details, see L<vos(1)>.
76
77 =item B<-verbose>
78
79 Produces on the standard output stream a detailed trace of the command's
80 execution. If this argument is omitted, only warnings and error messages
81 appear.
82
83 =item B<-help>
84
85 Prints the online help for this command. All other valid options are
86 ignored.
87
88 =back
89
90 =head1 EXAMPLES
91
92 The following example verifies the VLDB entries in which a site definition
93 mentions the file server machine C<fs3.abc.com>.
94
95    % vos syncserv -server fs3.abc.com
96
97 =head1 PRIVILEGE REQUIRED
98
99 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
100 machine specified with the B<-server> argument and on each database server
101 machine. If the B<-localauth> flag is included, the issuer must instead be
102 logged on to a server machine as the local superuser C<root>.
103
104 =head1 SEE ALSO
105
106 L<vos(1)>,
107 L<vos_syncvldb(1)>
108
109 =head1 COPYRIGHT
110
111 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
112
113 This documentation is covered by the IBM Public License Version 1.0.  It was
114 converted from HTML to POD by software written by Chas Williams and Russ
115 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.