viced-multiple-ports-per-client-20051208
[openafs.git] / doc / man-pages / pod / kas_create.pod
1 =head1 NAME
2
3 kas create - Creates an entry in the Authentication Database
4
5 =head1 SYNOPSIS
6
7 kas create S<B<-name> I<name of user>>
8 S<[B<-initial_password> I<initial password>]>
9 S<[B<-admin_username> I<admin principal to use for authentication>]>
10 S<[B<-password_for_admin> I<admin password>]>
11 S<[B<-cell> I<cell name>]>
12 S<[B<-servers> I<explicit list of authentication servers> ...]>
13 [B<-noauth>]  [B<-help>]
14
15 kas c B<-na> I<name of user> S<[B<-i> I<initial password>]>
16 S<[B<-a> I<admin principal to use for authentication>]>
17 S<[B<-p> I<admin password>]> S<[B<-c> I<cell name>]>
18 S<[B<-s> I<explicit list of authentication servers> ...]>  [B<-no>]  [B<-h>]
19
20 =head1 DESCRIPTION
21
22 The C<kas create> command creates an entry in the Authentication Database
23 for the user named by the B<-name> argument.
24
25 To avoid having the account's initial password echo visibly at the
26 shell prompt, omit the B<-initial_password> argument; the command
27 interpreter prompts for the password and does not echo it visibly.
28 Whether or not B<-initial_password> is omitted, the Authentication Server
29 converts the password into a form suitable for use as an encryption
30 key, and records it in the entry's key field.
31
32 To alter settings in an Authentication Database entry, use the C<kas
33 setfields> command. To examine an entry, use the C<kas examine> command.
34 To list every entry in the database, use the C<kas list> command.
35
36 =head1 OPTIONS
37
38 =over 4
39
40 =item B<-name> I<name of user>
41
42 Names the new Authentication Database entry. Because it is the
43 name under which the user logs in, it must obey the
44 restrictions that many operating systems impose on user names
45 (usually, to contain no more than eight lowercase letters).
46
47 =item B<-initial_password> I<initial password>
48
49 Sets the user's password; provide a character string that can
50 include uppercase and lowercase letters, numerals and
51 punctuation. The Authentication Server scrambles the string
52 into an octal string suitable for use as an encryption key
53 before placing it in the entry's key field. If this argument is
54 omitted, the command interpreter prompts for the string and
55 does not echo it visibly.
56
57 =item B<-admin_username> I<admin principal to use for authentication>
58
59 Specifies the user identity under which to authenticate with
60 the Authentication Server for execution of the command. For
61 more details, see the introductory L<kas(1)> reference page.
62
63 =item B<-password_for_admin> I<admin password>
64
65 Specifies the password of the command's issuer. If it is
66 omitted (as recommended), the C<kas> command interpreter prompts
67 for it and does not echo it visibly. For more details, see the
68 introductory L<kas(1)> reference page.
69
70 =item B<-cell> I<cell name>
71
72 Names the cell in which to run the command. For more details,
73 see the introductory L<kas(1)> reference page.
74
75 =item B<-servers> I<explicit list of authentication servers> ...
76
77 Names each machine running an Authentication Server with which
78 to establish a connection. For more details, see the
79 introductory L<kas(1)> reference page.
80
81 =item B<-noauth>
82
83 Assigns the unprivileged identity B<anonymous> to the issuer. For
84 more details, see the introductory L<kas(1)> reference page.
85
86 =item B<-help>
87
88 Prints the online help for this command. All other valid
89 options are ignored.
90
91 =back
92
93 =head1 EXAMPLES
94
95 The following example shows the prompts that appear when an
96 administrator logged in as B<admin> creates an Authentication Database
97 entry for the user B<smith>, and does not include either the
98 B<-initial_password> or B<-password_for_admin arguments>.
99
100     kas create smith
101    Password for admin:
102    initial_password:
103    Verifying, please re-enter initial_password:
104
105 =head1 PRIVILEGE REQUIRED
106
107 The issuer must have the C<ADMIN> flag set on his or her Authentication
108 Database entry.
109
110 =head1 COPYRIGHT
111
112 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
113
114 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
115 and Elizabeth Cassell <e_a_c@mailsnare.net>, 2004,
116 Stanford Linear Accelerator Center, a department of Stanford University.
117
118 =head1 SEE ALSO
119
120 L<kas(1)>,
121 L<kas_examine(1)>,
122 L<kas_list(1)>,
123 L<kas_setfields(1)>
124
125 =cut