backport to buster
[hcoop/debian/openafs.git] / doc / man-pages / pod8 / kas_delete.pod
CommitLineData
805e021f
CE
1=head1 NAME
2
3kas_delete - Deletes an entry from the Authentication Database
4
5=head1 SYNOPSIS
6
7=for html
8<div class="synopsis">
9
10B<kas delete> S<<< B<-name> <I<name of user>> >>>
11 S<<< [B<-admin_username> <I<admin principal to use for authentication>>] >>>
12 S<<< [B<-password_for_admin> <I<admin password>>] >>> S<<< [B<-cell> <I<cell name>>] >>>
13 S<<< [B<-servers> <I<explicit list of authentication servers>>+] >>>
14 [B<-noauth>] [B<-help>]
15
16B<kas d> S<<< B<-na> <I<name of user>> >>>
17 S<<< [B<-a> <I<admin principal to use for authentication>>] >>>
18 S<<< [B<-p> <I<admin password>>] >>> S<<< [B<-c> <I<cell name>>] >>>
19 S<<< [B<-s> <I<explicit list of authentication servers>>+] >>> [B<-no>] [B<-h>]
20
21B<kas rm> S<<< B<-na> <I<name of user>> >>>
22 S<<< [B<-a> <I<admin principal to use for authentication>>] >>>
23 S<<< [B<-p> <I<admin password>>] >>> S<<< [B<-c> <I<cell name>>] >>>
24 S<<< [B<-s> <I<explicit list of authentication servers>>+] >>> [B<-no>] [B<-h>]
25
26=for html
27</div>
28
29=head1 DESCRIPTION
30
31The B<kas delete> command removes from the Authentication Database the
32user entry named by the B<-name> argument. The indicated user becomes
33unable to log in, or the indicated server becomes unreachable (because the
34Authentication Server's Ticket Granting Service module no longer has a key
35with which to seal tickets for the server).
36
37=head1 OPTIONS
38
39=over 4
40
41=item B<-name> <I<name of user>>
42
43Names the Authentication Database entry to delete.
44
45=item B<-admin_username> <I<admin principal>>
46
47Specifies the user identity under which to authenticate with the
48Authentication Server for execution of the command. For more details, see
49L<kas(8)>.
50
51=item B<-password_for_admin> <I<admin password>>
52
53Specifies the password of the command's issuer. If it is omitted (as
54recommended), the B<kas> command interpreter prompts for it and does not
55echo it visibly. For more details, see L<kas(8)>.
56
57=item B<-cell> <I<cell name>>
58
59Names the cell in which to run the command. For more details, see
60L<kas(8)>.
61
62=item B<-servers> <I<authentication servers>>+
63
64Names each machine running an Authentication Server with which to
65establish a connection. For more details, see L<kas(8)>.
66
67=item B<-noauth>
68
69Assigns the unprivileged identity C<anonymous> to the issuer. For more
70details, see L<kas(8)>.
71
72=item B<-help>
73
74Prints the online help for this command. All other valid options are
75ignored.
76
77=back
78
79=head1 EXAMPLES
80
81The following example shows the administrative user C<admin> entering
82interactive mode to delete three accounts.
83
84 % kas
85 Password for admin:
86 ka> delete smith
87 ka> delete pat
88 ka> delete terry
89
90=head1 PRIVILEGE REQUIRED
91
92The issuer must have the C<ADMIN> flag set on his or her Authentication
93Database entry.
94
95=head1 SEE ALSO
96
97L<kas(8)>,
98L<kas_create(8)>
99
100=head1 COPYRIGHT
101
102IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
103
104This documentation is covered by the IBM Public License Version 1.0. It was
105converted from HTML to POD by software written by Chas Williams and Russ
106Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.