dhcp6-srv.xml 202 KB
Newer Older
1 2 3 4 5 6
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY mdash  "&#x2014;" >
]>

Tomek Mrugalski's avatar
Tomek Mrugalski committed
7
 <chapter id="dhcp6">
8 9 10 11 12 13
    <title>The DHCPv6 Server</title>

    <section id="dhcp6-start-stop">
      <title>Starting and Stopping the DHCPv6 Server</title>

      <para>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
14 15 16 17
        It is recommended that the Kea DHCPv6 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:
18 19
      </para>

20 21
      <itemizedlist>
          <listitem>
22 23 24 25
            <simpara>
            <command>-c <replaceable>file</replaceable></command> -
            specifies the configuration file. This is the only mandatory
            switch.</simpara>
26 27
          </listitem>
          <listitem>
28
            <simpara>
29
            <command>-d</command> - specifies whether the server
30
            logging should be switched to verbose mode. In verbose mode,
31
            the logging severity and debuglevel specified in the configuration
32 33 34 35
            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
            debugging.</simpara>
36 37
          </listitem>
          <listitem>
38 39
            <simpara>
            <command>-p <replaceable>port</replaceable></command> -
40 41
            specifies UDP port on which the server will listen. This is only
            useful during testing, as a DHCPv6 server listening on
42
            ports other than the standard ones will not be able to
43
            handle regular DHCPv6 queries.</simpara>
44
          </listitem>
Francis Dupont's avatar
Francis Dupont committed
45
          <listitem>
46 47 48
            <simpara>
            <command>-t <replaceable>file</replaceable></command> -
            specifies the configuration file to be tested. Kea-dhcp6
Francis Dupont's avatar
Francis Dupont committed
49 50 51 52 53 54 55
            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
            configuration.</simpara>
56
          </listitem>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
57 58
          <listitem>
            <simpara>
59
              <command>-v</command> - prints out the Kea version and exits.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
60 61 62 63
            </simpara>
          </listitem>
          <listitem>
            <simpara>
64 65 66
              <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
67 68
            </simpara>
          </listitem>
69 70
          <listitem>
            <simpara>
71 72 73 74 75
              <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.
76 77
            </simpara>
          </listitem>
78 79
      </itemizedlist>

Francis Dupont's avatar
Francis Dupont committed
80
      <para>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
81 82 83 84 85 86
        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
        <filename>kea/src/bin/dhcp6/.libs/kea-dhcp6</filename>.
87

88 89 90 91 92
<screen>
strings <userinput>path</userinput>/kea-dhcp6 | sed -n 's/;;;; //p'
</screen>
      </para>

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

101 102
      <para>
        During startup the server will attempt to create a PID file of the
103
        form: localstatedir]/[conf name].kea-dhcp6.pid where:
104 105 106
        <itemizedlist>
            <listitem>
            <simpara><command>localstatedir</command>: The value as passed into the
Jeremy C. Reed's avatar
Jeremy C. Reed committed
107
            build configure script. It defaults to "/usr/local/var".  Note
108 109 110 111 112
            that this value may be overridden at run time by setting the environment
            variable KEA_PIDFILE_DIR.  This is intended primarily for testing purposes.
            </simpara>
            </listitem>
            <listitem>
113
            <simpara><command>conf name</command>: The configuration file name
114 115 116 117 118 119 120 121 122
            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".
            </simpara>
            </listitem>
        </itemizedlist>
        If the file already exists and contains the PID of a live process,
        the server will issue a DHCP6_ALREADY_RUNNING log message and exit. It
        is possible, though unlikely, that the file is a remnant of a system crash
123
        and the process to which the PID belongs is unrelated to Kea.  In such a
124 125
        case it would be necessary to manually delete the PID file.
      </para>
126 127 128 129 130 131 132

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

    <section id="dhcp6-configuration">
      <title>DHCPv6 Server Configuration</title>
137 138
<section>
  <title>Introduction</title>
139
      <para>
140
        This section explains how to configure the DHCPv6 server using the
141 142
        Kea configuration backend. (Kea configuration using any other
        backends is outside of scope of this document.) Before DHCPv6
143
        is started, its configuration file has to be created. The
144
        basic configuration is as follows:
