doc/man-pages/pod1/pts_createuser.pod

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