afsmonitor-document-stat-entries-correctly-20040729
[openafs.git] / doc / html / AdminReference / auarf214.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="auarf213.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="auarf215.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_CREATEGROUP" HREF="auarf002.htm#ToC_228">pts creategroup</A></H2>
19 <A NAME="IDX5252"></A>
20 <A NAME="IDX5253"></A>
21 <A NAME="IDX5254"></A>
22 <A NAME="IDX5255"></A>
23 <A NAME="IDX5256"></A>
24 <A NAME="IDX5257"></A>
25 <A NAME="IDX5258"></A>
26 <A NAME="IDX5259"></A>
27 <A NAME="IDX5260"></A>
28 <A NAME="IDX5261"></A>
29 <A NAME="IDX5262"></A>
30 <A NAME="IDX5263"></A>
31 <A NAME="IDX5264"></A>
32 <A NAME="IDX5265"></A>
33 <A NAME="IDX5266"></A>
34 <A NAME="IDX5267"></A>
35 <A NAME="IDX5268"></A>
36 <A NAME="IDX5269"></A>
37 <A NAME="IDX5270"></A>
38 <A NAME="IDX5271"></A>
39 <A NAME="IDX5272"></A>
40 <A NAME="IDX5273"></A>
41 <P><STRONG>Purpose</STRONG>
42 <P>Creates an (empty) Protection Database group entry
43 <P><STRONG>Synopsis</STRONG>
44 <PRE><B>pts creategroup -name</B> &lt;<VAR>group&nbsp;name</VAR>><SUP>+</SUP>  [<B>-owner</B> &lt;<VAR>owner&nbsp;of&nbsp;the&nbsp;group</VAR>>] 
45                 [<B>-id</B> &lt;<VAR>id&nbsp;(negated)&nbsp;for&nbsp;the&nbsp;group</VAR>><SUP>+</SUP>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  
46                 [<B>-noauth</B>]  [<B>-force</B>]  [<B>-help</B>]
47    
48 <B>pts createg -na</B> &lt;<VAR>group&nbsp;name</VAR>><SUP>+</SUP>  [<B>-o</B> &lt;<VAR>owner&nbsp;of&nbsp;the&nbsp;group</VAR>>] 
49             [<B>-i</B> &lt;<VAR>id&nbsp;(negated)&nbsp;for&nbsp;the&nbsp;group</VAR>><SUP>+</SUP>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  
50             [<B>-no</B>]  [<B>-f</B>]  [<B>-h</B>]
51       
52 <B>pts cg -na</B> &lt;<VAR>group&nbsp;name</VAR>><SUP>+</SUP>  [<B>-o</B> &lt;<VAR>owner&nbsp;of&nbsp;the&nbsp;group</VAR>>]  
53        [<B>-i</B> &lt;<VAR>id&nbsp;(negated)&nbsp;for&nbsp;the&nbsp;group</VAR>><SUP>+</SUP>]  
54        [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-no</B>]  [<B>-f</B>]  [<B>-h</B>]
55 </PRE>
56 <P><STRONG>Description</STRONG>
57 <P>The <B>pts creategroup</B> command creates an entry in the Protection
58 Database for each group specified by the <B>-name</B> argument. The
59 entry records the issuer of the command as the group's creator, and as
60 the group's owner unless the <B>-owner</B> argument names an
61 alternate user or group as the owner.
62 <P>There are two types of groups:
63 <UL>
64 <P><LI><I>regular</I>, the names of which have two parts separated by a
65 colon. The part before the colon names the group's owner.
66 Any user can create such groups.
67 <P><LI><I>prefix-less</I>, which do not have an owner prefix. Only
68 members of the <B>system:administrators</B> group can create
69 prefix-less groups.
70 </UL>
71 <P>Creating a group lowers the issuer's group-creation quota by
72 one. This is true even if the <B>-owner</B> argument is used to
73 assign ownership to an alternate user or group. To display a
74 user's group-creation quota, use the <B>pts examine</B> command;
75 to set it, use the <B>pts setfields</B> command.
76 <P>AFS group ID (AFS GID) numbers are negative integers and by default the
77 Protection Server assigns a GID that is one less (more negative) than the
78 current value of the <TT>max group id</TT> counter in the Protection
79 Database, decrementing the counter by one for each group. Members of
80 the <B>system:administrators</B> group can use the <B>-id</B>
81 argument to assign specific AFS GID numbers. If any of the specified
82 GIDs is lower (more negative) than the current value of the <TT>max group
83 id</TT> counter, the counter is reset to that value. It is acceptable
84 to specify a GID greater (less negative) than the current value of the
85 counter, but the creation operation fails if an existing group already has
86 it. To display or set the value of the <TT>max group id</TT> counter,
87 use the <B>pts listmax</B> or <B>pts setmax</B> command,
88 respectively.
89 <P><STRONG>Output</STRONG>
90 <P>The command generates the following string to confirm creation of each
91 group:
92 <PRE>   group <VAR>name</VAR> has id <VAR>AFS GID</VAR>
93    
94 </PRE>
95 <P><STRONG>Cautions</STRONG>
96 <P>Although using the <B>-owner</B> argument to designate a machine entry
97 as a group's owner does not generate an error, it is not
98 recommended. The Protection Server does not extend the usual privileges
99 of group ownership to users logged onto the machine.
100 <P><STRONG>Options</STRONG>
101 <DL>
102 <P><DT><B>-name
103 </B><DD>Specifies the name of each group to create. Provide a string of up
104 to 63 characters, which can include lowercase (but not uppercase) letters,
105 numbers, and punctuation marks. A regular name includes a single colon
106 (<B>:</B>) to separate the two parts of the name; the colon
107 cannot appear in a prefix-less group name.
108 <P>A regular group's name must have the following format:
109 <PRE>   <VAR>owner_name</VAR><B>:</B><VAR>group_name</VAR>
110    
111 </PRE>
112 <P>and the <VAR>owner_name</VAR> field must reflect the actual owner of the
113 group, as follows: 
114 <UL>
115 <P><LI>If the optional <B>-owner</B> argument is not included, the field must
116 match the AFS username under which the issuer is currently
117 authenticated.
118 <P><LI>If the <B>-owner</B> argument names an alternate AFS user, the field
119 must match that AFS username.
120 <P><LI>If the <B>-owner</B> argument names another regular group, the field
121 must match the owning group's owner field (the part of its name before
122 the colon). If the <B>-owner</B> argument names a prefix-less
123 group, the field must match the owning group's complete name.
124 </UL>
125 <P><DT><B>-owner
126 </B><DD>Specifies a user or group as the owner for each group, rather than the
127 issuer of the command. Provide either an AFS username or the name of a
128 regular or prefix-less group. An owning group must already have at
129 least one member. This requirement prevents assignment of
130 self-ownership to a group during its creation; use the <B>pts
131 chown</B> command after issuing this command, if desired.
132 <P><DT><B>-id
133 </B><DD>Specifies a negative integer AFS GID number for each group, rather than
134 allowing the Protection Server to assign it. Precede the integer with a
135 hyphen (<B>-</B>) to indicate that it is negative.
136 <P>If this argument is used and the <B>-name</B> argument names multiple
137 new groups, it is best to provide an equivalent number of AFS GIDs. The
138 first GID is assigned to the first group, the second to the second group, and
139 so on. If there are fewer GIDs than groups, the Protection Server
140 assigns GIDs to the unmatched groups based on the <TT>max group id</TT>
141 counter. If there are more GIDs than groups, the excess GIDs are
142 ignored. If any of the GIDs is lower (more negative) than the current
143 value of the <TT>max group id</TT> counter, the counter is reset to that
144 value.
145 <P><DT><B>-cell
146 </B><DD>Names the cell in which to run the command. For more details, see
147 the introductory <B>pts</B> reference page.
148 <P><DT><B>-noauth
149 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
150 issuer. For more details, see the introductory <B>pts</B> reference
151 page.
152 <P><DT><B>-force
153 </B><DD>Enables the command to continue executing as far as possible when errors
154 or other problems occur, rather than halting execution at the first
155 error.
156 <P><DT><B>-help
157 </B><DD>Prints the online help for this command. All other valid options
158 are ignored.
159 </DL>
160 <P><STRONG>Examples</STRONG>
161 <P>In the following example, the user <B>pat</B> creates groups called
162 <B>pat:friends</B> and <B>pat:colleagues</B>.
163 <PRE>   % <B>pts creategroup -name pat:friends pat:colleagues</B>
164    
165 </PRE>
166 <P>The following example shows a member of the
167 <B>system:administrators</B> group creating the prefix-less group
168 <B>staff</B> and assigning its ownership to the
169 <B>system:administrators</B> group rather than to herself.
170 <PRE>   % <B>pts creategroup -name staff -owner system:administrators</B>
171    
172 </PRE>
173 <P>In the following example, the user <B>pat</B> creates a group called
174 <B>smith:team-members</B>, which is allowed because the
175 <B>-owner</B> argument specifies the required value
176 (<B>smith</B>). 
177 <PRE>   % <B>pts creategroup -name smith:team-members -owner smith</B>
178    
179 </PRE>
180 <P><STRONG>Privilege Required</STRONG>
181 <P>The issuer must belong to the <B>system:administrators</B> group
182 to create prefix-less groups or include the <B>-id</B> argument.
183 <P>To create a regular group, the issuer must
184 <UL>
185 <P><LI>Be authenticated. The command fails if the <B>-noauth</B> flag
186 is provided.
187 <P><LI>Have a group-creation quota greater than zero. The <B>pts
188 examine</B> command displays this quota.
189 </UL>
190 <P><STRONG>Related Information</STRONG>
191 <P><A HREF="auarf210.htm#HDRPTS_INTRO">pts</A>
192 <P><A HREF="auarf217.htm#HDRPTS_EXAMINE">pts examine</A>
193 <P><A HREF="auarf220.htm#HDRPTS_LISTMAX">pts listmax</A>
194 <P><A HREF="auarf225.htm#HDRPTS_SETFIELDS">pts setfields</A>
195 <P><A HREF="auarf226.htm#HDRPTS_SETMAX">pts setmax</A>
196 <P>
197 <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="auarf213.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="auarf215.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> 
198 <!-- Begin Footer Records  ========================================== -->
199 <P><HR><B> 
200 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
201 </B> 
202 <!-- End Footer Records  ============================================ -->
203 <A NAME="Bot_Of_Page"></A>
204 </BODY></HTML>