doc/xml/AdminReference/sect8/bos_start.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="bos_start8">
   3   <refmeta>
   4     <refentrytitle>bos start</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>bos start</refname>
   9     <refpurpose>Starts a process after setting its status flag</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">bos start</emphasis> <emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt;
  14         <emphasis role="bold">-instance</emphasis> &lt;<emphasis>server process name</emphasis>&gt;+ [<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 start</emphasis> <emphasis role="bold">-s</emphasis> &lt;<emphasis>machine name</emphasis>&gt; <emphasis role="bold">-i</emphasis> &lt;<emphasis>server process name</emphasis>&gt;+
  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 start</emphasis> command sets the status flag for each process specified
  24     by the <emphasis role="bold">-instance</emphasis> argument to <computeroutput>Run</computeroutput> in the <replaceable>/usr/afs/local/BosConfig</replaceable>
  25     file and in the BOS Server's memory on the server machine named by the
  26     <emphasis role="bold">-server</emphasis> argument, then starts it. If the process is already running,
  27     the command's only effect is to guarantee that the status flag is <computeroutput>Run</computeroutput>;
  28     it does not restart the process.</para>
  29
  30     <para>To start a process without changing its status flag in the <replaceable>BosConfig</replaceable>
  31     file, use the <emphasis role="bold">bos startup</emphasis> command instead.</para>
  32
  33   </refsect1>
  34   <refsect1>
  35     <title>Options</title>
  36     <variablelist>
  37       <varlistentry>
  38         <term><emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt;</term>
  39         <listitem>
  40           <para>Indicates the server machine on which to start processes. Identify the
  41           machine by IP address or its host name (either fully-qualified or
  42           abbreviated unambiguously). For details, see <link linkend="bos8">bos(8)</link>.</para>
  43
  44         </listitem>
  45       </varlistentry>
  46       <varlistentry>
  47         <term><emphasis role="bold">-instance</emphasis> &lt;<emphasis>server process name</emphasis>&gt;+</term>
  48         <listitem>
  49           <para>Names each process to start. Use the process name assigned with the
  50           <emphasis role="bold">-instance</emphasis> argument to the <emphasis role="bold">bos create</emphasis> command. The output from the
  51           <emphasis role="bold">bos status</emphasis> command lists the names.</para>
  52
  53         </listitem>
  54       </varlistentry>
  55       <varlistentry>
  56         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
  57         <listitem>
  58           <para>Names the cell in which to run the command. Do not combine this argument
  59           with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="bos8">bos(8)</link>.</para>
  60
  61         </listitem>
  62       </varlistentry>
  63       <varlistentry>
  64         <term><emphasis role="bold">-noauth</emphasis></term>
  65         <listitem>
  66           <para>Assigns the unprivileged identity <computeroutput>anonymous</computeroutput> to the issuer. Do not
  67           combine this flag with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see
  68           <link linkend="bos8">bos(8)</link>.</para>
  69
  70         </listitem>
  71       </varlistentry>
  72       <varlistentry>
  73         <term><emphasis role="bold">-localauth</emphasis></term>
  74         <listitem>
  75           <para>Constructs a server ticket using a key from the local
  76           <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">bos</emphasis> command interpreter presents the
  77           ticket to the BOS Server during mutual authentication. Do not combine this
  78           flag with the <emphasis role="bold">-cell</emphasis> or <emphasis role="bold">-noauth</emphasis> options. For more details, see
  79           <link linkend="bos8">bos(8)</link>.</para>
  80
  81         </listitem>
  82       </varlistentry>
  83       <varlistentry>
  84         <term><emphasis role="bold">-help</emphasis></term>
  85         <listitem>
  86           <para>Prints the online help for this command. All other valid options are
  87           ignored.</para>
  88
  89         </listitem>
  90       </varlistentry>
  91     </variablelist>
  92   </refsect1>
  93   <refsect1>
  94     <title>Examples</title>
  95     <para>The following command changes the status flag for the <computeroutput>upclientbin</computeroutput> and
  96     <computeroutput>upclientetc</computeroutput> processes to <computeroutput>Run</computeroutput> in the <replaceable>BosConfig</replaceable> file on the machine
  97     <computeroutput>fs6.abc.com</computeroutput> and starts them running.</para>
  98
  99 <programlisting>
 100    % bos start -server fs6.abc.com -instance upclientbin upclientetc
 101
 102 </programlisting>
 103     </refsect1>
 104     <refsect1>
 105       <title>Privilege Required</title>
 106       <para>The issuer must be listed in the <replaceable>/usr/afs/etc/UserList</replaceable> file on the
 107       machine named by the <emphasis role="bold">-server</emphasis> argument, or must be logged onto a server
 108       machine as the local superuser <computeroutput>root</computeroutput> if the <emphasis role="bold">-localauth</emphasis> flag is
 109       included.</para>
 110
 111     </refsect1>
 112     <refsect1>
 113       <title>See Also</title>
 114       <para><link linkend="BosConfig5">BosConfig(5)</link>,
 115       <link linkend="KeyFile5">KeyFile(5)</link>,
 116       <link linkend="UserList5">UserList(5)</link>,
 117       <link linkend="bos8">bos(8)</link>,
 118       <link linkend="bos_create8">bos_create(8)</link>,
 119       <link linkend="bos_startup8">bos_startup(8)</link>,
 120       <link linkend="bos_status8">bos_status(8)</link></para>
 121
 122     </refsect1>
 123     <refsect1>
 124       <title>Copyright</title>
 125       <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 126
 127       <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 128       converted from HTML to POD by software written by Chas Williams and Russ
 129       Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 130
 131     </refsect1>
 132   </refentry>