doc/xml/AdminReference/sect1/vos_syncvldb.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="vos_syncvldb1">
   3   <refmeta>
   4     <refentrytitle>vos syncvldb</refentrytitle>
   5     <manvolnum>1</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>vos syncvldb</refname>
   9     <refpurpose>Verifies VLDB entries for volumes residing at specified site</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">vos syncvldb</emphasis> [<emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt;]
  14         [<emphasis role="bold">-partition</emphasis> &lt;<emphasis>partition name</emphasis>&gt;] [<emphasis role="bold">-volume</emphasis> &lt;<emphasis>volume name or ID</emphasis>&gt;]
  15         [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-noauth</emphasis>] [<emphasis role="bold">-localauth</emphasis>] [<emphasis role="bold">-verbose</emphasis>]
  16         [<emphasis role="bold">-help</emphasis>]</para>
  17
  18     <para><emphasis role="bold">vos syncv</emphasis> [<emphasis role="bold">-s</emphasis> &lt;<emphasis>machine name</emphasis>&gt;] [<emphasis role="bold">-p</emphasis> &lt;<emphasis>partition name</emphasis>&gt;]
  19         [<emphasis role="bold">-vo</emphasis> &lt;<emphasis>volume name or ID</emphasis>&gt;] [<emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-n</emphasis>] [<emphasis role="bold">-l</emphasis>]
  20         [<emphasis role="bold">-ve</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>
  21
  22   </refsect1>
  23   <refsect1>
  24     <title>Description</title>
  25     <para>The <emphasis role="bold">vos syncvldb</emphasis> command verifies that the status of the volumes housed
  26     either on all partitions on the file server machine specified by the
  27     <emphasis role="bold">-server</emphasis> argument, or on the single partition specified by the
  28     <emphasis role="bold">-server</emphasis> and <emphasis role="bold">-partition</emphasis> arguments, is recorded correctly in the
  29     VLDB. If the <emphasis role="bold">-volume</emphasis> argument is included to indicate a single volume,
  30     the command compares only its status on the file server machine with its
  31     VLDB entry.</para>
  32
  33     <para>If the <emphasis role="bold">-volume</emphasis> argument is not included, the command interpreter
  34     obtains from the Volume Server a list of the volumes that reside on each
  35     partition, then changes information in the VLDB as necessary to reflect
  36     their state on the partition. For example, it creates or updates a VLDB
  37     entry when it finds a volume for which the VLDB entry is missing or
  38     incomplete. However, if there is already a VLDB entry that defines a
  39     different location for the volume, or there are irreconcilable conflicts
  40     with other VLDB entries, it instead writes a message about the conflict to
  41     the standard error stream. The command never removes volumes from the file
  42     server machine.</para>
  43
  44     <para>To achieve complete VLDB consistency, run this command on all file server
  45     machines in the cell, and then run the <emphasis role="bold">vos syncserv</emphasis> command on all file
  46     server machines in the cell.</para>
  47
  48     <para>Using the <emphasis role="bold">-volume</emphasis> argument basically combines the effects of this
  49     command with those of the <emphasis role="bold">vos syncserv</emphasis> command, for a single
  50     volume. The command not only verifies that the VLDB entry is correct for
  51     the specified volume type (read/write, backup, or read-only), but also
  52     checks that any related volume types mentioned in the VLDB entry actually
  53     exist at the site listed in the entry. It is not necessary to provide the
  54     <emphasis role="bold">-server</emphasis> argument (and optionally, <emphasis role="bold">-partition</emphasis> argument); if one or
  55     both is provided, the results are reliable only if they specify the actual
  56     location of the volume indicated by the <emphasis role="bold">-volume</emphasis> argument.</para>
  57
  58   </refsect1>
  59   <refsect1>
  60     <title>Options</title>
  61     <variablelist>
  62       <varlistentry>
  63         <term><emphasis role="bold">-server</emphasis> &lt;<emphasis>server name</emphasis>&gt;</term>
  64         <listitem>
  65           <para>Identifies the file server machine housing the volumes for which to verify
  66           VLDB entries. Provide the machine's IP address or its host name (either
  67           fully qualified or using an unambiguous abbreviation). For details, see
  68           <link linkend="vos1">vos(1)</link>.</para>
  69
  70         </listitem>
  71       </varlistentry>
  72       <varlistentry>
  73         <term><emphasis role="bold">-partition</emphasis> &lt;<emphasis>partition name</emphasis>&gt;</term>
  74         <listitem>
  75           <para>Identifies the partition housing the volumes for which to verify VLDB
  76           entries. Provide the <emphasis role="bold">-server</emphasis> argument along with this one. Provide the
  77           partition's complete name with preceding slash (for example, <computeroutput>/vicepa</computeroutput>)
  78           or use one of the three acceptable abbreviated forms. For details, see
  79           <link linkend="vos1">vos(1)</link>.</para>
  80
  81         </listitem>
  82       </varlistentry>
  83       <varlistentry>
  84         <term><emphasis role="bold">-volume</emphasis> &lt;<emphasis>volume name or ID</emphasis>&gt;</term>
  85         <listitem>
  86           <para>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 <emphasis role="bold">-server</emphasis>
  88           (and optionally, the <emphasis role="bold">-partition</emphasis>) argument.</para>
  89
  90         </listitem>
  91       </varlistentry>
  92       <varlistentry>
  93         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
  94         <listitem>
  95           <para>Names the cell in which to run the command. Do not combine this argument
  96           with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="vos1">vos(1)</link>.</para>
  97
  98         </listitem>
  99       </varlistentry>
 100       <varlistentry>
 101         <term><emphasis role="bold">-noauth</emphasis></term>
 102         <listitem>
 103           <para>Assigns the unprivileged identity <computeroutput>anonymous</computeroutput> to the issuer. Do not
 104           combine this flag with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see
 105           <link linkend="vos1">vos(1)</link>.</para>
 106
 107         </listitem>
 108       </varlistentry>
 109       <varlistentry>
 110         <term><emphasis role="bold">-localauth</emphasis></term>
 111         <listitem>
 112           <para>Constructs a server ticket using a key from the local
 113           <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">vos</emphasis> command interpreter presents it
 114           to the Volume Server and Volume Location Server during mutual
 115           authentication. Do not combine this flag with the <emphasis role="bold">-cell</emphasis> argument or
 116           <emphasis role="bold">-noauth</emphasis> flag. For more details, see <link linkend="vos1">vos(1)</link>.</para>
 117
 118         </listitem>
 119       </varlistentry>
 120       <varlistentry>
 121         <term><emphasis role="bold">-verbose</emphasis></term>
 122         <listitem>
 123           <para>Produces on the standard output stream a detailed trace of the command's
 124           execution. If this argument is omitted, only warnings and error messages
 125           appear.</para>
 126
 127         </listitem>
 128       </varlistentry>
 129       <varlistentry>
 130         <term><emphasis role="bold">-help</emphasis></term>
 131         <listitem>
 132           <para>Prints the online help for this command. All other valid options are
 133           ignored.</para>
 134
 135         </listitem>
 136       </varlistentry>
 137     </variablelist>
 138   </refsect1>
 139   <refsect1>
 140     <title>Examples</title>
 141     <para>The following example command verifies the VLDB entry for each volume
 142     stored on the file server machine <computeroutput>fs4.abc.com</computeroutput>.</para>
 143
 144 <programlisting>
 145    % vos syncvldb fs4.abc.com
 146
 147 </programlisting>
 148     </refsect1>
 149     <refsect1>
 150       <title>Privilege Required</title>
 151       <para>The issuer must be listed in the <replaceable>/usr/afs/etc/UserList</replaceable> file on the
 152       machine specified with the <emphasis role="bold">-server</emphasis> argument and on each database server
 153       machine. If the <emphasis role="bold">-localauth</emphasis> flag is included, the issuer must instead be
 154       logged on to a server machine as the local superuser <computeroutput>root</computeroutput>.</para>
 155
 156     </refsect1>
 157     <refsect1>
 158       <title>See Also</title>
 159       <para><link linkend="vos1">vos(1)</link>,
 160       <link linkend="vos_syncserv1">vos_syncserv(1)</link></para>
 161
 162     </refsect1>
 163     <refsect1>
 164       <title>Copyright</title>
 165       <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 166
 167       <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 168       converted from HTML to POD by software written by Chas Williams and Russ
 169       Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 170
 171     </refsect1>
 172   </refentry>