db19d3269626cbbc730e9296beb837c84d2bade7
[openafs.git] / doc / man-pages / pod8 / kas_delete.pod
1 =head1 NAME
2
3 kas delete - Deletes an entry from the Authentication Database
4
5 =head1 SYNOPSIS
6
7 B<kas delete> B<-name> <I<name of user>>  
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 d> B<-na> <I<name of user>>
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 B<kas rm> B<-na> <I<name of user>>
19     [B<-a> <I<admin principal to use for authentication>>]  
20     [B<-p> <I<admin password>>] [B<-c> <I<cell name>>]  
21     [B<-s> <I<explicit list of authentication servers>>+] [B<-no>] [B<-h>]
22
23 =head1 DESCRIPTION
24
25 The B<kas delete> command removes from the Authentication Database the
26 user entry named by the B<-name> argument. The indicated user becomes
27 unable to log in, or the indicated server becomes unreachable (because the
28 Authentication Server's Ticket Granting Service module no longer has a key
29 with which to seal tickets for the server).
30
31 =head1 OPTIONS
32
33 =over 4
34
35 =item B<-name> <I<name of user>>
36
37 Names the Authentication Database entry to delete.
38
39 =item B<-admin_username> <I<admin principal>>
40
41 Specifies the user identity under which to authenticate with the
42 Authentication Server for execution of the command. For more details, see
43 L<kas(8)>.
44
45 =item B<-password_for_admin> <I<admin password>>
46
47 Specifies the password of the command's issuer. If it is omitted (as
48 recommended), the B<kas> command interpreter prompts for it and does not
49 echo it visibly. For more details, see L<kas(8)>.
50
51 =item B<-cell> <I<cell name>>
52
53 Names the cell in which to run the command. For more details, see
54 L<kas(8)>.
55
56 =item B<-servers> <I<authentication servers>>+
57
58 Names each machine running an Authentication Server with which to
59 establish a connection. For more details, see L<kas(8)>.
60
61 =item B<-noauth>
62
63 Assigns the unprivileged identity C<anonymous> to the issuer. For more
64 details, see L<kas(8)>.
65
66 =item B<-help>
67
68 Prints the online help for this command. All other valid options are
69 ignored.
70
71 =back
72
73 =head1 EXAMPLES
74
75 The following example shows the administrative user C<admin> entering
76 interactive mode to delete three accounts.
77
78    % kas
79    Password for admin:
80    ka> delete smith
81    ka> delete pat
82    ka> delete terry
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 SEE ALSO
90
91 L<kas(8)>,
92 L<kas_create(8)>
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.