145
<screen>
146
{
147
# DHCPv6 configuration starts on the next line
148 149 150
"Dhcp6": {

# First we set up global values
151
    "valid-lifetime": 4000,
152 153 154 155
    "renew-timer": 1000,
    "rebind-timer": 2000,
    "preferred-lifetime": 3000,

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

161
# And we specify the type of lease database
162 163
    "lease-database": {
        "type": "memfile",
164
        "persist": true,
165 166 167 168 169 170 171 172 173 174 175 176 177 178
        "name": "/var/kea/dhcp6.leases"
    },

# Finally, we list the subnets from which we will be leasing addresses.
    "subnet6": [
        {
            "subnet": "2001:db8:1::/64",
            "pools": [
                 {
                     "pool": "2001:db8:1::1-2001:db8:1::ffff"
                 }
             ]
        }
    ]
179
# DHCPv6 configuration ends with the next line
180 181 182 183 184 185
}

} </screen>
</para>

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

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

<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
197
object, called Dhcp6. This is a simplified configuration, as usually
198
there will be additional objects, like <command>Logging</command> or
Francis Dupont's avatar
Francis Dupont committed
199
<command>DhcpDdns</command>, but we omit them now for clarity. The Dhcp6
200
configuration starts with the <command>"Dhcp6": {</command> line
201 202 203 204
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 Dhcp6 configuration.</para>

205
<para>In the general case, the order in which those parameters appear does not
206
matter. There are two caveats here though. The first one is to remember that
207 208 209
the configuration file must be well formed JSON. That means that 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
210 211
moving a parameter to or from the last position in a given scope may also require
moving the comma. The second caveat is that it is uncommon &mdash; although
212
legal JSON &mdash; to
213 214 215 216 217 218
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
reasons to keep multiple copies of the same parameter in your configuration
file.</para>

219 220
<para>Moving onto the DHCPv6 configuration elements, the very first few elements
define some global parameters. <command>valid-lifetime</command>
221
defines for how long the addresses (leases) given out by the server are valid. If
222
nothing changes, a client that got an address is allowed to use it for 4000
223 224 225
seconds. (Note that integer numbers are specified as is, without any quotes
around them.) The address will become deprecated in 3000 seconds (clients are
allowed to keep old connections, but can't use this address for creating new
226 227 228
connections). <command>renew-timer</command> and
<command> rebind-timer</command> are values that define T1 and T2 timers that
govern when the client will begin the renewal and rebind procedures.</para>
229

230 231 232 233 234 235 236 237 238 239 240 241 242 243
<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:
<screen>
"interfaces-config": {
    "interfaces": [ "eth0", "eth1" ]
},
</screen>
</para>

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

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

<para>The example contains a single subnet. Had more than one been defined,
additional elements
in the <command>subnet6</command> parameter would be specified and
separated by commas. For example, to define two subnets, the following
syntax would be used:
274
<screen>
275 276
"subnet6": [
    {
277
        "pools": [ { "pool": "2001:db8:1::/112" } ],
278 279 280
        "subnet": "2001:db8:1::/64"
    },
    {
281
        "pools": [ { "pool": "2001:db8:2::1-2001:db8:2::ffff" } ],
282
        "subnet": "2001:db8:2::/64"
283 284
    }
]
285
</screen>
286
Note that indentation is optional and is used for aesthetic purposes only.
287
In some cases in may be preferable to use more compact notation.
288
</para>
289

290 291
<para>After all parameters are specified, we have two contexts open:
global and Dhcp6, hence we need two closing curly brackets to close them.
292 293
In a real life configuration file there most likely would be additional
components defined such as Logging or DhcpDdns, so the closing brace would
294 295 296 297 298 299
be followed by a comma and another object definition.</para>
</section>

<section>
  <title>Lease Storage</title>
  <para>All leases issued by the server are stored in the lease database.
300
  Currently there are four database backends available:  memfile (which is the
301
  default backend), MySQL, PostgreSQL and Cassandra.</para>
302
<section>
303
  <title>Memfile - Basic Storage for Leases</title>
304 305 306

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

  <para>The configuration of the file backend (Memfile) is controlled through
314 315 316
  the Dhcp6/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
317 318
  be used as the storage. The following list gives additional, optional,
  parameters that can be used to configure the Memfile backend.
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345

  <itemizedlist>
    <listitem>
      <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>
    </listitem>

    <listitem>
      <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-leases6.csv"
      </userinput>.</simpara>
    </listitem>

    <listitem>
      <simpara><command>lfc-interval</command>: specifies the interval in seconds, at
346 347
      which the server will perform a lease file cleanup (LFC).  This
      removes redundant (historical) information from the lease file
348 349 350 351 352 353 354 355 356
      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
      <command>lfc-interval</command> is <userinput>0</userinput>, which disables
      the LFC.</simpara>
    </listitem>

  </itemizedlist>
  </para>

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

359
<screen>
360
"Dhcp6": {
361 362
    "lease-database": {
        <userinput>"type": "memfile"</userinput>,
363
        <userinput>"persist": true</userinput>,
364 365
        <userinput>"name": "/tmp/kea-leases6.csv"</userinput>,
        <userinput>"lfc-interval": 1800</userinput>
366 367 368
    }
}
</screen>
369 370 371 372 373

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

376
  <para>It is important to know how the lease file contents are organized
377
  to understand why the periodic lease file cleanup is needed. Every time
378 379
  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,
380 381 382
  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
383 384 385 386 387 388
  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
389
  the server's startup and reconfiguration as it needs to process a larger number
390 391 392
  of lease entries.
  </para>

393
  <para>Lease file cleanup (LFC) removes all previous entries for each client and
394 395
  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
396 397
  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
398 399 400 401
  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
402
  is still in progress. But it implies that the actual cleanups will be
403
  triggered more rarely than configured. Moreover, triggering a new cleanup
404
  adds an overhead to the server which will not be able to respond to new
405 406
  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
407
  is selected in a way that would allow for the LFC to complete the cleanup before a
408 409 410
  new cleanup is triggered.
  </para>

411 412 413
  <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
414 415 416 417 418 419
  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:
  <ulink url="http://kea.isc.org/wiki/LFCDesign"/>.
  </para>
420

421 422 423
</section>

<section id="database-configuration6">
424
  <title>Lease Database Configuration</title>
425 426

  <note>
427
    <para>Lease database access information must be configured for the DHCPv6 server,
428 429 430 431 432
    even if it has already been configured for the DHCPv4 server.  The servers
    store their information independently, so each server can use a separate
    database or both servers can use the same database.</para>
  </note>

433 434
  <para>Lease database configuration is controlled through the
  Dhcp6/lease-database parameters. The type of the database must be set to
435
  "memfile", "mysql", "postgresql" or "cql", e.g.
436
<screen>
437
"Dhcp6": { "lease-database": { <userinput>"type": "mysql"</userinput>, ... }, ... }
438
</screen>
439
  Next, the name of the database is to hold the leases must be set: this is the
440
  name used when the database was created
441 442 443
  (see <xref linkend="mysql-database-create"/>,
  <xref linkend="pgsql-database-create"/>
  or <xref linkend="cql-database-create"/>).
444
<screen>
445
"Dhcp6": { "lease-database": { <userinput>"name": "<replaceable>database-name</replaceable>" </userinput>, ... }, ... }
446
</screen>
447 448 449
  If the database is located on a different system to the DHCPv6 server, the
  database host name must also be specified. (It should be noted that this
  configuration may have a severe impact on server performance.):
450
<screen>
451
"Dhcp6": { "lease-database": { <userinput>"host": <replaceable>remote-host-name</replaceable></userinput>, ... }, ... }
452
</screen>
453 454
  The usual state of affairs will be to have the database on the same machine as
  the DHCPv6 server.  In this case, set the value to the empty string:
455
<screen>
456
"Dhcp6": { "lease-database": { <userinput>"host" : ""</userinput>, ... }, ... }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
457
</screen>
458
  Should the database use a port different than default, it may be
Tomek Mrugalski's avatar
Tomek Mrugalski committed
459 460 461
  specified as well:
<screen>
"Dhcp4": { "lease-database": { <userinput>"port" : 12345</userinput>, ... }, ... }
462
</screen>
463 464 465
  Should the database be located on a different system, you may need to specify a longer interval
  for the connection timeout:
<screen>
466
"Dhcp6": { "lease-database": { <userinput>"connect-timeout" : <replaceable>timeout-in-seconds</replaceable></userinput>, ... }, ... }
467 468
</screen>
The default value of five seconds should be more than adequate for local connections.
469
If a timeout is given though, it should be an integer greater than zero.
470
  </para>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
471 472 473 474 475 476 477 478 479 480 481

  <para>
    Note that host parameter is used by MySQL and PostgreSQL
    backends. 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:
<screen>
"Dhcp4": { "lease-database": { <userinput>"contact-points" : "192.0.2.1,192.0.2.2"</userinput>, ... }, ... }
</screen>
  </para>

482 483
  <para>Finally, the credentials of the account under which the server will
  access the database should be set:
484
<screen>
485
"Dhcp6": { "lease-database": { <userinput>"user": "<replaceable>user-name</replaceable>"</userinput>,
486
                               <userinput>"password": "<replaceable>password</replaceable>"</userinput>,
487 488
                              ... },
           ... }
489
</screen>
490 491 492 493
  If there is no password to the account, set the password to the empty string
  "". (This is also the default.)</para>
</section>
</section>
494

495
<section id="hosts6-storage">
496 497
  <title>Hosts Storage</title>
    <para>Kea is also able to store information about host reservations in the
498 499
    database. The hosts database configuration uses the same syntax as the lease
    database. In fact, a Kea server opens independent connections for each
500
    purpose, be it lease or hosts information. This arrangement gives the most
501
    flexibility. Kea can be used to keep leases and host reservations
502
    separately, but can also point to the same database. Currently the
503
    supported hosts database types are MySQL and PostgreSQL. The Cassandra
504
    backend does not support host reservations yet.</para>
505

506
    <para>Please note that usage of hosts storage is optional. A user can define
507
    all host reservations in the configuration file. That is the recommended way
508 509 510
    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)
