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