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