doc/html/AdminReference/auarf217.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="auarf216.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="auarf218.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_EXAMINE" HREF="auarf002.htm#ToC_231">pts examine</A></H2>
  19 <A NAME="IDX5303"></A>
  20 <A NAME="IDX5304"></A>
  21 <A NAME="IDX5305"></A>
  22 <A NAME="IDX5306"></A>
  23 <A NAME="IDX5307"></A>
  24 <A NAME="IDX5308"></A>
  25 <A NAME="IDX5309"></A>
  26 <A NAME="IDX5310"></A>
  27 <A NAME="IDX5311"></A>
  28 <A NAME="IDX5312"></A>
  29 <A NAME="IDX5313"></A>
  30 <A NAME="IDX5314"></A>
  31 <A NAME="IDX5315"></A>
  32 <A NAME="IDX5316"></A>
  33 <A NAME="IDX5317"></A>
  34 <A NAME="IDX5318"></A>
  35 <A NAME="IDX5319"></A>
  36 <A NAME="IDX5320"></A>
  37 <A NAME="IDX5321"></A>
  38 <A NAME="IDX5322"></A>
  39 <A NAME="IDX5323"></A>
  40 <A NAME="IDX5324"></A>
  41 <A NAME="IDX5325"></A>
  42 <A NAME="IDX5326"></A>
  43 <A NAME="IDX5327"></A>
  44 <A NAME="IDX5328"></A>
  45 <A NAME="IDX5329"></A>
  46 <A NAME="IDX5330"></A>
  47 <A NAME="IDX5331"></A>
  48 <A NAME="IDX5332"></A>
  49 <A NAME="IDX5333"></A>
  50 <A NAME="IDX5334"></A>
  51 <A NAME="IDX5335"></A>
  52 <A NAME="IDX5336"></A>
  53 <A NAME="IDX5337"></A>
  54 <A NAME="IDX5338"></A>
  55 <A NAME="IDX5339"></A>
  56 <A NAME="IDX5340"></A>
  57 <P><STRONG>Purpose</STRONG>
  58 <P>Displays a Protection Database entry
  59 <P><STRONG>Synopsis</STRONG>
  60 <PRE><B>pts examine -nameorid</B> &lt;<VAR>user&nbsp;or&nbsp;group&nbsp;name&nbsp;or&nbsp;id</VAR>><SUP>+</SUP>  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]
  61             [<B>-noauth</B>]  [<B>-force</B>]  [<B>-help</B>]
  62
  63 <B>pts e -na</B> &lt;<VAR>user&nbsp;or&nbsp;group&nbsp;name&nbsp;or&nbsp;id</VAR>><SUP>+</SUP>  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-no</B>]  [<B>-f</B>]  [<B>-h</B>]
  64
  65 <B>pts check -na</B> &lt;<VAR>user&nbsp;or&nbsp;group&nbsp;name&nbsp;or&nbsp;id</VAR>><SUP>+</SUP>  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]
  66           [<B>-no</B>]  [<B>-f</B>]  [<B>-h</B>]
  67
  68 <B>pts che -na</B> &lt;<VAR>user&nbsp;or&nbsp;group&nbsp;name&nbsp;or&nbsp;id</VAR>><SUP>+</SUP>  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]
  69         [<B>-no</B>]  [<B>-f</B>]  [<B>-h</B>]
  70 </PRE>
  71 <P><STRONG>Description</STRONG>
  72 <P>The <B>pts examine</B> command displays information from the Protection
  73 Database entry of each user, machine or group specified by the
  74 <B>-nameorid</B> argument.
  75 <P><STRONG>Options</STRONG>
  76 <DL>
  77 <P><DT><B>-nameorid
  78 </B><DD>Specifies the name or AFS UID of each user, the name or AFS GID of each
  79 group, or the IP address (complete or wildcard-style) or AFS UID of each
  80 machine for which to display the Protection Database entry. It is
  81 acceptable to mix users, machines, and groups on the same command line, as
  82 well as names (IP addresses for machines) and IDs. Precede the GID of
  83 each group with a hyphen to indicate that it is negative.
  84 <P><DT><B>-cell
  85 </B><DD>Names the cell in which to run the command. For more details, see
  86 the introductory <B>pts</B> reference page.
  87 <P><DT><B>-noauth
  88 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
  89 issuer. For more details, see the introductory <B>pts</B> reference
  90 page.
  91 <P><DT><B>-force
  92 </B><DD>Enables the command to continue executing as far as possible when errors
  93 or other problems occur, rather than halting execution at the first
  94 error.
  95 <P><DT><B>-help
  96 </B><DD>Prints the online help for this command. All other valid options
  97 are ignored.
  98 </DL>
  99 <P><STRONG>Output</STRONG>
 100 <P>The output for each entry consists of two lines that include the following
 101 fields:
 102 <DL>
 103 <P><DT><B><TT>Name</TT>
 104 </B><DD>The contents of this field depend on the type of entry:
 105 <UL>
 106 <P><LI>For a user entry, it is the username that the user types when
 107 authenticating with AFS.
 108 <P><LI>For a machine entry, it is either the IP address of a single machine in
 109 dotted decimal format, or a wildcard notation that represents a group of
 110 machines on the same network. See the <B>pts createuser</B>
 111 reference page for an explanation of the wildcard notation.
 112 <P><LI>For a group entry, it is one of two types of group name. If the
 113 name has a colon between the two parts, it represents a regular group and the
 114 part before the prefix reflects the group's owner. A prefix-less
 115 group does not have the owner field or the colon. For more details on
 116 group names, see the <B>pts creategroup</B> reference page.
 117 </UL>
 118 <A NAME="IDX5341"></A>
 119 <A NAME="IDX5342"></A>
 120 <A NAME="IDX5343"></A>
 121 <P><DT><B><TT>id</TT>
 122 </B><DD>A unique number that the AFS server processes use to identify AFS users,
 123 machines and groups. AFS UIDs for user and machine entries are positive
 124 integers, and AFS GIDs for group entries are negative integers. AFS
 125 UIDs and GIDs are similar in function to the UIDs and GIDs used in local file
 126 systems such as UFS, but apply only to AFS operations.
 127 <A NAME="IDX5344"></A>
 128 <A NAME="IDX5345"></A>
 129 <P><DT><B><TT>owner</TT>
 130 </B><DD>The user or group that owns the entry and thus can administer it (change
 131 the values in most of the fields displayed in the output of this command), or
 132 delete it entirely. The Protection Server automatically records the
 133 <B>system:administrators</B> group in this field for user and
 134 machine entries at creation time.
 135 <A NAME="IDX5346"></A>
 136 <P><DT><B><TT>creator</TT>
 137 </B><DD>The user who issued the <B>pts createuser</B> or <B>pts
 138 creategroup</B> command to create the entry. This field serves as an
 139 audit trail, and cannot be changed.
 140 <A NAME="IDX5347"></A>
 141 <P><DT><B><TT>membership</TT>
 142 </B><DD>An integer that for users and machines represents the number of groups to
 143 which the user or machine belongs. For groups, it represents the number
 144 of group members.
 145 <P><DT><B><TT>flags</TT>
 146 </B><DD>A string of five characters, referred to as <I>privacy flags</I>,
 147 which indicate who can display or administer certain aspects of the
 148 entry.
 149 <DL>
 150 <P><DT><B>s
 151 </B><DD>Controls who can issue the <B>pts examine</B> command to display the
 152 entry.
 153 <P><DT><B>o
 154 </B><DD>Controls who can issue the <B>pts listowned</B> command to display the
 155 groups that a user or group owns.
 156 <P><DT><B>m
 157 </B><DD>Controls who can issue the <B>pts membership</B> command to display
 158 the groups a user or machine belongs to, or which users or machines belong to
 159 a group.
 160 <P><DT><B>a
 161 </B><DD>Controls who can issue the <B>pts adduser</B> command to add a user or
 162 machine to a group. It is meaningful only for groups, but a value must
 163 always be set for it even on user and machine entries.
 164 <P><DT><B>r
 165 </B><DD>Controls who can issue the <B>pts removeuser</B> command to remove a
 166 user or machine from a group. It is meaningful only for groups, but a
 167 value must always be set for it even on user and machine entries.
 168 </DL>
 169 <P>
 170 <P>Each flag can take three possible types of values to enable a different set
 171 of users to issue the corresponding command:
 172 <UL>
 173 <P><LI>A hyphen (<B>-</B>) designates the members of the
 174 <B>system:administrators</B> group and the entry's
 175 owner. For user entries, it designates the user in addition.
 176 <P><LI>The lowercase version of the letter applies meaningfully to groups only,
 177 and designates members of the group in addition to the individuals designated
 178 by the hyphen.
 179 <P><LI>The uppercase version of the letter designates everyone.
 180 </UL>
 181 <P>
 182 <P>For example, the flags <TT>SOmar</TT> on a group entry indicate that
 183 anyone can examine the group's entry and display the groups that it owns,
 184 and that only the group's members can display, add, or remove its
 185 members.
 186 <P>The default privacy flags for user and machine entries are
 187 <TT>S----</TT>, meaning that anyone can display the entry. The
 188 ability to perform any other functions is restricted to members of the
 189 <B>system:administrators</B> group and the entry's owner (as
 190 well as the user for a user entry).
 191 <P>The default privacy flags for group entries are <TT>S-M--</TT>, meaning
 192 that all users can display the entry and the members of the group, but only
 193 the entry owner and members of the <B>system:administrators</B>
 194 group can perform other functions.
 195 <P><DT><B><TT>group quota</TT>
 196 </B><DD>The number of additional groups the user is allowed to create. The
 197 <B>pts createuser</B> command sets it to 20 for both users and machines,
 198 but it has no meaningful interpretation for a machine, because it is not
 199 possible to authenticate as a machine. Similarly, it has no meaning in
 200 group entries and the <B>pts creategroup</B> command sets it to 0
 201 (zero); do not change this value.
 202 <A NAME="IDX5348"></A>
 203 <A NAME="IDX5349"></A>
 204 </DL>
 205 <P><STRONG>Examples</STRONG>
 206 <P>The following example displays the user entry for <B>terry</B> and the
 207 machine entry <B>158.12.105.44</B>.
 208 <PRE>   % <B>pts examine terry 158.12.105.44</B>
 209    Name: terry, id: 1045, owner: system:administrators, creator: admin,
 210      membership: 9, flags: S----, group quota: 15.
 211    Name: 158.12.105.44, id: 5151, owner: system:administrators,
 212      creator: byu, membership: 1, flags: S----, group quota: 20.
 213
 214 </PRE>
 215 <P>The following example displays the entries for the AFS groups with GIDs
 216 -673 and -674.
 217 <PRE>   % <B>pts examine -673 -674</B>
 218    Name: terry:friends, id: -673, owner: terry, creator: terry,
 219      membership: 5, flags: S-M--, group quota: 0.
 220    Name: smith:colleagues, id: -674, owner: smith, creator: smith,
 221      membership: 14, flags: SOM--, group quota: 0.
 222
 223 </PRE>
 224 <P><STRONG>Privilege Required</STRONG>
 225 <P>The required privilege depends on the setting of the first privacy flag in
 226 the Protection Database entry of each entry specified by the
 227 <B>-nameorid</B> argument:
 228 <UL>
 229 <P><LI>If it is lowercase <TT>s</TT>, members of the
 230 <B>system:administrators</B> group and the user associated with a
 231 user entry can examine it, and only members of the
 232 <B>system:administrators</B> group can examine a machine or group
 233 entry.
 234 <P><LI>If it is uppercase <TT>S</TT>, anyone who can access the cell's
 235 database server machines can examine the entry.
 236 </UL>
 237 <P><STRONG>Related Information</STRONG>
 238 <P><A HREF="auarf210.htm#HDRPTS_INTRO">pts</A>
 239 <P><A HREF="auarf211.htm#HDRPTS_ADDUSER">pts adduser</A>
 240 <P><A HREF="auarf213.htm#HDRPTS_CHOWN">pts chown</A>
 241 <P><A HREF="auarf214.htm#HDRPTS_CREATEGROUP">pts creategroup</A>
 242 <P><A HREF="auarf215.htm#HDRPTS_CREATEUSER">pts createuser</A>
 243 <P><A HREF="auarf221.htm#HDRPTS_LISTOWNED">pts listowned</A>
 244 <P><A HREF="auarf222.htm#HDRPTS_MEMBERSHIP">pts membership</A>
 245 <P><A HREF="auarf223.htm#HDRPTS_REMOVEUSER">pts removeuser</A>
 246 <P><A HREF="auarf224.htm#HDRPTS_RENAME">pts rename</A>
 247 <P><A HREF="auarf225.htm#HDRPTS_SETFIELDS">pts setfields</A>
 248 <P>
 249 <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="auarf216.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="auarf218.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>
 250 <!-- Begin Footer Records  ========================================== -->
 251 <P><HR><B>
 252 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved
 253 </B>
 254 <!-- End Footer Records  ============================================ -->
 255 <A NAME="Bot_Of_Page"></A>
 256 </BODY></HTML>