]>

It is recommended that the Kea DHCPv4 server be started and stopped using keactrl (described in ). However, it is also possible to run the server directly: it accepts the following command-line switches: -c file - specifies the configuration file. This is the only mandatory switch. -d - specifies whether the server logging should be switched to debug/verbose mode. In verbose mode, the logging severity and debuglevel specified in the configuration 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. -p port - specifies UDP port the server will listen on. This is only useful during testing, as the DHCPv4 server listening on ports other than default DHCPv4 ports will not be able to handle regular DHCPv4 queries. -v - prints out Kea version and exits. -V - prints out Kea extended version with additional parameters and exits. -W - prints out Kea configuration report and exits. The -V command returns the versions of the external libraries dynamically linked. The -W command describes the environment used to build Kea. This command displays a copy of the config.report file produced by ./configure that is embedded in the executable binary. The config.report may also be accessed more directly. The following command may be used to extract this information. The binary path may be found in the install directory or in the .libs subdirectory in the source tree. For example kea/src/bin/dhcp4/.libs/kea-dhcp4. strings path/kea-dhcp4 | sed -n 's/;;;; //p' When running in a console, the server can be shut down by pressing ctrl-c. It detects the key combination and shuts down gracefully. On start-up, the server will detect available network interfaces and will attempt to open UDP sockets on all interfaces mentioned in the configuration file. Since the DHCPv4 server opens privileged ports, it requires root access. Make sure you run this daemon as root. During startup the server will attempt to create a PID file of the form: [localstatedir]/[conf name].kea-dhcp4.pid where: localstatedir: 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. conf name: The configuration file name 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 case it would be necessary to manually delete the PID file.

This section explains how to configure the DHCPv4 server using the 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: { # DHCPv4 configuration starts in this line "Dhcp4": { # First we set up global values "valid-lifetime": 4000, "renew-timer": 1000, "rebind-timer": 2000, # 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": { "type": "memfile", "persist": true, "name": "/var/kea/dhcp4.leases" }, # Finally, we list the subnets from which we will be leasing addresses. "subnet4": [ { "subnet": "192.0.2.0/24", "pools": [ { "pool": "192.0.2.1 - 192.0.2.200" } ] } ] # DHCPv4 configuration ends with this line } } The following paragraphs provide a brief overview of the parameters in the above example and their format. Subsequent sections of this chapter go into much greater detail for these and other parameters. The lines starting with a hash (#) are comments and are ignored by the server; they do not impact its operation in any way. 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 Logging or DhcpDns, but we omit them now for clarity. The Dhcp4 configuration starts with the "Dhcp4": { line 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. 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 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 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 reasons to keep multiple copies of the same parameter in your configuration file. Moving onto the DHCPv4 configuration elements, the very first few elements define some global parameters. valid-lifetime defines for how long the addresses (leases) given out by the server are valid. If nothing changes, a client that got an address is allowed to use it for 4000 seconds. (Note that integer numbers are specified as is, without any quotes around them.) renew-timer and rebind-timer are values that define T1 and T2 timers that govern when the client will begin the renewal and rebind procedures. Note that renew-timer and rebind-timer are optional. If they are not specified the client will select values for T1 and T2 timers according to the RFC 2131. The interfaces-config map specifies the server configuration concerning the network interfaces, on which the server should listen to the DHCP messages. The interfaces 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 interfaces-config would look like this: "interfaces-config": { "interfaces": [ "eth0", "eth1" ] }, 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 memfile, 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, lease database configuration is more extensive and contains additional parameters. Note that lease-database is an object and opens up a new scope, using an opening brace. Its parameters (just one in this example -- type) follow. Had there been more than one, they would be separated by commas. This scope is closed with a closing brace. As more parameters follow, a trailing comma is present. Finally, we need to define a list of IPv4 subnets. This is the most important DHCPv4 configuration structure as the server uses that information to process clients' requests. It defines all subnets from which the server is expected to receive DHCP requests. The subnets are specified with the subnet4 parameter. It is a list, so it starts and ends with square brackets. Each subnet definition in 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: subnet (that defines the whole subnet) and pools (which is a list of dynamically allocated pools that are governed by the DHCP server). The example contains a single subnet. Had more than one been defined, additional elements in the subnet4 parameter would be specified and separated by commas. For example, to define three subnets, the following syntax would be used: "subnet4": [ { "pools": [ { "pool": "192.0.2.1 - 192.0.2.200" } ], "subnet": "192.0.2.0/24" }, { "pools": [ { "pool": "192.0.3.100 - 192.0.3.200" } ], "subnet": "192.0.3.0/24" }, { "pools": [ { "pool": "192.0.4.1 - 192.0.4.254" } ], "subnet": "192.0.4.0/24" } ] After all parameters are specified, we have two contexts open: global and Dhcp4, hence we need two closing curly brackets to close them. In a real life configuration file there most likely would be additional components defined such as Logging or DhcpDdns, so the closing brace would be followed by a comma and another object definition.

All leases issued by the server are stored in the lease database. Currently there are three database backends available: memfile (which is the default backend), MySQL and PostgreSQL.

The server is able to store lease data in different repositories. Larger deployments may elect to store leases in a database. describes this option. In typical smaller deployments though, the server will use a CSV file rather than a database to store lease information. As well as requiring less administration, an advantage of using a file for storage is that it eliminates a dependency on third-party database software. The configuration of the file backend (Memfile) is controlled through the Dhcp4/lease-database parameters. The type parameter is mandatory and it specifies which storage for leases the server should use. The value of "memfile" indicates that the file should be used as the storage. The following list presents the remaining, not mandatory parameters, which can be used to configure the Memfile backend. persist: 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 true 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 false is mostly useful for performance testing purposes. The default value of the persist parameter is true, which enables writing lease updates to the lease file. name: 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 "[kea-install-dir]/var/kea/kea-leases4.csv" . lfc-interval: specifies the interval in seconds, at which the server (Memfile backend) will perform a lease file cleanup (LFC), which removes the redundant (historical) information from the lease file 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 lfc-interval is 0, which disables the LFC. The example configuration of the Memfile backend is presented below: "Dhcp4": { "lease-database": { "type": "memfile", "persist": true, "name": "/tmp/kea-leases4.csv", "lfc-interval": 1800 } } This configuration selects the /tmp/kea-leases4.csv 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. It is important to know how the lease file contents are organized to understand why the periodic lease file cleanup is needed. Every time when 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, the server does not supersede the existing client's lease, as it would require the lookup of the specific lease entry, but simply appends the new lease information at the end of the lease file. The previous lease entries for the 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 larger number of lease entries. The lease file cleanup removes all previous entries for each client and 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 renewals initiated by the clients. The more frequent renewals are, the lesser value of the lfc-interval should be. Note however, that the 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 lfc-interval 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, this 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 requests for a short period of time when the new cleanup process is spawned. Therefore, it is recommended that the lfc-interval value is selected in a way that would allow for completing the cleanup before the new cleanup is triggered. The LFC is performed by a separate process (in background) to avoid performance impact on the server process. In order to avoid the conflicts between the two processes both using the same lease files, the LFC process 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: .

Lease database access information must be configured for the DHCPv4 server, even if it has already been configured for the DHCPv6 server. The servers store their information independently, so each server can use a separate database or both servers can use the same database. Lease database configuration is controlled through the Dhcp4/lease-database parameters. The type of the database must be set to "memfile", "mysql" or "postgresql", e.g. "Dhcp4": { "lease-database": { "type": "mysql", ... }, ... } Next, the name of the database to hold the leases must be set: this is the name used when the lease database was created (see or ). "Dhcp4": { "lease-database": { "name": "database-name" , ... }, ... } If the database is located on a different system to the DHCPv4 server, the database host name must also be specified (although it should be noted that this configuration may have a severe impact on server performance): "Dhcp4": { "lease-database": { "host": remote-host-name, ... }, ... } 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": { "host" : "", ... }, ... } Finally, the credentials of the account under which the server will access the database should be set: "Dhcp4": { "lease-database": { "user": "user-name", "password": "password", ... }, ... } If there is no password to the account, set the password to the empty string "". (This is also the default.)

This feature did not undergo the regular system level testing conducted by ISC. As such, please treat it as experimental. Kea is also able to store information about host reservations in the database. Hosts database configuration uses the same syntax as lease database. In fact, Kea server opens independent connections for each purpose, be it lease or hosts information. This gives the solution most flexibility. Kea can be used to keep leases and host reservations separately, but can also point to the same database. Currently the only supported hosts database type is MySQL. Please note that usage of hosts storage is optional. User can define all host reservations in the configuration file. That is the recommended way if the number of reservations is small. However, with the number of reservations growing it's more convenient to use host storage. Please note that both storages (configuration file and MySQL) can be used together. If hosts are defined in both places, the definitions from configuration file are checked first and external storage is checked later, if necessary. All hosts leases issued by the server are stored in the hosts database. Currently there is only one available backend: MySQL. Other host backends will become available in future Kea versions.

Hosts database configuration is controlled through the Dhcp4/hosts-database parameters. If enabled, the type of the database must be set to "mysql". Other hosts backends may be added in later Kea versions. "Dhcp4": { "hosts-database": { "type": "mysql", ... }, ... } Next, the name of the database to hold the leases must be set: this is the name used when the lease database was created (see ). "Dhcp4": { "hosts-database": { "name": "database-name" , ... }, ... } If the database is located on a different system to the DHCPv4 server, the database host name must also be specified (although it should be noted that this configuration may have a severe impact on server performance): "Dhcp4": { "hosts-database": { "host": remote-host-name, ... }, ... } 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": { "host" : "", ... }, ... } Finally, the credentials of the account under which the server will access the database should be set: "Dhcp4": { "hosts-database": { "user": "user-name", "password": "password", ... }, ... } If there is no password to the account, set the password to the empty string "". (This is also the default.)

The DHCPv4 server has to be configured to listen on specific network interfaces. The simplest network interface configuration tells the server to listen on all available interfaces: "Dhcp4": { "interfaces-config": { "interfaces": [ "*" ] } ... }, 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: "Dhcp4": { "interfaces-config": { "interfaces": [ "eth1", "eth3" ] }, ... } It is possible to use wildcard interface name (asterisk) concurrently with explicit interface names: "Dhcp4": { "interfaces-config": { "interfaces": [ "eth1", "eth3", "*" ] }, ... } 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. Some deployments of the DHCP servers require that the servers listen 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: "Dhcp4": { "interfaces-config": { "interfaces": [ "eth1/10.0.0.1", "eth3/192.0.2.3" ] }, ... } If it is desired that the server listens on multiple IPv4 addresses assigned to the same interface, multiple addresses can be specified for this interface as in the example below: "Dhcp4": { "interfaces-config": { "interfaces": [ "eth1/10.0.0.1", "eth1/10.0.0.2" ] }, ... } Alternatively, if the server should listen on all addresses for the particular interface, an interface name without any address should be specified. Kea supports responding to directly connected clients which don't have an address configured on the interface yet. This requires that the server 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 unicast packets from the relay agents, it is desired to configure the DHCP server to utilize the IP/UDP datagram sockets, instead of raw sockets. The following configuration demonstrates how this can be achieved: "Dhcp4": { "interfaces-config": { "interfaces": [ "eth1", "eth3" ], "dhcp-socket-type": "udp" }, ... } The dhcp-socket-type 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 dhcp-socket-type is set to raw, it configures the server to use raw sockets instead. If the dhcp-socket-type value is not specified, the default value raw is used. Using UDP sockets automatically disables the reception of broadcast 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 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. Specifying the value raw 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 the IP/UDP sockets.

The use of UDP sockets has certain benefits in deployments where the server receives only relayed traffic. These benefits are mentioned in the . From the administrator's perspective it is often desired to be able to configure the system's firewall to filter out the unwanted traffic, and the use of UDP sockets facilitates it. However, the administrator must also be aware of the implications related to filtering certain types of traffic as it may impair the DHCP server's operation. In this section we are focusing on the case when the server receives the DHCPINFORM message from the client via a relay. According to the RFC 2131, 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 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 a previous transaction that the client had with the server. When the ARP exchange is successful, the DHCP message can be unicast to the client, using the obtained address. 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. 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. 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.

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 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: 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. The following configuration will assign the specified subnet identifier to the newly configured subnet: "Dhcp4": { "subnet4": [ { "subnet": "192.0.2.0/24", "id": 1024, ... } ] } 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.

The essential role of DHCPv4 server is address assignment. 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 192.0.2.0/24 prefix. The Administrator of that network has decided that addresses from range 192.0.2.10 to 192.0.2.20 are going to be managed by the Dhcp4 server. Such a configuration can be achieved in the following way: "Dhcp4": { "subnet4": [ { "subnet": "192.0.2.0/24", "pools": [ { "pool": "192.0.2.10 - 192.0.2.20" } ], ... } ] } Note that subnet is defined as a simple string, but the pools parameter is actually a list of pools: for this reason, the pools definition is enclosed in square brackets, even though only one range of addresses is specified in this example. Each pool is a structure that contains the parameters that describe a single pool. Currently there is only one parameter, pool, which gives the range of addresses in the pool. Additional parameters will be added in future releases of Kea. It is possible to define more than one pool in a subnet: continuing the previous example, further assume that 192.0.2.64/26 should be also be managed by the server. It could be written as 192.0.2.64 to 192.0.2.127. Alternatively, it can be expressed more simply as 192.0.2.64/26. Both formats are supported by Dhcp4 and can be mixed in the pool list. For example, one could define the following pools: "Dhcp4": { "subnet4": [ { "subnet": "192.0.2.0/24", "pools": [ { "pool": "192.0.2.10-192.0.2.20" }, { "pool": "192.0.2.64/26" } ], ... } ], ... } The number of pools is not limited, but for performance reasons it is recommended to use as few as possible. White space in pool definitions is ignored, so spaces before and after the hyphen are optional. They can be used to improve readability. The server may be configured to serve more than one subnet: "Dhcp4": { "subnet4": [ { "subnet": "192.0.2.0/24", "pools": [ { "pool": "192.0.2.1 - 192.0.2.200" } ], ... }, { "subnet": "192.0.3.0/24", "pools": [ { "pool": "192.0.3.100 - 192.0.3.200" } ], ... }, { "subnet": "192.0.4.0/24", "pools": [ { "pool": "192.0.4.1 - 192.0.4.254" } ], ... } ] } When configuring a DHCPv4 server using prefix/length notation, please pay 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 address) and the last (typically broadcast address) address from that pool. In the aforementioned example of pool 192.0.3.0/24, both 192.0.3.0 and 192.0.3.255 addresses may be assigned as well. This may be invalid in some network configurations. If you want to avoid this, please use the "min-max" notation.