511
    can be used together. If hosts are defined in both places, the definitions
512
    from the configuration file are checked first and external storage is checked
513
    later, if necessary.</para>
514 515

<section id="hosts-database-configuration6">
516
  <title>DHCPv6 Hosts Database Configuration</title>
517 518

  <para>Hosts database configuration is controlled through the Dhcp6/hosts-database
519
  parameters. If enabled, the type of the database must be set to "mysql" or
520
  "postgresql". Other hosts backends may be added in later version of Kea.
521 522 523
<screen>
"Dhcp6": { "hosts-database": { <userinput>"type": "mysql"</userinput>, ... }, ... }
</screen>
524 525 526
  Next, the name of the database to hold the reservations must be set: this is the
  name used when the database was created  (see <xref linkend="supported-databases"/>
  for instructions how to setup desired database type).
527 528 529
<screen>
"Dhcp6": { "hosts-database": { <userinput>"name": "<replaceable>database-name</replaceable>" </userinput>, ... }, ... }
</screen>
530
  If the database is located on a different system than the DHCPv6 server, the
531
  database host name must also be specified. (Again it should be noted that this
532 533 534 535 536 537 538 539
  configuration may have a severe impact on server performance):
<screen>
"Dhcp6": { "hosts-database": { <userinput>"host": <replaceable>remote-host-name</replaceable></userinput>, ... }, ... }
</screen>
  The usual state of affairs will be to have the database on the same machine as
  the DHCPv6 server.  In this case, set the value to the empty string:
