dhcp4-srv.xml 236 KB
Newer Older
1 2 3 4 5 6 7
 - Copyright (C) 2014-2018 Internet Systems Consortium, Inc. ("ISC")
 - 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/.
8 9
<!-- Converted by db4-upgrade version 1.1 -->
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="dhcp4">
10 11
    <title>The DHCPv4 Server</title>

    <section xml:id="dhcp4-start-stop">
13 14 15
      <title>Starting and Stopping the DHCPv4 Server</title>

Tomek Mrugalski's avatar
Tomek Mrugalski committed
16 17 18 19
        It is recommended that the Kea DHCPv4 server be started and stopped
        using <command>keactrl</command> (described in <xref linkend="keactrl"/>).
        However, it is also possible to run the server directly: it accepts
        the following command-line switches:
21 22 23

24 25 26 27
            <command>-c <replaceable>file</replaceable></command> -
            specifies the configuration file. This is the only mandatory
28 29
Tomek Mrugalski's avatar
Tomek Mrugalski committed
31 32
            <command>-d</command> - specifies whether the server
            logging should be switched to debug/verbose mode. In verbose mode,
            the logging severity and debuglevel specified in the configuration
34 35 36 37
            file are ignored and "debug" severity and the maximum debuglevel
            (99) are assumed. The flag is convenient, for temporarily
            switching the server into maximum verbosity, e.g. when
38 39
40 41
            <command>-p <replaceable>port</replaceable></command> -
            specifies UDP port on which the server will listen. This is only
43 44
            useful during testing, as a DHCPv4 server listening on
            ports other than the standard ones will not be able to
            handle regular DHCPv4 queries.</simpara>
Francis Dupont's avatar
Francis Dupont committed
48 49 50
            <command>-t <replaceable>file</replaceable></command> -
            specifies the configuration file to be tested. Kea-dhcp4
Francis Dupont's avatar
Francis Dupont committed
51 52 53 54 55 56 57
            will attempt to load it, and will conduct sanity
            checks. Note that certain checks are possible only while
            running the actual server. The actual status is reported
            with exit code (0 = configuration looks ok, 1 = error
            encountered). Kea will print out log messages to standard
            output and error to standard error when testing
Tomek Mrugalski's avatar
Tomek Mrugalski committed
59 60
              <command>-v</command> - prints out the Kea version and exits.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
62 63 64 65
66 67
              <command>-V</command> - prints out the Kea extended version with
              additional parameters and exits. The listing includes the versions
              of the libraries dynamically linked to Kea.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
69 70
71 72
73 74 75 76 77
              <command>-W</command> - prints out the Kea configuration report
              and exits. The report is a copy of the
              <filename>config.report</filename> file produced by
              <userinput>./configure</userinput>: it is embedded in the
              executable binary.
78 79
80 81

Francis Dupont's avatar
Francis Dupont committed
Tomek Mrugalski's avatar
Tomek Mrugalski committed
83 84 85 86 87 88
        The <filename>config.report</filename> may also be accessed more
        directly.  The following command may be used to extract this
        information.  The binary <userinput>path</userinput> may be found
        in the install directory or in the <filename>.libs</filename>
        subdirectory in the source tree. For example

90 91 92 93 94
strings <userinput>path</userinput>/kea-dhcp4 | sed -n 's/;;;; //p'

95 96
        On start-up, the server will detect available network interfaces
97 98
        and will attempt to open UDP sockets on all interfaces
        mentioned in the configuration file.
99 100 101 102
        Since the DHCPv4 server opens privileged ports, it requires root
        access. Make sure you run this daemon as root.

103 104
        During startup the server will attempt to create a PID file of the
        form: localstatedir]/[conf name].kea-dhcp6.pid where:
106 107 108
            <simpara><command>localstatedir</command>: The value as passed into the
            build configure script. It defaults to "/usr/local/var".  (Note
            that this value may be overridden at run time by setting the environment
            variable KEA_PIDFILE_DIR.  This is intended primarily for testing purposes.)
112 113 114
            <simpara><command>conf name</command>: The configuration file name
116 117 118 119 120 121 122 123 124
            used to start the server, minus all preceding path and file extension.
            For example, given a pathname of "/usr/local/etc/kea/myconf.txt", the
            portion used would be "myconf".
        If the file already exists and contains the PID of a live process,
        the server will issue a DHCP4_ALREADY_RUNNING log message and exit. It
        is possible, though unlikely, that the file is a remnant of a system crash
        and the process to which the PID belongs is unrelated to Kea.  In such a
126 127 128
        case it would be necessary to manually delete the PID file.

129 130 131 132 133 134
        The server can be stopped using the <command>kill</command> command.
        When running in a console, the server can also be shut down by
        pressing ctrl-c. It detects the key combination and shuts
        down gracefully.
135 136

    <section xml:id="dhcp4-configuration">
      <title>DHCPv4 Server Configuration</title>
139 140
        This section explains how to configure the DHCPv4 server using the
143 144
        Kea configuration backend. (Kea configuration using any other
        backends is outside of scope of this document.) Before DHCPv4
        is started, its configuration file has to be created. The
        basic configuration is as follows:
