doc/xml/AdminReference/sect8/bos_shutdown.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="bos_shutdown8">
   3   <refmeta>
   4     <refentrytitle>bos shutdown</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>bos shutdown</refname>
   9     <refpurpose>Stops a process without changing its status flag</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">bos shutdown</emphasis> <emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt;
  14         [<emphasis role="bold">-instance</emphasis> &lt;<emphasis>instances</emphasis>&gt;+] [<emphasis role="bold">-wait</emphasis>] [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;]
  15         [<emphasis role="bold">-noauth</emphasis>] [<emphasis role="bold">-localauth</emphasis>] [<emphasis role="bold">-help</emphasis>]</para>
  16
  17     <para><emphasis role="bold">bos sh</emphasis> <emphasis role="bold">-s</emphasis> &lt;<emphasis>machine name</emphasis>&gt; [<emphasis role="bold">-i</emphasis> &lt;<emphasis>instances</emphasis>&gt;+] [<emphasis role="bold">-w</emphasis>]
  18         [<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>
  19
  20   </refsect1>
  21   <refsect1>
  22     <title>Description</title>
  23     <para>The <emphasis role="bold">bos shutdown</emphasis> command stops, on the server machine named by the
  24     <emphasis role="bold">-server</emphasis> argument, either</para>
  25
  26     <itemizedlist>
  27       <listitem>
  28         <para>All of the currently running AFS server processes, except the BOS Server.</para>
  29
  30       </listitem>
  31       <listitem>
  32         <para>Only the processes specified by the <emphasis role="bold">-instance</emphasis> argument.</para>
  33
  34       </listitem>
  35     </itemizedlist>
  36     <para>This command does not change a process's status flag in the
  37     <replaceable>/usr/afs/local/BosConfig</replaceable> file, but only in the BOS Server's memory. To
  38     stop a process and change its <replaceable>BosConfig</replaceable> status flag, use the <emphasis role="bold">bos
  39     stop</emphasis> command instead.</para>
  40
  41     <para>Once stopped with this command, a process does not run again until an
  42     administrator starts it by using the <emphasis role="bold">bos start</emphasis>, <emphasis role="bold">bos startup</emphasis>, or
  43     <emphasis role="bold">bos restart</emphasis> command, or until the BOS Server restarts (assuming that
  44     the process's <replaceable>BosConfig</replaceable> status flag is <computeroutput>Run</computeroutput>).</para>
  45
  46   </refsect1>
  47   <refsect1>
  48     <title>Options</title>
  49     <variablelist>
  50       <varlistentry>
  51         <term><emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt;</term>
  52         <listitem>
  53           <para>Indicates the server machine on which to stop processes. Identify the
  54           machine by IP address or its host name (either fully-qualified or
  55           abbreviated unambiguously). For details, see <link linkend="bos8">bos(8)</link>.</para>
  56
  57         </listitem>
  58       </varlistentry>
  59       <varlistentry>
  60         <term><emphasis role="bold">-instance</emphasis> &lt;<emphasis>instances</emphasis>&gt;+</term>
  61         <listitem>
  62           <para>Names each process to stop. Use the process name assigned with the
  63           <emphasis role="bold">-instance</emphasis> argument to the <emphasis role="bold">bos create</emphasis> command. The output from the
  64           <emphasis role="bold">bos status</emphasis> command lists the names. Omit this argument to stop all
  65           processes other than the BOS Server.</para>
  66
  67         </listitem>
  68       </varlistentry>
  69       <varlistentry>
  70         <term><emphasis role="bold">-wait</emphasis></term>
  71         <listitem>
  72           <para>Delays the return of the command shell prompt until all processes actually
  73           stop. If this argument is omitted, the prompt returns almost immediately
  74           even if all processes are not stopped.</para>
  75
  76         </listitem>
  77       </varlistentry>
  78       <varlistentry>
  79         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
  80         <listitem>
  81           <para>Names the cell in which to run the command. Do not combine this argument
  82           with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="bos8">bos(8)</link>.</para>
  83
  84         </listitem>
  85       </varlistentry>
  86       <varlistentry>
  87         <term><emphasis role="bold">-noauth</emphasis></term>
  88         <listitem>
  89           <para>Assigns the unprivileged identity <computeroutput>anonymous</computeroutput> to the issuer. Do not
  90           combine this flag with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see
  91           <link linkend="bos8">bos(8)</link>.</para>
  92
  93         </listitem>
  94       </varlistentry>
  95       <varlistentry>
  96         <term><emphasis role="bold">-localauth</emphasis></term>
  97         <listitem>
  98           <para>Constructs a server ticket using a key from the local
  99           <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">bos</emphasis> command interpreter presents the
 100           ticket to the BOS Server during mutual authentication. Do not combine this
 101           flag with the <emphasis role="bold">-cell</emphasis> or <emphasis role="bold">-noauth</emphasis> options. For more details, see
 102           <link linkend="bos8">bos(8)</link>.</para>
 103
 104         </listitem>
 105       </varlistentry>
 106       <varlistentry>
 107         <term><emphasis role="bold">-help</emphasis></term>
 108         <listitem>
 109           <para>Prints the online help for this command. All other valid options are
 110           ignored.</para>
 111
 112         </listitem>
 113       </varlistentry>
 114     </variablelist>
 115   </refsect1>
 116   <refsect1>
 117     <title>Examples</title>
 118     <para>The following command stops all processes other than the BOS Server on the
 119     machine <computeroutput>fs3.abc.com</computeroutput>.</para>
 120
 121 <programlisting>
 122    % bos shutdown fs3.abc.com
 123
 124 </programlisting>
 125       <para>The following command stops the <computeroutput>upserver</computeroutput> process (server portion of the
 126       Update Server) on the machine <computeroutput>fs5.abc.com</computeroutput>.</para>
 127
 128 <programlisting>
 129    % bos shutdown -server fs5.abc.com -instance upserver
 130
 131 </programlisting>
 132       </refsect1>
 133       <refsect1>
 134         <title>Privilege Required</title>
 135         <para>The issuer must be listed in the <replaceable>/usr/afs/etc/UserList</replaceable> file on the
 136         machine named by the <emphasis role="bold">-server</emphasis> argument, or must be logged onto a server
 137         machine as the local superuser <computeroutput>root</computeroutput> if the <emphasis role="bold">-localauth</emphasis> flag is
 138         included.</para>
 139
 140       </refsect1>
 141       <refsect1>
 142         <title>See Also</title>
 143         <para><link linkend="BosConfig5">BosConfig(5)</link>,
 144         <link linkend="KeyFile5">KeyFile(5)</link>,
 145         <link linkend="UserList5">UserList(5)</link>,
 146         <link linkend="bos8">bos(8)</link>,
 147         <link linkend="bos_create8">bos_create(8)</link>,
 148         <link linkend="bos_restart8">bos_restart(8)</link>,
 149         <link linkend="bos_start8">bos_start(8)</link>,
 150         <link linkend="bos_startup8">bos_startup(8)</link>,
 151         <link linkend="bos_status8">bos_status(8)</link></para>
 152
 153       </refsect1>
 154       <refsect1>
 155         <title>Copyright</title>
 156         <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 157
 158         <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 159         converted from HTML to POD by software written by Chas Williams and Russ
 160         Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 161
 162       </refsect1>
 163     </refentry>