Merge 1.8.0~pre4 packaging into master
[pkg-k5-afs_openafs.git] / doc / man-pages / pod8 / kas_delete.pod
blob9596d386051ce3484b317e57bb1f0c9c3b143efb
1 =head1 NAME
3 kas_delete - Deletes an entry from the Authentication Database
5 =head1 SYNOPSIS
7 =for html
8 <div class="synopsis">
10 B<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>]
16 B<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>]
21 B<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>]
26 =for html
27 </div>
29 =head1 DESCRIPTION
31 The B<kas delete> command removes from the Authentication Database the
32 user entry named by the B<-name> argument. The indicated user becomes
33 unable to log in, or the indicated server becomes unreachable (because the
34 Authentication Server's Ticket Granting Service module no longer has a key
35 with which to seal tickets for the server).
37 =head1 OPTIONS
39 =over 4
41 =item B<-name> <I<name of user>>
43 Names the Authentication Database entry to delete.
45 =item B<-admin_username> <I<admin principal>>
47 Specifies the user identity under which to authenticate with the
48 Authentication Server for execution of the command. For more details, see
49 L<kas(8)>.
51 =item B<-password_for_admin> <I<admin password>>
53 Specifies the password of the command's issuer. If it is omitted (as
54 recommended), the B<kas> command interpreter prompts for it and does not
55 echo it visibly. For more details, see L<kas(8)>.
57 =item B<-cell> <I<cell name>>
59 Names the cell in which to run the command. For more details, see
60 L<kas(8)>.
62 =item B<-servers> <I<authentication servers>>+
64 Names each machine running an Authentication Server with which to
65 establish a connection. For more details, see L<kas(8)>.
67 =item B<-noauth>
69 Assigns the unprivileged identity C<anonymous> to the issuer. For more
70 details, see L<kas(8)>.
72 =item B<-help>
74 Prints the online help for this command. All other valid options are
75 ignored.
77 =back
79 =head1 EXAMPLES
81 The following example shows the administrative user C<admin> entering
82 interactive mode to delete three accounts.
84    % kas
85    Password for admin:
86    ka> delete smith
87    ka> delete pat
88    ka> delete terry
90 =head1 PRIVILEGE REQUIRED
92 The issuer must have the C<ADMIN> flag set on his or her Authentication
93 Database entry.
95 =head1 SEE ALSO
97 L<kas(8)>,
98 L<kas_create(8)>
100 =head1 COPYRIGHT
102 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
104 This documentation is covered by the IBM Public License Version 1.0.  It was
105 converted from HTML to POD by software written by Chas Williams and Russ
106 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.