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>>] >>>
  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
  19 B<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
  32 The B<vos syncvldb> command verifies that the status of the volumes housed
  33 either on all partitions on the file server machine specified by the
  34 B<-server> argument, or on the single partition specified by the
  35 B<-server> and B<-partition> arguments, is recorded correctly in the
  36 VLDB. If the B<-volume> argument is included to indicate a single volume,
  37 the command compares only its status on the file server machine with its
  38 VLDB entry.
  39
  40 If the B<-volume> argument is not included, the command interpreter
  41 obtains from the Volume Server a list of the volumes that reside on each
  42 partition, then changes information in the VLDB as necessary to reflect
  43 their state on the partition. For example, it creates or updates a VLDB
  44 entry when it finds a volume for which the VLDB entry is missing or
  45 incomplete. However, if there is already a VLDB entry that defines a
  46 different location for the volume, or there are irreconcilable conflicts
  47 with other VLDB entries, it instead writes a message about the conflict to
  48 the standard error stream. The command never removes volumes from the file
  49 server machine.
  50
  51 To achieve complete VLDB consistency, run this command on all file server
  52 machines in the cell, and then run the B<vos syncserv> command on all file
  53 server machines in the cell.
  54
  55 Using the B<-volume> argument basically combines the effects of this
  56 command with those of the B<vos syncserv> command, for a single
  57 volume. The command not only verifies that the VLDB entry is correct for
  58 the specified volume type (read/write, backup, or read-only), but also
  59 checks that any related volume types mentioned in the VLDB entry actually
  60 exist at the site listed in the entry. It is not necessary to provide the
  61 B<-server> argument (and optionally, B<-partition> argument); if one or
  62 both is provided, the results are reliable only if they specify the actual
  63 location 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
  71 Identifies the file server machine housing the volumes for which to verify
  72 VLDB entries. Provide the machine's IP address or its host name (either
  73 fully qualified or using an unambiguous abbreviation). For details, see
  74 L<vos(1)>.
  75
  76 =item B<-partition> <I<partition name>>
  77
  78 Identifies the partition housing the volumes for which to verify VLDB
  79 entries. Provide the B<-server> argument along with this one. Provide the
  80 partition's complete name with preceding slash (for example, C</vicepa>)
  81 or use one of the three acceptable abbreviated forms. For details, see
  82 L<vos(1)>.
  83
  84 =item B<-volume> <I<volume name or ID>>
  85
  86 Specifies the name or volume ID number of a single volume for which to
  87 verify the VLDB entry. This argument can be combined with the B<-server>
  88 (and optionally, the B<-partition>) argument.
  89
  90 =item B<-cell> <I<cell name>>
  91
  92 Names the cell in which to run the command. Do not combine this argument
  93 with the B<-localauth> flag. For more details, see L<vos(1)>.
  94
  95 =item B<-dryrun>
  96
  97 Show the actions which would be taken, but do not make changes.
  98
  99 =item B<-noauth>
 100
 101 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
 102 combine this flag with the B<-localauth> flag. For more details, see
 103 L<vos(1)>.
 104
 105 =item B<-localauth>
 106
 107 Constructs a server ticket using a key from the local
 108 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
 109 to the Volume Server and Volume Location Server during mutual
 110 authentication. Do not combine this flag with the B<-cell> argument or
 111 B<-noauth> flag. For more details, see L<vos(1)>.
 112
 113 =item B<-verbose>
 114
 115 Produces on the standard output stream a detailed trace of the command's
 116 execution. If this argument is omitted, only warnings and error messages
 117 appear.
 118
 119 =item B<-encrypt>
 120
 121 Encrypts the command so that the operation's results are not transmitted
 122 across the network in clear text. This option is available in OpenAFS
 123 versions 1.4.11 or later and 1.5.60 or later.
 124
 125 =item B<-noresolve>
 126
 127 Shows all servers as IP addresses instead of the DNS name. This is very
 128 useful when the server address is registered as 127.0.0.1 or when dealing
 129 with multi-homed servers. This option is available in OpenAFS
 130 versions 1.4.8 or later and 1.5.35 or later.
 131
 132 =item B<-help>
 133
 134 Prints the online help for this command. All other valid options are
 135 ignored.
 136
 137 =back
 138
 139 =head1 EXAMPLES
 140
 141 The following example command verifies the VLDB entry for each volume
 142 stored on the file server machine C<fs4.example.com>.
 143
 144    % vos syncvldb fs4.example.com
 145
 146 =head1 PRIVILEGE REQUIRED
 147
 148 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 149 machine specified with the B<-server> argument and on each database server
 150 machine. If the B<-localauth> flag is included, the issuer must instead be
 151 logged on to a server machine as the local superuser C<root>.
 152
 153 =head1 SEE ALSO
 154
 155 L<vos(1)>,
 156 L<vos_syncserv(1)>
 157
 158 =head1 COPYRIGHT
 159
 160 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 161
 162 This documentation is covered by the IBM Public License Version 1.0.  It was
 163 converted from HTML to POD by software written by Chas Williams and Russ
 164 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.