openafs/doc/xml/AdminReference/sect8/bos_removehost.xml

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="bos_removehost8">
  <refmeta>
    <refentrytitle>bos removehost</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>bos removehost</refname>
    <refpurpose>Removes a database server machine from the CellServDB file</refpurpose>
  </refnamediv>
  <refsect1>
    <title>Synopsis</title>
    <para><emphasis role="bold">bos removehost</emphasis> <emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt; <emphasis role="bold">-host</emphasis> &lt;<emphasis>host name</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">-help</emphasis>]</para>

    <para><emphasis role="bold">bos removeh</emphasis> <emphasis role="bold">-s</emphasis> &lt;<emphasis>machine name</emphasis>&gt; <emphasis role="bold">-ho</emphasis> &lt;<emphasis>host name</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">-he</emphasis>]</para>

  </refsect1>
  <refsect1>
    <title>Description</title>
    <para>The <emphasis role="bold">bos removehost</emphasis> command removes the entry for each database server
    machine specified with the <emphasis role="bold">-host</emphasis> argument from the
    <replaceable>/usr/afs/etc/CellServDB</replaceable> file on the server machine named by the
    <emphasis role="bold">-server</emphasis> argument.</para>

  </refsect1>
  <refsect1>
    <title>Cautions</title>
    <para>After executing this command (and waiting for the Update Server to
    propagate the changes, if it is used), restart the database server
    processes on all database server machines to force election of a quorum
    that includes the new set of machines listed in the
    <replaceable>/usr/afs/etc/CellServDB</replaceable> file. The <emphasis>IBM AFS Quick Beginnings</emphasis> explains
    in more detail how to add and remove database server machines.</para>

  </refsect1>
  <refsect1>
    <title>Options</title>
    <variablelist>
      <varlistentry>
        <term><emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt;</term>
        <listitem>
          <para>Indicates the server machine on which to change the
          <replaceable>/usr/afs/etc/CellServDB</replaceable> file. Identify the machine by IP address or its
          host name (either fully-qualified or abbreviated unambiguously). For
          details, see <link linkend="bos8">bos(8)</link>.</para>

          <para>In cells that use the Update Server to distribute the contents of the
          <replaceable>/usr/afs/etc</replaceable> directory, it is conventional to specify only the system
          control machine as a value for the <emphasis role="bold">-server</emphasis> argument. Otherwise, repeat
          the command for each file server machine. For further discussion, see
          <link linkend="bos8">bos(8)</link>.</para>

        </listitem>
      </varlistentry>
      <varlistentry>
        <term><emphasis role="bold">-host</emphasis> &lt;<emphasis>host name</emphasis>&gt;+</term>
        <listitem>
          <para>Specifies the fully-qualified host name (such as <computeroutput>fs2.abc.com</computeroutput>) of each
          database server machine to remove from the <emphasis role="bold">CellServDB</emphasis> file.</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="bos8">bos(8)</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="bos8">bos(8)</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">bos</emphasis> command interpreter presents the
          ticket to the BOS Server during mutual authentication. Do not combine this
          flag with the <emphasis role="bold">-cell</emphasis> or <emphasis role="bold">-noauth</emphasis> options. For more details, see
          <link linkend="bos8">bos(8)</link>.</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 former database server machine
    <computeroutput>db2.abc.com</computeroutput> from the <replaceable>CellServDB</replaceable> file on the system control machine
    <computeroutput>fs1.abc.com</computeroutput>.</para>

<programlisting>
   % bos removehost -server fs1.abc.com -host db2.abc.com

</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 named by the <emphasis role="bold">-server</emphasis> argument, or must be logged onto a server
      machine as the local superuser <computeroutput>root</computeroutput> if the <emphasis role="bold">-localauth</emphasis> flag is
      included.</para>

    </refsect1>
    <refsect1>
      <title>See Also</title>
      <para><link linkend="KeyFile5">KeyFile(5)</link>,
      <link linkend="UserList5">UserList(5)</link>,
      <link linkend="bos8">bos(8)</link>,
      <link linkend="bos_addhost8">bos_addhost(8)</link>,
      <link linkend="bos_listhosts8">bos_listhosts(8)</link></para>

      <para><emphasis>IBM AFS Quick Beginnings</emphasis></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>