ed906398dfaa39e80e1fc42292e42a8d97056863
[platform/upstream/krb5.git] / doc / admin / admin_commands / kproplog.rst
1 .. _kproplog(8):
2
3 kproplog
4 ========
5
6 SYNOPSIS
7 --------
8
9 **kproplog** [**-h**] [**-e** *num*] [-v]
10 **kproplog** [-R]
11
12
13 DESCRIPTION
14 -----------
15
16 The kproplog command displays the contents of the KDC database update
17 log to standard output.  It can be used to keep track of incremental
18 updates to the principal database.  The update log file contains the
19 update log maintained by the :ref:`kadmind(8)` process on the master
20 KDC server and the :ref:`kpropd(8)` process on the slave KDC servers.
21 When updates occur, they are logged to this file.  Subsequently any
22 KDC slave configured for incremental updates will request the current
23 data from the master KDC and update their log file with any updates
24 returned.
25
26 The kproplog command requires read access to the update log file.  It
27 will display update entries only for the KDC it runs on.
28
29 If no options are specified, kproplog displays a summary of the update
30 log.  If invoked on the master, kproplog also displays all of the
31 update entries.  If invoked on a slave KDC server, kproplog displays
32 only a summary of the updates, which includes the serial number of the
33 last update received and the associated time stamp of the last update.
34
35
36 OPTIONS
37 -------
38
39 **-R**
40     Reset the update log.  This forces full resynchronization.  If used
41     on a slave then that slave will request a full resync.  If used on
42     the master then all slaves will request full resyncs.
43
44 **-h**
45     Display a summary of the update log.  This information includes
46     the database version number, state of the database, the number of
47     updates in the log, the time stamp of the first and last update,
48     and the version number of the first and last update entry.
49
50 **-e** *num*
51     Display the last *num* update entries in the log.  This is useful
52     when debugging synchronization between KDC servers.
53
54 **-v**
55     Display individual attributes per update.  An example of the
56     output generated for one entry::
57
58         Update Entry
59            Update serial # : 4
60            Update operation : Add
61            Update principal : test@EXAMPLE.COM
62            Update size : 424
63            Update committed : True
64            Update time stamp : Fri Feb 20 23:37:42 2004
65            Attributes changed : 6
66                  Principal
67                  Key data
68                  Password last changed
69                  Modifying principal
70                  Modification time
71                  TL data
72
73
74 ENVIRONMENT
75 -----------
76
77 kproplog uses the following environment variables:
78
79 * **KRB5_KDC_PROFILE**
80
81
82 SEE ALSO
83 --------
84
85 :ref:`kpropd(8)`