1KEA-LFC(8) Kea KEA-LFC(8)
2
6 kea-lfc - Lease File Cleanup process in Kea
7
9 kea-lfc [-4|-6] [-c config-file] [-p pid-file] [-x previous-file]
10 [-i copy-file] [-o output-file] [-f finish-file] [-v] [-V] [-W]
11 [-d] [-h]
12
14 The kea-lfc service process removes redundant information from the
15 files used to provide persistent storage for the memfile data base
16 backend. The service is written to run as a stand alone process. While
17 it can be started externally, there is usually no need to do this. It
18 will be run on a periodic basis by the Kea DHCP servers.
19
21 The arguments are as follows:
22 -d
24 Verbose mode sets the logging level to debug. This is primarily for
25 development purposes in stand-alone mode.
26 -v
28 version causes the version stamp to be printed.
29 -V
31 Version causes a longer form of the version stamp to be printed.
32 -W
34 Display the configuration report.
35 -h
37 Help causes the usage string to be printed.
38 -4 | -6
40 The protocol version of the lease files, must be one of 4 or 6.
41 -c
43 Configuration file including the configuration for kea-lfc process.
44 It may also contain configuration entries for other Kea services.
45 Currently kea-lfc gets all of its arguments from the command line,
46 in the future it will be extended to get some arguments from the
47 config file.
48 -p
50 PID file - When the kea-lfc process starts it attempts to determine
51 if another instance of the process is already running by examining
52 the pid file. If one is already running the new process is
53 terminated. If one isn't running it writes its pid into the pid
54 file.
55 -x
57 Previous or ex lease file - When kea-lfc starts this is the result
58 of any previous run of kea-lfc. When kea-lfc finishes it is the
59 result of this run. If kea-lfc is interrupted before completing,
60 this file may not exist.
61 -i
63 Input or copy of lease file - Before the DHCP server invokes
64 kea-lfc it will move the current lease file here and then call
65 kea-lfc with this file.
66 -o
68 Output lease file - The temporary file kea-lfc should use to write
69 the leases. Upon completion of writing this this file it will be
70 moved to the finish file (see below).
71 -f
73 Finish or completion file - Another temporary file kea-lfc uses for
74 bookkeeping. When kea-lfc completes writing the output file it
75 moves it to this file name. After kea-lfc finishes deleting the
76 other files (previous and input) it moves this file to previous
77 lease file. By moving the files in this fashion the kea-lfc and the
78 DHCP server processes can determine the correct file to use even if
79 one of the processes was interrupted before completing its task.
80
82 Kea comes with an extensive Kea User's Guide documentation that covers
83 all aspects of running the Kea software - compilation, installation,
84 configuration, configuration examples and many more. Kea also features
85 a Kea Messages Manual, which lists all possible messages Kea can print
86 with a brief description for each of them. Both documents are typically
87 available in various formats (txt, html, pdf) with your Kea
88 distribution. The Kea documentation is available at
89 https://kb.isc.org/docs/kea-administrator-reference-manual .
90 Kea source code is documented in the Kea Developer's Guide. Its on-line
92 version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/.
93 Kea project website is available at: https://kea.isc.org.
95
97 There are two mailing lists available for Kea project. kea-users
98 (kea-users at lists.isc.org) is intended for Kea users, while kea-dev
99 (kea-dev at lists.isc.org) is intended for Kea developers, prospective
100 contributors and other advanced users. Both lists are available at
101 http://lists.isc.org. The community provides best effort type of
102 support on both of those lists.
103 ISC provides professional support for Kea services. See
105 https://www.isc.org/kea/ for details.
106
108 The kea-lfc process was first coded in January 2015 by the ISC Kea/DHCP
109 team.
110
112 kea-dhcp4(8), kea-dhcp6(8), kea-dhcp-ddns(8), kea-ctrl-agent(8), kea-
113 admin(8), kea-netconf(8), keactrl(8), perfdhcp(8), Kea Administrator's
114 Guide.
115
117 The Kea software has been written by a number of engineers working
118 for ISC: Tomek Mrugalski, Stephen Morris, Marcin Siodelski, Thomas
119 Markwalder, Francis Dupont, Jeremy C. Reed, Wlodek Wencel and Shawn
120 Routhier. That list is roughly in the chronological order in which
121 the authors made their first contribution. For a complete list of
122 authors and contributors, see AUTHORS file.
123
125 Copyright © 2015-2018 Internet Systems Consortium, Inc. ("ISC")
126ISC Kea 1.5.0 Dec 14, 2018 KEA-LFC(8)