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