xml-docbook-documentation-first-pass-20060915
[openafs.git] / doc / xml / AdminReference / sect1 / vos_remsite.xml
diff --git a/doc/xml/AdminReference/sect1/vos_remsite.xml b/doc/xml/AdminReference/sect1/vos_remsite.xml
new file mode 100644 (file)
index 0000000..f32437a
--- /dev/null
@@ -0,0 +1,161 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<refentry id="vos_remsite1">
+  <refmeta>
+    <refentrytitle>vos remsite</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+  <refnamediv>
+    <refname>vos remsite</refname>
+    <refpurpose>Removes a read-only site definition from a VLDB entry</refpurpose>
+  </refnamediv>
+  <refsect1>
+    <title>Synopsis</title>
+    <para><emphasis role="bold">vos remsite</emphasis> <emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt;
+        <emphasis role="bold">-partition</emphasis> &lt;<emphasis>partition name</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 rems</emphasis> <emphasis role="bold">-s</emphasis> &lt;<emphasis>machine name</emphasis>&gt; <emphasis role="bold">-p</emphasis> &lt;<emphasis>partition name</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 remsite</emphasis> command removes the read-only replication site
+    specified by the <emphasis role="bold">-machine</emphasis> and <emphasis role="bold">-partition</emphasis> arguments from the Volume
+    Location Database (VLDB) entry for the indicated volume, which is
+    read/write.</para>
+
+    <para>This command is useful for removing read-only sites that were mistakenly
+    created with the <emphasis role="bold">vos addsite</emphasis> command, before the <emphasis role="bold">vos release</emphasis> command
+    actually releases them. If a read-only copy already exists at the site, it
+    is not affected. However, if this read-only site was the last site housing
+    any version of the volume, then the entire VLDB entry is removed, even if
+    a copy of the read-only version still actually exists at the site. The VL
+    Server does not correct the discrepancy until the <emphasis role="bold">vos syncserv</emphasis> and
+    <emphasis role="bold">vos syncvldb</emphasis> commands are run.</para>
+
+  </refsect1>
+  <refsect1>
+    <title>Cautions</title>
+    <para>Do not use this command as the standard way to remove a read-only volume,
+    because it can create a discrepancy between the VLDB and the volumes on
+    file server machines. Use the <emphasis role="bold">vos remove</emphasis> command instead.</para>
+
+  </refsect1>
+  <refsect1>
+    <title>Options</title>
+    <variablelist>
+      <varlistentry>
+        <term><emphasis role="bold">-server</emphasis> &lt;<emphasis>server name</emphasis>&gt;</term>
+        <listitem>
+          <para>Specifies the file server machine portion of the site definition to
+          remove. 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>Specifies the partition name portion of the site definition to
+          remove. 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
+          volume to remove.</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 <computeroutput>anonymous</computeroutput> 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><emphasis role="bold">-localauth</emphasis></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 command removes the mistakenly defined read-only site
+    <replaceable>/viceph</replaceable> on the file server machine <computeroutput>fs5.abc.com</computeroutput> from the VLDB entry
+    for the volume <computeroutput>root.cell</computeroutput>.</para>
+
+<programlisting>
+   % vos remsite -server fs5.abc.com -partition h -id root.cell
+
+</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_delentry1">vos_delentry(1)</link>,
+      <link linkend="vos_remove1">vos_remove(1)</link>,
+      <link linkend="vos_zap1">vos_zap(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>