36e695b0806f63314fc1f61d76bce6b1b7ef3e76
[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 B<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 B<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 B<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 the
23 wrong password to either an AFS-modified login utility or the B<klog>
24 command. Use the B<kas setfields> command to set the limit and the lockout
25 time, and the B<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 F</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>>
41
42 Specifies the user identity under which to authenticate with the
43 Authentication Server for execution of the command. For more details, see
44 L<kas(8)>.
45
46 =item B<-password_for_admin> <I<admin password>>
47
48 Specifies the password of the command's issuer. If it is omitted (as
49 recommended), the B<kas> command interpreter prompts for it and does not
50 echo it visibly. For more details, see L<kas(8)>.
51
52 =item B<-cell> <I<cell name>>
53
54 Names the cell in which to run the command. For more details, see
55 L<kas(8)>.
56
57 =item B<-servers> <I<authentication servers>>+
58
59 Names each machine running an Authentication Server with which to
60 establish a connection. For more details, see L<kas(8)>.
61
62 =item B<-noauth>
63
64 Assigns the unprivileged identity C<anonymous> to the issuer. For more
65 details, see L<kas(8)>.
66
67 =item B<-help>
68
69 Prints the online help for this command. All other valid options are
70 ignored.
71
72 =back
73
74 =head1 EXAMPLES
75
76 In the following example, an administrator using the C<admin> account
77 unlocks the entry for C<jones>:
78
79    % kas unlock -name jones -admin_username admin
80    Administrator's (admin) Password:
81
82 =head1 PRIVILEGE REQUIRED
83
84 The issuer must have the C<ADMIN> flag set on his or her Authentication
85 Database entry.
86
87 =head1 SEE ALSO
88
89 L<kas(8)>,
90 L<kas_examine(8)>,
91 L<kas_setfields(8)>,
92 L<klog(1)>
93
94 =head1 COPYRIGHT
95
96 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
97
98 This documentation is covered by the IBM Public License Version 1.0.  It was
99 converted from HTML to POD by software written by Chas Williams and Russ
100 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.