<screen>
"Dhcp6": { "hosts-database": { <userinput>"host" : ""</userinput>, ... }, ... }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
540 541 542
</screen>
<screen>
"Dhcp4": { "hosts-database": { <userinput>"port" : 12345</userinput>, ... }, ... }
543 544 545 546 547 548 549 550 551 552 553 554 555
</screen>
  </para>
  <para>Finally, the credentials of the account under which the server will
  access the database should be set:
<screen>
"Dhcp6": { "hosts-database": { <userinput>"user": "<replaceable>user-name</replaceable>"</userinput>,
                               <userinput>"password": "<replaceable>password</replaceable>"</userinput>,
                              ... },
           ... }
</screen>
  If there is no password to the account, set the password to the empty string
  "". (This is also the default.)</para>
</section>
556 557

<section id="read-only-database-configuration6">
558
<title>Using Read-Only Databases for Host Reservations</title>
559
<para>
560 561
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
562 563 564
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
565
static reservations assigned to them. The inventory database can be used to create
566 567 568
a view of a Kea hosts database and such view is often read only.
</para>
<para>
569 570 571 572 573 574 575
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
576 577
<command>readonly</command> boolean parameter as follows:
<screen>
578
"Dhcp6": { "hosts-database": { <userinput>"readonly": true</userinput>, ... }, ... }
579 580 581 582 583 584 585 586 587
</screen>
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.
</para>
<note><para>The <command>readonly</command> parameter is currently only supported
for MySQL and PostgreSQL databases.</para></note>
</section>

588
</section>
589

590

591
<section id="dhcp6-interface-selection">
592
  <title>Interface Selection</title>
593
  <para>The DHCPv6 server has to be configured to listen on specific network
594
  interfaces.  The simplest network interface configuration instructs the server to
595 596
  listen on all available interfaces:
  <screen>
597 598 599 600 601 602 603
"Dhcp6": {
    "interfaces-config": {
        "interfaces": [ <userinput>"*"</userinput> ]
    }
    ...
}
</screen>
604 605 606
  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:
  <screen>
607 608 609 610 611 612 613 614
"Dhcp6": {
    "interfaces-config": {
        "interfaces": [ <userinput>"eth1", "eth3"</userinput> ]
    },
    ...
}
  </screen>
</para>
615
  <para>It is possible to use wildcard interface name (asterisk) concurrently
616
  with the actual interface names:
617
  <screen>
618 619 620 621 622 623 624
"Dhcp6": {
    "interfaces-config": {
        "interfaces": [ <userinput>"eth1", "eth3", "*"</userinput> ]
    },
    ...
}
  </screen>
