openafs/doc/xml/AdminReference/sect1/vos_addsite.xml

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="vos_addsite1">
  <refmeta>
    <refentrytitle>vos addsite</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>vos addsite</refname>
    <refpurpose>Adds a read-only site definition to a volume's VLDB entry</refpurpose>
  </refnamediv>
  <refsect1>
    <title>Synopsis</title>
    <para><emphasis role="bold">vos addsite</emphasis> <emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name for new site</emphasis>&gt;
        <emphasis role="bold">-partition</emphasis> &lt;<emphasis>partition name for new site</emphasis>&gt;
        <emphasis role="bold">-id</emphasis> &lt;<emphasis>volume name or ID</emphasis>&gt; [<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>] [<emphasis role="bold">-help</emphasis>]</para>

    <para><emphasis role="bold">vos ad</emphasis> <emphasis role="bold">-s</emphasis> &lt;<emphasis>machine name for new site</emphasis>&gt;
        <emphasis role="bold">-p</emphasis> &lt;<emphasis>partition name for new site</emphasis>&gt;
        <emphasis role="bold">-i</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>] [<emphasis role="bold">-v</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>

  </refsect1>
  <refsect1>
    <title>Description</title>
    <para>The <emphasis role="bold">vos addsite</emphasis> command defines a new read-only site (partition on a
    file server machine, specified by the <emphasis role="bold">-server</emphasis> and <emphasis role="bold">-partition</emphasis>
    arguments) in the Volume Location Database (VLDB) entry of the read/write
    volume named by the <emphasis role="bold">-id</emphasis> argument. When the <emphasis role="bold">vos release</emphasis> command is
    next issued against the read/write volume, a read-only copy of it is
    distributed to all of the read-only sites, including the newly defined
    one.</para>

  </refsect1>
  <refsect1>
    <title>Cautions</title>
    <para>A volume's VLDB entry accommodates a maximum number of site definitions,
    as defined in the <emphasis>IBM AFS Release Notes</emphasis>. The site housing the
    read/write and backup versions of the volume counts as one site, and each
    read-only site counts as an additional site (even the read-only site
    defined on the same file server machine and partition as the read/write
    site counts as a separate site). The limit in the VLDB entry effectively
    determines the maximum number of copies of the volume that are available
    to AFS clients.</para>

    <para>Attempts to create additional sites by using this command fail with an
    error.</para>

  </refsect1>
  <refsect1>
    <title>Options</title>
    <variablelist>
      <varlistentry>
        <term><emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt;</term>
        <listitem>
          <para>Identifies the file server machine where the read-only volume is to
          reside. Provide the machine's IP address or its host name (either fully
          qualified or using an unambiguous abbreviation). For details, see
          <link linkend="vos1">vos(1)</link>.</para>

        </listitem>
      </varlistentry>
      <varlistentry>
        <term><emphasis role="bold">-partition</emphasis> &lt;<emphasis>partition name</emphasis>&gt;</term>
        <listitem>
          <para>Identifies the partition where the read-only volume is to reside, on the
          file server machine named by the <emphasis role="bold">-server</emphasis> argument. Provide the
          partition's complete name with preceding slash (for example, <computeroutput>/vicepa</computeroutput>)
          or use one of the three acceptable abbreviated forms. For details, see
          <link linkend="vos1">vos(1)</link>.</para>

        </listitem>
      </varlistentry>
      <varlistentry>
        <term><emphasis role="bold">-id</emphasis> &lt;<emphasis>volume name or ID</emphasis>&gt;</term>
        <listitem>
          <para>Specifies either the complete name or volume ID number of the read/write
          source volume.</para>

        </listitem>
      </varlistentry>
      <varlistentry>
        <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
        <listitem>
          <para>Names the cell in which to run the command. Do not combine this argument
          with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="vos1">vos(1)</link>.</para>

        </listitem>
      </varlistentry>
      <varlistentry>
        <term><emphasis role="bold">-noauth</emphasis></term>
        <listitem>
          <para>Assigns the unprivileged identity anonymous to the issuer. Do not combine
          this flag with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="vos1">vos(1)</link>.</para>

        </listitem>
      </varlistentry>
      <varlistentry>
        <term>-localauth</term>
        <listitem>
          <para>Constructs a server ticket using a key from the local
          <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">vos</emphasis> command interpreter presents it
          to the Volume Server and Volume Location Server during mutual
          authentication. Do not combine this flag with the <emphasis role="bold">-cell</emphasis> argument or
          <emphasis role="bold">-noauth</emphasis> flag. For more details, see <link linkend="vos1">vos(1)</link>.</para>

        </listitem>
      </varlistentry>
      <varlistentry>
        <term><emphasis role="bold">-verbose</emphasis></term>
        <listitem>
          <para>Produces on the standard output stream a detailed trace of the command's
          execution. If this argument is omitted, only warnings and error messages
          appear.</para>

        </listitem>
      </varlistentry>
      <varlistentry>
        <term><emphasis role="bold">-help</emphasis></term>
        <listitem>
          <para>Prints the online help for this command. All other valid options are
          ignored.</para>

        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>Examples</title>
    <para>The following example, appropriate in the State University cell, defines a
    read-only site for the cell's <computeroutput>root.afs</computeroutput> volume.</para>

<programlisting>
   % vos addsite -server sv7.stateu.edu -partition /vicepb -id root.afs

</programlisting>
    </refsect1>
    <refsect1>
      <title>Privilege Required</title>
      <para>The issuer must be listed in the <replaceable>/usr/afs/etc/UserList</replaceable> file on the
      machine specified with the <emphasis role="bold">-server</emphasis> argument and on each database server
      machine. If the <emphasis role="bold">-localauth</emphasis> flag is included, the issuer must instead be
      logged on to a server machine as the local superuser <computeroutput>root</computeroutput>.</para>

    </refsect1>
    <refsect1>
      <title>See Also</title>
      <para><link linkend="vos1">vos(1)</link>,
      <link linkend="vos_examine1">vos_examine(1)</link>,
      <link linkend="vos_release1">vos_release(1)</link></para>

    </refsect1>
    <refsect1>
      <title>Copyright</title>
      <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>

      <para>This documentation is covered by the IBM Public License Version 1.0.  It was
      converted from HTML to POD by software written by Chas Williams and Russ
      Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>

    </refsect1>
  </refentry>