Kea Administrator Reference Manual I
Total Page:16
File Type:pdf, Size:1020Kb
Kea Administrator Reference Manual i Kea Administrator Reference Manual Kea Administrator Reference Manual ii Copyright © 2010-2018 Internet Systems Consortium, Inc. ("ISC") Kea Administrator Reference Manual iii Contents 1 Introduction 1 1.1 Supported Platforms . .1 1.2 Required Software at Run-time . .1 1.3 Kea Software . .2 2 Quick Start 3 2.1 Quick Start Guide for DHCPv4 and DHCPv6 Services . .3 2.2 Running the Kea Servers Directly . .4 3 Installation 5 3.1 Packages . .5 3.2 Installation Hierarchy . .5 3.3 Building Requirements . .5 3.4 Installation from Source . .6 3.4.1 Download Tar File . .6 3.4.2 Retrieve from Git . .6 3.4.3 Configure Before the Build . .7 3.4.4 Build . .8 3.4.5 Install . .8 3.5 Selecting the Configuration Backend . .9 3.6 DHCP Database Installation and Configuration . .9 3.6.1 Building with MySQL Support . .9 3.6.2 Building with PostgreSQL support . .9 3.6.3 Building with CQL (Cassandra) support . 10 4 Kea Database Administration 11 4.1 Databases and Database Version Numbers . 11 4.2 The kea-admin Tool . 11 4.3 Supported Databases . 12 4.3.1 memfile . 12 4.3.1.1 Upgrading Memfile Lease Files from an Earlier Version of Kea . 12 Kea Administrator Reference Manual iv 4.3.2 MySQL . 12 4.3.2.1 First Time Creation of the MySQL Database . 13 4.3.2.2 Upgrading a MySQL Database from an Earlier Version of Kea . 13 4.3.3 PostgreSQL . 14 4.3.3.1 First Time Creation of the PostgreSQL Database . 14 4.3.3.2 Initialize the PostgreSQL Database Using kea-admin . 15 4.3.3.3 Upgrading a PostgreSQL Database from an Earlier Version of Kea . 15 4.3.4 CQL (Cassandra) . 16 4.3.4.1 First Time Creation of the Cassandra Database . 16 4.3.4.2 Upgrading a CQL Database from an Earlier Version of Kea . 16 4.3.5 Using Read-Only Databases with Host Reservations . 17 4.3.6 Limitations Related to the use of SQL Databases . 17 4.3.6.1 Year 2038 issue . 17 4.3.6.2 Server Terminates when Database Connection is Lost . 17 5 Kea Configuration 18 5.1 JSON Configuration . 18 5.1.1 JSON Syntax . 18 5.1.2 Simplified Notation . 19 6 Managing Kea with keactrl 21 6.1 Overview . 21 6.2 Command Line Options . 21 6.3 The keactrl Configuration File . 21 6.4 Commands . 22 6.5 Overriding the Server Selection . 24 7 Kea Control Agent 25 7.1 Overview . 25 7.2 Configuration . 25 7.3 Secure Connections . 27 7.4 Control Agent Limitations . 28 7.5 Starting Control Agent . 28 7.6 Connecting to the Control Agent . 28 8 The DHCPv4 Server 29 8.1 Starting and Stopping the DHCPv4 Server . 29 8.2 DHCPv4 Server Configuration . 30 8.2.1 Introduction . 30 8.2.2 Lease Storage . 32 Kea Administrator Reference Manual v 8.2.2.1 Memfile - Basic Storage for Leases . 32 8.2.2.2 Lease Database Configuration . 33 8.2.2.3 Cassandra specific parameters . 34 8.2.3 Hosts Storage . 35 8.2.3.1 DHCPv4 Hosts Database Configuration . 35 8.2.3.2 Using Read-Only Databases for Host Reservations . 36 8.2.4 Interface Configuration . 37 8.2.5 Issues with Unicast Responses to DHCPINFORM . 39 8.2.6 IPv4 Subnet Identifier . 39 8.2.7 Configuration of IPv4 Address Pools . 40 8.2.8 Standard DHCPv4 Options . 41 8.2.9 Custom DHCPv4 options . 45 8.2.10 DHCPv4 Private Options . 49 8.2.11 DHCPv4 Vendor Specific Options . 50 8.2.12 Nested DHCPv4 Options (Custom Option Spaces) . 52 8.2.13 Unspecified Parameters for DHCPv4 Option Configuration . 53 8.2.14 Stateless Configuration of DHCPv4 Clients . 53 8.2.15 Client Classification in DHCPv4 . 54 8.2.15.1 Setting Fixed Fields in Classification . 55 8.2.15.2 Using Vendor Class Information in Classification . 55 8.2.15.3 Defining and Using Custom Classes . 56 8.2.15.4 Required Classification . ..