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