doc/xml/AdminReference/sect8/bos_adduser.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="bos_adduser8">
   3   <refmeta>
   4     <refentrytitle>bos adduser</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>bos adduser</refname>
   9     <refpurpose>Adds a privileged user to the UserList file</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">bos adduser</emphasis> <emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt; <emphasis role="bold">-user</emphasis> &lt;<emphasis>user names</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 addu</emphasis> <emphasis role="bold">-s</emphasis> &lt;<emphasis>machine name</emphasis>&gt; <emphasis role="bold">-u</emphasis> &lt;<emphasis>user names</emphasis>&gt;+
  17         [<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>
  18
  19   </refsect1>
  20   <refsect1>
  21     <title>Description</title>
  22     <para>The bos adduser command adds each user name specified with the <emphasis role="bold">-user</emphasis>
  23     argument to the <replaceable>/usr/afs/etc/UserList</replaceable> file on the machine named by the
  24     <emphasis role="bold">-server</emphasis> argument. It is the issuer's responsibility to verify that an
  25     entry for the user exists in the Authentication and Protection Databases.</para>
  26
  27   </refsect1>
  28   <refsect1>
  29     <title>Options</title>
  30     <variablelist>
  31       <varlistentry>
  32         <term><emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt;</term>
  33         <listitem>
  34           <para>Indicates the server machine on which to change the
  35           <replaceable>/usr/afs/etc/UserList</replaceable> file. Identify the machine by IP address or its
  36           host name (either fully-qualified or abbreviated unambiguously). For
  37           details, see <link linkend="bos8">bos(8)</link>.</para>
  38
  39           <para>In cells that use the Update Server to distribute the contents of the
  40           <replaceable>/usr/afs/etc</replaceable> directory, it is conventional to specify only the system
  41           control machine as a value for the <emphasis role="bold">-server</emphasis> argument. Otherwise, repeat
  42           the command for each file server machine. For further discussion, see
  43           <link linkend="bos8">bos(8)</link>.</para>
  44
  45         </listitem>
  46       </varlistentry>
  47       <varlistentry>
  48         <term><emphasis role="bold">-user</emphasis> &lt;<emphasis>user names</emphasis>&gt;+</term>
  49         <listitem>
  50           <para>Specifies each user name to insert into the <replaceable>/usr/afs/etc/UserList</replaceable> file.</para>
  51
  52         </listitem>
  53       </varlistentry>
  54       <varlistentry>
  55         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
  56         <listitem>
  57           <para>Names the cell in which to run the command. Do not combine this argument
  58           with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="bos8">bos(8)</link>.</para>
  59
  60         </listitem>
  61       </varlistentry>
  62       <varlistentry>
  63         <term><emphasis role="bold">-noauth</emphasis></term>
  64         <listitem>
  65           <para>Assigns the unprivileged identity <computeroutput>anonymous</computeroutput> to the issuer. Do not
  66           combine this flag with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see
  67           <link linkend="bos8">bos(8)</link>.</para>
  68
  69         </listitem>
  70       </varlistentry>
  71       <varlistentry>
  72         <term><emphasis role="bold">-localauth</emphasis></term>
  73         <listitem>
  74           <para>Constructs a server ticket using a key from the local
  75           <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">bos</emphasis> command interpreter presents the
  76           ticket to the BOS Server during mutual authentication. Do not combine this
  77           flag with the <emphasis role="bold">-cell</emphasis> or <emphasis role="bold">-noauth</emphasis> options. For more details, see
  78           <link linkend="bos8">bos(8)</link>.</para>
  79
  80         </listitem>
  81       </varlistentry>
  82       <varlistentry>
  83         <term><emphasis role="bold">-help</emphasis></term>
  84         <listitem>
  85           <para>Prints the online help for this command. All other valid options are
  86           ignored.</para>
  87
  88         </listitem>
  89       </varlistentry>
  90     </variablelist>
  91   </refsect1>
  92   <refsect1>
  93     <title>Examples</title>
  94     <para>The following command adds the user names <computeroutput>pat</computeroutput> and <computeroutput>smith</computeroutput> to the
  95     <replaceable>/usr/afs/etc/UserList</replaceable> file on the machine <computeroutput>fs1.abc.com</computeroutput> (the system
  96     control machine).</para>
  97
  98 <programlisting>
  99    % bos adduser -server fs1.abc.com -user pat smith
 100
 101 </programlisting>
 102     </refsect1>
 103     <refsect1>
 104       <title>Privilege Required</title>
 105       <para>The issuer must be listed in the <replaceable>/usr/afs/etc/UserList</replaceable> file on the
 106       machine named by the <emphasis role="bold">-server</emphasis> argument, or must be logged onto a server
 107       machine as the local superuser <computeroutput>root</computeroutput> if the <emphasis role="bold">-localauth</emphasis> flag is
 108       included.</para>
 109
 110     </refsect1>
 111     <refsect1>
 112       <title>See Also</title>
 113       <para><link linkend="KeyFile5">KeyFile(5)</link>,
 114       <link linkend="UserList5">UserList(5)</link>,
 115       <link linkend="bos8">bos(8)</link>,
 116       <link linkend="bos_listusers8">bos_listusers(8)</link>,
 117       <link linkend="bos_removeuser8">bos_removeuser(8)</link></para>
 118
 119     </refsect1>
 120     <refsect1>
 121       <title>Copyright</title>
 122       <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 123
 124       <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 125       converted from HTML to POD by software written by Chas Williams and Russ
 126       Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 127
 128     </refsect1>
 129   </refentry>