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