Windows: Support new Cygwin docbook stylesheet location
[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>>] >>>
12     S<<< [B<-cell> <I<cell name>>] >>>
13     [B<-dryrun>]
14     [B<-noauth>] [B<-localauth>]
15     [B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
16
17 B<vos syncs> S<<< B<-s> <I<machine name>> >>>
18     S<<< [B<-p> <I<partition name>>] >>>
19     S<<< [B<-c> <I<cell name>>] >>> [B<-d>]
20     [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>] [B<-h>]
21
22 =for html
23 </div>
24
25 =head1 DESCRIPTION
26
27 The B<vos syncserv> command verifies that each volume mentioned in a VLDB
28 entry actually exists at the site indicated in the entry. It checks all
29 VLDB entries that mention a read/write, read-only, or backup site either
30 on any partition on the file server machine specified by the B<-server>
31 argument, or on the one partition specified by the B<-server> and
32 B<-partition> arguments. Note that the command can end up inspecting sites
33 other than those specified by the B<-server> and B<-partition> arguments,
34 if there are versions of the volume at sites other than the one specified.
35
36 The command alters any incorrect information in the VLDB, unless there is
37 an irreconcilable conflict with other VLDB entries. In that case, it
38 writes a message to the standard error stream instead. The command never
39 removes volumes from file server machines.
40
41 To achieve complete VLDB consistency, first run the B<vos syncvldb>
42 command on all file server machines in the cell, then run this command on
43 all file server machines in the cell.
44
45 =head1 OPTIONS
46
47 =over 4
48
49 =item B<-server> <I<server name>>
50
51 Identifies the file server machine mentioned in each VLDB entry to
52 check. Provide the machine's IP address or its host name (either fully
53 qualified or using an unambiguous abbreviation). For details, see
54 L<vos(1)>.
55
56 =item B<-partition> <I<partition name>>
57
58 Identifies the partition mentioned in each VLDB entry to check.  Provide
59 the partition's complete name with preceding slash (for example,
60 C</vicepa>) or use one of the three acceptable abbreviated forms. For
61 details, see L<vos(1)>.
62
63 =item B<-cell> <I<cell name>>
64
65 Names the cell in which to run the command. Do not combine this argument
66 with the B<-localauth> flag. For more details, see L<vos(1)>.
67
68 =item B<-dryrun>
69
70 Show the actions which would be taken, but do not make changes.
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<-encrypt>
93
94 Encrypts the command so that the operation's results are not transmitted
95 across the network in clear text. This option is available in OpenAFS
96 versions 1.4.11 or later and 1.5.60 or later.
97
98 =item B<-noresolve>
99
100 Shows all servers as IP addresses instead of the DNS name. This is very
101 useful when the server address is registered as 127.0.0.1 or when dealing
102 with multi-homed servers. This option is available in OpenAFS
103 versions 1.4.8 or later and 1.5.35 or later.
104
105 =item B<-help>
106
107 Prints the online help for this command. All other valid options are
108 ignored.
109
110 =back
111
112 =head1 EXAMPLES
113
114 The following example verifies the VLDB entries in which a site definition
115 mentions the file server machine C<fs3.abc.com>.
116
117    % vos syncserv -server fs3.abc.com
118
119 =head1 PRIVILEGE REQUIRED
120
121 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
122 machine specified with the B<-server> argument and on each database server
123 machine. If the B<-localauth> flag is included, the issuer must instead be
124 logged on to a server machine as the local superuser C<root>.
125
126 =head1 SEE ALSO
127
128 L<vos(1)>,
129 L<vos_syncvldb(1)>
130
131 =head1 COPYRIGHT
132
133 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
134
135 This documentation is covered by the IBM Public License Version 1.0.  It was
136 converted from HTML to POD by software written by Chas Williams and Russ
137 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.