doc/html/AdminReference/auarf243.htm

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
   2 <HTML><HEAD>
   3 <TITLE>Administration Reference</TITLE>
   4 <!-- Begin Header Records  ========================================== -->
   5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
   6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
   7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
   8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
   9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
  10 </HEAD><BODY>
  11 <!-- (C) IBM Corporation 2000. All Rights Reserved    -->
  12 <BODY bgcolor="ffffff">
  13 <!-- End Header Records  ============================================ -->
  14 <A NAME="Top_Of_Page"></A>
  15 <H1>Administration Reference</H1>
  16 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf242.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf244.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P>
  17 <P>
  18 <H2><A NAME="HDRUSS_ADD" HREF="auarf002.htm#ToC_257">uss add</A></H2>
  19 <A NAME="IDX5517"></A>
  20 <A NAME="IDX5518"></A>
  21 <A NAME="IDX5519"></A>
  22 <A NAME="IDX5520"></A>
  23 <A NAME="IDX5521"></A>
  24 <A NAME="IDX5522"></A>
  25 <A NAME="IDX5523"></A>
  26 <A NAME="IDX5524"></A>
  27 <A NAME="IDX5525"></A>
  28 <A NAME="IDX5526"></A>
  29 <A NAME="IDX5527"></A>
  30 <A NAME="IDX5528"></A>
  31 <A NAME="IDX5529"></A>
  32 <A NAME="IDX5530"></A>
  33 <A NAME="IDX5531"></A>
  34 <A NAME="IDX5532"></A>
  35 <A NAME="IDX5533"></A>
  36 <A NAME="IDX5534"></A>
  37 <A NAME="IDX5535"></A>
  38 <P><STRONG>Purpose</STRONG>
  39 <P>Creates a user account
  40 <P><STRONG>Synopsis</STRONG>
  41 <PRE><B>uss add -user</B> &lt;<VAR>login&nbsp;name</VAR>>  [<B>-realname</B> &lt;<VAR>full&nbsp;name&nbsp;in&nbsp;quotes</VAR>>]
  42         [<B>-pass</B> &lt;<VAR>initial&nbsp;password</VAR>>]
  43         [<B>-pwexpires</B> &lt;<VAR>password&nbsp;expires&nbsp;in&nbsp;[0..254]&nbsp;days&nbsp;(0&nbsp;=>&nbsp;never)</VAR>>]
  44         [<B>-server</B> &lt;<VAR>FileServer&nbsp;for&nbsp;home&nbsp;volume</VAR>>]
  45         [<B>-partition</B> &lt;<VAR>FileServer's&nbsp;disk&nbsp;partition&nbsp;for&nbsp;home&nbsp;volume</VAR>>]
  46         [<B>-mount</B> &lt;<VAR>home&nbsp;directory&nbsp;mount&nbsp;point</VAR>>]
  47         [<B>-uid</B> &lt;<VAR>uid&nbsp;to&nbsp;assign&nbsp;the&nbsp;user</VAR>>]
  48         [<B>-template</B> &lt;<VAR>pathname&nbsp;of&nbsp;template&nbsp;file</VAR>>]
  49         [<B>-verbose</B>]  [<B>-var</B> &lt;<VAR>auxiliary&nbsp;argument&nbsp;pairs&nbsp;(Num&nbsp;val)</VAR>><SUP>+</SUP>]
  50         [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-admin</B> &lt;<VAR>administrator&nbsp;to&nbsp;authenticate</VAR>>]
  51         [<B>-dryrun</B>]  [<B>-skipauth</B>]  [<B>-overwrite</B>]  [<B>-help</B>]
  52
  53 <B>uss ad -us</B> &lt;<VAR>login&nbsp;name</VAR>>  [<B>-r</B> &lt;<VAR>full&nbsp;name&nbsp;in&nbsp;quotes</VAR>>]
  54        [<B>-pas</B> &lt;<VAR>initial&nbsp;password</VAR>>]
  55        [<B>-pw</B> &lt;<VAR>password&nbsp;expires&nbsp;in&nbsp;[0..254]&nbsp;days&nbsp;(0&nbsp;=>&nbsp;never)</VAR>>]
  56        [<B>-se</B> &lt;<VAR>FileServer&nbsp;for&nbsp;home&nbsp;volume</VAR>>]
  57        [<B>-par</B> &lt;<VAR>FileServer's&nbsp;disk&nbsp;partition&nbsp;for&nbsp;home&nbsp;volume</VAR>>]
  58        [<B>-m</B> &lt;<VAR>home&nbsp;directory&nbsp;mount&nbsp;point</VAR>>]  [<B>-ui</B> &lt;<VAR>uid&nbsp;to&nbsp;assign&nbsp;the&nbsp;user</VAR>>]
  59        [<B>-t</B> &lt;<VAR>pathname&nbsp;of&nbsp;template&nbsp;file</VAR>>]  [<B>-ve</B>]
  60        [<B>-va</B> &lt;<VAR>auxiliary&nbsp;argument&nbsp;pairs&nbsp;(Num&nbsp;val)</VAR>><SUP>+</SUP>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]
  61        [<B>-a</B> &lt;<VAR>administrator&nbsp;to&nbsp;authenticate</VAR>>]  [<B>-d</B>]  [<B>-sk</B>]  [<B>-o</B>]  [<B>-h</B>]
  62 </PRE>
  63 <P><STRONG>Description</STRONG>
  64 <P>The <B>uss add</B> command creates entries in the Protection Database
  65 and Authentication Database for the user name specified by the
  66 <B>-user</B> argument. By default, the Protection Server
  67 automatically allocates an AFS user ID (UID) for the new user; to specify
  68 an alternate AFS UID, include the <B>-uid</B> argument. If a
  69 password is provided with the <B>-pass</B> argument, it is stored as the
  70 user's password in the Authentication Database after conversion into a
  71 form suitable for use as an encryption key. Otherwise, the string
  72 <B>changeme</B> is assigned as the user's initial password.
  73 <P>The other results of the command depend on which instructions and which of
  74 a defined set of variables appear in the template file specified with the
  75 <B>-template</B> argument. Many of the command's arguments
  76 supply a value for one of the defined variables, and failure to provide an
  77 argument when the corresponding variable appears in the template file halts
  78 the account creation process at the point where the command interpreter first
  79 encounters the variable in the template file.
  80 <P>To create multiple accounts with a single command, use the <B>uss
  81 bulk</B> command. To delete accounts with a single command, use the
  82 <B>uss delete</B> command.
  83 <P><STRONG>Options</STRONG>
  84 <DL>
  85 <P><DT><B>-user
  86 </B><DD>Names the user's Authentication Database and Protection Database
  87 entries. It can include up to eight alphanumeric characters, but not
  88 any of the following characters: <B>:</B> (colon),
  89 <B>@</B> (at-sign), <B>.</B> (period), space, or
  90 newline. Because it becomes the username (the name under which a user
  91 logs in), it is best not to include shell metacharacters and to obey the
  92 restrictions that many operating systems impose on usernames (usually, to
  93 contain no more than eight lowercase letters).
  94 <P>Corresponding variable in the template file: $USER.
  95 <P><DT><B>-realname
  96 </B><DD>Specifies the user's full name. If it contains spaces or
  97 punctuation, surround it with double quotes. If not provided, it
  98 defaults to the user name provided with the <B>-user</B> argument.
  99 <P>Corresponding variable in the template file: $NAME. Many
 100 operating systems include a field for the full name in a user's entry in
 101 the local password file (<B>/etc/passwd</B> or equivalent), and this
 102 variable can be used to pass a value to be used in that field.
 103 <P><DT><B>-pass
 104 </B><DD>Specifies the user's initial password. Although the AFS
 105 commands that handle passwords accept strings of virtually unlimited length,
 106 it is best to use a password of eight characters or less, which is the maximum
 107 length that many applications and utilities accept. If not provided,
 108 this argument defaults to the string <B>changeme</B>.
 109 <P>Corresponding variable in the template file: none.
 110 <P><DT><B>-pwexpires
 111 </B><DD>Sets the number of days after a user's password is changed that it
 112 remains valid. Provide an integer from the range <B>1</B> through
 113 <B>254</B> to specify the number of days until expiration, or the value
 114 <B>0</B> to indicate that the password never expires (the default).
 115 <P>When the password becomes invalid (expires), the user is unable to
 116 authenticate, but has 30 more days in which to issue the <B>kpasswd</B>
 117 command to change the password (after that, only an administrator can change
 118 it).
 119 <P>Corresponding variable in the template file: $PWEXPIRES.
 120 <P><DT><B>-server
 121 </B><DD>Names the file server machine on which to create the new user's
 122 volume. It is best to provide a fully qualified hostname (for example,
 123 <B>fs1.abc.com</B>), but an abbreviated form is acceptable
 124 provided that the cell's naming service is available to resolve it at the
 125 time the volume is created.
 126 <P>Corresponding variable in the template file: $SERVER.
 127 <P><DT><B>-partition
 128 </B><DD>Specifies the partition on which to create the user's volume; it
 129 must be on the file server machine named by the <B>-server</B>
 130 argument. Provide the complete partition name (for example
 131 <B>/vicepa</B>) or one of the following abbreviated forms:
 132 <PRE>   <B>/vicepa</B>     =     <B>vicepa</B>      =      <B>a</B>      =      <B>0</B>
 133    <B>/vicepb</B>     =     <B>vicepb</B>      =      <B>b</B>      =      <B>1</B>
 134
 135 </PRE>
 136 <P>
 137 <P>After <B>/vicepz</B> (for which the index is 25) comes
 138 <PRE>   <B>/vicepaa</B>    =     <B>vicepaa</B>     =      <B>aa</B>     =      <B>26</B>
 139    <B>/vicepab</B>    =     <B>vicepab</B>     =      <B>ab</B>     =      <B>27</B>
 140
 141 </PRE>
 142 <P>and so on through
 143 <PRE>   <B>/vicepiv</B>    =     <B>vicepiv</B>     =      <B>iv</B>     =      <B>255</B>
 144
 145 </PRE>
 146 <P>
 147 <P>Corresponding variable in the template file: $PART.
 148 <P><DT><B>-mount
 149 </B><DD>Specifies the pathname for the user's home directory. Partial
 150 pathnames are interpreted relative to the current working directory.
 151 <P>Specify the read/write path to the directory, to avoid the failure that
 152 results from attempting to create a new mount point in a read-only
 153 volume. By convention, the read/write path is indicated by placing a
 154 period before the cell name at the pathname's second level (for example,
 155 <B>/afs/.abc.com</B>). For further discussion of the
 156 concept of read/write and read-only paths through the filespace, see the
 157 <B>fs mkmount</B> reference page.
 158 <P>Corresponding variable in template: $MTPT, but in the template
 159 file's <B>V</B> instruction only. Occurrences of the $MTPT
 160 variable in template instructions that follow the <B>V</B> instruction
 161 take their value from the <B>V</B> instruction's
 162 <B>mount_point</B> field. Thus the value of this command line
 163 argument becomes the value for the $MTPT variable in instructions that follow
 164 the <B>V</B> instruction only if the string $MTPT appears alone in the
 165 <B>V</B> instruction's <B>mount_point</B> field.
 166 <P><DT><B>-uid
 167 </B><DD>Specifies a positive integer other than 0 (zero) to assign as the
 168 user's AFS UID. If this argument is omitted, the Protection Server
 169 assigns an AFS UID that is one greater than the current value of the
 170 <TT>max</TT> <TT>user</TT> <TT>id</TT> counter (use the <B>pts
 171 listmax</B> command to display the counter). If including this
 172 argument, it is best first to use the <B>pts examine</B> command to verify
 173 that no existing account already has the desired AFS UID; it one does,
 174 the account creation process terminates with an error.
 175 <P>Corresponding variable in the template file: $UID.
 176 <P><DT><B>-template
 177 </B><DD>Specifies the pathname of the template file. If this argument is
 178 omitted, the command interpreter searches the following directories in the
 179 indicated order for a file called <B>uss.template</B>:
 180 <OL TYPE=1>
 181 <P><LI>The current working directory
 182 <P><LI><B>/afs/</B><VAR>cellname</VAR><B>/common/uss</B>, where
 183 <VAR>cellname</VAR> names the local cell
 184 <P><LI><B>/etc</B>
 185 </OL>
 186 <P>
 187 <P>If the issuer provides a filename other than <B>uss.template</B>
 188 but without a pathname, the command interpreter searches for it in the
 189 indicated directories. If the issuer provides a full or partial
 190 pathname, the command interpreter consults the specified file only; it
 191 interprets partial pathnames relative to the current working directory.
 192 <P>
 193 <P>If the specified template file is empty (zero-length), the command creates
 194 Protection and Authentication Database entries only.
 195 <P>The <B>uss Template File</B> reference page details the file's
 196 format.
 197 <P><DT><B>-verbose
 198 </B><DD>Produces on the standard output stream a detailed trace of the
 199 command's execution. If this argument is omitted, only warnings
 200 and error messages appear.
 201 <P><DT><B>-var
 202 </B><DD>Specifies values for each of the number variables $1 through $9 that can
 203 appear in the template file. Use the number variables to assign values
 204 to variables in the <B>uss</B> template file that are not part of the
 205 standard set.
 206 <P>Corresponding variables in the template file: $1 through $9.
 207 <P>For each instance of this argument, provide two parts in the indicated
 208 order, separated by a space:
 209 <UL>
 210 <P><LI>The integer from the range <B>1</B> through <B>9</B> that matches
 211 the variable in the template file. Do not precede it with a dollar
 212 sign.
 213 <P><LI>A string of alphanumeric characters to assign as the value of the
 214 variable.
 215 </UL>
 216 <P>See the chapter on <B>uss</B> in the <I>IBM AFS Administration
 217 Guide</I> for further explanation.
 218 <P><DT><B>-cell
 219 </B><DD>Specifies the cell in which to run the command. For more details,
 220 see the introductory <B>uss</B> reference page.
 221 <P><DT><B>-admin
 222 </B><DD>Specifies the AFS user name under which to establish authenticated
 223 connections to the AFS server processes that maintain the various components
 224 of a user account. For more details, see the introductory
 225 <B>uss</B> reference page.
 226 <P><DT><B>-dryrun
 227 </B><DD>Reports actions that the command interpreter needs to perform while
 228 executing the command, without actually performing them. For more
 229 details, see the introductory <B>uss</B> reference page.
 230 <P><DT><B>-skipauth
 231 </B><DD>Prevents authentication with the AFS Authentication Server, allowing a
 232 site using Kerberos to substitute that form of authentication.
 233 <P><DT><B>-overwrite
 234 </B><DD>Overwrites any directories, files and links that exist in the file system
 235 and for which there are definitions in <B>D</B>, <B>E</B>,
 236 <B>F</B>, <B>L</B>, or <B>S</B> instructions in the template file
 237 named by the <B>-template</B> argument. If this flag is omitted,
 238 the command interpreter prompts once for confirmation that it is to overwrite
 239 all such elements.
 240 <P><DT><B>-help
 241 </B><DD>Prints the online help for this command. All other valid options
 242 are ignored.
 243 </DL>
 244 <P><STRONG>Examples</STRONG>
 245 <P>The combination of the following example <B>uss add</B> command and
 246 <B>V</B> instruction in a template file called <B>uss.tpl</B>
 247 creates Protection and Authentication Database entries named <B>smith</B>,
 248 and a volume called <TT>user.smith</TT> with a quota of 2500 kilobyte
 249 blocks, mounted at the pathname
 250 <B>/afs/abc.com/usr/smith</B>. The access control list (ACL)
 251 on the mount point grants <B>smith</B> all rights.
 252 <P>The issuer of the <B>uss add</B> command provides only the template
 253 file's name, not its complete pathname, because it resides in the current
 254 working directory. The command and <B>V</B> instruction appear here
 255 on two lines only for legibility; there are no line breaks in the actual
 256 instruction or command.
 257 <PRE>   V user.$USER $SERVER.abc.com /vice$PART $1   \
 258        /afs/abc.com/usr/$USER $UID $USER all
 259
 260    % <B>uss add  -user smith -realname "John Smith" -pass js_pswd -server fs2</B>   \
 261               <B>-partition b -template uss.tpl -var 1 2500</B>
 262
 263 </PRE>
 264 <P><STRONG>Privilege Required</STRONG>
 265 <P>The issuer (or the user named by the <B>-admin</B> argument) must
 266 belong to the <B>system:administrators</B> group in the Protection
 267 Database and must have the <TT>ADMIN</TT> flag turned on in his or her
 268 Authentication Database entry.
 269 <P>If the template contains a <B>V</B> instruction, the issuer must be
 270 listed in the <B>/usr/afs/etc/UserList</B> file and must have at least
 271 <B>a</B> (<B>administer</B>) and <B>i</B> (<B>insert</B>)
 272 permissions on the ACL of the directory that houses the new mount
 273 point. If the template file includes instructions for creating other
 274 types of objects (directories, files or links), the issuer must have each
 275 privilege necessary to create them.
 276 <P><STRONG>Related Information</STRONG>
 277 <P><A HREF="auarf035.htm#HDRUSERLIST">UserList</A>
 278 <P><A HREF="auarf055.htm#HDRUSSFILE">uss Template File</A>
 279 <P><A HREF="auarf153.htm#HDRFS_MKMOUNT">fs mkmount</A>
 280 <P><A HREF="auarf242.htm#HDRUSS_INTRO">uss</A>
 281 <P><A HREF="auarf245.htm#HDRUSS_BULK">uss bulk</A>
 282 <P><A HREF="auarf246.htm#HDRUSS_DELETE">uss delete</A>
 283 <P>
 284 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf242.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf244.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P>
 285 <!-- Begin Footer Records  ========================================== -->
 286 <P><HR><B>
 287 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved
 288 </B>
 289 <!-- End Footer Records  ============================================ -->
 290 <A NAME="Bot_Of_Page"></A>
 291 </BODY></HTML>