kea-lfc.xml 10.2 KB
Newer Older
1
<!--
2
 - Copyright (C) 2015-2018 Internet Systems Consortium, Inc. ("ISC")
3
 -
4 5 6
 - This Source Code Form is subject to the terms of the Mozilla Public
 - License, v. 2.0. If a copy of the MPL was not distributed with this
 - file, You can obtain one at http://mozilla.org/MPL/2.0/.
7 8
-->

9
<!-- Converted by db4-upgrade version 1.1 -->
10
<refentry>
11

12
  <info>
13
    <productname>ISC Kea</productname>
14 15
    <date>Nov 9, 2018</date>
    <edition>1.5.0-beta</edition>
16
    <author><personname/><contrib>The Kea software has been written by a number of
17 18 19 20 21
        engineers working for ISC: Tomek Mrugalski, Stephen Morris, Marcin
        Siodelski, Thomas Markwalder, Francis Dupont, Jeremy C. Reed,
        Wlodek Wencel and Shawn Routhier.  That list is roughly in the
        chronological order in which the authors made their first
        contribution. For a complete list of authors and
22 23
        contributors, see AUTHORS file.</contrib><orgname>Internet Systems Consortium, Inc.</orgname></author>
  </info>
24 25 26 27

  <refmeta>
    <refentrytitle>kea-lfc</refentrytitle>
    <manvolnum>8</manvolnum>
28
    <refmiscinfo class="manual">Kea</refmiscinfo>
29 30 31 32 33 34 35 36 37
  </refmeta>

  <refnamediv>
    <refname>kea-lfc</refname>
    <refpurpose>Lease File Cleanup  process in Kea</refpurpose>
  </refnamediv>

  <docinfo>
    <copyright>
38
      <year>2015-2018</year>
39 40 41 42 43
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
    </copyright>
  </docinfo>

  <refsynopsisdiv>
44
    <cmdsynopsis sepchar=" ">
45
      <command>kea-lfc</command>
46 47 48 49 50 51 52 53 54 55 56 57
      <arg choice="opt" rep="norepeat"><option>-4|-6</option></arg>
      <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">config-file</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">pid-file</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-x <replaceable class="parameter">previous-file</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-i <replaceable class="parameter">copy-file</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-o <replaceable class="parameter">output-file</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-f <replaceable class="parameter">finish-file</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-v</option></arg>
      <arg choice="opt" rep="norepeat"><option>-V</option></arg>
      <arg choice="opt" rep="norepeat"><option>-W</option></arg>
      <arg choice="opt" rep="norepeat"><option>-d</option></arg>
      <arg choice="opt" rep="norepeat"><option>-h</option></arg>
58 59 60 61 62 63 64
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
    <para>
      The <command>kea-lfc</command> service process removes redundant
65
      information from the files used to provide persistent storage for
66
      the memfile data base backend.  The service is written to run as
67 68 69
      a stand alone process.  While it can be started externally, there
      is usually no need to do this.  It will be run on a periodic basis
      by the Kea DHCP servers.
70 71 72 73 74 75 76 77 78 79 80
    </para>
  </refsect1>

  <refsect1>
    <title>ARGUMENTS</title>

    <para>The arguments are as follows:</para>

    <variablelist>

      <varlistentry>
Shawn Routhier's avatar
Shawn Routhier committed
81
        <term><option>-d</option></term>
82 83 84 85 86 87
        <listitem><para>
          Verbose mode sets the logging level to debug. This is primarily
          for development purposes in stand-alone mode.
        </para></listitem>
      </varlistentry>

Shawn Routhier's avatar
Shawn Routhier committed
88 89 90 91 92 93 94 95 96 97 98 99 100 101
      <varlistentry>
        <term><option>-v</option></term>
        <listitem><para>
          version causes the version stamp to be printed.
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-V</option></term>
        <listitem><para>
          Version causes a longer form of the version stamp to be printed.
        </para></listitem>
      </varlistentry>

102 103 104 105 106 107 108
      <varlistentry>
        <term><option>-W</option></term>
        <listitem><para>
          Display the configuration report.
        </para></listitem>
      </varlistentry>

109 110 111 112 113 114 115
      <varlistentry>
        <term><option>-h</option></term>
        <listitem><para>
          Help causes the usage string to be printed.
        </para></listitem>
      </varlistentry>

Shawn Routhier's avatar
Shawn Routhier committed
116 117 118 119 120 121 122
      <varlistentry>
        <term><option>-4 | -6</option></term>
        <listitem><para>
          The protocol version of the lease files, must be one of 4 or 6.
        </para></listitem>
      </varlistentry>

123 124 125
      <varlistentry>
        <term><option>-c</option></term>
        <listitem><para>
126 127 128
          Configuration file including the configuration for
          <command>kea-lfc</command> process.  It may also
          contain configuration entries for other Kea services.
129
          Currently <command>kea-lfc</command> gets all of its arguments from