One of the major features of the DHCPv4 server is to provide configuration options to clients. Most of the options are sent by the server, only if the client explicitly requests them using the Parameter Request List option. Those that do not require being requested using the Parameter Request List option are commonly used options, e.g. "Domain Server", and options which require special behavior, e.g. "Client FQDN" is returned to the client if the client has included this option in its message to the server. The comprises the list of the standard DHCPv4 options, whose values can be configured using the configuration structures described in this section. This table excludes the options which require special processing and thus cannot be configured with some fixed values. The last column of this table specifies which options can be sent by the server even when they are not requested in the Parameter Request list option, and which are sent only when explicitly requested. These options are marked with the values 'true' and 'false' respectively. The following example shows how to configure the addresses of DNS servers, which is one of the most frequently used options. Options specified in this way are considered global and apply to all configured subnets. "Dhcp4": { "option-data": [ { "name": "domain-name-servers", "code": 6, "space": "dhcp4", "csv-format": true, "data": "192.0.2.1, 192.0.2.2" }, ... ] } The name parameter specifies the option name. For a list of currently supported names, see below. The code parameter specifies the option code, which must match one of the values from that list. The next line specifies the option space, which must always be set to "dhcp4" as these are standard DHCPv4 options. For other option spaces, including custom option spaces, see . The next line specifies the format in which the data will be entered: use of CSV (comma separated values) is recommended. The sixth line gives the actual value to be sent to clients. Data is specified as normal text, with values separated by commas if more than one value is allowed. Options can also be configured as hexadecimal values. If csv-format is set to false, option data must be specified as a hexadecimal string. The following commands configure the domain-name-servers option for all subnets with the following addresses: 192.0.3.1 and 192.0.3.2. Note that csv-format is set to false. "Dhcp4": { "option-data": [ { "name": "domain-name-servers", "code": 6, "space": "dhcp4", "csv-format": false, "data": "C0 00 03 01 C0 00 03 02" }, ... ], ... } Most of the parameters in the "option-data" structure are optional and can be omitted in some circumstances as discussed in the . It is possible to specify or 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 (Dhcp4/option-data), rather you should set only subnet-specific values (Dhcp4/subnet[X]/option-data[Y]). The following commands override the global DNS servers option for a particular subnet, setting a single DNS server with address 192.0.2.3. "Dhcp4": { "subnet4": [ { "option-data": [ { "name": "domain-name-servers", "code": 6, "space": "dhcp4", "csv-format": true, "data": "192.0.2.3" }, ... ], ... }, ... ], ... } The currently supported standard DHCPv4 options are listed in and . The "Name" and "Code" are the values that should be used as a name in the option-data structures. "Type" designates the format of the data: the meanings of the various types is given in . Some options are designated as arrays, which means that more than one value is allowed in such an option. For example the option time-servers allows the specification of more than one IPv4 address, so allowing clients to obtain the addresses of multiple NTP servers. The describes the configuration syntax to create custom option definitions (formats). It is generally not allowed to create custom definitions for standard options, even if the definition being created matches the actual option format defined in the RFCs. There is an exception from this rule for standard options for which Kea does not provide a definition yet. In order to use such options, a server administrator must create a definition as described in in the 'dhcp4' option space. This definition should match the option format described in the relevant RFC but the configuration mechanism will allow any option format as it has no means to validate the format at the moment. Name Code Type Array? Returned if not requested? time-offset2int32falsefalserouters3ipv4-addresstruetruetime-servers4ipv4-addresstruefalsename-servers5ipv4-addresstruefalsedomain-name-servers6ipv4-addresstruetruelog-servers7ipv4-addresstruefalsecookie-servers8ipv4-addresstruefalselpr-servers9ipv4-addresstruefalseimpress-servers10ipv4-addresstruefalseresource-location-servers11ipv4-addresstruefalseboot-size13uint16falsefalsemerit-dump14stringfalsefalsedomain-name15fqdnfalsetrueswap-server16ipv4-addressfalsefalseroot-path17stringfalsefalseextensions-path18stringfalsefalseip-forwarding19booleanfalsefalsenon-local-source-routing20booleanfalsefalsepolicy-filter21ipv4-addresstruefalsemax-dgram-reassembly22uint16falsefalsedefault-ip-ttl23uint8falsefalsepath-mtu-aging-timeout24uint32falsefalsepath-mtu-plateau-table25uint16truefalseinterface-mtu26uint16falsefalseall-subnets-local27booleanfalsefalsebroadcast-address28ipv4-addressfalsefalseperform-mask-discovery29booleanfalsefalsemask-supplier30booleanfalsefalserouter-discovery31booleanfalsefalserouter-solicitation-address32ipv4-addressfalsefalsestatic-routes33ipv4-addresstruefalsetrailer-encapsulation34booleanfalsefalsearp-cache-timeout35uint32falsefalseieee802-3-encapsulation36booleanfalsefalsedefault-tcp-ttl37uint8falsefalsetcp-keepalive-interval38uint32falsefalsetcp-keepalive-garbage39booleanfalsefalse Name Code Type Array? Returned if not requested? nis-domain40stringfalsefalsenis-servers41ipv4-addresstruefalsentp-servers42ipv4-addresstruefalsevendor-encapsulated-options43emptyfalsefalsenetbios-name-servers44ipv4-addresstruefalsenetbios-dd-server45ipv4-addresstruefalsenetbios-node-type46uint8falsefalsenetbios-scope47stringfalsefalsefont-servers48ipv4-addresstruefalsex-display-manager49ipv4-addresstruefalsedhcp-option-overload52uint8falsefalsedhcp-message56stringfalsefalsedhcp-max-message-size57uint16falsefalsevendor-class-identifier60binaryfalsefalsenwip-domain-name62stringfalsefalsenwip-suboptions63binaryfalsefalsetftp-server-name66stringfalsefalseboot-file-name67stringfalsefalseuser-class77binaryfalsefalseclient-system93uint16truefalseclient-ndi94record (uint8, uint8, uint8)falsefalseuuid-guid97record (uint8, binary)falsefalsesubnet-selection118ipv4-addressfalsefalsedomain-search119binaryfalsefalsevivco-suboptions124binaryfalsefalsevivso-suboptions125binaryfalsefalse NameMeaningbinaryAn arbitrary string of bytes, specified as a set of hexadecimal digits.booleanBoolean value with allowed values true or falseemptyNo value, data is carried in suboptionsfqdnFully qualified domain name (e.g. www.example.com)ipv4-addressIPv4 address in the usual dotted-decimal notation (e.g. 192.0.2.1)ipv6-addressIPv6 address in the usual colon notation (e.g. 2001:db8::1)recordStructured data that may comprise any types (except "record" and "empty")stringAny textuint88 bit unsigned integer with allowed values 0 to 255uint1616 bit unsigned integer with allowed values 0 to 65535uint3232 bit unsigned integer with allowed values 0 to 4294967295

