fsbnode-rename-unused-to-dummy-20090604
[openafs.git] / src / WINNT / doc / install / Documentation / en_US / html / CmdRef / auarf215.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3//EN">
2 <HTML><HEAD>
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3190/auarf000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 5 Nov 1999 at 13:58:29                -->
7 <META HTTP-EQUIV="updated" CONTENT="Fri, 05 Nov 1999 13:58:29">
8 <META HTTP-EQUIV="review" CONTENT="Sun, 05 Nov 2000 13:58:29">
9 <META HTTP-EQUIV="expires" CONTENT="Mon, 05 Nov 2001 13:58: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="auarf214.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="auarf216.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="HDRPTS_CREATEUSER" HREF="auarf002.htm#ToC_229">pts createuser</A></H2>
19 <A NAME="IDX5274"></A>
20 <A NAME="IDX5275"></A>
21 <A NAME="IDX5276"></A>
22 <A NAME="IDX5277"></A>
23 <A NAME="IDX5278"></A>
24 <A NAME="IDX5279"></A>
25 <A NAME="IDX5280"></A>
26 <A NAME="IDX5281"></A>
27 <A NAME="IDX5282"></A>
28 <A NAME="IDX5283"></A>
29 <A NAME="IDX5284"></A>
30 <A NAME="IDX5285"></A>
31 <A NAME="IDX5286"></A>
32 <A NAME="IDX5287"></A>
33 <A NAME="IDX5288"></A>
34 <A NAME="IDX5289"></A>
35 <A NAME="IDX5290"></A>
36 <A NAME="IDX5291"></A>
37 <A NAME="IDX5292"></A>
38 <P><STRONG>Purpose</STRONG>
39 <P>Creates a user or machine entry in the Protection Database
40 <P><STRONG>Synopsis</STRONG>
41 <PRE><B>pts createuser -name</B> &lt;<VAR>user&nbsp;name</VAR>><SUP>+</SUP>  [<B>-id</B> &lt;<VAR>user&nbsp;id</VAR>><SUP>+</SUP>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  
42                [<B>-noauth</B>]  [<B>-force</B>]  [<B>-help</B>]
43    
44 <B>pts createu -na</B> &lt;<VAR>user&nbsp;name</VAR>><SUP>+</SUP>  [<B>-i</B> &lt;<VAR>user&nbsp;id</VAR>><SUP>+</SUP>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  
45             [<B>-no</B>] [<B>-f</B>]  [<B>-h</B>]
46    
47 <B>pts cu -na</B> &lt;<VAR>user&nbsp;name</VAR>><SUP>+</SUP>  [<B>-i</B> &lt;<VAR>user&nbsp;id</VAR>><SUP>+</SUP>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-no</B>] [<B>-f</B>]  [<B>-h</B>]
48 </PRE>
49 <P><STRONG>Description</STRONG>
50 <P>The <B>pts createuser</B> command creates an entry in the Protection
51 Database for each user or machine specified by the <B>-name</B>
52 argument. A user entry name becomes the user&#39;s AFS username (the
53 one to provide when authenticating with the AFS Authentication Server).
54 A machine entry&#39;s name is the machine&#39;s IP address or a wildcard
55 notation that represents a range of consecutive IP addresses (a group of
56 machines on the same network). It is not possible to authenticate as a
57 machine, but a group to which a machine entry belongs can appear on a
58 directory&#39;s access control list (ACL), thereby granting the indicated
59 permissions to any user logged on to the machine.
60 <P>AFS user IDs (AFS UIDs) are positive integers and by default the Protection
61 Server assigns an AFS UID that is one greater than the current value of the
62 <TT>max user id</TT> counter in the Protection Database, incrementing the
63 counter by one for each user. To assign a specific AFS UID, use the
64 <B>-id</B> argument. If any of the specified AFS UIDs is greater
65 than the current value of the <TT>max user id</TT> counter, the counter is
66 reset to that value. It is acceptable to specify an AFS UID smaller
67 than the current value of the counter, but the creation operation fails if an
68 existing user or machine entry already has it. To display or set the
69 value of the <TT>max user id</TT> counter, use the <B>pts listmax</B> or
70 <B>pts setmax</B> command, respectively.
71 <P>The issuer of the <B>pts createuser</B> command is recorded as the
72 entry&#39;s creator and the group <B>system&#58;administrators</B> as
73 its owner.
74 <P><STRONG>Cautions</STRONG>
75 <P>The Protection Server reserves AFS UID 0 (zero) and returns an error if the
76 <B>-id</B> argument has that value.
77 <P><STRONG>Options</STRONG>
78 <DL>
79 <P><DT><B>-name
80 </B><DD>Specifies either a username for a user entry, or an IP address (complete
81 or wildcarded) for a machine entry&#58; 
82 <UL>
83 <P><LI>A username can include up to 63 numbers and lowercase letters, but it is
84 best to make it shorter than eight characters, because many application
85 programs cannot handle longer names. Also, it is best not to include
86 shell metacharacters or other punctuation marks. In particular, the
87 colon (<B>&#58;</B>) and at-sign (<B>@</B>) characters are not
88 acceptable. The period is generally used only in special administrative
89 names, to separate the username and an <I>instance</I>, as in the example
90 <B>pat.admin</B>.
91 <P><LI>A machine identifier is its IP address in dotted decimal notation (for
92 example, 192.12.108.240), or a wildcard notation that
93 represents a set of IP addresses (a group of machines on the same
94 network). The following are acceptable wildcard formats. The
95 letters <B>W</B>, <B>X</B>, <B>Y</B> and <B>Z</B> each
96 represent an actual number from the range 1 through 255. 
97 <UL>
98 <P><LI><B>W.X.Y.Z</B> represents a single machine, for
99 example <B>192.12.108.240</B>.
100 <P><LI><B>W.X.Y.0</B> matches all machines whose IP
101 addresses start with the first three numbers. For example,
102 <B>192.12.108.0</B> matches both
103 <B>192.12.108.119</B> and
104 <B>192.12.108.120</B>, but does not match
105 <B>192.12.105.144</B>.
106 <P><LI><B>W.X.0.0</B> matches all machines whose IP
107 addresses start with the first two numbers. For example, the address
108 <B>192.12.0.0</B> matches both
109 <B>192.12.106.23</B> and
110 <B>192.12.108.120</B>, but does not match
111 <B>192.5.30.95</B>.
112 <P><LI><B>W.0.0.0</B> matches all machines whose IP
113 addresses start with the first number in the specified address. For
114 example, the address <B>192.0.0.0</B> matches both
115 <B>192.5.30.95</B> and
116 <B>192.12.108.120</B>, but does not match
117 <B>138.255.63.52</B>.
118 </UL>
119 <P>Do not define a machine entry with the name
120 <B>0.0.0.0</B> to match every machine. The
121 <B>system&#58;anyuser</B> group is equivalent.
122 </UL>
123 <P><DT><B>-id
124 </B><DD>Specifies an AFS UID for each user or machine entry, rather than allowing
125 the Protection Server to assign it. Provide a positive integer. 
126 <P>If this argument is used and the <B>-name</B> argument names multiple
127 new entries, it is best to provide an equivalent number of AFS UIDs.
128 The first UID is assigned to the first entry, the second to the second entry,
129 and so on. If there are fewer UIDs than entries, the Protection Server
130 assigns UIDs to the unmatched entries based on the <TT>max user id</TT>
131 counter. If there are more UIDs than entries, the excess UIDs are
132 ignored. If any of the UIDs is greater than the current value of the
133 <TT>max user id</TT> counter, the counter is reset to that value.
134 <P><DT><B>-cell
135 </B><DD>Names the cell in which to run the command. For more details, see
136 the introductory <B>pts</B> reference page.
137 <P><DT><B>-noauth
138 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
139 issuer. For more details, see the introductory <B>pts</B> reference
140 page.
141 <P><DT><B>-force
142 </B><DD>Enables the command to continue executing as far as possible when errors
143 or other problems occur, rather than halting execution at the first
144 error.
145 <P><DT><B>-help
146 </B><DD>Prints the online help for this command. All other valid options
147 are ignored.
148 </DL>
149 <P><STRONG>Output</STRONG>
150 <P>The command generates the following string to confirm creation of each
151 user&#58;
152 <PRE>   User <VAR>name</VAR> has id <VAR>id</VAR>
153    
154 </PRE>
155 <P><STRONG>Examples</STRONG>
156 <P>The following example creates a Protection Database entry for the user
157 <B>johnson</B>.
158 <PRE>   % <B>pts createuser -name johnson</B>
159    
160 </PRE>
161 <P>The following example creates three wildcarded machine entries in the ABC
162 Corporation cell. The three entries encompass all of the machines on
163 the company&#39;s networks without including machines on other
164 networks&#58;
165 <PRE>   % <B>pts createuser -name 138.255.0.0 192.12.105.0 192.12.106.0</B>
166    
167 </PRE>
168 <P><STRONG>Privilege Required</STRONG>
169 <P>The issuer must belong to the <B>system&#58;administrators</B>
170 group.
171 <P><STRONG>Related Information</STRONG>
172 <P><A HREF="auarf210.htm#HDRPTS_INTRO">pts</A>
173 <P><A HREF="auarf220.htm#HDRPTS_LISTMAX">pts listmax</A>
174 <P><A HREF="auarf226.htm#HDRPTS_SETMAX">pts setmax</A>
175 <P>
176 <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="auarf214.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="auarf216.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> 
177 <!-- Begin Footer Records  ========================================== -->
178 <P><HR><B> 
179 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
180 </B> 
181 <!-- End Footer Records  ============================================ -->
182 <A NAME="Bot_Of_Page"></A>
183 </BODY></HTML>