Jeremy C. Reed's avatar
Jeremy C. Reed committed
130
          the command line, in the future it will be extended to get some arguments
131
          from the config file.
132 133 134
        </para></listitem>
      </varlistentry>

Shawn Routhier's avatar
Shawn Routhier committed
135 136 137
      <varlistentry>
        <term><option>-p</option></term>
        <listitem><para>
138 139
          PID file - When the <command>kea-lfc</command> process starts
          it attempts to determine if another instance of the process is
140 141 142
          already running by examining the pid file.  If one is already
          running the new process is terminated.  If one isn't running it
          writes its pid into the pid file.
143 144 145 146 147 148 149
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-x</option></term>
        <listitem><para>
          Previous or ex lease file - When <command>kea-lfc</command> starts this
150 151
          is the result of any previous run of <command>kea-lfc</command>.
          When <command>kea-lfc</command> finishes it is the result of this run.
Jeremy C. Reed's avatar
Jeremy C. Reed committed
152
          If <command>kea-lfc</command> is interrupted before completing,
153
          this file may not exist.
Shawn Routhier's avatar
Shawn Routhier committed
154 155 156 157 158 159
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-i</option></term>
        <listitem><para>
160
          Input or copy of lease file - Before the DHCP server invokes
161
          <command>kea-lfc</command> it will move the current lease file
162
          here and then call <command>kea-lfc</command> with this file.
Shawn Routhier's avatar
Shawn Routhier committed
163 164 165 166 167 168
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-o</option></term>
        <listitem><para>
169 170 171
          Output lease file - The temporary file <command>kea-lfc</command>
          should use to write the leases.  Upon completion of writing this
          this file it will be moved to the finish file (see below).
Shawn Routhier's avatar
Shawn Routhier committed
172 173 174 175 176 177
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-f</option></term>
        <listitem><para>
178 179 180 181 182 183 184 185 186 187
          Finish or completion file - Another temporary file
          <command>kea-lfc</command> uses for bookkeeping.  When
          <command>kea-lfc</command> completes writing the output
          file it moves it to this file name.  After
          <command>kea-lfc</command> finishes deleting the other
          files (previous and input) it moves this file to previous
          lease file.  By moving the files in this fashion the
          <command>kea-lfc</command> and the DHCP server processes
          can determine the correct file to use even if one of the
          processes was interrupted before completing its task.
Shawn Routhier's avatar
Shawn Routhier committed
188 189
        </para></listitem>
      </varlistentry>
190 191 192
    </variablelist>
  </refsect1>

193 194 195 196 197 198 199 200 201 202
  <refsect1>
    <title>DOCUMENTATION</title>
    <para>Kea comes with an extensive Kea User's Guide documentation
      that covers all aspects of running the Kea software -
      compilation, installation, configuration, configuration examples
      and many more. Kea also features a Kea Messages Manual, which
      lists all possible messages Kea can print with a brief
      description for each of them. Both documents are typically
      available in various formats (txt, html, pdf) with your Kea
      distribution. The on-line version is available at
203
      http://oldkea.isc.org/docs/.</para>
204 205
    <para>
      Kea source code is documented in the Kea Developer's Guide. It's
206
      on-line version is available at http://oldkea.isc.org. Please
207 208 209
      follow Developer's Guide link.
    </para>
    <para>
210
      Kea project website is available at: http://oldkea.isc.org.
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
    </para>
  </refsect1>

  <refsect1>
    <title>MAILING LISTS AND SUPPORT</title>
    <para>
      There are two mailing lists available for Kea project. kea-users
      (kea-users at lists.isc.org) is intended for Kea users, while kea-dev
      (kea-dev at lists.isc.org) is intended for Kea developers, prospective
      contributors and other advanced users.  Both lists are available at
      http://lists.isc.org. The community provides best effort type of support
      on both of those lists.
    </para>
    <para>
      ISC provides professional support for Kea services. See
      https://www.isc.org/kea/ for details.
    </para>
  </refsect1>

230 231 232 233 234 235 236
  <refsect1>
    <title>HISTORY</title>
    <para>
      The <command>kea-lfc</command> process was first coded in January
      2015 by the ISC Kea/DHCP team.
    </para>
  </refsect1>
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255

  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>kea-dhcp4</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

      <citerefentry>
        <refentrytitle>kea-dhcp6</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

      <citerefentry>
        <refentrytitle>kea-dhcp-ddns</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

256 257 258 259 260
      <citerefentry>
        <refentrytitle>kea-ctrl-agent</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

261 262 263 264 265
      <citerefentry>
        <refentrytitle>kea-admin</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

Tomek Mrugalski's avatar
Tomek Mrugalski committed
266 267 268 269 270
      <citerefentry>
        <refentrytitle>kea-netconf</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
      <citerefentry>
        <refentrytitle>keactrl</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

      <citerefentry>
        <refentrytitle>perfdhcp</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

      <citetitle>Kea Administrator's Guide</citetitle>.

    </para>
  </refsect1>

286
</refentry>