625 626 627
It is anticipated that this will form of usage only be used where it is desired to
temporarily override a list of interface names and listen on all interfaces.
  </para>
Francis Dupont's avatar
Francis Dupont committed
628 629 630 631

  <para>As for the DHCPv4 server binding to specific addresses and
  disabling re-detection of interfaces are supported. But
  <command>dhcp-socket-type</command> is not because DHCPv6 uses
632 633
  UDP/IPv6 sockets only. The following example shows how to disable the
  interface detection:
Francis Dupont's avatar
Francis Dupont committed
634 635
  </para>

636 637 638 639 640 641 642 643 644 645
  <screen>
"Dhcp6": {
    "interfaces-config": {
        "interfaces": [ <userinput>"eth1", "eth3"</userinput> ],
        "re-detect": <userinput>false</userinput>
    },
    ...
}
  </screen>

646
</section>
647 648 649 650

    <section id="ipv6-subnet-id">
      <title>IPv6 Subnet Identifier</title>
      <para>
651
        The subnet identifier is a unique number associated with a particular subnet.
652 653
        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
654 655 656 657 658
        be automatically assigned by the configuration mechanism. The identifiers
        are assigned from 1 and are monotonically increased for each subsequent
        subnet: 1, 2, 3 ....
      </para>
      <para>
659 660 661 662 663 664 665 666 667 668
        If there are multiple subnets configured with auto-generated identifiers and
        one of them is removed, the subnet identifiers may be renumbered. For example:
        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
        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
        future version of Kea.  However, the only remedy for this issue
        at present is to
        manually specify a unique identifier for each subnet.
669 670
      </para>
      <para>
671 672
        The following configuration will assign the specified subnet
        identifier to the newly configured subnet:
673

674
        <screen>
675 676
"Dhcp6": {
    "subnet6": [
677 678 679 680 681
        {
            "subnet": "2001:db8:1::/64",
            <userinput>"id": 1024</userinput>,
            ...
        }
682 683 684
    ]
}
</screen>
685 686 687
        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
        identifier.
688
      </para>
689 690
      <!-- @todo: describe whether database needs to be updated after changing
      id -->
691 692 693
    </section>

    <section id="dhcp6-unicast">
694
      <title>Unicast Traffic Support</title>
695
      <para>
696
        When the DHCPv6 server starts, by default it listens to the DHCP traffic
697 698 699 700
        sent to multicast address ff02::1:2 on each interface that it is
        configured to listen on (see <xref linkend="dhcp6-interface-selection"/>).
        In some cases it is useful to configure a server to handle incoming
        traffic sent to the global unicast addresses as well. The most common
701 702 703
        reason for this is to have relays send their traffic to the server
        directly. To configure the server to listen on a specific unicast address,
        nn interface name can be
704
        optionally followed by a slash, followed by the global unicast address on which
705 706
        the server should listen. The server listens to this address in addition to normal
        link-local binding and listening on ff02::1:2 address. The sample configuration
707
        below shows how to listen on 2001:db8::1 (a global address)
708 709 710
        configured on the eth1 interface.
      </para>
      <para>
711 712
 <screen>
"Dhcp6": {
713 714 715
    "interfaces-config": {
        "interfaces": [ <userinput>"eth1/2001:db8::1"</userinput> ]
    },
716
    ...
717 718 719
    "option-data": [
        {
            "name": "unicast",
Francis Dupont's avatar
Francis Dupont committed
720
            "data": "2001:db8::1"
721 722
        } ],
    ...
723 724
}
 </screen>
725

726
        This configuration will cause the server to listen on
727
        eth1 on the link-local address, the multicast group (ff02::1:2) and 2001:db8::1.
728
      </para>
729 730 731
      <para>
        Usually unicast support is associated with a server unicast option
        which allows clients to send unicast messages to the server.
732 733
        The example above includes a server unicast option specification
        which will cause the client to send messages to the specified
Francis Dupont's avatar
Francis Dupont committed
734
        unicast address.
735
      </para>
736 737
      <para>
        It is possible to mix interface names, wildcards and interface name/addresses
738
        in the list of interfaces. It is not possible however to specify more than one
739 740 741 742
        unicast address on a given interface.
      </para>
      <para>
        Care should be taken to specify proper unicast addresses. The server will
743 744 745
        attempt to bind to the addresses specified without any additional checks.
        This approach has selected on purpose to allow the software to
        communicate over uncommon addresses if so desired.
746 747 748 749 750 751
      </para>
    </section>

    <section id="dhcp6-address-config">
      <title>Subnet and Address Pool</title>
      <para>
