ca039cf26ba159e14c460b3dd026382e89257509
[openafs.git] / doc / man-pages / pod8 / kdb.pod
1 =head1 NAME
2
3 kdb - Displays log or privileged actions performed by the Authentication Server
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<kdb> S<<< [B<-dbmfile> <I<dbmfile to use (default /usr/afs/logs/AuthLog)>>] >>>
11     S<<< [B<-key> <I<extract entries that match specified key>>] >>> [B<-help>]
12
13 =for html
14 </div>
15
16 =head1 DESCRIPTION
17
18 The B<kdb> command displays the contents of the F<AuthLog.dir> and
19 F<AuthLog.pag> files associated with the F<AuthLog> file that resides on
20 the local disk, by default in the F</usr/afs/logs> directory. The files
21 must exist in that directory, which normally implies that the
22 Authentication Server is running on the machine. The files contain
23 information on privileged actions performed by the Authentication Server.
24
25 =head1 CAUTIONS
26
27 It is possible that on some operating systems that AFS otherwise supports,
28 the Authentication Server cannot create the F</usr/afs/logs/AuthLog.dir>
29 and F</usr/afs/logs/AuthLog.pag> files, making this command inoperative.
30
31 =head1 OPTIONS
32
33 =over 4
34
35 =item B<-dbmfile> <I<dbmfile to use>>
36
37 Specifies the pathname of the file to display. Provide either a complete
38 pathname, a pathname relative to the F</usr/afs/logs> directory, or a
39 filename only, in which case the file must reside in the F</usr/afs/logs>
40 directory. Omit this argument to display information from the
41 F<AuthLog.dir> and F<AuthLog.pag> files in the F</usr/afs/logs> directory.
42
43 =item B<-key> <I<extract entries that match specified key>>
44
45 Specifies each entry to be displayed from the indicated file.
46
47 =item B<-help>
48
49 Prints the online help for this command. All other valid options are
50 ignored.
51
52 =back
53
54 =head1 OUTPUT
55
56 The first line of output indicates the location of the files from which
57 the subsequent information is derived:
58
59    Printing all entries found in <file_location>
60
61 Each entry then includes the following two fields, separated by a colon:
62
63 =over 4
64
65 =item user/server
66
67 Identifies the user requesting the corresponding service and the server
68 that performed that service. In cases where no user is directly involved,
69 only the server appears; in cases where no server is directly involved,
70 only the user appears.
71
72 =item service
73
74 Identifies one of the following actions or services performed by the user
75 or server process.
76
77 =over 4
78
79 =item *
80
81 C<auth>: Obtained a ticket-granting ticket.
82
83 =item *
84
85 C<chp>: Changed a user password.
86
87 =item *
88
89 C<cruser>: Created a user entry in the Authentication Database.
90
91 =item *
92
93 C<delu>: Deleted a user entry from the Authentication Database.
94
95 =item *
96
97 C<gtck>: Obtained a ticket other than a ticket-granting ticket.
98
99 =item *
100
101 C<setf>: Set fields in an Authentication Database entry.
102
103 =item *
104
105 C<unlok>: Unlocked an Authentication Database entry.
106
107 =back
108
109 =back
110
111 The final line of output sums the number of entries.
112
113 =head1 EXAMPLES
114
115 The following example shows the output of the B<kdb> command in the ABC
116 Corporation cell (C<abc.com>):
117
118    % kdb
119    Printing all entries found in /usr/afs/logs/AuthLog
120    admin,krbtgt.ABC.COM:auth
121    admin,afs:gtck
122    admin:cruser
123    admin:delu
124    4 entries were found
125
126 =head1 PRIVILEGE REQUIRED
127
128 The issuer must be logged in as the local superuser C<root>.
129
130 =head1 SEE ALSO
131
132 L<AuthLog.dir(5)>,
133 L<bos_getlog(8)>,
134 L<kaserver(8)>
135
136 =head1 COPYRIGHT
137
138 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
139
140 This documentation is covered by the IBM Public License Version 1.0.  It was
141 converted from HTML to POD by software written by Chas Williams and Russ
142 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.