pod-man-pages-20051015
[openafs.git] / doc / man-pages / pod / kas_unlock.pod
1 =head1 NAME
2
3 kas unlock - Unlocks a locked user account
4
5 =head1 SYNOPSIS
6
7 kas unlock B<-name> I<authentication ID>
8 [B<-admin_username> I<admin principal to use for authentication>]
9 [B<-password_for_admin> I<admin password>]  [B<-cell> I<cell name>]
10 [B<-servers> I<explicit list of authentication servers> ...]
11 [B<-noauth>]  [B<-help>]
12
13 kas u B<-na> I<authentication ID>
14 [B<-a> I<admin principal to use for authentication>]
15 [B<-p> I<admin password>]  [B<-c> I<cell name>]
16 [B<-s> I<explicit list of authentication servers> ...]  [B<-no>]  [B<-h>]
17
18 =head1 DESCRIPTION
19
20 The C<kas unlock> command unlocks the Authentication Database entry named
21 by the B<-name> argument. An entry becomes locked when the user exceeds
22 the limit on failed authentication attempts, generally by providing
23 the wrong password to either an AFS-modified login utility or the C<klog>
24 command. Use the C<kas setfields> command to set the limit and the
25 lockout time, and the C<kas examine> command to examine the settings.
26
27 To unlock all locked user accounts at once, shutdown the B<kaserver>
28 process on every database server machine, and remove the
29 B</usr/afs/local/kaauxdb> file from each one. The B<kaserver> process
30 recreates the file as it restarts.
31
32 =head1 OPTIONS
33
34 =over 4
35
36 =item B<-name> I<authentication ID>
37
38 Names the Authentication Database entry to unlock.
39
40 =item B<-admin_username> I<admin principal to use for authentication>
41
42 Specifies the user identity under which to authenticate with
43 the Authentication Server for execution of the command. For
44 more details, see the introductory L<kas(1)> reference page.
45
46 =item B<-password_for_admin> I<admin password>
47
48 Specifies the password of the command's issuer. If it is
49 omitted (as recommended), the C<kas> command interpreter prompts
50 for it and does not echo it visibly. For more details, see the
51 introductory L<kas(1)> reference page.
52
53 =item B<-cell> I<cell name>
54
55 Names the cell in which to run the command. For more details,
56 see the introductory L<kas(1)> reference page.
57
58 =item B<-servers> I<explicit list of authentication servers> ...
59
60 Names each machine running an Authentication Server with which
61 to establish a connection. For more details, see the
62 introductory L<kas(1)> reference page.
63
64 =item B<-noauth>
65
66 Assigns the unprivileged identity B<anonymous> to the issuer. For
67 more details, see the introductory L<kas(1)> reference page.
68
69 =item B<-help>
70
71 Prints the online help for this command. All other valid
72 options are ignored.
73
74 =back
75
76 =head1 EXAMPLES
77
78 In the following example, an administrator using the B<admin> account
79 unlocks the entry for B<jones>:
80
81 B<    kas unlock -name jones -admin_username admin>
82    Administrator's (admin) Password:
83
84 =head1 PRIVILEGE REQUIRED
85
86 The issuer must have the C<ADMIN> flag set on his or her Authentication
87 Database entry.
88
89 =head1 COPYRIGHT
90
91 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
92
93 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
94 and Elizabeth Cassell <e_a_c@mailsnare.net>, 2004,
95 Stanford Linear Accelerator Center, a department of Stanford University.
96
97 =head1 SEE ALSO
98
99 L<kas(1)>,
100 L<kas_examine(1)>,
101 L<kas_setfields(1)>,
102 L<klog(1)>
103
104 =cut