752
        The main role of a DHCPv6 server is address assignment. For this,
753 754 755 756 757 758 759
        the server has to be configured with at least one subnet and one pool of dynamic
        addresses to be managed. For example, assume that the server
        is connected to a network segment that uses the 2001:db8:1::/64
        prefix. The Administrator of that network has decided that addresses from range
        2001:db8:1::1 to 2001:db8:1::ffff are going to be managed by the Dhcp6
        server. Such a configuration can be achieved in the following way:
        <screen>
760 761 762 763 764 765
"Dhcp6": {
    <userinput>"subnet6": [
       {
           "subnet": "2001:db8:1::/64",
           "pools": [
               {
766
                   "pool": "2001:db8:1::1-2001:db8:1::ffff"
767 768 769 770 771 772 773
               }
           ],
           ...
       }
    ]</userinput>
}</screen>

774 775 776 777
        Note that <command>subnet</command> is defined as a simple string, but
        the <command>pools</command> parameter is actually a list of pools: for
        this reason, the pool definition is enclosed in square brackets, even
        though only one range of addresses is specified.</para>
778 779

        <para>Each <command>pool</command> is a structure that contains the
780
        parameters that describe a single pool. Currently there is only one
781 782 783 784
        parameter, <command>pool</command>, which gives the range of addresses
        in the pool. Additional parameters will be added in future releases of
        Kea.</para>

785 786
        <para>It is possible to define more than one pool in a
        subnet: continuing the previous example, further assume that
787
        2001:db8:1:0:5::/80 should also be managed by the server. It could be written as
788 789 790 791 792
        2001:db8:1:0:5:: to 2001:db8:1::5:ffff:ffff:ffff, but typing so many 'f's
        is cumbersome. It can be expressed more simply as 2001:db8:1:0:5::/80. Both
        formats are supported by Dhcp6 and can be mixed in the pool list.
        For example, one could define the following pools:
        <screen>
793 794 795 796 797
"Dhcp6": {
    <userinput>"subnet6": [
    {
        "subnet": "2001:db8:1::/64",
        "pools": [
798 799
            { "pool": "2001:db8:1::1-2001:db8:1::ffff" },
            { "pool": "2001:db8:1:05::/80" }
800 801 802 803 804
        ]</userinput>,
        ...
    }
    ]
}</screen>
805 806 807 808
        White space in pool definitions is ignored, so spaces before and after the hyphen are optional.
        They can be used to improve readability.
      </para>
      <para>
809 810 811 812 813 814 815
        The number of pools is not limited, but for performance reasons it is recommended to
        use as few as possible.
      </para>
      <para>
         The server may be configured to serve more than one subnet. To add a second subnet,
         use a command similar to the following:
        <screen>
816 817 818 819 820
"Dhcp6": {
    <userinput>"subnet6": [
    {
        "subnet": "2001:db8:1::/64",
        "pools": [
821
            { "pool": "2001:db8:1::1-2001:db8:1::ffff" }
822 823 824 825 826
        ]
    },
    {
        "subnet": "2001:db8:2::/64",
        "pools": [
827
            { "pool": "2001:db8:2::/64" }
828 829 830 831 832 833
        ]
    },
</userinput>
        ...
    ]
}</screen>
834
        In this example, we allow the server to
835
        dynamically assign all addresses available in the whole subnet. Although
836
        rather wasteful, it is certainly a valid configuration to dedicate the
837
        whole /64 subnet for that purpose. Note that the Kea server does not preallocate
838
        the leases, so there is no danger in using gigantic address pools.
839 840 841
      </para>
      <para>
        When configuring a DHCPv6 server using prefix/length notation, please pay
842 843
        attention to the boundary values. When specifying that the server can use
        a given pool, it will also be able to allocate the first (typically network
844
        address) address from that pool. For example, for pool 2001:db8:2::/64 the
845 846
        2001:db8:2:: address may be assigned as well. If you want to avoid this,
        use the "min-max" notation.
847 848 849 850 851 852
      </para>
    </section>

    <section>
      <title>Subnet and Prefix Delegation Pools</title>
      <para>
853
        Subnets may also be configured to delegate prefixes, as defined in
854 855 856 857 858 859 860 861 862 863
        <ulink url="http://tools.ietf.org/html/rfc3633">RFC 3633</ulink>.  A
        subnet may have one or more prefix delegation pools.  Each pool has a
        prefixed address, which is specified as a prefix
        (<command>prefix</command>) and a prefix length
        (<command>prefix-len</command>), as well as a delegated prefix length
        (<command>delegated-len</command>). The delegated length must not be
        shorter (that is it must be numerically greater or equal) than the
        prefix length.  If both the delegated and prefix lengths are equal, the
        server will be able to delegate only one prefix. The delegated prefix
        does not have to match the subnet prefix.
