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