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