864 865 866
      </para>
      <para> Below is a sample subnet configuration which enables prefix
      delegation for the subnet:
867
      <screen>
868 869 870 871 872 873
"Dhcp6": {
    "subnet6": [
        {
            "subnet": "2001:d8b:1::/64",
            <userinput>"pd-pools": [
                {
874
                    "prefix": "3000:1::",
875 876 877 878 879 880 881 882
                    "prefix-len": 64,
                    "delegated-len": 96
                }
            ]</userinput>
        }
    ],
    ...
}</screen>
883
      </para>
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919

    </section>

    <section id="pd-exclude-option">
        <title>Prefix Exclude Option</title>
        <para>
          For each delegated prefix the delegating router may choose to exclude
          a single prefix out of the delegated prefix as specified in the
          <ulink url="http://tools.ietf.org/html/rfc6603"> RFC 6603</ulink>.
          The requesting router must not assign the excluded prefix to any
          of its downstream interfaces and it is intended to be used on a
          link through which the delegating router exchanges DHCPv6 messages with
          the requesting router. The configuration example below demonstrates how
          to specify an excluded prefix within a prefix pool definition. The
          excluded prefix "2001:db8:1:babe:cafe:80::/72" will be sent to a
          requesting router which includes Prefix Exclude option in the ORO, and
          which is delegated a prefix from this pool.
        </para>
<screen>
"Dhcp6": {
    "subnet6": [
        {
            "subnet": "2001:db8:1::/48",
            "pd-pools": [
                {
                    "prefix": "2001:db8:1:8000::",
                    "prefix-len": 48,
                    "delegated-len": 64,
                    "excluded-prefix": "2001:db8:1:babe:cafe:80::",
                    "excluded-prefix-len": 72
                }
            ]
        }
    ]
}
</screen>
920 921 922
    </section>

    <section id="dhcp6-std-options">
923
      <title>Standard DHCPv6 Options</title>
924
      <para>
925 926
        One of the major features of a DHCPv6 server is to provide configuration
        options to clients.  Although there are several options that require
927
        special behavior, most options are sent by the server only if the client
928
        explicitly requests them.  The following example shows how to
929 930
        configure DNS servers, one of the most frequently used
        options.  Options specified in this way are considered
931 932 933
        global and apply to all configured subnets.

        <screen>
934
"Dhcp6": {
935 936 937 938 939
    "option-data": [
        {
           <userinput>"name": "dns-servers",
           "code": 23,
           "space": "dhcp6",
940
           "csv-format": true,
941 942 943 944 945
           "data": "2001:db8::cafe, 2001:db8::babe"</userinput>
        },
        ...
    ]
}
946 947
</screen>
      </para>
948

949
    <para>
950
      The <command>option-data</command> line creates a new entry in
951
      the option-data table.  This table contains
952
      information on all global options that the server is supposed to configure
953
      in all subnets.  The <command>name</command> line specifies the option name.
954
      (For a complete list
955
      of currently supported names, see <xref
956
      linkend="dhcp6-std-options-list"/>.)  The next line specifies the option code,
957 958 959
      which must match one of the values from that list. The line beginning with
      <command>space</command> specifies the option space, which must always be set
      to "dhcp6" as these are standard DHCPv6 options.  For other name spaces,
960
      including custom option spaces, see <xref
961
      linkend="dhcp6-option-spaces"/>. The following line specifies the format in
962
      which the data will be entered: use of CSV (comma separated values) is
963
      recommended. Finally, the <command>data</command> line gives the actual value to be sent to
964
      clients.  Data is specified as normal text, with values separated by
965
      commas if more than one value is allowed.
966 967 968
    </para>

    <para>
969
      Options can also be configured as hexadecimal values.  If "csv-format" is
970
      set to false, the option data must be specified as a string of hexadecimal
971
      numbers.  The
972 973 974
      following commands configure the DNS-SERVERS option for all
      subnets with the following addresses: 2001:db8:1::cafe and
      2001:db8:1::babe.
975
        <screen>
976
"Dhcp6": {
977 978 979 980 981
    "option-data": [
        {
           <userinput>"name": "dns-servers",
           "code": 23,
           "space": "dhcp6",
982
           "csv-format": false,
983 984 985 986 987 988 989
           "data": "2001 0DB8 0001 0000 0000 0000 0000 CAFE
                    2001 0DB8 0001 0000 0000 0000 0000 BABE"</userinput>
        },
        ...
    ]
}
</screen>
990 991
       </para>
       <note><para>
