openafs/doc/xml/AdminReference/sect8/bos_stop.xml

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="bos_stop8">
  <refmeta>
    <refentrytitle>bos stop</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>bos stop</refname>
    <refpurpose>Stops a process after changing its status flag</refpurpose>
  </refnamediv>
  <refsect1>
    <title>Synopsis</title>
    <para><emphasis role="bold">bos stop</emphasis> <emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt;
        <emphasis role="bold">-instance</emphasis> &lt;<emphasis>server process name</emphasis>&gt;+ [<emphasis role="bold">-wait</emphasis>]
        [<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 sto</emphasis> <emphasis role="bold">-s</emphasis> &lt;<emphasis>machine name</emphasis>&gt; <emphasis role="bold">-i</emphasis> &lt;<emphasis>server process name</emphasis>&gt;+
        [<emphasis role="bold">-w</emphasis>] [<emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-n</emphasis>] [<emphasis role="bold">-l</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>

  </refsect1>
  <refsect1>
    <title>Description</title>
    <para>The <emphasis role="bold">bos stop</emphasis> command sets the status flag for each process specified
    with the <emphasis role="bold">-instance</emphasis> argument to <computeroutput>NotRun</computeroutput> in the
    <replaceable>/usr/afs/local/BosConfig</replaceable> file on the server machine named by the
    <emphasis role="bold">-server</emphasis> argument, then stops it.</para>

    <para>To stop a process without changing its <replaceable>BosConfig</replaceable> status flag, use the
    <emphasis role="bold">bos shutdown</emphasis> command instead.</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 stop processes. 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>

        </listitem>
      </varlistentry>
      <varlistentry>
        <term><emphasis role="bold">-instance</emphasis> &lt;<emphasis>server process name</emphasis>&gt;+</term>
        <listitem>
          <para>Names each process to stop. Use the process name assigned with the
          <emphasis role="bold">-instance</emphasis> argument to the <emphasis role="bold">bos create</emphasis> command. The output from the
          <emphasis role="bold">bos status</emphasis> command lists the names.</para>

        </listitem>
      </varlistentry>
      <varlistentry>
        <term><emphasis role="bold">-wait</emphasis></term>
        <listitem>
          <para>Delays the return of the command shell prompt until all processes actually
          stop. If this argument is omitted, the prompt returns almost immediately
          even if all processes are not stopped.</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 example command stops the <emphasis role="bold">upserver</emphasis> and <emphasis role="bold">runntp</emphasis>
    processes on the machine <computeroutput>fs7.abc.com</computeroutput>.</para>

<programlisting>
   % bos stop -server fs7.abc.com -instance upserver runntp

</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="BosConfig5">BosConfig(5)</link>,
      <link linkend="KeyFile5">KeyFile(5)</link>,
      <link linkend="UserList5">UserList(5)</link>,
      <link linkend="bos8">bos(8)</link>,
      <link linkend="bos_create8">bos_create(8)</link>,
      <link linkend="bos_shutdown8">bos_shutdown(8)</link>,
      <link linkend="bos_status8">bos_status(8)</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>