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.
32
33       -p pid-file
34              Specifies  the PID file. When the kea-lfc process starts, it at‐
35              tempts to determine if another instance of the  process  is  al‐
36              ready running, by examining the PID file. If one is already run‐
37              ning, the new process is terminated. If one is not running,  Kea
38              writes its PID into the PID file.
39
40       -x previous-file
41              Specifies  the  previous  or ex-lease file. When kea-lfc starts,
42              this is the result of any previous run of kea-lfc; when  kea-lfc
43              finishes, it is the result of the current run. If kea-lfc is in‐
44              terrupted before completing, this file may not exist.
45
46       -i copy-file
47              Specifies the input or copy  of  lease  file.  Before  the  DHCP
48              server invokes kea-lfc, it moves the current lease file here and
49              then calls kea-lfc with this file.
50
51       -o output-file
52              Specifies the output lease file, which  is  the  temporary  file
53              kea-lfc  should  use to write the leases. Once this file is fin‐
54              ished writing, it is moved to the finish file (see below).
55
56       -f finish-file
57              Specifies the finish or completion file, another temporary  file
58              kea-lfc  uses for bookkeeping. When kea-lfc finishes writing the
59              output file, it moves it to this file name. After  kea-lfc  fin‐
60              ishes  deleting  the  other files (previous and input), it moves
61              this file to the previous lease file. By  moving  the  files  in
62              this  fashion, the kea-lfc and the DHCP server processes can de‐
63              termine the correct file to use even if one of the processes was
64              interrupted before completing its task.
65
66       -v     Causes the version stamp to be printed.
67
68       -V     Causes a longer form of the version stamp to be printed.
69
70       -W     Displays the configuration report.
71
72       -d     Sets  the  logging  level to debug with extra verbosity. This is
73              primarily for development purposes in stand-alone mode.
74
75       -h     Causes the usage string to be printed.
76

DOCUMENTATION

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

MAILING LISTS AND SUPPORT

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

HISTORY

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

SEE ALSO

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

AUTHOR

112       Internet Systems Consortium
113

115       2019-2022, Internet Systems Consortium
116
117
118
119
1202.2.0                            Jul 27, 2022                       KEA-LFC(8)
Impressum