992
       The value for the setting of the "data" element is split across two
993 994 995 996 997
       lines in this example for clarity: when entering the command, the
       whole string should be entered on the same line.
       </para></note>
       <para>
       Care should be taken
998 999
       to use proper encoding when using hexadecimal format as Kea's ability
       to validate data correctness in hexadecimal is limited.
1000 1001
      </para>

1002
      <para>
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
        Most of the parameters in the "option-data" structure are
        optional and can be omitted in some circumstances as discussed
        in the <xref linkend="dhcp6-option-data-defaults"/>. Only one
        of name or code is required, so you don't need to specify
        both. Space has a default value of "dhcp6", so you can skip
        this as well if you define a regular (not encapsulated) DHCPv6
        option.  Finally, csv-format defaults to true, so it too can
        be skipped, unless you want to specify the option value as
        hexstring. Therefore the above example can be simplified to:
        <screen>
1013
"Dhcp6": {
1014 1015 1016 1017 1018 1019 1020
    "option-data": [
        {
           <userinput>"name": "dns-servers",
           "data": "2001:db8::cafe, 2001:db8::babe"</userinput>
        },
        ...
    ]
1021 1022 1023 1024
}
        </screen>
        Defined options are added to response when the client requests them
        at a few exceptions which are always added. To enforce the addition
1025
        of a particular option set the always-send flag to true as in:
1026 1027 1028 1029 1030 1031
        <screen>
"Dhcp6": {
    "option-data": [
        {
           <userinput>"name": "dns-servers",
           "data": "2001:db8::cafe, 2001:db8::babe",
1032
           "always-send": true</userinput>
1033 1034 1035 1036 1037
        },
        ...
    ]
}
        </screen>
1038
        The effect is the same as if the client added the option code in the
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
        Option Request Option (or its equivalent for vendor options) so in:
        <screen>
"Dhcp6": {
    "option-data": [
        {
           <userinput>"name": "dns-servers",
           "data": "2001:db8::cafe, 2001:db8::babe",
           "always-send": true</userinput>
        },
        ...
    ],
    "subnet6": [
        {
           "subnet": "2001:db8:1::/64",
           "option-data": [
               {
                   <userinput>"name": "dns-servers",
                   "data": "2001:db8:1::cafe, 2001:db8:1::babe"</userinput>
               },
               ...
           ],
           ...
        },
        ...
    ],
    ...
}
        </screen>
        The DNS Servers option is always added to responses
        (the always-send is "sticky") but the value is the subnet one
        when the client is localized in the subnet.
1070 1071
      </para>

1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
    <para>
      It is possible to override options on a per-subnet basis.  If
      clients connected to most of your subnets are expected to get the
      same values of a given option, you should use global options: you
      can then override specific values for a small number of subnets.
      On the other hand, if you use different values in each subnet,
      it does not make sense to specify global option values
      (Dhcp6/option-data), rather you should set only subnet-specific values
      (Dhcp6/subnet[X]/option-data[Y]).
     </para>
1082

1083 1084 1085 1086
     <para>
      The following commands override the global
      DNS servers option for a particular subnet, setting a single DNS
      server with address 2001:db8:1::3.
1087 1088 1089 1090 1091 1092 1093 1094
<screen>
"Dhcp6": {
    "subnet6": [
        {
            <userinput>"option-data": [
                {
                    "name": "dns-servers",
                    "code": 23,
Jeremy C. Reed's avatar
Jeremy C. Reed committed
1095
                    "space": "dhcp6",
1096
                    "csv-format": true,
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
                    "data": "2001:db8:1::3"
                },
                ...
            ]</userinput>,
            ...
        },
        ...
    ],
    ...
}
</screen>
1108 1109
    </para>

1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
     <para>
       In some cases it is useful to associate some options with an
       address or prefix pool from which a client is assigned a lease. Pool
       specific option values override subnet specific and global option
       values. If the client is assigned multiple leases from different
       pools, the server will assign options from all pools from which the
       leases have been obtained. However, if the particular option is specified
       in multiple pools from which the client obtains the leases, only one
       instance of this option will be handed out to the client. The server's
       administrator must not try to prioritize assignment of pool specific
       options by trying to order pools declarations in the server
       configuration. Future Kea releases may change the order in which
       options are assigned from the pools without any notice.
     </para>

     <para>
       The following configuration snippet demonstrates how to specify the
       DNS servers option, which will be assigned to a client only if the
       client obtains an address from the given pool:
<screen>
"Dhcp6": {
    "subnet6": [
        {
            "pools": [