doc/xml/AdminReference/sect8/kas_create.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="kas_create8">
   3   <refmeta>
   4     <refentrytitle>kas create</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>kas create</refname>
   9     <refpurpose>Creates an entry in the Authentication Database</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">kas create</emphasis> <emphasis role="bold">-name</emphasis> &lt;<emphasis>name of user</emphasis>&gt;
  14         [<emphasis role="bold">-initial_password</emphasis> &lt;<emphasis>initial password</emphasis>&gt;]
  15         [<emphasis role="bold">-admin_username</emphasis> &lt;<emphasis>admin principal to use for authentication</emphasis>&gt;]
  16         [<emphasis role="bold">-password_for_admin</emphasis> &lt;<emphasis>admin password</emphasis>&gt;] [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;]
  17         [<emphasis role="bold">-servers</emphasis> &lt;<emphasis>explicit list of authentication servers</emphasis>&gt;+]
  18         [<emphasis role="bold">-noauth</emphasis>] [<emphasis role="bold">-help</emphasis>]</para>
  19
  20     <para><emphasis role="bold">kas c</emphasis> <emphasis role="bold">-na</emphasis> &lt;<emphasis>name of user</emphasis>&gt; [<emphasis role="bold">-i</emphasis> &lt;<emphasis>initial password</emphasis>&gt;]
  21         [<emphasis role="bold">-a</emphasis> &lt;<emphasis>admin principal to use for authentication</emphasis>&gt;]
  22         [<emphasis role="bold">-p</emphasis> &lt;<emphasis>admin password</emphasis>&gt;] [<emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;]
  23         [<emphasis role="bold">-s</emphasis> &lt;<emphasis>explicit list of authentication servers</emphasis>&gt;+] [<emphasis role="bold">-no</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>
  24
  25   </refsect1>
  26   <refsect1>
  27     <title>Description</title>
  28     <para>The <emphasis role="bold">kas create</emphasis> command creates an entry in the Authentication Database
  29     for the user named by the <emphasis role="bold">-name</emphasis> argument.</para>
  30
  31     <para>To avoid having the account's initial password echo visibly at the shell
  32     prompt, omit the <emphasis role="bold">-initial_password</emphasis> argument; the command interpreter
  33     prompts for the password and does not echo it visibly.  Whether or not
  34     <emphasis role="bold">-initial_password</emphasis> is omitted, the Authentication Server converts the
  35     password into a form suitable for use as an encryption key, and records it
  36     in the entry's key field.</para>
  37
  38     <para>To alter settings in an Authentication Database entry, use the <emphasis role="bold">kas
  39     setfields</emphasis> command. To examine an entry, use the <emphasis role="bold">kas examine</emphasis>
  40     command. To list every entry in the database, use the <emphasis role="bold">kas list</emphasis> command.</para>
  41
  42   </refsect1>
  43   <refsect1>
  44     <title>Options</title>
  45     <variablelist>
  46       <varlistentry>
  47         <term><emphasis role="bold">-name</emphasis> &lt;<emphasis>name of user</emphasis>&gt;</term>
  48         <listitem>
  49           <para>Names the new Authentication Database entry. Because it is the name under
  50           which the user logs in, it must obey the restrictions that many operating
  51           systems impose on user names (usually, to contain no more than eight
  52           lowercase letters).</para>
  53
  54         </listitem>
  55       </varlistentry>
  56       <varlistentry>
  57         <term><emphasis role="bold">-initial_password</emphasis> &lt;<emphasis>initial password</emphasis>&gt;</term>
  58         <listitem>
  59           <para>Sets the user's password; provide a character string that can include
  60           uppercase and lowercase letters, numerals and punctuation. The
  61           Authentication Server scrambles the string into an octal string suitable
  62           for use as an encryption key before placing it in the entry's key
  63           field. If this argument is omitted, the command interpreter prompts for
  64           the string and does not echo it visibly.</para>
  65
  66         </listitem>
  67       </varlistentry>
  68       <varlistentry>
  69         <term><emphasis role="bold">-admin_username</emphasis> &lt;<emphasis>admin principal</emphasis>&gt;</term>
  70         <listitem>
  71           <para>Specifies the user identity under which to authenticate with the
  72           Authentication Server for execution of the command. For more details,
  73           see <link linkend="kas8">kas(8)</link>.</para>
  74
  75         </listitem>
  76       </varlistentry>
  77       <varlistentry>
  78         <term><emphasis role="bold">-password_for_admin</emphasis> &lt;<emphasis>admin password</emphasis>&gt;</term>
  79         <listitem>
  80           <para>Specifies the password of the command's issuer. If it is omitted (as
  81           recommended), the <emphasis role="bold">kas</emphasis> command interpreter prompts for it and does not
  82           echo it visibly. For more details, see <link linkend="kas8">kas(8)</link>.</para>
  83
  84         </listitem>
  85       </varlistentry>
  86       <varlistentry>
  87         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
  88         <listitem>
  89           <para>Names the cell in which to run the command. For more details, see
  90           <link linkend="kas8">kas(8)</link>.</para>
  91
  92         </listitem>
  93       </varlistentry>
  94       <varlistentry>
  95         <term><emphasis role="bold">-servers</emphasis> &lt;<emphasis>authentication servers</emphasis>&gt;</term>
  96         <listitem>
  97           <para>Names each machine running an Authentication Server with which to
  98           establish a connection. For more details, see <link linkend="kas8">kas(8)</link>.</para>
  99
 100         </listitem>
 101       </varlistentry>
 102       <varlistentry>
 103         <term><emphasis role="bold">-noauth</emphasis></term>
 104         <listitem>
 105           <para>Assigns the unprivileged identity <computeroutput>anonymous</computeroutput> to the issuer. For more
 106           details, see <link linkend="kas8">kas(8)</link>.</para>
 107
 108         </listitem>
 109       </varlistentry>
 110       <varlistentry>
 111         <term><emphasis role="bold">-help</emphasis></term>
 112         <listitem>
 113           <para>Prints the online help for this command. All other valid options are
 114           ignored.</para>
 115
 116         </listitem>
 117       </varlistentry>
 118     </variablelist>
 119   </refsect1>
 120   <refsect1>
 121     <title>Examples</title>
 122     <para>The following example shows the prompts that appear when an administrator
 123     logged in as <computeroutput>admin</computeroutput> creates an Authentication Database entry for the
 124     user <computeroutput>smith</computeroutput>, and does not include either the <emphasis role="bold">-initial_password</emphasis> or
 125     <emphasis role="bold">-password_for_admin</emphasis> arguments.</para>
 126
 127 <programlisting>
 128    % kas create smith
 129    Password for admin:
 130    initial_password:
 131    Verifying, please re-enter initial_password:
 132
 133 </programlisting>
 134     </refsect1>
 135     <refsect1>
 136       <title>Privilege Required</title>
 137       <para>The issuer must have the <computeroutput>ADMIN</computeroutput> flag set on his or her Authentication
 138       Database entry.</para>
 139
 140     </refsect1>
 141     <refsect1>
 142       <title>See Also</title>
 143       <para><link linkend="kas8">kas(8)</link>,
 144       <link linkend="kas_examine8">kas_examine(8)</link>,
 145       <link linkend="kas_list8">kas_list(8)</link>,
 146       <link linkend="kas_setfields8">kas_setfields(8)</link></para>
 147
 148     </refsect1>
 149     <refsect1>
 150       <title>Copyright</title>
 151       <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 152
 153       <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 154       converted from HTML to POD by software written by Chas Williams and Russ
 155       Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 156
 157     </refsect1>
 158   </refentry>