man-page-fileserver-update-20080311
[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
30 inoperative. See the I<IBM AFS Release Notes> for details.
31
32 =head1 OPTIONS
33
34 =over 4
35
36 =item B<-dbmfile> <I<dbmfile to use>>
37
38 Specifies the pathname of the file to display. Provide either a complete
39 pathname, a pathname relative to the F</usr/afs/logs> directory, or a
40 filename only, in which case the file must reside in the F</usr/afs/logs>
41 directory. Omit this argument to display information from the
42 F<AuthLog.dir> and F<AuthLog.pag> files in the F</usr/afs/logs> directory.
43
44 =item B<-key> <I<extract entries that match specified key>>
45
46 Specifies each entry to be displayed from the indicated file.
47
48 =item B<-help>
49
50 Prints the online help for this command. All other valid options are
51 ignored.
52
53 =back
54
55 =head1 OUTPUT
56
57 The first line of output indicates the location of the files from which
58 the subsequent information is derived:
59
60    Printing all entries found in <file_location>
61
62 Each entry then includes the following two fields, separated by a colon:
63
64 =over 4
65
66 =item user/server
67
68 Identifies the user requesting the corresponding service and the server
69 that performed that service. In cases where no user is directly involved,
70 only the server appears; in cases where no server is directly involved,
71 only the user appears.
72
73 =item service
74
75 Identifies one of the following actions or services performed by the user
76 or server process.
77
78 =over 4
79
80 =item *
81
82 C<auth>: Obtained a ticket-granting ticket.
83
84 =item *
85
86 C<chp>: Changed a user password.
87
88 =item *
89
90 C<cruser>: Created a user entry in the Authentication Database.
91
92 =item *
93
94 C<delu>: Deleted a user entry from the Authentication Database.
95
96 =item *
97
98 C<gtck>: Obtained a ticket other than a ticket-granting ticket.
99
100 =item *
101
102 C<setf>: Set fields in an Authentication Database entry.
103
104 =item *
105
106 C<unlok>: Unlocked an Authentication Database entry.
107
108 =back
109
110 =back
111
112 The final line of output sums the number of entries.
113
114 =head1 EXAMPLES
115
116 The following example shows the output of the B<kdb> command in the ABC
117 Corporation cell (C<abc.com>):
118
119    % kdb
120    Printing all entries found in /usr/afs/logs/AuthLog
121    admin,krbtgt.ABC.COM:auth
122    admin,afs:gtck
123    admin:cruser
124    admin:delu
125    4 entries were found
126
127 =head1 PRIVILEGE REQUIRED
128
129 The issuer must be logged in as the local superuser C<root>.
130
131 =head1 SEE ALSO
132
133 L<AuthLog.dir(5)>,
134 L<bos_getlog(8)>,
135 L<kaserver(8)>
136
137 =head1 COPYRIGHT
138
139 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
140
141 This documentation is covered by the IBM Public License Version 1.0.  It was
142 converted from HTML to POD by software written by Chas Williams and Russ
143 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.