openafs/doc/xml/AdminReference/sect8/bos_adduser.xml

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="bos_adduser8">
  <refmeta>
    <refentrytitle>bos adduser</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>bos adduser</refname>
    <refpurpose>Adds a privileged user to the UserList file</refpurpose>
  </refnamediv>
  <refsect1>
    <title>Synopsis</title>
    <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;+
        [<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 addu</emphasis> <emphasis role="bold">-s</emphasis> &lt;<emphasis>machine name</emphasis>&gt; <emphasis role="bold">-u</emphasis> &lt;<emphasis>user names</emphasis>&gt;+
        [<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 bos adduser command adds each user name specified with the <emphasis role="bold">-user</emphasis>
    argument to the <replaceable>/usr/afs/etc/UserList</replaceable> file on the machine named by the
    <emphasis role="bold">-server</emphasis> argument. It is the issuer's responsibility to verify that an
    entry for the user exists in the Authentication and Protection Databases.</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 change the
          <replaceable>/usr/afs/etc/UserList</replaceable> file. 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>

          <para>In cells that use the Update Server to distribute the contents of the
          <replaceable>/usr/afs/etc</replaceable> directory, it is conventional to specify only the system
          control machine as a value for the <emphasis role="bold">-server</emphasis> argument. Otherwise, repeat
          the command for each file server machine. For further discussion, see
          <link linkend="bos8">bos(8)</link>.</para>

        </listitem>
      </varlistentry>
      <varlistentry>
        <term><emphasis role="bold">-user</emphasis> &lt;<emphasis>user names</emphasis>&gt;+</term>
        <listitem>
          <para>Specifies each user name to insert into the <replaceable>/usr/afs/etc/UserList</replaceable> file.</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 command adds the user names <computeroutput>pat</computeroutput> and <computeroutput>smith</computeroutput> to the
    <replaceable>/usr/afs/etc/UserList</replaceable> file on the machine <computeroutput>fs1.abc.com</computeroutput> (the system
    control machine).</para>

<programlisting>
   % bos adduser -server fs1.abc.com -user pat smith

</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="KeyFile5">KeyFile(5)</link>,
      <link linkend="UserList5">UserList(5)</link>,
      <link linkend="bos8">bos(8)</link>,
      <link linkend="bos_listusers8">bos_listusers(8)</link>,
      <link linkend="bos_removeuser8">bos_removeuser(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>