doc/xml/AdminReference/sect8/bos_exec.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="bos_exec8">
   3   <refmeta>
   4     <refentrytitle>bos exec</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>bos exec</refname>
   9     <refpurpose>Executes a command on a remote server machine</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">bos exec</emphasis> <emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt; <emphasis role="bold">-cmd</emphasis> &lt;<emphasis>command to execute</emphasis>&gt;
  14         [<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>
  15
  16     <para><emphasis role="bold">bos e</emphasis> <emphasis role="bold">-s</emphasis> &lt;<emphasis>machine name</emphasis>&gt; <emphasis role="bold">-cm</emphasis> &lt;<emphasis>command to execute</emphasis>&gt;
  17         [<emphasis role="bold">-ce</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-n</emphasis>] [<emphasis role="bold">-l</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>
  18
  19   </refsect1>
  20   <refsect1>
  21     <title>Description</title>
  22     <para>The <emphasis role="bold">bos exec</emphasis> command executes the indicated command on the file server
  23     machine named by the <emphasis role="bold">-server</emphasis> argument. Its intended use is to reboot
  24     the machine, using the <replaceable>/sbin/reboot</replaceable> command or equivalent.</para>
  25
  26   </refsect1>
  27   <refsect1>
  28     <title>Options</title>
  29     <variablelist>
  30       <varlistentry>
  31         <term><emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt;</term>
  32         <listitem>
  33           <para>Indicates the server machine on which to execute the command.  Identify
  34           the machine by IP address or its host name (either fully-qualified or
  35           abbreviated unambiguously). For details, see <link linkend="bos8">bos(8)</link>.</para>
  36
  37         </listitem>
  38       </varlistentry>
  39       <varlistentry>
  40         <term><emphasis role="bold">-cmd</emphasis> &lt;<emphasis>command to execute</emphasis>&gt;</term>
  41         <listitem>
  42           <para>Specifies the complete local disk pathname of the command to execute (for
  43           example, <replaceable>/sbin/reboot</replaceable>). Surround this argument with double quotes
  44           (<computeroutput>""</computeroutput>) if the command contains one or more spaces.</para>
  45
  46         </listitem>
  47       </varlistentry>
  48       <varlistentry>
  49         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
  50         <listitem>
  51           <para>Names the cell in which to run the command. Do not combine this argument
  52           with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="bos8">bos(8)</link>.</para>
  53
  54         </listitem>
  55       </varlistentry>
  56       <varlistentry>
  57         <term><emphasis role="bold">-noauth</emphasis></term>
  58         <listitem>
  59           <para>Assigns the unprivileged identity <computeroutput>anonymous</computeroutput> to the issuer. Do not
  60           combine this flag with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see
  61           <link linkend="bos8">bos(8)</link>.</para>
  62
  63         </listitem>
  64       </varlistentry>
  65       <varlistentry>
  66         <term><emphasis role="bold">-localauth</emphasis></term>
  67         <listitem>
  68           <para>Constructs a server ticket using a key from the local
  69           <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">bos</emphasis> command interpreter presents the
  70           ticket to the BOS Server during mutual authentication. Do not combine this
  71           flag with the <emphasis role="bold">-cell</emphasis> or <emphasis role="bold">-noauth</emphasis> options. For more details, see
  72           <link linkend="bos8">bos(8)</link>.</para>
  73
  74         </listitem>
  75       </varlistentry>
  76       <varlistentry>
  77         <term><emphasis role="bold">-help</emphasis></term>
  78         <listitem>
  79           <para>Prints the online help for this command. All other valid options are
  80           ignored.</para>
  81
  82         </listitem>
  83       </varlistentry>
  84     </variablelist>
  85   </refsect1>
  86   <refsect1>
  87     <title>Examples</title>
  88     <para>The following command reboots the machine <computeroutput>fs2.abc.com</computeroutput>. The issuer has
  89     previously issued the <emphasis role="bold">bos shutdown</emphasis> command to shutdown all processes
  90     cleanly.</para>
  91
  92 <programlisting>
  93    % bos exec -server fs2.abc.com -cmd /sbin/shutdown -r now
  94
  95 </programlisting>
  96     </refsect1>
  97     <refsect1>
  98       <title>Privilege Required</title>
  99       <para>The issuer must be listed in the <replaceable>/usr/afs/etc/UserList</replaceable> file on the
 100       machine named by the <emphasis role="bold">-server</emphasis> argument, or must be logged onto a server
 101       machine as the local superuser <computeroutput>root</computeroutput> if the <emphasis role="bold">-localauth</emphasis> flag is
 102       included.</para>
 103
 104     </refsect1>
 105     <refsect1>
 106       <title>See Also</title>
 107       <para><link linkend="bos8">bos(8)</link></para>
 108
 109     </refsect1>
 110     <refsect1>
 111       <title>Copyright</title>
 112       <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 113
 114       <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 115       converted from HTML to POD by software written by Chas Williams and Russ
 116       Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 117
 118     </refsect1>
 119   </refentry>