Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod1 / vos_syncvldb.pod.in
CommitLineData
805e021f
CE
1=head1 NAME
2
3vos_syncvldb - Verifies VLDB entries for volumes residing at specified site
4
5=head1 SYNOPSIS
6
7=for html
8<div class="synopsis">
9
10B<vos syncvldb> S<<< [B<-server> <I<machine name>>] >>>
11 S<<< [B<-partition> <I<partition name>>] >>>
12 S<<< [B<-volume> <I<volume name or ID>>] >>>
13 [B<-dryrun>] S<<< [B<-cell> <I<cell name>>] >>>
14 [B<-noauth>] [B<-localauth>]
15 [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
16 S<<< [B<-config> <I<config directory>>] >>>
17 [B<-help>]
18
19B<vos syncv> S<<< [B<-s> <I<machine name>>] >>>
20 S<<< [B<-p> <I<partition name>>] >>>
21 S<<< [B<-vo> <I<volume name or ID>>] >>>
22 [B<-d>] S<<< [B<-c> <I<cell name>>] >>>
23 [B<-noa>] [B<-l>] [B<-ve>] [B<-e>] [B<-nor>]
24 S<<< [B<-co> <I<config directory>>] >>>
25 [B<-h>]
26
27=for html
28</div>
29
30=head1 DESCRIPTION
31
32The B<vos syncvldb> command verifies that the status of the volumes housed
33either on all partitions on the file server machine specified by the
34B<-server> argument, or on the single partition specified by the
35B<-server> and B<-partition> arguments, is recorded correctly in the
36VLDB. If the B<-volume> argument is included to indicate a single volume,
37the command compares only its status on the file server machine with its
38VLDB entry.
39
40If the B<-volume> argument is not included, the command interpreter
41obtains from the Volume Server a list of the volumes that reside on each
42partition, then changes information in the VLDB as necessary to reflect
43their state on the partition. For example, it creates or updates a VLDB
44entry when it finds a volume for which the VLDB entry is missing or
45incomplete. However, if there is already a VLDB entry that defines a
46different location for the volume, or there are irreconcilable conflicts
47with other VLDB entries, it instead writes a message about the conflict to
48the standard error stream. The command never removes volumes from the file
49server machine.
50
51To achieve complete VLDB consistency, run this command on all file server
52machines in the cell, and then run the B<vos syncserv> command on all file
53server machines in the cell.
54
55Using the B<-volume> argument basically combines the effects of this
56command with those of the B<vos syncserv> command, for a single
57volume. The command not only verifies that the VLDB entry is correct for
58the specified volume type (read/write, backup, or read-only), but also
59checks that any related volume types mentioned in the VLDB entry actually
60exist at the site listed in the entry. It is not necessary to provide the
61B<-server> argument (and optionally, B<-partition> argument); if one or
62both is provided, the results are reliable only if they specify the actual
63location of the volume indicated by the B<-volume> argument.
64
65=head1 OPTIONS
66
67=over 4
68
69=item B<-server> <I<server name>>
70
71Identifies the file server machine housing the volumes for which to verify
72VLDB entries. Provide the machine's IP address or its host name (either
73fully qualified or using an unambiguous abbreviation). For details, see
74L<vos(1)>.
75
76=item B<-partition> <I<partition name>>
77
78Identifies the partition housing the volumes for which to verify VLDB
79entries. Provide the B<-server> argument along with this one. Provide the
80partition's complete name with preceding slash (for example, C</vicepa>)
81or use one of the three acceptable abbreviated forms. For details, see
82L<vos(1)>.
83
84=item B<-volume> <I<volume name or ID>>
85
86Specifies the name or volume ID number of a single volume for which to
87verify the VLDB entry. This argument can be combined with the B<-server>
88(and optionally, the B<-partition>) argument.
89
90=item B<-dryrun>
91
92Show the actions which would be taken, but do not make changes.
93
94=include fragments/vos-common.pod
95
96=back
97
98=head1 EXAMPLES
99
100The following example command verifies the VLDB entry for each volume
101stored on the file server machine C<fs4.example.com>.
102
103 % vos syncvldb fs4.example.com
104
105=head1 PRIVILEGE REQUIRED
106
107The issuer must be listed in the F</usr/afs/etc/UserList> file on the
108machine specified with the B<-server> argument and on each database server
109machine. If the B<-localauth> flag is included, the issuer must instead be
110logged on to a server machine as the local superuser C<root>.
111
112=head1 SEE ALSO
113
114L<vos(1)>,
115L<vos_syncserv(1)>
116
117=head1 COPYRIGHT
118
119IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
120
121This documentation is covered by the IBM Public License Version 1.0. It was
122converted from HTML to POD by software written by Chas Williams and Russ
123Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.