1KEA-LFC(8)                            Kea                           KEA-LFC(8)
2
3
4

NAME

6       kea-lfc - Lease File Cleanup process in Kea
7

SYNOPSIS

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]  [-d]
11       [-h]
12

DESCRIPTION

14       The  kea-lfc  service  process  removes  redundant information from the
15       files used to provide persistent storage for the memfile database back‐
16       end.  The  service is written to run as a stand-alone process. While it
17       can be started externally, there is usually no need to do this.  It  is
18       run periodically by the Kea DHCP servers.
19

ARGUMENTS

21       The arguments are as follows:
22
23       -4 | -6
24              Indicates  the  protocol version of the lease files; must be ei‐
25              ther 4 or 6.
26
27       -c config-file
28              Specifies the  file  with  the  configuration  for  the  kea-lfc
29              process. It may also contain configuration entries for other Kea
30              services. Currently kea-lfc gets all of its arguments  from  the
31              command  line;  in the future it will be extended to obtain some
32              arguments from the configuration file.
33
34       -p pid-file
35              Specifies the PID file. When the kea-lfc process starts, it  at‐
36              tempts  to  determine  if another instance of the process is al‐
37              ready running by examining the PID file. If one is already  run‐
38              ning,  the new process is terminated. If one is not running, Kea
39              writes its PID into the PID file.
40
41       -x previous-file
42              Specifies the previous or ex-lease file.  When  kea-lfc  starts,
43              this  is the result of any previous run of kea-lfc; when kea-lfc
44              finishes, it is the result of this run.  If  kea-lfc  is  inter‐
45              rupted before completing, this file may not exist.
46
47       -i copy-file
48              Specifies  the  input  or  copy  of  lease file. Before the DHCP
49              server invokes kea-lfc, it will move the current lease file here
50              and then call kea-lfc with this file.
51
52       -o output-file
53              Specifies  the  output  lease  file, which is the temporary file
54              kea-lfc should use to write the leases. Once this file  is  fin‐
55              ished writing, it is moved to the finish file (see below).
56
57       -f finish-file
58              Specifies  the finish or completion file, another temporary file
59              kea-lfc uses for bookkeeping. When kea-lfc finishes writing  the
60              output  file,  it moves it to this file name. After kea-lfc fin‐
61              ishes deleting the other files (previous and  input),  it  moves
62              this  file  to  the  previous lease file. By moving the files in
63              this fashion, the kea-lfc and the DHCP server processes can  de‐
64              termine the correct file to use even if one of the processes was
65              interrupted before completing its task.
66
67       -v     Causes the version stamp to be printed.
68
69       -V     Causes a longer form of the version stamp to be printed.
70
71       -W     Displays the configuration report.
72
73       -d     Sets the logging level to debug with extra  verbosity.  This  is
74              primarily for development purposes in stand-alone mode.
75
76       -h     Causes the usage string to be printed.
77

DOCUMENTATION

79       Kea  comes  with  an  extensive Kea Administrator Reference Manual that
80       covers all aspects of running the Kea software - compilation, installa‐
81       tion,  configuration,  configuration  examples, and much more. Kea also
82       features a Kea Messages Manual, which lists all possible  messages  Kea
83       can print with a brief description for each of them. Both documents are
84       available in various formats (.txt, .html, .pdf) with the Kea distribu‐
85       tion. The Kea documentation is available at https://kea.readthedocs.io.
86
87       Kea  source code is documented in the Kea Developer's Guide. Its online
88       version is available at https://reports.kea.isc.org/dev_guide/.
89
90       The Kea project website is available at https://kea.isc.org.
91

MAILING LISTS AND SUPPORT

93       There are two public mailing  lists  available  for  the  Kea  project.
94       kea-users (kea-users at lists.isc.org) is intended for Kea users, while
95       kea-dev (kea-dev at lists.isc.org)  is  intended  for  Kea  developers,
96       prospective  contributors,  and  other  advanced  users. Both lists are
97       available at https://lists.isc.org. The community provides  best-effort
98       support on both of those lists.
99
100       ISC    provides    professional   support   for   Kea   services.   See
101       https://www.isc.org/kea/ for details.
102

HISTORY

104       The kea-lfc process was first coded in January 2015 by the ISC Kea/DHCP
105       team.
106

SEE ALSO

108       kea-dhcp4(8),    kea-dhcp6(8),   kea-dhcp-ddns(8),   kea-ctrl-agent(8),
109       kea-admin(8), keactrl(8), perfdhcp(8), kea-netconf(8), Kea  Administra‐
110       tor Reference Manual.
111

AUTHOR

113       Internet Systems Consortium
114

116       2019-2022, Internet Systems Consortium
117
118
119
120
1212.0.2                            Mar 03, 2022                       KEA-LFC(8)
Impressum