Kea supports custom (non-standard) DHCPv4 options. Assume that we want to define a new DHCPv4 option called "foo" which will have code 222 and will convey a single unsigned 32 bit integer value. We can define such an option by using the following entry in the configuration file: "Dhcp4": { "option-def": [ { "name": "foo", "code": 222, "type": "uint32", "array": false, "record-types": "", "space": "dhcp4", "encapsulate": "" }, ... ], ... } The false value of the array parameter determines that the option does NOT comprise an array of "uint32" values but rather a single value. Two other parameters have been left blank: record-types and encapsulate. The former specifies the comma separated list of option data fields if the option comprises a record of data fields. This should be non-empty if the type is set to "record". Otherwise it must be left blank. The latter parameter specifies the name of the option space being encapsulated by the particular option. If the particular option does not encapsulate any option space it should be left blank. Note that the above set of comments define the format of the new option and do not set its values. The name, code and type parameters are required, all others are optional. The array default value is false. The record-types and encapsulate default values are blank (i.e. ""). The default space is "dhcp4". Once the new option format is defined, its value is set in the same way as for a standard option. For example the following commands set a global value that applies to all subnets. "Dhcp4": { "option-data": [ { "name": "foo", "code": 222, "space": "dhcp4", "csv-format": true, "data": "12345" }, ... ], ... } New options can take more complex forms than simple use of primitives (uint8, string, ipv4-address etc): it is possible to define an option comprising a number of existing primitives. Assume we want to define a new option that will consist of an IPv4 address, followed by an unsigned 16 bit integer, followed by a boolean value, followed by a text string. Such an option could be defined in the following way: "Dhcp4": { "option-def": [ { "name": "bar", "code": 223, "space": "dhcp4", "type": "record", "array": false, "record-types": "ipv4-address, uint16, boolean, string", "encapsulate": "" }, ... ], ... } The type is set to "record" to indicate that the option contains multiple values of different types. These types are given as a comma-separated list in the record-types field and should be those listed in . The values of the option are set as follows: "Dhcp4": { "option-data": [ { "name": "bar", "space": "dhcp4", "code": 223, "csv-format": true, "data": "192.0.2.100, 123, true, Hello World" } ], ... } csv-format is set to true to indicate that the data field comprises a command-separated list of values. The values in the data must correspond to the types set in the record-types field of the option definition. In the general case, boolean values are specified as true or false, without quotes. Some specific boolean parameters may accept also "true", "false", 0, 1, "0" and "1". Future Kea versions will accept all those values for all boolean parameters.

Currently there are two option spaces defined for the DHCPv4 daemon: "dhcp4" (for the top level DHCPv4 options) and "vendor-encapsulated-options-space", which is empty by default but options can be defined in it. Those options will be carried in the Vendor Specific Information option (code 43). The following examples show how to define an option "foo", with code 1, that consists of an IPv4 address, an unsigned 16 bit integer and a string. The "foo" option is conveyed in a Vendor Specific Information option. The first step is to define the format of the option: "Dhcp4": { "option-def": [ { "name": "foo", "code": 1, "space": "vendor-encapsulated-options-space", "type": "record", "array": false, "record-types": "ipv4-address, uint16, string", "encapsulate": "" } ], ... } (Note that the option space is set to "vendor-encapsulated-options-space".) Once the option format is defined, the next step is to define actual values for that option: "Dhcp4": { "option-data": [ { "name": "foo", "space": "vendor-encapsulated-options-space", "code": 1, "csv-format": true, "data": "192.0.2.3, 123, Hello World" } ], ... } We also include the Vendor Specific Information option, the option that conveys our sub-option "foo". This is required, else the option will not be included in messages sent to the client. "Dhcp4": { "option-data": [ { "name": "vendor-encapsulated-options" } ], ... } Alternatively, the option can be specified using its code. "Dhcp4": { "option-data": [ { "code": 43 } ], ... }