148 149 150 151 152 153 154 155 156
# DHCPv4 configuration starts in this line
"Dhcp4": {

# First we set up global values
    "valid-lifetime": 4000,
    "renew-timer": 1000,
    "rebind-timer": 2000,

157 158 159 160 161 162
# Next we setup the interfaces to be used by the server.
    "interfaces-config": {
        "interfaces": [ "eth0" ]

# And we specify the type of lease database
    "lease-database": {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
        "type": "memfile",
        "persist": true,
Tomek Mrugalski's avatar
Tomek Mrugalski committed
        "name": "/var/kea/dhcp4.leases"
167 168 169 170 171 172

# Finally, we list the subnets from which we will be leasing addresses.
    "subnet4": [
            "subnet": "",
            "pools": [
174 175 176
                     "pool": " -"
178 179
# DHCPv4 configuration ends with the next line
181 182 183

} </screen>

<para>The following paragraphs provide a brief overview of the parameters in
the above example together with
188 189
their format. Subsequent sections of this chapter go into much greater detail
for these and other parameters.</para>

191 192
<para>The lines starting with a hash (#) are comments and are ignored by
the server; they do not impact its
193 194
operation in any way.</para>

195 196 197
<para>The configuration starts in the first line with the initial
opening curly bracket (or brace). Each configuration consists of
one or more objects. In this specific example, we have only one
object, called Dhcp4. This is a simplified configuration, as usually
there will be additional objects, like <command>Logging</command> or
Francis Dupont's avatar
Francis Dupont committed
<command>DhcpDdns</command>, but we omit them now for clarity. The Dhcp4
configuration starts with the <command>"Dhcp4": {</command> line
202 203 204 205
and ends with the corresponding closing brace (in the above example,
the brace after the last comment).  Everything defined between those
lines is considered to be the Dhcp4 configuration.</para>

<para>In the general case, the order in which those parameters appear does not
matter. There are two caveats here though. The first one is to remember that
208 209 210 211
the configuration file must be well formed JSON. That means that the parameters
for any given scope must be separated by a comma and there must not be a comma
after the last parameter. When reordering a configuration file, keep in mind that
moving a parameter to or from the last position in a given scope may also require
212 213
moving the comma. The second caveat is that it is uncommon — although
legal JSON — to
repeat the same parameter multiple times. If that happens, the last occurrence of a
given parameter in a given scope is used while all previous instances are
ignored. This is unlikely to cause any confusion as there are no real life
217 218 219
reasons to keep multiple copies of the same parameter in your configuration

<para>Moving onto the DHCPv4 configuration elements, the first few elements
define some global parameters. <command>valid-lifetime</command>
defines how long the addresses (leases) given out by the
server are valid. If nothing changes, a client that got an address is allowed to
224 225
use it for 4000 seconds. (Note that integer numbers are specified as is,
without any quotes around them.) <command>renew-timer</command> and
<command>rebind-timer</command> are values (also in seconds) that
define T1 and T2 timers that govern when the client will begin the renewal and
228 229 230 231 232 233 234 235
rebind procedures. <note> Both <command>renew-timer</command> and
<command>rebind-timer</command> are optional.  The server will only send
rebind-timer to the client, via DHPv4 option code 59, if it is less than
valid-lifetime; and it will only send renew-timer, via DHCPv4 option code 58,
if it is less than rebind-timer (or valid-lifetime if rebind-timer was not
specified).  In their absence, the client should select values for T1 and T2
timers according to the <link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:href="http://tools.ietf.org/html/rfc2131">RFC 2131</link>.</note></para>

237 238 239 240 241 242 243 244 245 246 247 248 249 250
<para>The <command>interfaces-config</command> map specifies the server
configuration concerning the network interfaces, on which the server should
listen to the DHCP messages. The <command>interfaces</command> parameter
specifies a list of network interfaces on which the server should listen.
Lists are opened and closed with square brackets, with elements separated
by commas. Had we wanted to listen on two interfaces, the
<command>interfaces-config</command> would look like this:
"interfaces-config": {
    "interfaces": [ "eth0", "eth1" ]

<para>The next couple of lines define the lease database, the place where the server
stores its lease information. This particular example tells the server to use
<command>memfile</command>, which is the simplest (and fastest) database
backend. It uses an in-memory database and stores leases on disk in a CSV
file. This is a very simple configuration. Usually the lease database configuration
256 257 258
is more extensive and contains additional parameters.  Note that
is an object and opens up a new scope, using an opening brace.
Its parameters (just one in this example - <command>type</command>)
follow. Had there been more than one, they would be separated by commas. This
261 262
scope is closed with a closing brace. As more parameters for the Dhcp4 definition
follow, a trailing comma is present.</para>
263 264 265

<para>Finally, we need to define a list of IPv4 subnets. This is the
most important DHCPv4 configuration structure as the server uses that
266 267
information to process clients' requests. It defines all subnets from
which the server is expected to receive DHCP requests. The subnets are
268 269
specified with the <command>subnet4</command> parameter.  It is a list,
so it starts and ends with square brackets.  Each subnet definition in
270 271
the list has several attributes associated with it, so it is a structure
and is opened and closed with braces. At a minimum, a subnet definition
has to have at least two parameters: <command>subnet</command> (that
defines the whole subnet) and <command>pools</command> (which is a list of
dynamically allocated pools that are governed by the DHCP server).</para>
275 276 277 278 279 280

<para>The example contains a single subnet. Had more than one been defined,
additional elements
in the <command>subnet4</command> parameter would be specified and
separated by commas. For example, to define three subnets, the following
syntax would be used:
282 283
"subnet4": [
        "pools": [ { "pool":  " -" } ],
285 286 287
        "subnet": ""
        "pools": [ { "pool": " -" } ],
289 290 291
        "subnet": ""
Adam Osuchowski's avatar
Adam Osuchowski committed
        "pools": [ { "pool": " -" } ],
293 294 295
        "subnet": ""
297 298
Note that indentation is optional and is used for aesthetic purposes only.
In some cases in may be preferable to use more compact notation.
299 300

<para>After all the parameters have been specified, we have two contexts open:
global and Dhcp4, hence we need two closing curly brackets to close them.
303 304
In a real life configuration file there most likely would be additional
components defined such as Logging or DhcpDdns, so the closing brace would
305 306
be followed by a comma and another object definition.</para>

309 310
  <title>Lease Storage</title>
  <para>All leases issued by the server are stored in the lease database.
  Currently there are four database backends available:  memfile (which is the
  default backend), MySQL, PostgreSQL and Cassandra.</para>
  <title>Memfile - Basic Storage for Leases</title>
315 316

  <para>The server is able to store lease data in different repositories. Larger
  deployments may elect to store leases in a database. <xref linkend="database-configuration4"/> describes this option. In typical
318 319
  smaller deployments though, the server will store lease information in a CSV file rather
  than a database. As well as requiring less administration, an
320 321
  advantage of using a file for storage is that it
  eliminates a dependency on third-party database software.</para>
322 323

  <para>The configuration of the file backend (Memfile) is controlled through
324 325 326
  the Dhcp4/lease-database parameters. The <command>type</command> parameter
  is mandatory and it specifies which storage for leases the server should use.
  The value of <userinput>"memfile"</userinput> indicates that the file should
327 328
  be used as the storage. The following list gives additional, optional,
  parameters that can be used to configure the Memfile backend.
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355

      <simpara><command>persist</command>: controls whether the new leases and
      updates to existing leases are written to the file. It is strongly
      recommended that the value of this parameter is set to
      <userinput>true</userinput> at all times, during the server's normal
      operation. Not writing leases to disk will mean that if a server is restarted
      (e.g. after a power failure), it will not know what addresses have been
      assigned.  As a result, it may hand out addresses to new clients that are
      already in use. The value of <userinput>false</userinput> is mostly useful
      for performance testing purposes. The default value of the
      <command>persist</command> parameter is <userinput>true</userinput>,
      which enables writing lease updates
      to the lease file.

      <simpara><command>name</command>: specifies an absolute location of the lease
      file in which new leases and lease updates will be recorded. The default value
      for this parameter is <userinput>"[kea-install-dir]/var/kea/kea-leases4.csv"

      <simpara><command>lfc-interval</command>: specifies the interval in seconds, at
356 357
      which the server will perform a lease file cleanup (LFC).  This
      removes redundant (historical) information from the lease file
358 359
      and effectively reduces the lease file size. The cleanup process is described
      in more detailed fashion further in this section. The default value of the
360 361
      <command>lfc-interval</command> is <userinput>3600</userinput>. A value of 0
      disables the LFC.</simpara>
362 363 364 365 366


  <para>An example configuration of the Memfile backend is presented below:
Jeremy C. Reed's avatar
Jeremy C. Reed committed

370 371 372
"Dhcp4": {
    "lease-database": {
        <userinput>"type": "memfile"</userinput>,
        <userinput>"persist": true</userinput>,
374 375
        <userinput>"name": "/tmp/kea-leases4.csv",</userinput>
        <userinput>"lfc-interval": 1800</userinput>
376 377
379 380

    This configuration selects the <filename>/tmp/kea-leases4.csv</filename> as
    the storage for lease information and enables persistence (writing lease updates
382 383 384 385 386
    to this file). It also configures the backend perform the periodic cleanup
    of the lease files, executed every 30 minutes.

  <para>It is important to know how the lease file contents are organized
  to understand why the periodic lease file cleanup is needed. Every time
388 389
  the server updates a lease or creates a new lease for the client, the new
  lease information must be recorded in the lease file. For performance reasons,
390 391 392
  the server does not update the existing client's lease in the file, as it would
  potentially require rewriting the entire file. Instead, it simply appends the new lease
  information to the end of the file: the previous lease entries for the
393 394 395 396 397 398
  client are not removed. When the server loads leases from the lease file, e.g.
  at the server startup, it assumes that the latest lease entry for the client
  is the valid one. The previous entries are discarded. This means that the
  server can re-construct the accurate information about the leases even though
  there may be many lease entries for each client. However, storing many entries
  for each client results in bloated lease file and impairs the performance of
  the server's startup and reconfiguration as it needs to process a larger number
400 401 402
  of lease entries.

  <para>Lease file cleanup (LFC) removes all previous entries for each client and
404 405
  leaves only the latest ones. The interval at which the cleanup is performed
  is configurable, and it should be selected according to the frequency of lease
406 407
  renewals initiated by the clients. The more frequent the renewals, the smaller
  the value of <command>lfc-interval</command> should be. Note however, that the
408 409 410 411
  LFC takes time and thus it is possible (although unlikely) that new cleanup
  is started while the previous cleanup instance is still running, if the
  <command>lfc-interval</command> is too short. The server would recover from
  this by skipping the new cleanup when it detects that the previous cleanup
  is still in progress. But it implies that the actual cleanups will be
  triggered more rarely than configured. Moreover, triggering a new cleanup
  adds an overhead to the server which will not be able to respond to new
415 416
  requests for a short period of time when the new cleanup process is spawned.
  Therefore, it is recommended that the <command>lfc-interval</command> value
  is selected in a way that would allow for the LFC to complete the cleanup before a
418 419 420
  new cleanup is triggered.

421 422 423
  <para>Lease file cleanup is performed by a separate process (in background) to avoid
  a performance impact on the server process. In order to avoid the conflicts
  between two processes both using the same lease files, the LFC process
424 425 426 427
  operates on the copy of the original lease file, rather than on the lease
  file used by the server to record lease updates. There are also other files
  being created as a side effect of the lease file cleanup. The detailed
  description of the LFC is located on the Kea wiki:
  <uri xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://kea.isc.org/wiki/LFCDesign">http://kea.isc.org/wiki/LFCDesign</uri>.
429 430 431 432


<section xml:id="database-configuration4">
  <title>Lease Database Configuration</title>
435 436

437 438
    <para>Lease database access information must be configured for the DHCPv4 server,
    even if it has already been configured for the DHCPv6 server. The servers
439 440 441 442
    store their information independently, so each server can use a separate
    database or both servers can use the same database.</para>

  <para>Lease database configuration is controlled through the Dhcp4/lease-database
444 445
  parameters. The type of the database must be set to "memfile", "mysql", "postgresql" or
  "cql", e.g.
"Dhcp4": { "lease-database": { <userinput>"type": "mysql"</userinput>, ... }, ... }
  Next, the name of the database to hold the leases must be set: this is the
  name used when the database was created
451 452 453
  (see <xref linkend="mysql-database-create"/>,
  <xref linkend="pgsql-database-create"/> or
  <xref linkend="cql-database-create"/>).
"Dhcp4": { "lease-database": { <userinput>"name": "<replaceable>database-name</replaceable>" </userinput>, ... }, ... }
456 457 458 459
  For Cassandra:
"Dhcp4": { "lease-database": { <userinput>"keyspace": "<replaceable>database-name</replaceable>" </userinput>, ... }, ... }
  If the database is located on a different system to the DHCPv4 server, the
462 463
  database host name must also be specified. (It should be noted that this
  configuration may have a severe impact on server performance.):
465 466
"Dhcp4": { "lease-database": { <userinput>"host": "<replaceable>remote-host-name</replaceable>"</userinput>, ... }, ... }

468 469
  The usual state of affairs will be to have the database on the same machine as
  the DHCPv4 server.  In this case, set the value to the empty string:
"Dhcp4": { "lease-database": { <userinput>"host" : ""</userinput>, ... }, ... }

  Should the database use a port different than default, it may be
Tomek Mrugalski's avatar
Tomek Mrugalski committed
475 476 477
  specified as well:
"Dhcp4": { "lease-database": { <userinput>"port" : 12345</userinput>, ... }, ... }
479 480 481
  Should the database be located on a different system, you may need to specify a longer interval
  for the connection timeout:
"Dhcp4": { "lease-database": { <userinput>"connect-timeout" : <replaceable>timeout-in-seconds</replaceable></userinput>, ... }, ... }
483 484
The default value of five seconds should be more than adequate for local connections.
If a timeout is given though, it should be an integer greater than zero.
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
The maxiumum number of times the server will automatically attempt to reconnect to
the lease database after connectivity has been lost may be specified:
"Dhcp4": { "lease-database": { <userinput>"max-reconnect-tries" : <replaceable>number-of-tries</replaceable></userinput>, ... }, ... }
If the server is unable to reconnect to the database after making the maximum number
of attempts the server will exit. A value of zero (the default) disables automatic
recovery and the server will exit immediately upon detecting a loss of connectivity
(MySQL and Postgres only).
The number of seconds the server will wait in between attempts to reconnect to the
lease database after connectivity has been lost may also be specified:
"Dhcp4": { "lease-database": { <userinput>"reconnect-wait-time" : <replaceable>number-of-seconds</replaceable></userinput>, ... }, ... }
A value of zero (the default) disables automatic recovery and the server will exit
immediately upon detecting a loss of connectivity (MySQL and Postgres only).
507 508
  <para>Finally, the credentials of the account under which the server will
  access the database should be set:
"Dhcp4": { "lease-database": { <userinput>"user": "<replaceable>user-name</replaceable>"</userinput>,
                               <userinput>"password": "<replaceable>password</replaceable>"</userinput>,
512 513
                              ... },
           ... }
515 516 517
  If there is no password to the account, set the password to the empty string
  "". (This is also the default.)</para>
518 519 520 521 522 523 524 525 526 527 528

<section xml:id="cassandra-database-configuration4">
  <title>Cassandra specific parameters</title>
    Cassandra backend is configured slightly differently. Cassandra has a
    concept of contact points that could be used to contact the cluster,
    instead of a single IP or hostname. It takes a list of comma separated IP
    addresses. This may be specified as:
"Dhcp4": {
    "lease-database": {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
        "type": "cql",
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594
        <userinput>"contact-points": "<replaceable>ip-address1, ip-address2 [,...]</replaceable>"</userinput>,

    Cassandra also supports a number of optional parameters:

        <command>reconnect-wait-time</command> - governs how long Kea waits
        before attempting to reconnect. Expressed in milliseconds. The default
        is 2000 [ms].

        <command>connect-timeout</command> - sets the timeout for connecting to
        a node. Expressed in milliseconds. The default is 5000 [ms].

        <command>request-timeout</command> - this parameter sets the timeout for
        waiting for a response from a node. Expressed in milliseconds. The
        default is 12000 [ms].

        <command>tcp-keepalive</command> - This parameter governs the TCP
        keep-alive mechanism. Expressed in seconds of delay. If the parameter
        is not present, the mechanism is disabled.

        <command>tcp-nodelay</command> - This parameter enables/disabled Nagle's
        algorithm on connections. The default is true.


    For example, a complex Cassandra configuration with most parameters specified
    could look as follows:
"Dhcp4": {
  "lease-database": {
      "type": "cql",
      "keyspace": "keatest",
      "contact-points": ",,",
      "port": 9042,
      "reconnect-wait-time": 2000,
      "connect-timeout": 5000,
      "request-timeout": 12000,
      "tcp-keepalive": 1,
      "tcp-nodelay": true

Similar parameters can be specified for hosts database.


<section xml:id="hosts4-storage">
  <title>Hosts Storage</title>
    <para>Kea is also able to store information about host reservations in the
600 601 602
    database. The hosts database configuration uses the same syntax as the lease
    database. In fact, a Kea server opens independent connections for each
    purpose, be it lease or hosts information. This arrangement gives the most
    flexibility. Kea can be used to keep leases and host reservations
    separately, but can also point to the same database. Currently the
    supported hosts database types are MySQL, PostgreSQL and Cassandra.</para>

    <para>Please note that usage of hosts storage is optional. A user can define
    all host reservations in the configuration file. That is the recommended way
609 610 611
    if the number of reservations is small. However, when the number of
    reservations grows it's more convenient to use host storage. Please note
    that both storage methods (configuration file and one of the supported databases)
    can be used together. If hosts are defined in both places, the definitions
    from the configuration file are checked first and external storage is checked
    later, if necessary.</para>

Francis Dupont's avatar
Francis Dupont committed
616 617 618 619 620 621 622
    <para>Version 1.4 extends the host storage to multiple storages. Operations
    are performed on host storages in the configuration order with a special
    case for addition: read-only storages must be configured after a
    required read-write storage, or host reservation addition will
    always fail.</para>

<section xml:id="hosts-databases-configuration4">
  <title>DHCPv4 Hosts Database Configuration</title>
624 625

  <para>Hosts database configuration is controlled through the Dhcp4/hosts-database
  parameters. If enabled, the type of the database must be set to "mysql" or
  "postgresql". Other hosts backends may be added in later versions of Kea.
628 629 630
"Dhcp4": { "hosts-database": { <userinput>"type": "mysql"</userinput>, ... }, ... }
631 632
  Next, the name of the database to hold the reservations must be set: this is the
  name used when the lease database was created (see <xref linkend="supported-databases"/>
  for instructions how to setup the desired database type).
634 635 636
"Dhcp4": { "hosts-database": { <userinput>"name": "<replaceable>database-name</replaceable>" </userinput>, ... }, ... }
  If the database is located on a different system than the DHCPv4 server, the
638 639
  database host name must also be specified. (Again it should be noted that this
  configuration may have a severe impact on server performance.):
640 641 642 643 644 645 646 647
"Dhcp4": { "hosts-database": { <userinput>"host": <replaceable>remote-host-name</replaceable></userinput>, ... }, ... }
  The usual state of affairs will be to have the database on the same machine as
  the DHCPv4 server.  In this case, set the value to the empty string:
"Dhcp4": { "hosts-database": { <userinput>"host" : ""</userinput>, ... }, ... }
  Should the database use a port different than default, it may be
Tomek Mrugalski's avatar
Tomek Mrugalski committed
649 650 651 652
  specified as well:
"Dhcp4": { "hosts-database": { <userinput>"port" : 12345</userinput>, ... }, ... }
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672
The maxiumum number of times the server will automatically attempt to reconnect to
the host database after connectivity has been lost may be specified:
"Dhcp4": { "hosts-database": { <userinput>"max-reconnect-tries" : <replaceable>number-of-tries</replaceable></userinput>, ... }, ... }
If the server is unable to reconnect to the database after making the maximum number
of attempts the server will exit. A value of zero (the default) disables automatic
recovery and the server will exit immediately upon detecting a loss of connectivity
(MySQL and Postgres only).
The number of seconds the server will wait in between attempts to reconnect to the
host database after connectivity has been lost may also be specified:
"Dhcp4": { "hosts-database": { <userinput>"reconnect-wait-time" : <replaceable>number-of-seconds</replaceable></userinput>, ... }, ... }
A value of zero (the default) disables automatic recovery and the server will exit
immediately upon detecting a loss of connectivity (MySQL and Postgres only).
Tomek Mrugalski's avatar
Tomek Mrugalski committed

674 675 676 677 678 679 680 681 682 683 684
  <para>Finally, the credentials of the account under which the server will
  access the database should be set:
"Dhcp4": { "hosts-database": { <userinput>"user": "<replaceable>user-name</replaceable>"</userinput>,
                               <userinput>"password": "<replaceable>password</replaceable>"</userinput>,
                              ... },
           ... }
  If there is no password to the account, set the password to the empty string
  "". (This is also the default.)</para>

Francis Dupont's avatar
Francis Dupont committed
686 687 688 689 690 691
  <para>The multiple storage extension uses a similar syntax: a configuration
  is placed into a "hosts-databases" list instead of into a "hosts-database"
  entry as in:
"Dhcp4": { "hosts-databases": [ { <userinput>"type": "mysql"</userinput>, ... }, ... ], ... }
Francis Dupont's avatar
Francis Dupont committed

694 695 696
  <para>For additional Cassandra specific parameters, see <xref


<section xml:id="read-only-database-configuration4">
<title>Using Read-Only Databases for Host Reservations</title>
702 703
In some deployments the database user whose name is specified in the database backend
configuration may not have write privileges to the database. This is often
704 705 706
required by the policy within a given network to secure the data from being
unintentionally modified. In many cases administrators have inventory databases
deployed, which contain substantially more information about the hosts than
static reservations assigned to them. The inventory database can be used to create
708 709 710
a view of a Kea hosts database and such view is often read only.
711 712 713 714 715 716 717
Kea host database backends operate with an implicit configuration to both
read from and write to the database. If the database user does not have
write access to the host database, the backend will fail to start and the
server will refuse to start (or reconfigure). However, if access to a read
only host database is required for retrieving reservations for clients
and/or assign specific addresses and options, it is possible to explicitly
configure Kea to start in "read-only" mode. This is controlled by the
718 719 720 721 722 723 724 725 726 727 728 729
<command>readonly</command> boolean parameter as follows:
"Dhcp4": { "hosts-database": { <userinput>"readonly": true</userinput>, ... }, ... }
Setting this parameter to <userinput>false</userinput> would configure the
database backend to operate in "read-write" mode, which is also a default
configuration if the parameter is not specified.
<note><para>The <command>readonly</command> parameter is currently only supported
for MySQL and PostgreSQL databases.</para></note>

730 731

<section xml:id="dhcp4-interface-configuration">
  <title>Interface Configuration</title>
  <para>The DHCPv4 server has to be configured to listen on specific network
735 736 737
  interfaces.  The simplest network interface configuration tells the server to
  listen on all available interfaces:
738 739 740 741 742 743 744
"Dhcp4": {
    "interfaces-config": {
        "interfaces": [ <userinput>"*"</userinput> ]
745 746
  The asterisk plays the role of a wildcard and means "listen on all interfaces".
  However, it is usually a good idea to explicitly specify interface names:
748 749 750 751 752 753 754
"Dhcp4": {
    "interfaces-config": {
        "interfaces": [ <userinput>"eth1", "eth3"</userinput> ]
755 756 757 758
  <para>It is possible to use wildcard interface name (asterisk) concurrently
  with explicit interface names:
759 760 761 762 763 764 765
"Dhcp4": {
    "interfaces-config": {
        "interfaces": [ <userinput>"eth1", "eth3", "*"</userinput> ]
It is anticipated that this form of usage will only be used when it is desired to
temporarily override a list of interface names and listen on all interfaces.
  <para>Some deployments of DHCP servers require that the servers listen
770 771 772
  on the interfaces with multiple IPv4 addresses configured. In these situations,
  the address to use can be selected by appending an IPv4 address to the interface
  name in the following manner:
773 774 775 776 777 778 779 780
"Dhcp4": {
    "interfaces-config": {
        "interfaces": [ <userinput>"eth1/", "eth3/"</userinput> ]

783 784
  <para>Should the server be required to listen on multiple IPv4 addresses assigned
  to the same interface, multiple addresses can be specified for an interface
785 786 787 788 789 790 791 792 793 794 795 796 797 798
  as in the example below:
"Dhcp4": {
    "interfaces-config": {
        "interfaces": [ <userinput>"eth1/", "eth1/"</userinput> ]

  <para>Alternatively, if the server should listen on all addresses for the particular
  interface, an interface name without any address should be specified.</para>

  <para>Kea supports responding to directly connected clients which don't have
  an address configured. This requires that the server
801 802 803 804 805 806 807 808 809 810 811 812
  injects the hardware address of the destination into the data link layer
  of the packet being sent to the client. The DHCPv4 server utilizes the
  raw sockets to achieve this, and builds the entire IP/UDP stack for the
  outgoing packets. The down side of raw socket use, however, is that incoming
  and outgoing packets bypass the firewalls (e.g. iptables). It is also
  troublesome to handle traffic on multiple IPv4 addresses assigned to the
  same interface, as raw sockets are bound to the interface and advanced
  packet filtering techniques (e.g. using the BPF) have to be used to
  receive unicast traffic on the desired addresses assigned to the interface,
  rather than capturing whole traffic reaching the interface to which the raw
  socket is bound. Therefore, in the deployments where the server doesn't
  have to provision the directly connected clients and only receives the
813 814
  unicast packets from the relay agents, the
  DHCP server should be configured to utilize IP/UDP datagram sockets instead of raw sockets.
815 816 817 818 819 820
  The following configuration demonstrates how this can be achieved:

"Dhcp4": {
    "interfaces-config": {
        "interfaces": [ <userinput>"eth1", "eth3"</userinput> ],
        "dhcp-socket-type": "udp"
822 823 824 825
  The <command>dhcp-socket-type</command> specifies that the IP/UDP sockets will
  be opened on all interfaces on which the server listens, i.e. "eth1" and
  "eth3" in our case. If the <command>dhcp-socket-type</command> is set to
  <userinput>raw</userinput>, it configures the server to use raw sockets
  instead. If the <command>dhcp-socket-type</command> value is not specified, the
831 832 833
  default value <userinput>raw</userinput> is used.

  <para>Using UDP sockets automatically disables the reception of broadcast
835 836 837 838 839
  packets from directly connected clients. This effectively means that the
  UDP sockets can be used for relayed traffic only. When using the raw sockets,
  both the traffic from the directly connected clients and the relayed traffic
  will be handled. Caution should be taken when configuring the server to open
  multiple raw sockets on the interface with several IPv4 addresses assigned.
  If the directly connected client sends the message to the broadcast address
841 842 843 844 845 846 847
  all sockets on this link will receive this message and multiple responses
  will be sent to the client. Hence, the configuration with multiple IPv4
  addresses assigned to the interface should not be used when the directly
  connected clients are operating on that link. To use a single address on
  such interface, the "interface-name/address" notation should be used.

848 849 850 851 852 853
    <para>Specifying the value <userinput>raw</userinput> as the socket type,
    doesn't guarantee that the raw sockets will be used! The use of raw sockets
    to handle the traffic from the directly connected clients is currently
    supported on Linux and BSD systems only. If the raw sockets are not
    supported on the particular OS, the server will issue a warning and
    fall back to use IP/UDP sockets.</para>
Francis Dupont's avatar
Francis Dupont committed

857 858 859 860 861 862 863
  <para>In typical environment the DHCP server is expected to send back a
  response on the same network interface on which the query is received. This is
  the default behavior. However, in some deployments it is desired that the
  outbound (response) packets will be sent as regular traffic and the outbound
  interface will be determined by the routing tables. This kind of asymetric
  traffic is uncommon, but valid. Kea now supports a parameter called
  <command>outbound-interface</command> that controls this behavior. It supports
  two values. The first one, <userinput>same-as-inbound</userinput>, tells Kea
  to send back the response on the same inteface the query packet is received. This
866 867
  is the default behavior. The second one, <userinput>use-routing</userinput>
  tells Kea to send regular UDP packets and let the kernel's routing table to
868 869 870
  determine most appropriate interface. This only works when
  <command>dhcp-socket-type</command> is  set to <userinput>udp</userinput>.
  An example configuration looks as follows:
871 872 873 874 875 876 877 878 879 880 881
"Dhcp4": {
    "interfaces-config": {
        "interfaces": [ "eth1", "eth3" ],
        "dhcp-socket-type": "udp",
        <userinput>"outbound-interface": "use-routing"</userinput>

Francis Dupont's avatar
Francis Dupont committed
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
  <para>Interfaces are re-detected at each reconfiguration. This behavior
  can be disabled by setting <command>re-detect</command> value to
  <userinput>false</userinput>, for instance:

"Dhcp4": {
    "interfaces-config": {
        "interfaces": [ <userinput>"eth1", "eth3"</userinput> ],
        "re-detect": <userinput>false</userinput>
  Note interfaces are not re-detected during <command>config-test</command>.

  <para>Usually loopback interfaces (e.g. the "lo" or "lo0" interface)
  may not be configured but if a loopback interface is explicitely configured
  and IP/UDP sockets are specified the loopback interface is accepted.
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915

  <para>It can be used for instance to run Kea in a FreeBSD jail having
  only a loopback interface, servicing relayed DHCP request:

"Dhcp4": {
    "interfaces-config": {
        "interfaces": [ <userinput>"lo0"</userinput> ],
        "dhcp-socket-type": "udp"

916 917

<section xml:id="dhcpinform-unicast-issues">
  <title>Issues with Unicast Responses to DHCPINFORM</title>
Shawn Routhier's avatar
Shawn Routhier committed
  <para>The use of UDP sockets has certain benefits in deployments
921 922 923
  where the server receives only relayed traffic; these benefits are
  mentioned in <xref linkend="dhcp4-interface-configuration"/>. From
  the administrator's perspective it is often desirable to
  configure the system's firewall to filter out the unwanted traffic, and
  the use of UDP sockets facilitates this. However, the administrator must
  also be aware of the implications related to filtering certain types
Shawn Routhier's avatar
Shawn Routhier committed
  of traffic as it may impair the DHCP server's operation.
928 929 930 931

  <para>In this section we are focusing on the case when the server
  receives the DHCPINFORM message from the client via a relay. According
  to <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://tools.ietf.org/html/rfc2131">RFC 2131</link>,
Shawn Routhier's avatar
Shawn Routhier committed
  the server should unicast the DHCPACK response to the address carried in
  the "ciaddr" field. When the UDP socket is in use, the DHCP server
  relies on the low level functions of an operating system to build the
Shawn Routhier's avatar
Shawn Routhier committed
  data link, IP and UDP layers of the outgoing message. Typically, the
  OS will first use ARP to obtain the client's link layer address to be
  inserted into the frame's header, if the address is not cached from
Shawn Routhier's avatar
Shawn Routhier committed
  a previous transaction that the client had with the server.
  When the ARP exchange is successful, the DHCP message can be unicast
Shawn Routhier's avatar
Shawn Routhier committed
  to the client, using the  obtained address.
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963

  <para>Some system administrators block ARP messages in their network,
  which causes issues for the server when it responds to the
  DHCPINFORM messages, because the server is unable to send the
  DHCPACK if the preceding ARP communication fails. Since the OS is
  entirely responsible for the ARP communication and then sending
  the DHCP packet over the wire, the DHCP server has no means to
  determine that the ARP exchange failed and the DHCP response message
  was dropped. Thus, the server does not log any error messages when
  the outgoing DHCP response is dropped. At the same time, all hooks
  pertaining to the packet sending operation will be called, even
  though the message never reaches its destination.

  <para>Note that the issue described in this section is not observed
  when the raw sockets are in use, because, in this case, the DHCP server
  builds all the layers of the outgoing message on its own and does not
  use ARP. Instead, it inserts the value carried in the 'chaddr' field
  of the DHCPINFORM message into the link layer.

Shawn Routhier's avatar
Shawn Routhier committed
964 965 966
  <para>Server administrators willing to support DHCPINFORM
  messages via relays should not block ARP traffic in their
  networks or should use raw sockets instead of UDP sockets.
967 968 969

<section xml:id="ipv4-subnet-id">
971 972
  <title>IPv4 Subnet Identifier</title>
    The subnet identifier is a unique number associated with a particular subnet.
    In principle, it is used to associate clients' leases with their respective subnets.
    When a subnet identifier is not specified for a subnet being configured, it will
976 977 978 979 980 981 982
    be automatically assigned by the configuration mechanism. The identifiers
    are assigned from 1 and are monotonically increased for each subsequent
    subnet: 1, 2, 3 ....
    If there are multiple subnets configured with auto-generated identifiers and
    one of them is removed, the subnet identifiers may be renumbered. For example:
983 984
    if there are four subnets and the third is removed the last subnet will be assigned
    the identifier that the third subnet had before removal. As a result, the leases
985 986
    stored in the lease database for subnet 3 are now associated with
    subnet 4, something that may have unexpected consequences. It is planned
    to implement a mechanism to preserve auto-generated subnet ids in a
988 989 990
    future version of Kea.  However, the only remedy for this issue
    at present is to
    manually specify a unique identifier for each subnet.
993 994
        The following configuration will assign the specified subnet
        identifier to the newly configured subnet:

997 998
"Dhcp4": {
    "subnet4": [
999 1000 1001 1002 1003
            "subnet": "",
            <userinput>"id": 1024</userinput>,
1004 1005 1006
1007 1008
    This identifier will not change for this subnet unless the "id" parameter is
    removed or set to 0. The value of 0 forces auto-generation of the subnet
1009 1010 1011 1012 1013 1014
    <!-- @todo: describe whether database needs to be updated after changing
      id -->

<section xml:id="dhcp4-address-config">
1016 1017
  <title>Configuration of IPv4 Address Pools</title>
1018 1019 1020
    The main role of a DHCPv4 server is address assignment. For this, the server has to
    be configured with at least one subnet and one pool of dynamic addresses for it to manage.
    For example, assume that the server is connected to a network
1021 1022 1023 1024 1025 1026 1027
    segment that uses the prefix. The Administrator of that network
    has decided that addresses from range to are going to
    be managed by the Dhcp4 server. Such a configuration can be achieved in the
    following way: