doc/xml/AdminReference/sect1/pts_createuser.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="pts_createuser1">
   3   <refmeta>
   4     <refentrytitle>pts createuser</refentrytitle>
   5     <manvolnum>1</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>pts createuser</refname>
   9     <refpurpose>Creates a user or machine entry in the Protection Database</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">pts createuser</emphasis> <emphasis role="bold">-name</emphasis> &lt;<emphasis>user name</emphasis>&gt;+ [<emphasis role="bold">-id</emphasis> &lt;<emphasis>user id</emphasis>&gt;+]
  14         [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-noauth</emphasis>] [<emphasis role="bold">-force</emphasis>] [<emphasis role="bold">-help</emphasis>]</para>
  15
  16     <para><emphasis role="bold">pts createu</emphasis> <emphasis role="bold">-na</emphasis> &lt;<emphasis>user name</emphasis>&gt;+ [<emphasis role="bold">-i</emphasis> &lt;<emphasis>user id</emphasis>&gt;+]
  17         [<emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-no</emphasis>] [<emphasis role="bold">-f</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>
  18
  19     <para><emphasis role="bold">pts cu</emphasis> <emphasis role="bold">-na</emphasis> &lt;<emphasis>user name</emphasis>&gt;+ [<emphasis role="bold">-i</emphasis> &lt;<emphasis>user id</emphasis>&gt;+]
  20         [<emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-no</emphasis>] [<emphasis role="bold">-f</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>
  21
  22   </refsect1>
  23   <refsect1>
  24     <title>Description</title>
  25     <para>The <emphasis role="bold">pts createuser</emphasis> command creates an entry in the Protection Database
  26     for each user or machine specified by the <emphasis role="bold">-name</emphasis> argument. A user entry
  27     name becomes the user's AFS username (the one to provide when
  28     authenticating with the AFS Authentication Server).  A machine entry's
  29     name is the machine's IP address or a wildcard notation that represents a
  30     range of consecutive IP addresses (a group of machines on the same
  31     network). It is not possible to authenticate as a machine, but a group to
  32     which a machine entry belongs can appear on a directory's access control
  33     list (ACL), thereby granting the indicated permissions to any user logged
  34     on to the machine.</para>
  35
  36     <para>AFS user IDs (AFS UIDs) are positive integers and by default the
  37     Protection Server assigns an AFS UID that is one greater than the current
  38     value of the <computeroutput>max user id</computeroutput> counter in the Protection Database,
  39     incrementing the counter by one for each user. To assign a specific AFS
  40     UID, use the <emphasis role="bold">-id</emphasis> argument. If any of the specified AFS UIDs is greater
  41     than the current value of the <computeroutput>max user id</computeroutput> counter, the counter is reset
  42     to that value. It is acceptable to specify an AFS UID smaller than the
  43     current value of the counter, but the creation operation fails if an
  44     existing user or machine entry already has it. To display or set the value
  45     of the <computeroutput>max user id</computeroutput> counter, use the <emphasis role="bold">pts listmax</emphasis> or <emphasis role="bold">pts setmax</emphasis>
  46     command, respectively.</para>
  47
  48     <para>The issuer of the <emphasis role="bold">pts createuser</emphasis> command is recorded as the entry's
  49     creator and the group system:administrators as its owner.</para>
  50
  51   </refsect1>
  52   <refsect1>
  53     <title>Cautions</title>
  54     <para>The Protection Server reserves AFS UID 0 (zero) and returns an error if
  55     the <emphasis role="bold">-id</emphasis> argument has that value.</para>
  56
  57   </refsect1>
  58   <refsect1>
  59     <title>Options</title>
  60     <variablelist>
  61       <varlistentry>
  62         <term><emphasis role="bold">-name</emphasis> &lt;<emphasis>user name</emphasis>&gt;+</term>
  63         <listitem>
  64           <para>Specifies either a username for a user entry, or an IP address (complete
  65           or wildcarded) for a machine entry:</para>
  66
  67           <itemizedlist>
  68             <listitem>
  69               <para>A username can include up to 63 numbers and lowercase letters, but it is
  70               best to make it shorter than eight characters, because many application
  71               programs cannot handle longer names. Also, it is best not to include shell
  72               metacharacters or other punctuation marks. In particular, the colon (<computeroutput>:</computeroutput>)
  73               and at-sign (<computeroutput>@</computeroutput>) characters are not acceptable. The period is generally
  74               used only in special administrative names, to separate the username and an
  75               <emphasis>instance</emphasis>, as in the example <computeroutput>pat.admin</computeroutput>.</para>
  76
  77             </listitem>
  78             <listitem>
  79               <para>A machine identifier is its IP address in dotted decimal notation (for
  80               example, 192.12.108.240), or a wildcard notation that represents a set of
  81               IP addresses (a group of machines on the same network). The following are
  82               acceptable wildcard formats. The letters <computeroutput>W</computeroutput>, <computeroutput>X</computeroutput>, <computeroutput>Y</computeroutput> and <computeroutput>Z</computeroutput> each
  83               represent an actual number from the range 1 through 255.</para>
  84
  85               <itemizedlist>
  86                 <listitem>
  87                   <para>W.X.Y.Z represents a single machine, for example <computeroutput>192.12.108.240</computeroutput>.</para>
  88
  89                 </listitem>
  90                 <listitem>
  91                   <para>W.X.Y.0 matches all machines whose IP addresses start with the first three
  92                   numbers. For example, <computeroutput>192.12.108.0</computeroutput> matches both <computeroutput>192.12.108.119</computeroutput> and
  93                   <computeroutput>192.12.108.120</computeroutput>, but does not match <computeroutput>192.12.105.144</computeroutput>.</para>
  94
  95                 </listitem>
  96                 <listitem>
  97                   <para>W.X.0.0 matches all machines whose IP addresses start with the first two
  98                   numbers. For example, the address <computeroutput>192.12.0.0</computeroutput> matches both
  99                   <computeroutput>192.12.106.23</computeroutput> and <computeroutput>192.12.108.120</computeroutput>, but does not match <computeroutput>192.5.30.95</computeroutput>.</para>
 100
 101                 </listitem>
 102                 <listitem>
 103                   <para>W.0.0.0 matches all machines whose IP addresses start with the first
 104                   number in the specified address. For example, the address <computeroutput>192.0.0.0</computeroutput>
 105                   matches both <computeroutput>192.5.30.95</computeroutput> and <computeroutput>192.12.108.120</computeroutput>, but does not match
 106                   <computeroutput>138.255.63.52</computeroutput>.</para>
 107
 108                 </listitem>
 109               </itemizedlist>
 110               <para>Do not define a machine entry with the name <computeroutput>0.0.0.0</computeroutput> to match every
 111               machine. The system:anyuser group is equivalent.</para>
 112
 113             </listitem>
 114           </itemizedlist>
 115         </listitem>
 116       </varlistentry>
 117       <varlistentry>
 118         <term><emphasis role="bold">-id</emphasis> &lt;<emphasis>user id</emphasis>&gt;+</term>
 119         <listitem>
 120           <para>Specifies an AFS UID for each user or machine entry, rather than allowing
 121           the Protection Server to assign it. Provide a positive integer.</para>
 122
 123           <para>If this argument is used and the <emphasis role="bold">-name</emphasis> argument names multiple new
 124           entries, it is best to provide an equivalent number of AFS UIDs.  The
 125           first UID is assigned to the first entry, the second to the second entry,
 126           and so on. If there are fewer UIDs than entries, the Protection Server
 127           assigns UIDs to the unmatched entries based on the <computeroutput>max user id</computeroutput>
 128           counter. If there are more UIDs than entries, the excess UIDs are
 129           ignored. If any of the UIDs is greater than the current value of the <computeroutput>max
 130           user id</computeroutput> counter, the counter is reset to that value.</para>
 131
 132         </listitem>
 133       </varlistentry>
 134       <varlistentry>
 135         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
 136         <listitem>
 137           <para>Names the cell in which to run the command. For more details, see
 138           <link linkend="pts1">pts(1)</link>.</para>
 139
 140         </listitem>
 141       </varlistentry>
 142       <varlistentry>
 143         <term><emphasis role="bold">-noauth</emphasis></term>
 144         <listitem>
 145           <para>Assigns the unprivileged identity anonymous to the issuer. For more
 146           details, see <link linkend="pts1">pts(1)</link>.</para>
 147
 148         </listitem>
 149       </varlistentry>
 150       <varlistentry>
 151         <term><emphasis role="bold">-force</emphasis></term>
 152         <listitem>
 153           <para>Enables the command to continue executing as far as possible when errors
 154           or other problems occur, rather than halting execution at the first error.</para>
 155
 156         </listitem>
 157       </varlistentry>
 158       <varlistentry>
 159         <term><emphasis role="bold">-help</emphasis></term>
 160         <listitem>
 161           <para>Prints the online help for this command. All other valid options are
 162           ignored.</para>
 163
 164         </listitem>
 165       </varlistentry>
 166     </variablelist>
 167   </refsect1>
 168   <refsect1>
 169     <title>Output</title>
 170     <para>The command generates the following string to confirm creation of each
 171     user:</para>
 172
 173 <programlisting>
 174    User &amp;lt;name&amp;gt; has id &amp;lt;id&amp;gt;
 175
 176 </programlisting>
 177     </refsect1>
 178     <refsect1>
 179       <title>Examples</title>
 180       <para>The following example creates a Protection Database entry for the user
 181       <computeroutput>johnson</computeroutput>.</para>
 182
 183 <programlisting>
 184    % pts createuser -name johnson
 185
 186 </programlisting>
 187         <para>The following example creates three wildcarded machine entries in the ABC
 188         Corporation cell. The three entries encompass all of the machines on the
 189         company's networks without including machines on other networks:</para>
 190
 191 <programlisting>
 192    % pts createuser -name 138.255.0.0 192.12.105.0 192.12.106.0
 193
 194 </programlisting>
 195         </refsect1>
 196         <refsect1>
 197           <title>Privilege Required</title>
 198           <para>The issuer must belong to the system:administrators group.</para>
 199
 200         </refsect1>
 201         <refsect1>
 202           <title>See Also</title>
 203           <para><link linkend="pts1">pts(1)</link>,
 204           <link linkend="pts_listmax1">pts_listmax(1)</link>,
 205           <link linkend="pts_setmax1">pts_setmax(1)</link></para>
 206
 207         </refsect1>
 208         <refsect1>
 209           <title>Copyright</title>
 210           <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 211
 212           <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 213           converted from HTML to POD by software written by Chas Williams and Russ
 214           Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 215
 216         </refsect1>
 217       </refentry>