It is sometimes useful to define completely new option space. This is the case when user creates new option in the standard option space ("dhcp4") and wants this option to convey sub-options. Since they are in a separate space, sub-option codes will have a separate numbering scheme and may overlap with the codes of standard options. Note that creation of a new option space when defining sub-options for a standard option is not required, because it is created by default if the standard option is meant to convey any sub-options (see ). Assume that we want to have a DHCPv4 option called "container" with code 222 that conveys two sub-options with codes 1 and 2. First we need to define the new sub-options: "Dhcp4": { "option-def": [ { "name": "subopt1", "code": 1, "space": "isc", "type": "ipv4-address", "record-types": "", "array": false, "encapsulate "" }, { "name": "subopt2", "code": 2, "space": "isc", "type": "string", "record-types": "", "array": false, "encapsulate": "" } ], ... } Note that we have defined the options to belong to a new option space (in this case, "isc"). The next step is to define a regular DHCPv4 option with our desired code and specify that it should include options from the new option space: "Dhcp4": { "option-def": [ ..., { "name": "container", "code": 222, "space": "dhcp4", "type": "empty", "array": false, "record-types": "", "encapsulate": "isc" } ], ... } The name of the option space in which the sub-options are defined is set in the "encapsulate" field. The "type" field is set to "empty" to indicate that this option does not carry any data other than sub-options. Finally, we can set values for the new options: "Dhcp4": { "option-data": [ { "name": "subopt1", "code": 1, "space": "isc", "data": "192.0.2.3" }, } "name": "subopt2", "code": 2, "space": "isc", "data": "Hello world" }, { "name": "container", "code": 222, "space": "dhcp4" } ], ... } Note that it is possible to create an option which carries some data in addition to the sub-options defined in the encapsulated option space. For example, if the "container" option from the previous example was required to carry an uint16 value as well as the sub-options, the "type" value would have to be set to "uint16" in the option definition. (Such an option would then have the following data structure: DHCP header, uint16 value, sub-options.) The value specified with the "data" parameter — which should be a valid integer enclosed in quotes, e.g. "123" — would then be assigned to the uint16 field in the "container" option.

In many cases it is not required to specify all parameters for an option configuration and the default values may be used. However, it is important to understand the implications of not specifying some of them as it may result in configuration errors. The list below explains the behavior of the server when a particular parameter is not explicitly specified: name - the server requires an option name or option code to identify an option. If this parameter is unspecified, the option code must be specified. code - the server requires an option name or option code to identify an option. This parameter may be left unspecified if the name parameter is specified. However, this also requires that the particular option has its definition (it is either a standard option or an administrator created a definition for the option using an 'option-def' structure), as the option definition associates an option with a particular name. It is possible to configure an option for which there is no definition (unspecified option format). Configuration of such options requires the use of option code. space - if the option space is unspecified it will default to 'dhcp4' which is an option space holding DHCPv4 standard options. data - if the option data is unspecified it defaults to an empty value. The empty value is mostly used for the options which have no payload (boolean options), but it is legal to specify empty values for some options which carry variable length data and which spec allows for the length of 0. For such options, the data parameter may be omitted in the configuration. csv-format - if this value is not specified and the definition for the particular option exists, the server will assume that the option data is specified as a list of comma separated values to be assigned to individual fields of the DHCP option. If the definition does not exist for this option, the server will assume that the data parameter contains the option payload in the binary format (represented as a string of hexadecimal digits). Note that not specifying this parameter doesn't imply that it defaults to a fixed value, but the configuration data interpretation also depends on the presence of the option definition. An administrator must be aware if the definition for the particular option exists when this parameter is not specified. It is generally recommended to not specify this parameter only for the options for which the definition exists, e.g. standard options. Setting csv-format to an explicit value will cause the server to strictly check the format of the option data specified.

The DHCPv4 server supports the stateless client configuration whereby the client has an IP address configured (e.g. using manual configuration) and only contacts the server to obtain other configuration parameters, e.g. DNS servers' addresses. In order to obtain the stateless configuration parameters the client sends the DHCPINFORM message to the server with the "ciaddr" set to the address that the client is currently using. The server unicasts the DHCPACK message to the client that includes the stateless configuration ("yiaddr" not set). The server will respond to the DHCPINFORM when the client is associated with the particular subnet defined in the server's configuration. The example subnet configuration will look like this: "Dhcp4": { "subnet4": [ { "subnet": "192.0.2.0/24" "option-data": [ { "name": "domain-name-servers", "code": 6, "data": "192.0.2.200,192.0.2.201", "csv-format": true, "space": "dhcp4" } ] } ] } This subnet specifies the single option which will be included in the DHCPACK message to the client in response to DHCPINFORM. Note that the subnet definition does not require the address pool configuration if it will be used solely for the stateless configuration. This server will associate the subnet with the client if one of the following conditions is met: The DHCPINFORM is relayed and the giaddr matches the configured subnet. The DHCPINFORM is unicast from the client and the ciaddr matches the configured subnet. The DHCPINFORM is unicast from the client, the ciaddr is not set but the source address of the IP packet matches the configured subnet. The DHCPINFORM is not relayed and the IP address on the interface on which the message is received matches the configured subnet.

The DHCPv4 server includes support for client classification. At the current time the capabilities of the classification process are limited but it is expected they will be expanded in the future. For a deeper discussion of the classification process see . In certain cases it is useful to differentiate between different types of clients and treat them accordingly. It is envisaged that client classification will be used for changing the behavior of almost any part of the DHCP message processing, including the assignment of leases from different pools, the assignment of different options (or different values of the same options) etc. In the current release of the software however, there are only three mechanisms that take advantage of client classification: subnet selection, assignment of different options, and, for cable modems, there are specific options for use with the TFTP server address and the boot file field. Kea can be instructed to limit access to given subnets based on class information. This is particularly useful for cases where two types of devices share the same link and are expected to be served from two different subnets. The primary use case for such a scenario is cable networks. There are two classes of devices: the cable modem itself, which should be handed a lease from subnet A and all other devices behind the modem that should get a lease from subnet B. That segregation is essential to prevent overly curious users from playing with their cable modems. For details on how to set up class restrictions on subnets, see . The process of doing classification is conducted in three steps. The first step is to assess an incoming packet and assign it to zero or more classes. The second step is to choose a subnet, possibly based on the class information. The third step is to assign options again possibly based on the class information. There are two methods of doing classification. The first is automatic and relies on examining the values in the vendor class options. Information from these options is extracted and a class name is constructed from it and added to the class list for the packet. The second allows you to specify an expression that is evaluated for each packet. If the result is true the packet is a member of the class. Care should be taken with client classification as it is easy for clients that do not meet class criteria to be denied any service altogether.

The server checks whether an incoming packet includes the vendor class identifier option (60). If it does, the content of that option is prepended with "VENDOR_CLASS_" then it is interpreted as a class. For example, modern cable modems will send this option with value "docsis3.0" and as a result the packet will belong to class "VENDOR_CLASS_docsis3.0". For clients that belong to the VENDOR_CLASS_docsis3.0 class, the siaddr field is set to the value of next-server (if specified in a subnet). If there is a boot-file-name option specified, its value is also set in the file field in the DHCPv4 packet. For eRouter1.0 class, the siaddr is always set to 0.0.0.0. That capability is expected to be moved to an external hook library that will be dedicated to cable modems. This example shows a configuration using an automatically generated "VENDOR_CLASS_" class. The Administrator of the network has decided that addresses from range 192.0.2.10 to 192.0.2.20 are going to be managed by the Dhcp4 server and only clients belonging to the docsis3.0 client class are allowed to use that pool. "Dhcp4": { "subnet4": [ { "subnet": "192.0.2.0/24", "pools": [ { "pool": "192.0.2.10 - 192.0.2.20" } ], "client-class": "VENDOR_CLASS_docsis3.0" } ], ... }

The following example shows how to configure a class using an expression and a subnet making use of that class. This configuration defines the class named "Client_foo". It is comprised of all clients who's client ids (option 61) start with the string "foo". Members of this class will be given addresses from 192.0.2.10 to 192.0.2.20 and 192.0.2.1 and 192.0.2.2 as their domain name servers. For a deeper discussion of the classification process see . "Dhcp4": { "client-classes": [ { "name": "Client_foo", "test": "substring(option[61].hex,0,3) == 'foo'", "option-data": [ { "name": "domain-name-servers", "code": 6, "space": "dhcp4", "csv-format": true, "data": "192.0.2.1, 192.0.2.2" } ] }, ... ], "subnet4": [ { "subnet": "192.0.2.0/24", "pools": [ { "pool": "192.0.2.10 - 192.0.2.20" } ], "client-class": "Client_foo" }, ... ], ... }

As mentioned earlier, kea-dhcp4 can be configured to generate requests to the DHCP-DDNS server (referred to here as "D2" ) to update DNS entries. These requests are known as NameChangeRequests or NCRs. Each NCR contains the following information: Whether it is a request to add (update) or remove DNS entries Whether the change requests forward DNS updates (A records), reverse DNS updates (PTR records), or both. The FQDN, lease address, and DHCID The parameters for controlling the generation of NCRs for submission to D2 are contained in the dhcp-ddns section of the kea-dhcp4 server configuration. The mandatory parameters for the DHCP DDNS configuration are enable-updates which is unconditionally required, and qualifying-suffix which has no default value and is required when enable-updates is set to true. The two (disabled and enabled) minimal DHCP DDNS configurations are: "Dhcp4": { "dhcp-ddns": { "enable-updates": false }, ... } and for example: "Dhcp4": { "dhcp-ddns": { "enable-updates": true, "qualifying-suffix": "example." }, ... } The default values for the "dhcp-ddns" section are as follows: "server-ip": "127.0.0.1" "server-port": 53001 "sender-ip": "" "sender-port": 0 "max-queue-size": 1024 "ncr-protocol": "UDP" "ncr-format": "JSON" "override-no-update": false "override-client-update": false "replace-client-name": false "generated-prefix": "myhost"

In order for NCRs to reach the D2 server, kea-dhcp4 must be able to communicate with it. kea-dhcp4 uses the following configuration parameters to control how it communications with D2: enable-updates - determines whether or not kea-dhcp4 will generate NCRs. By default, this value is false hence DDNS updates are disabled. To enable DDNS updates set this value to true: server-ip - IP address on which D2 listens for requests. The default is the local loopback interface at address 127.0.0.1. You may specify either an IPv4 or IPv6 address. server-port - port on which D2 listens for requests. The default value is 53001. sender-ip - IP address which kea-dhcp4 should use to send requests to D2. The default value is blank which instructs kea-dhcp4 to select a suitable address. sender-port - port which kea-dhcp4 should use to send requests to D2. The default value of 0 instructs kea-dhcp4 to select a suitable port. max-queue-size - maximum number of requests allowed to queue waiting to be sent to D2. This value guards against requests accumulating uncontrollably if they are being generated faster than they can be delivered. If the number of requests queued for transmission reaches this value, DDNS updating will be turned off until the queue backlog has been sufficiently reduced. The intention is to allow the kea-dhcp4 server to continue lease operations without running the risk that its memory usage grows without limit. The default value is 1024. ncr-protocol - socket protocol use when sending requests to D2. Currently only UDP is supported. TCP may be available in an upcoming release. ncr-format - packet format to use when sending requests to D2. Currently only JSON format is supported. Other formats may be available in future releases. By default, kea-dhcp-ddns is assumed to be running on the same machine as kea-dhcp4, and all of the default values mentioned above should be sufficient. If, however, D2 has been configured to listen on a different address or port, these values must be altered accordingly. For example, if D2 has been configured to listen on 192.168.1.10 port 900, the following configuration would be required: "Dhcp4": { "dhcp-ddns": { "server-ip": "192.168.1.10", "server-port": 900, ... }, ... }

kea-dhcp4 follows the behavior prescribed for DHCP servers in RFC 4702. It is important to keep in mind that kea-dhcp4 provides the initial decision making of when and what to update and forwards that information to D2 in the form of NCRs. Carrying out the actual DNS updates and dealing with such things as conflict resolution are within the purview of D2 itself (). This section describes when kea-dhcp4 will generate NCRs and the configuration parameters that can be used to influence this decision. It assumes that the "enable-updates" parameter is true. In general, kea-dhcp4 will generate DDNS update requests when: A new lease is granted in response to a DHCP REQUEST An existing lease is renewed but the FQDN associated with it has changed. An existing lease is released in response to a DHCP RELEASE In the second case, lease renewal, two DDNS requests will be issued: one request to remove entries for the previous FQDN and a second request to add entries for the new FQDN. In the last case, a lease release, a single DDNS request to remove its entries will be made. The decision making involved when granting a new lease (the first case) is more involved and is discussed next. When a new lease is granted, kea-dhcp4 will generate a DDNS update request if the DHCP REQUEST contains either the FQDN option (code 81) or the Host Name option (code 12). If both are present, the server will use the FQDN option. By default kea-dhcp4 will respect the FQDN N and S flags specified by the client as shown in the following table: Client Flags:N-S Client Intent Server Response Server Flags:N-S-O 0-0 Client wants to do forward updates, server should do reverse updates Server generates reverse-only request 1-0-0 0-1 Server should do both forward and reverse updates Server generates request to update both directions 0-1-0 1-0 Client wants no updates done Server does not generate a request 1-0-0 The first row in the table above represents "client delegation". Here the DHCP client states that it intends to do the forward DNS updates and the server should do the reverse updates. By default, kea-dhcp4 will honor the client's wishes and generate a DDNS request to the DHCP-DDNS server to update only reverse DNS data. The parameter override-client-update can be used to instruct the server to override client delegation requests. When this parameter is true, kea-dhcp4 will disregard requests for client delegation and generate a DDNS request to update both forward and reverse DNS data. In this case, the N-S-O flags in the server's response to the client will be 0-1-1 respectively. (Note that the flag combination N=1, S=1 is prohibited according to RFC 4702. If such a combination is received from the client, the packet will be dropped by kea-dhcp4.) To override client delegation, set the following values in your configuration file: "Dhcp4": { "dhcp-ddns": { "override-client-update": true, ... }, ... } The third row in the table above describes the case in which the client requests that no DNS updates be done. The parameter, override-no-update, can be used to instruct the server to disregard the client's wishes. When this parameter is true, kea-dhcp4 will generate a DDNS update request to kea-dhcp-ddns even if the client requests that no updates be done. The N-S-O flags in the server's response to the client will be 0-1-1. To override client delegation, the following values should be set in your configuration: "Dhcp4": { "dhcp-ddns": { "override-no-update": true, ... }, ... } kea-dhcp4 will always generate DDNS update requests if the client request only contains the Host Name option. In addition it will include an FQDN option in the response to the client with the FQDN N-S-O flags set to 0-1-0 respectively. The domain name portion of the FQDN option will be the name submitted to D2 in the DDNS update request.

Each NameChangeRequest must of course include the fully qualified domain name whose DNS entries are to be affected. kea-dhcp4 can be configured to supply a portion or all of that name based upon what it receives from the client in the DHCP REQUEST. The rules for determining the FQDN option are as follows: If configured to do, so ignore the DHCPREQUEST contents and generate a FQDN using a configurable prefix and suffix. If the DHCPREQUEST contains the client FQDN option, the candidate name is taken from there, otherwise it is taken from the Host Name option. The candidate name may then be modified: If the candidate name is a fully qualified domain name, use it. If the candidate name is a partial (i.e. unqualified) name then add a configurable suffix to the name and use the result as the FQDN. If the candidate name is a empty, generate a FQDN using a configurable prefix and suffix. To instruct kea-dhcp4 to always generate the FQDN for a client, set the parameter replace-client-name to true as follows: "Dhcp4": { "dhcp-ddns": { "replace-client-name": true, ... }, ... } The prefix used in the generation of a FQDN is specified by the generated-prefix parameter. The default value is "myhost". To alter its value simply set it to the desired string: "Dhcp4": { "dhcp-ddns": { "generated-prefix": "another.host", ... }, ... } The suffix used when generating a FQDN or when qualifying a partial name is specified by the qualifying-suffix parameter. This parameter has no default value, thus it is mandatory when DDNS updates are enabled. To set its value simply set it to the desired string: "Dhcp4": { "dhcp-ddns": { "qualifying-suffix": "foo.example.org", ... }, ... }

When generating a name, kea-dhcp4 will construct name of the format: [generated-prefix]-[address-text].[qualifying-suffix]. where address-text is simply the lease IP address converted to a hyphenated string. For example, if the lease address is 172.16.1.10, the qualifying suffix "example.com", and the default value is used for generated-prefix, the generated FQDN would be: myhost-172-16-1-10.example.com.

In some cases, clients want to obtain configuration from the TFTP server. Although there is a dedicated option for it, some devices may use the siaddr field in the DHCPv4 packet for that purpose. That specific field can be configured using next-server directive. It is possible to define it in the global scope or for a given subnet only. If both are defined, the subnet value takes precedence. The value in subnet can be set to 0.0.0.0, which means that next-server should not be sent. It may also be set to an empty string, which means the same as if it was not defined at all, i.e. use the global value. "Dhcp4": { "next-server": "192.0.2.123", ..., "subnet4": [ { "next-server": "192.0.2.234", ... } ] }

The original DHCPv4 specification (RFC 2131) states that the DHCPv4 server must not send back client-id options when responding to clients. However, in some cases that confused clients that did not have MAC address or client-id; see RFC 6842. for details. That behavior has changed with the publication of RFC 6842. which updated RFC 2131. That update now states that the server must send client-id if the client sent it. That is the default behaviour that Kea offers. However, in some cases older devices that do not support RFC 6842. may refuse to accept responses that include the client-id option. To enable backward compatibility, an optional configuration parameter has been introduced. To configure it, use the following configuration statement: "Dhcp4": { "echo-client-id": false, ... }

DHCP server must be able to identify the client (distinguish it from other clients) from which it receives the message. There are many reasons why this identification is required and the most important ones are listed below. When the client contacts the server to allocate a new lease, the server must store the client identification information in the lease database as a search key. When the client is trying to renew or release the existing lease, the server must be able to find the existing lease entry in the database for this client, using the client identification information as a search key. Some configurations use static reservations for the IP addresses and other configuration information. The server's administrator uses client identification information to create these static assignments. In the dual stack networks there is often a need to correlate the lease information stored in DHCPv4 and DHCPv6 server for a particular host. Using common identification information by the DHCPv4 and DHCPv6 client allows the network administrator to achieve this correlation and better administer the network. DHCPv4 makes use of two distinct identifiers which are placed by the client in the queries sent to the server and copied by the server to its responses to the client: 'chaddr' and 'client identifier'. The former was introduced as a part of the BOOTP specification and it is also used by DHCP to carry the hardware address of the interface used to send the query to the server (MAC address for the Ethernet). The latter is carried in the Client-identifier option, introduced in the RFC 2132. The RFC 2131 indicates that the server may use both of these identifiers to identify the client but the 'client identifier', if present, takes precedence over 'chaddr'. One of the reasons for this is that 'client identifier' is independent from the hardware used by the client to communicate with the server. For example, if the client obtained the lease using one network card and then the network card is moved to another host, the server will wrongly identify this host is the one which has obtained the lease. Moreover, the RFC 4361 gives the recommendation to use DUID (see DHCPv6 specification) carried as 'client identifier' when dual stack networks are in use, to provide consistent identification information of the client, regardless of the protocol type it is using. Kea adheres to these specifications and the 'client identifier' by default takes precedence over the value carried in 'chaddr' field when the server searches, creates, updates or removes the client's lease. When the server receives a DHCPDISCOVER or DHCPREQUEST message from the client, it will try to find out if the client already has a lease in the database and will hand out the existing lease rather than allocate a new one. Each lease in the lease database is associated with the 'client identifier' and/or 'chaddr'. The server will first use the 'client identifier' (if present) to search the lease. If the lease is found, the server will treat this lease as belonging to the client even if the current 'chaddr' and the 'chaddr' associated with the lease do not match. This facilitates the scenario when the network card on the client system has been replaced and thus the new MAC address appears in the messages sent by the DHCP client. If the server fails to find the lease using the 'client identifier' it will perform another lookup using the 'chaddr'. If this lookup returns no result, the client is considered as not having a lease and the new lease will be created. A common problem reported by network operators is that bogus client implementations do not use stable client identifiers such as generating a new 'client identifier' each time the client connects to the network. Another well known case is when the client changes its 'client identifier' during the multi-stage boot process (PXE). In such cases, the MAC address of the client's interface remains stable and using 'chaddr' field to identify the client guarantees that the particular system is considered to be the same client, even though its 'client identifier' changes. To address this problem, Kea includes a configuration option which enables client identification using 'chaddr' only by instructing the server to disregard server to "ignore" the 'client identifier' during lease lookups and allocations for a particular subnet. Consider the following simplified server configuration: "Dhcp4": { ... "match-client-id": true, ... "subnet4": [ { "subnet": "192.0.10.0/24", "pools": [ { "pool": "192.0.2.23-192.0.2.87" } ], "match-client-id": false }, { "subnet": "10.0.0.0/8", "pools": [ { "pool": "10.0.0.23-10.0.2.99" } ], } ] } The match-client-id is a boolean value which controls this behavior. The default value of true indicates that the server will use the 'client identifier' for lease lookups and 'chaddr' if the first lookup returns no results. The false means that the server will only use the 'chaddr' to search for client's lease. Whether the DHCID for DNS updates is generated from the 'client identifier' or 'chaddr' is controlled through the same parameter accordingly. The match-client-id parameter may appear both in the global configuration scope and/or under any subnet declaration. In the example shown above, the effective value of the match-client-id will be false for the subnet 192.0.10.0/24, because the subnet specific setting of the parameter overrides the global value of the parameter. The effective value of the match-client-id for the subnet 10.0.0.0/8 will be set to true because the subnet declaration lacks this parameter and the global setting is by default used for this subnet. In fact, the global entry for this parameter could be omitted in this case, because true is the default value. It is important to explain what happens when the client obtains its lease for one setting of the match-client-id and then renews when the setting has been changed. Let's first consider the case when the client obtains the lease when the match-client-id is set to true. The server will store the lease information including 'client identifier' (if supplied) and 'chaddr' in the lease database. When the setting is changed and the client renews the lease the server will determine that it should use the 'chaddr' to search for the existing lease. If the client hasn't changed its MAC address the server should successfully find the existing lease. The 'client identifier' associated with the returned lease is ignored and the client is allowed to use this lease. When the lease is renewed only the 'chaddr' is recorded for this lease according to the new server setting. In the second case the client has the lease with only a 'chaddr' value recorded. When the setting is changed to match-client-id set to true the server will first try to use the 'client identifier' to find the existing client's lease. This will return no results because the 'client identifier' was not recorded for this lease. The server will then use the 'chaddr' and the lease will be found. If the lease appears to have no 'client identifier' recorded, the server will assume that this lease belongs to the client and that it was created with the previous setting of the match-client-id. However, if the lease contains 'client identifier' which is different from the 'client identifier' used by the client the lease will be assumed to belong to another client and the new lease will be allocated.

There are many cases where it is useful to provide a configuration on a per host basis. The most obvious one is to reserve specific, static address for exclusive use by a given client (host) ‐ returning client will receive the same address from the server every time, and other clients will generally not receive that address. Note that there may be cases when the new reservation has been made for the client for the address being currently in use by another client. We call this situation a "conflict". The conflicts get resolved automatically over time as described in the subsequent sections. Once conflict is resolved, the client will keep receiving the reserved configuration when it renews. Another example when the host reservations are applicable is when a host that has specific requirements, e.g. a printer that needs additional DHCP options. Yet another possible use case is to define unique names for hosts. Although not all of the presented use cases are implemented yet, Kea software will support them in the near future. Hosts reservations are defined as parameters for each subnet. Each host has to be identified by its hardware/MAC address. There is an optional reservations array in the Subnet4 element. Each element in that array is a structure, that holds information about reservations for a single host. In particular, such a structure has to have an identifier that uniquely identifies a host. In DHCPv4 context, such an identifier is a hardware or MAC address. In most cases, also an address will be specified. It is possible to specify a hostname. Additional capabilities are planned. In Kea 1.0.0 it is only possible to create host reservations using client's hardware address. Host reservations by client identifier (or DUID) are not supported in this version of Kea. This capability will be implemented in Kea 1.1.0. Currently, the configuration parsing code will accept the "duid" parameter in the reservation configuration, but the server will misinterpret its value. Therefore, this parameter MUST NOT be used until the client identifier based host reservations are properly implemented and documented. The following example shows how to reserve addresses for specific hosts: "subnet4": [ { "pools": [ { "pool": "192.0.2.1 - 192.0.2.200" } ], "subnet": "192.0.2.0/24", "interface": "eth0", "reservations": [ { "hw-address": "1a:1b:1c:1d:1e:1f", "ip-address": "192.0.2.202" }, { "hw-address": "0a:0b:0c:0d:0e:0f", "ip-address": "192.0.2.100", "hostname": "alice-laptop" } ] } ] The first entry reserves the 192.0.2.202 address for the client that uses MAC address of 1a:1b:1c:1d:1e:1f. The second entry reserves the address 192.0.2.100 and the hostname of alice-laptop for client using MAC address 0a:0b:0c:0d:0e:0f. Note that if you plan to do DNS updates, it is strongly recommended for the hostnames to be unique. Making a reservation for a mobile host that may visit multiple subnets requires a separate host definition in each subnet it is expected to visit. It is not allowed to define multiple host definitions with the same hardware address in a single subnet. It is a valid configuration, if such definitions are specified in different subnets, though. Adding host reservation incurs a performance penalty. In principle, when the server that does not support host reservation responds to a query, it needs to check whether there is a lease for a given address being considered for allocation or renewal. The server that also supports host reservation, has to perform additional checks: not only if the address is currently used (if there is a lease for it), but also whether the address could be used by someone else (if there is a reservation for it). That additional check incurs performance penalty.

In a typical scenario there is an IPv4 subnet defined, e.g. 192.0.2.0/24, with certain part of it dedicated for dynamic allocation by the DHCPv4 server. That dynamic part is referred to as a dynamic pool or simply a pool. In principle, the host reservation can reserve any address that belongs to the subnet. The reservations that specify addresses that belong to configured pools are called in-pool reservations. In contrast, those that do not belong to dynamic pools are called out-of-pool reservations. There is no formal difference in the reservation syntax. As of 0.9.1, both reservation types are handled uniformly. However, upcoming releases may offer improved performance if there are only out-of-pool reservations as the server will be able to skip reservation checks when dealing with existing leases. Therefore, system administrators are encouraged to use out-of-pool reservations, if possible.

As the reservations and lease information are stored separately, conflicts may arise. Consider the following series of events. The server has configured the dynamic pool of addresses from the range of 192.0.2.10 to 192.0.2.20. The Host A requests an address and gets 19.0.2.10. Now the system administrator decides to reserve the address for the Host B. He decides to reserve 192.0.2.10 for that purpose. In general, reserving an address that is currently assigned to someone else is not recommended, but there are valid use cases where such an operation is warranted. The server now has a conflict to resolve. Let's analyze the situation here. If the Host B boots up and requests an address, the server is not able to assign the reserved address 192.0.2.10 for the Host B. A naive approach would to be immediately remove the existing lease for the Host A and create a new one for the Host B. That would not solve the problem, though, because as soon as the Host B gets the address, it will detect that the address is already in use by the Host A and would send the DHCPDECLINE message. Therefore, in this situation, the server has to temporarily assign a different address (not matching what has been reserved) to the Host B. When the Host A renews its address, the server will discover that the address being renewed is now reserved for another host - the Host B. Therefore the server will inform the Host A that it is no longer allowed to use it by sending DHCPNAK message. The server will not remove the lease, though, as there's small chance that the DHCPNAK may be lost if the network is lossy. If that happens, the client will not receive any responses, so it will retransmit its DHCPREQUEST packet. Once the DHCPNAK is received by the Host A, it will then revert to the server discovery and will eventually get a different address. Besides allocating a new lease, the server will also remove the old one. As a result, the address 192.0.2.10 will be no longer used. When Host B tries to renew its temporarily assigned address, the server will detect that it has a valid lease, but there is a reservation for a different address. The server will send DHCPNAK to inform Host B that its address is no longer usable, but will keep its lease (again, the DHCPNAK may be lost, so the server will keep it, until the client returns for a new address). The Host B will revert to the server discovery phase and will eventually send a DHCPREQUEST message. This time the server will find out that there is a reservation for that host and the reserved address 192.0.2.10 is not used, so it will be granted. It will also remove the lease for the temporarily assigned address that the Host B previously obtained. This recovery will succeed, even if other hosts will attempt to get the reserved address. Had the Host C requested address 192.0.2.10 after the reservation was made, the server will either offer a different address (when responding to DHCPDISCOVER) or would send DHCPNAK (when responding to DHCPREQUEST). This recovery mechanism allows the server to fully recover from a case where reservations conflict with the existing leases. This procedure takes time and will roughly take as long as renew-timer value specified. The best way to avoid such recovery is to not define new reservations that conflict with existing leases. Another recommendation is to use out-of-pool reservations. If the reserved address does not belong to a pool, there is no way that other clients could get this address (note that having multiple reservations for the same address is not allowed).

When the reservation for the client includes the hostname , the server will assign this hostname to the client and send it back in the Client FQDN or Hostname option, depending on which of them the client has sent to the server. The reserved hostname always takes precedence over the hostname supplied by the client or the autogenerated (from the IPv4 address) hostname. The server qualifies the reserved hostname with the value of the qualifying-suffix parameter. For example, the following subnet configuration: { "subnet4": [ { "subnet": "10.0.0.0/24", "pools": [ { "pool": "10.0.0.10-10.0.0.100" } ], "reservations": [ { "hw-address": "aa:bb:cc:dd:ee:ff", "hostname": "alice-laptop" } ] }], "dhcp-ddns": { "enable-updates": true, "qualifying-suffix": "example.isc.org." } } will result in assigning the "alice-laptop.example.isc.org." hostname to the client using the MAC address "aa:bb:cc:dd:ee:ff". If the qualifying-suffix is not specified, the default (empty) value will be used, and in this case the value specified as a hostname will be treated as fully qualified name. Thus, by leaving the qualifying-suffix empty it is possible to qualify hostnames for the different clients with different domain names: { "subnet4": [ { "subnet": "10.0.0.0/24", "pools": [ { "pool": "10.0.0.10-10.0.0.100" } ], "reservations": [ { "hw-address": "aa:bb:cc:dd:ee:ff", "hostname": "alice-laptop.isc.org." }, { "hw-address": "12:34:56:78:99:AA", "hostname": "mark-desktop.example.org." } ] }], "dhcp-ddns": { "enable-updates": true, } }

Currently it is not possible to specify options in host reservation. Such a feature will be added in the upcoming Kea releases.

reservation-mode configuration parameter in DHCPv4 server is accepted, but not used in the Kea 0.9.1 beta. Full implementation will be available in the upcoming releases. Host reservation capability introduces additional restrictions for the allocation engine during lease selection and renewal. In particular, three major checks are necessary. First, when selecting a new lease, it is not sufficient for a candidate lease to be not used by another DHCP client. It also must not be reserved for another client. Second, when renewing a lease, additional check must be performed whether the address being renewed is not reserved for another client. Finally, when a host renews an address, the server has to check whether there's a reservation for this host, so the existing (dynamically allocated) address should be revoked and the reserved one be used instead. Some of those checks may be unnecessary in certain deployments. Not performing them may improve performance. The Kea server provides the reservation-mode configuration parameter to select the types of reservations allowed for the particular subnet. Each reservation type has different constraints for the checks to be performed by the server when allocating or renewing a lease for the client. Allowed values are: all - enables all host reservation types. This is the default value. This setting is the safest and the most flexible. It allows in-pool and out-of-pool reservations. As all checks are conducted, it is also the slowest. out-of-pool - allows only out of pool host reservations. With this setting in place, the server may assume that all host reservations are for addresses that do not belong to the dynamic pool. Therefore it can skip the reservation checks when dealing with in-pool addresses, thus improving performance. Do not use this mode if any of your reservations use in-pool address. Caution is advised when using this setting. Kea 0.9.1 does not sanity check the reservations against reservation-mode. Misconfiguration may cause problems. disabled - host reservation support is disabled. As there are no reservations, the server will skip all checks. Any reservations defined will be completely ignored. As the checks are skipped, the server may operate faster in this mode. An example configuration that disables reservation looks like follows: "Dhcp4": { "subnet4": [ { "subnet": "192.0.2.0/24", "reservation-mode": "disabled", ... } ] }

The DHCPv4 protocol uses a "server identifier" to allow clients to discriminate between several servers present on the same link: this value is an IPv4 address of the server. The server chooses the IPv4 address of the interface on which the message from the client (or relay) has been received. A single server instance will use multiple server identifiers if it is receiving queries on multiple interfaces. Currently there is no mechanism to override the default server identifiers by an administrator. In the future, the configuration mechanism will be used to specify the custom server identifier.

The DHCPv4 server differentiates between the directly connected clients, clients trying to renew leases and clients sending their messages through relays. For the directly connected clients the server will check the configuration for the interface on which the message has been received, and if the server configuration doesn't match any configured subnet the message is discarded. Assuming that the server's interface is configured with the IPv4 address 192.0.2.3, the server will only process messages received through this interface from a directly connected client if there is a subnet configured to which this IPv4 address belongs, e.g. 192.0.2.0/24. The server will use this subnet to assign IPv4 address for the client. The rule above does not apply when the client unicasts its message, i.e. is trying to renew its lease. Such a message is accepted through any interface. The renewing client sets ciaddr to the currently used IPv4 address. The server uses this address to select the subnet for the client (in particular, to extend the lease using this address). If the message is relayed it is accepted through any interface. The giaddr set by the relay agent is used to select the subnet for the client. It is also possible to specify a relay IPv4 address for a given subnet. It can be used to match incoming packets into a subnet in uncommon configurations, e.g. shared subnets. See for details. The subnet selection mechanism described in this section is based on the assumption that client classification is not used. The classification mechanism alters the way in which a subnet is selected for the client, depending on the classes to which the client belongs.

The relay has to have an interface connected to the link on which the clients are being configured. Typically the relay has an IPv4 address configured on that interface that belongs to the subnet from which the server will assign addresses. In the typical case, the server is able to use the IPv4 address inserted by the relay (in the giaddr field of the DHCPv4 packet) to select the appropriate subnet. However, that is not always the case. In certain uncommon — valid — deployments, the relay address may not match the subnet. This usually means that there is more than one subnet allocated for a given link. The two most common examples where this is the case are long lasting network renumbering (where both old and new address space is still being used) and a cable network. In a cable network both cable modems and the devices behind them are physically connected to the same link, yet they use distinct addressing. In such a case, the DHCPv4 server needs additional information (the IPv4 address of the relay) to properly select an appropriate subnet. The following example assumes that there is a subnet 192.0.2.0/24 that is accessible via a relay that uses 10.0.0.1 as its IPv4 address. The server will be able to select this subnet for any incoming packets that came from a relay that has an address in 192.0.2.0/24 subnet. It will also select that subnet for a relay with address 10.0.0.1. "Dhcp4": { "subnet4": [ { "subnet": "192.0.2.0/24", "pools": [ { "pool": "192.0.2.10 - 192.0.2.20" } ], "relay": { "ip-address": "10.0.0.1" }, ... } ], ... }

In certain cases, it is useful to mix relay address information, introduced in with client classification, explained in . One specific example is cable network, where typically modems get addresses from a different subnet than all devices connected behind them. Let's assume that there is one CMTS (Cable Modem Termination System) with one CM MAC (a physical link that modems are connected to). We want the modems to get addresses from the 10.1.1.0/24 subnet, while everything connected behind modems should get addresses from another subnet (192.0.2.0/24). The CMTS that acts as a relay uses address 10.1.1.1. The following configuration can serve that configuration: "Dhcp4": { "subnet4": [ { "subnet": "10.1.1.0/24", "pools": [ { "pool": "10.1.1.2 - 10.1.1.20" } ], "client-class" "docsis3.0", "relay": { "ip-address": "10.1.1.1" } }, { "subnet": "192.0.2.0/24", "pools": [ { "pool": "192.0.2.10 - 192.0.2.20" } ], "relay": { "ip-address": "10.1.1.1" } } ], ... }

The DHCPv4 server is configured with a certain pool of addresses that it is expected to hand out to the DHCPv4 clients. It is assumed that the server is authoritative and has complete jurisdiction over those addresses. However, due to various reasons, such as misconfiguration or a faulty client implementation that retains its address beyond the valid lifetime, there may be devices connected that use those addresses without the server's approval or knowledge. Such an unwelcome event can be detected by legitimate clients (using ARP or ICMP Echo Request mechanisms) and reported to the DHCPv4 server using a DHCPDECLINE message. The server will do a sanity check (if the client declining an address really was supposed to use it), and then will conduct a clean up operation. Any DNS entries related to that address will be removed, the fact will be logged and hooks will be triggered. After that is done, the address will be marked as declined (which indicates that it is used by an unknown entity and thus not available for assignment to anyone) and a probation time will be set on it. Unless otherwise configured, the probation period lasts 24 hours. After that period, the server will recover the lease, i.e. put it back into the available state. The address will be available for assignment again. It should be noted that if the underlying issue of a misconfigured device is not resolved, the duplicate address scenario will repeat. On the other hand, it provides an opportunity to recover from such an event automatically, without any sysadmin intervention. To configure the decline probation period to a value different than the default, the following syntax can be used: "Dhcp4": { "decline-probation-period": 3600, "subnet4": [ ... ], ... } The parameter is expressed in seconds, so the example above will instruct the server to recycle declined leases after an hour. There are several statistics and hook points associated with the Decline handling procedure. The lease4_decline hook is triggered after the incoming DHCPDECLINE message has been sanitized and the server is about to decline the lease. The declined-addresses statistic is increased after the hook returns (both global and subnet specific variants). Once the probation time elapses, the declined lease is recovered using the standard expired lease reclamation procedure, with several additional steps. In particular, both declined-addresses statistics (global and subnet specific) are decreased. At the same time, reclaimed-declined-addresses statistics (again in two variants, global and subnet specific) are increased. Note about statistics: The server does not decrease assigned-addresses statistics when a DHCPDECLINE is received and processed successfully. While technically a declined address is no longer assigned, the primary usage of the assigned-addresses statistic is to monitor pool utilization. Most people would forget to include declined-addresses in the calculation, and simply do assigned-addresses/total-addresses. This would have a bias towards under-representing pool utilization. As this has a potential for major issues, we decided not to decrease assigned addresses immediately after receiving DHCPDECLINE, but to do it later when we recover the address back to the available pool.

This section describes DHCPv4-specific statistics. For a general overview and usage of statistics, see . The DHCPv4 server supports the following statistics: Statistic Data Type Description pkt4-received integer Number of DHCPv4 packets received. This includes all packets: valid, bogus, corrupted, rejected etc. This statistic is expected to grow rapidly. pkt4-discover-received integer Number of DHCPDISCOVER packets received. This statistic is expected to grow. Its increase means that clients that just booted started their configuration process and their initial packets reached your server. pkt4-offer-received integer Number of DHCPOFFER packets received. This statistic is expected to remain zero at all times, as DHCPOFFER packets are sent by the server and the server is never expected to receive them. Non-zero value indicates an error. One likely cause would be a misbehaving relay agent that incorrectly forwards DHCPOFFER messages towards the server, rather back to the clients. pkt4-request-received integer Number of DHCPREQUEST packets received. This statistic is expected to grow. Its increase means that clients that just booted received server's response (DHCPOFFER), accepted it and now requesting an address (DHCPREQUEST). pkt4-ack-received integer Number of DHCPACK packets received. This statistic is expected to remain zero at all times, as DHCPACK packets are sent by the server and the server is never expected to receive them. Non-zero value indicates an error. One likely cause would be a misbehaving relay agent that incorrectly forwards DHCPACK messages towards the server, rather back to the clients. pkt4-nak-received integer Number of DHCPNAK packets received. This statistic is expected to remain zero at all times, as DHCPNAK packets are sent by the server and the server is never expected to receive them. Non-zero value indicates an error. One likely cause would be a misbehaving relay agent that incorrectly forwards DHCPNAK messages towards the server, rather back to the clients. pkt4-release-received integer Number of DHCPRELEASE packets received. This statistic is expected to grow. Its increase means that clients that had an address are shutting down or stop using their addresses. pkt4-decline-received integer Number of DHCPDECLINE packets received. This statistic is expected to remain close to zero. Its increase means that a client that leased an address, but discovered that the address is currently used by an unknown device in your network. pkt4-inform-received integer Number of DHCPINFORM packets received. This statistic is expected to grow. Its increase means that there are clients that either do not need an address or already have an address and are interested only in getting additional configuration parameters. pkt4-unknown-received integer Number of packets received of an unknown type. Non-zero value of this statistic indicates that the server received a packet that it wasn't able to recognize: either with unsupported type or possibly malformed (without message type option). pkt4-sent integer Number of DHCPv4 packets sent. This statistic is expected to grow every time the server transmits a packet. In general, it should roughly match pkt4-received, as most incoming packets cause server to respond. There are exceptions (e.g. DHCPRELEASE), so do not worry, if it is lesser than pkt4-received. pkt4-offer-sent integer Number of DHCPOFFER packets sent. This statistic is expected to grow in most cases after a DHCPDISCOVER is processed. There are certain uncommon, but valid cases where incoming DHCPDISCOVER is dropped, but in general this statistic is expected to be close to pkt4-discover-received. pkt4-ack-sent integer Number of DHCPACK packets sent. This statistic is expected to grow in most cases after a DHCPREQUEST is processed. There are certain cases where DHCPNAK is sent instead. In general, the sum of pkt4-ack-sent and pkt4-nak-sent should be close to pkt4-request-received. pkt4-nak-sent integer Number of DHCPNAK packets sent. This statistic is expected to grow when the server choses to not honor the address requested by a client. In general, the sum of pkt4-ack-sent and pkt4-nak-sent should be close to pkt4-request-received. pkt4-parse-failed integer Number of incoming packets that could not be parsed. Non-zero value of this statistic indicates that the server received malformed or truncated packet. This may indicate problems in your network, faulty clients or server code bug. pkt4-receive-drop integer Number of incoming packets that were dropped. Exact reason for dropping packets is logged, but the most common reasons may be: an unacceptable packet type, direct responses are forbidden, or the server-id sent by the client does not match the server's server-id. subnet[id].total-addresses integer The total number of addresses available for the DHCPv4 management. In other words, this is the sum of all addresses in all configured pools. This statistic changes only during configuration changes. Note it does not take into account any addresses that may be reserved due to host reservation. The id is the subnet-id of a given subnet. This statistic is exposed for each subnet separately. This statistic is reset during reconfiguration event. subnet[id].assigned-addresses integer This statistic shows the number of assigned addresses in a given subnet. This statistic increases every time a new lease is allocated (as a result of receiving a DHCPREQUEST message) and is decreased every time a lease is released (a DHCPRELEASE message is received) or expires. The id is the subnet-id of a given subnet. This statistic is exposed for each subnet separately. This statistic is reset during reconfiguration event. declined-addresses integer This statistic shows the number of IPv4 addresses that are currently declined. This statistic counts the number of leases currently unavailable. Once a lease is recovered, this statistic will be decreased. Ideally, this statistic should be zero. If this statistic is non-zero (or worse increasing), a network administrator should investigate if there is a misbehaving device in his network. This is a global statistic that covers all subnets. subnet[id].declined-addresses integer This statistic shows the number of IPv4 addresses that are currently declined in a given subnet. This statistic counts the number of leases currently unavailable. Once a lease is recovered, this statistic will be decreased. Ideally, this statistic should be zero. If this statistic is non-zero (or worse increasing), a network administrator should investigate if there is a misbehaving device in his network. The id is the subnet-id of a given subnet. This statistic is exposed for each subnet separately. reclaimed-declined-addresses integer This statistic shows the number of IPv4 addresses that were declined, but have now been recovered. Unlike declined-addresses, this statistic never decreases. It can be used as a long term indicator of how many actual valid Declines were processed and recovered from. This is a global statistic that covers all subnets. subnet[id].reclaimed-declined-addresses integer This statistic shows the number of IPv4 addresses that were declined, but have now been recovered. Unlike declined-addresses, this statistic never decreases. It can be used as a long term indicator of how many actual valid Declines were processed and recovered from. The id is the subnet-id of a given subnet. This statistic is exposed for each subnet separately.

Management API has been introduced in Kea 0.9.2-beta. It allows issuing specific management commands, like statistics retrieval, reconfiguration or shutdown. For more details, see . Currently the only supported communication channel type is UNIX stream socket. By default there are no sockets open. To instruct Kea to open a socket, the following entry in the configuration file can be used: "Dhcp4": { "control-socket": { "socket-type": "unix", "socket-name": "/path/to/the/unix/socket" }, "subnet4": [ ... ], ... } The length of the path specified by the socket-name parameter is restricted by the maximum length for the unix socket name on your operating system, i.e. the size of the sun_path field in the sockaddr_un structure, decreased by 1. This value varies on different operating systems between 91 and 107 characters. The typical values are 107 on Linux and 103 on FreeBSD. Communication over control channel is conducted using JSON structures. See the Control Channel section in the Kea Developer's Guide for more details. DHCPv4 server supports statistic-get, statistic-reset, statistic-remove, statistic-get-all, statistic-reset-all and statistic-remove-all, specified in . It also supports list-commands and shutdown, specified in and , respectively.

The following standards are currently supported: Dynamic Host Configuration Protocol, RFC 2131: Supported messages are DHCPDISCOVER (1), DHCPOFFER (2), DHCPREQUEST (3), DHCPRELEASE (7), DHCPINFORM (8), DHCPACK (5), and DHCPNAK(6). DHCP Options and BOOTP Vendor Extensions, RFC 2132: Supported options are: PAD (0), END(255), Message Type(53), DHCP Server Identifier (54), Domain Name (15), DNS Servers (6), IP Address Lease Time (51), Subnet mask (1), and Routers (3). DHCP Relay Agent Information Option, RFC 3046: Relay Agent Information option is supported. Vendor-Identifying Vendor Options for Dynamic Host Configuration Protocol version 4, RFC 3925: Vendor-Identifying Vendor Class and Vendor-Identifying Vendor-Specific Information options are supported. Client Identifier Option in DHCP Server Replies, RFC 6842: Server by default sends back client-id option. That capability may be disabled. See for details.

These are the current limitations of the DHCPv4 server software. Most of them are reflections of the current stage of development and should be treated as not implemented yet, rather than actual limitations. However, some of them are implications of the design choices made. Those are clearly marked as such. Removal of a subnet during server reconfiguration may cause renumbering of auto-generated subnet identifiers, as described in section . Host reservation (static addresses) is not supported yet. Full featured client classification is not supported yet. BOOTP (RFC 951) is not supported. This is a design choice. BOOTP support is not planned. On Linux and BSD system families the DHCP messages are sent and received over the raw sockets (using LPF and BPF) and all packet headers (including data link layer, IP and UDP headers) are created and parsed by Kea, rather than the system kernel. Currently, Kea can only parse the data link layer headers with a format adhering to IEEE 802.3 standard and assumes this data link layer header format for all interfaces. Hence, Kea will fail to work on interfaces which use different data link layer header formats (e.g. Infiniband). The DHCPv4 server does not verify that assigned address is unused. According to RFC 2131, the allocating server should verify that address is not used by sending ICMP echo request. Address duplication report (DECLINE) is not supported yet.