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