mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-09-03 07:25:18 +00:00
Code Issues Releases Wiki Activity

[master] Merge branch 'trac5198' (default config improvements)

Browse Source 
# Conflicts:
#	doc/examples/ddns/sample1.json
This commit is contained in:
Tomek Mrugalski
2017-04-24 21:26:37 +02:00
parent 4cb3628a37 22a3228495
commit 280de81cfe
18 changed files with 1242 additions and 589 deletions
Download Patch File Download Diff File Expand all files Collapse all files

120
doc/examples/ddns/template.json
View File

@@ -1,108 +1,108 @@
# This file may be used a template for constructing DHCP-DDNS JSON // This file may be used a template for constructing DHCP-DDNS JSON
# configuration. // configuration.
# //
# Default values that may be omitted are '#' commented out. // Default values that may be omitted are '//' commented out.
# If in a file by itself, it must start with a left-curly-bracket. // If in a file by itself, it must start with a left-curly-bracket.
{ {
"DhcpDdns" : "DhcpDdns" :
{ {
# //
# -------------- Global Parameters ---------------- // -------------- Global Parameters ----------------
# //
# All of the global parameters have default values as shown. If these // All of the global parameters have default values as shown. If these
# are satisfactory you may omit them. // are satisfactory you may omit them.
# //
# "ip-address" : "127.0.0.1", // "ip-address" : "127.0.0.1",
# "port" : 53001, // "port" : 53001,
# "dns-server-timeout" : 100, // "dns-server-timeout" : 100,
# "ncr-protocol" : "UDP" // "ncr-protocol" : "UDP"
# "ncr-format" : "JSON" // "ncr-format" : "JSON"
# //
# ----------------- Forward DDNS ------------------ // ----------------- Forward DDNS ------------------
# //
"forward-ddns" : "forward-ddns" :
{ {
"ddns-domains" : "ddns-domains" :
[ [
{ {
"name" : "<zone name 1>", "name" : "<zone name 1>",
# "key-name" : "<key name>", // "key-name" : "<key name>",
"dns-servers" : "dns-servers" :
[ [
{ {
"ip-address" : "<ip address>" "ip-address" : "<ip address>"
# ,"port" : 53 // ,"port" : 53
} }
# , // ,
# { // {
# next DNS server for this DdnsDomain // next DNS server for this DdnsDomain
# } // }
# : // :
] ]
} }
# , // ,
# { // {
# next Forward DdnsDomain // next Forward DdnsDomain
# } // }
# : // :
] ]
}, },
# //
# ----------------- Reverse DDNS ------------------ // ----------------- Reverse DDNS ------------------
# //
"reverse-ddns" : "reverse-ddns" :
{ {
"ddns-domains" : "ddns-domains" :
[ [
{ {
"name" : "<reverse zone name 1>", "name" : "<reverse zone name 1>",
# "key-name" : "<key name>", // "key-name" : "<key name>",
"dns-servers" : "dns-servers" :
[ [
{ {
"ip-address" : "<ip address>" "ip-address" : "<ip address>"
# ,"port" : 53 // ,"port" : 53
} }
# , // ,
# { // {
# next DNS server for this DdnsDomain // next DNS server for this DdnsDomain
# } // }
# : // :
] ]
} }
# , // ,
# { // {
# next Reverse DdnsDomain // next Reverse DdnsDomain
# } // }
# : // :
] ]
}, },
# //
# ------------------ TSIG keys --------------------- // ------------------ TSIG keys ---------------------
# //
"tsig-keys" : "tsig-keys" :
[ [
{ {
"name" : "<key name>", "name" : "<key name>",
"algorithm" : "<algorithm name>", "algorithm" : "<algorithm name>",
# Valid values for algorithm are: HMAC-MD5, HMAC-SHA1, // Valid values for algorithm are: HMAC-MD5, HMAC-SHA1,
# HMAC-SHA224, HMAC-SHA256, // HMAC-SHA224, HMAC-SHA256,
# HMAC-SHA384, HMAC-SHA512 // HMAC-SHA384, HMAC-SHA512
# "digest-bits" : 256, // "digest-bits" : 256,
# Minimum truncated length in bits. // Minimum truncated length in bits.
# Default 0 (means truncation is forbidden). // Default 0 (means truncation is forbidden).
"secret" : "<shared secret value>" "secret" : "<shared secret value>"
} }
# , // ,
# { // {
# next TSIG Key // next TSIG Key
# } // }
] ]
} }
# If in a file by itself, it must end with an right-curly-bracket. // If in a file by itself, it must end with an right-curly-bracket.
} }

148
doc/examples/kea4/backends.json
View File

@@ -1,91 +1,91 @@
# This is an example configuration file for the DHCPv4 server in Kea. // This is an example configuration file for the DHCPv4 server in Kea.
# It is a basic scenario with one IPv4 subnet configured. It demonstrates // It is a basic scenario with one IPv4 subnet configured. It demonstrates
# how to configure Kea to use various backends to store leases: // how to configure Kea to use various backends to store leases:
# - memfile // - memfile
# - MySQL // - MySQL
# - PostgreSQL // - PostgreSQL
# - CQL (Cassandra) backend // - CQL (Cassandra) backend
{ "Dhcp4": { "Dhcp4":
{ {
# Kea is told to listen on ethX interface only. // Kea is told to listen on ethX interface only.
"interfaces-config": { "interfaces-config": {
"interfaces": [ "ethX" ] "interfaces": [ "ethX" ]
}, },
# We need to specify lease type. Exactly one lease-database section // We need to specify lease type. Exactly one lease-database section
# should be present. Make sure you uncomment only one. // should be present. Make sure you uncomment only one.
# 1. memfile backend. Leases information will be stored in flat CSV file. // 1. memfile backend. Leases information will be stored in flat CSV file.
# This is the easiest backend to use as it does not require any extra // This is the easiest backend to use as it does not require any extra
# dependencies or services running. // dependencies or services running.
# "lease-database": { // "lease-database": {
# "type": "memfile", // "type": "memfile",
# "persist": true, // "persist": true,
# "lfc-interval": 3600 // "lfc-interval": 3600
# }, // },
# 2. MySQL backend. Leases will be stored in MySQL database. Make sure it // 2. MySQL backend. Leases will be stored in MySQL database. Make sure it
# is up, running and properly initialized. See kea-admin documentation // is up, running and properly initialized. See kea-admin documentation
# for details on how to initialize the database. The only strictly required // for details on how to initialize the database. The only strictly required
# parameters are type and name. If other parameters are not specified, // parameters are type and name. If other parameters are not specified,
# Kea will assume the database is available on localhost, that user and // Kea will assume the database is available on localhost, that user and
# password is not necessary to connect and that timeout is 5 seconds. // password is not necessary to connect and that timeout is 5 seconds.
# Kea must be compiled with --with-dhcp-mysql option to use this backend. // Kea must be compiled with --with-dhcp-mysql option to use this backend.
# "lease-database": { // "lease-database": {
# "type": "mysql", // "type": "mysql",
# "name": "keatest", // "name": "keatest",
# "host": "localhost", // "host": "localhost",
# "port": 3306, // "port": 3306,
# "user": "keatest", // "user": "keatest",
# "password": "secret1", // "password": "secret1",
# "connect-timeout": 3 // "connect-timeout": 3
# }, // },
# 3. PostgreSQL backend. Leases will be stored in PostgreSQL database. Make // 3. PostgreSQL backend. Leases will be stored in PostgreSQL database. Make
# sure it is up, running and properly initialized. See kea-admin documentation // sure it is up, running and properly initialized. See kea-admin documentation
# for details on how to initialize the database. The only strictly required // for details on how to initialize the database. The only strictly required
# parameters are type and name. If other parameters are not specified, // parameters are type and name. If other parameters are not specified,
# Kea will assume the database is available on localhost, that user and // Kea will assume the database is available on localhost, that user and
# password is not necessary to connect and that timeout is 5 seconds. // password is not necessary to connect and that timeout is 5 seconds.
# Kea must be compiled with --with-dhcp-pgsql option to use this backend. // Kea must be compiled with --with-dhcp-pgsql option to use this backend.
# "lease-database": { // "lease-database": {
# "type": "pgsql", // "type": "pgsql",
# "name": "keatest", // "name": "keatest",
# "host": "localhost", // "host": "localhost",
# "port": 5432, // "port": 5432,
# "user": "keatest", // "user": "keatest",
# "password": "secret1", // "password": "secret1",
# "connect-timeout": 3 // "connect-timeout": 3
# }, // },
# 4. CQL (Cassandra) backend. Leases will be stored in Cassandra database. Make // 4. CQL (Cassandra) backend. Leases will be stored in Cassandra database. Make
# sure it is up, running and properly initialized. See kea-admin documentation // sure it is up, running and properly initialized. See kea-admin documentation
# for details on how to initialize the database. The only strictly required // for details on how to initialize the database. The only strictly required
# parameters are type, keyspace and contact-points. At least one contact point // parameters are type, keyspace and contact-points. At least one contact point
# must be specified, but more than one is required for redundancy. Make sure // must be specified, but more than one is required for redundancy. Make sure
# you specify the contact points without spaces. Kea must be compiled with // you specify the contact points without spaces. Kea must be compiled with
# --with-cql option to use this backend. // --with-cql option to use this backend.
# "lease-database": { // "lease-database": {
# "type": "cql", // "type": "cql",
# "keyspace": "keatest", // "keyspace": "keatest",
# "contact-points": "192.0.2.1,192.0.2.2,192.0.2.3", // "contact-points": "192.0.2.1,192.0.2.2,192.0.2.3",
# "port": 9042 // "port": 9042
# }, // },
# Addresses will be assigned with a lifetime of 4000 seconds. // Addresses will be assigned with a lifetime of 4000 seconds.
"valid-lifetime": 4000, "valid-lifetime": 4000,
# Renew and rebind timers are commented out. This implies that options // Renew and rebind timers are commented out. This implies that options
# 58 and 59 will not be sent to the client. In this case it is up to // 58 and 59 will not be sent to the client. In this case it is up to
# the client to pick the timer values according to RFC2131. Uncomment the // the client to pick the timer values according to RFC2131. Uncomment the
# timers to send these options to the client. // timers to send these options to the client.
# "renew-timer": 1000, // "renew-timer": 1000,
# "rebind-timer": 2000, // "rebind-timer": 2000,
# The following list defines subnets. We have only one subnet // The following list defines subnets. We have only one subnet
# here. We tell Kea that it is directly available over local interface. // here. We tell Kea that it is directly available over local interface.
"subnet4": [ "subnet4": [
{ {
"pools": [ { "pool": "192.0.2.1 - 192.0.2.200" } ], "pools": [ { "pool": "192.0.2.1 - 192.0.2.200" } ],
@@ -95,8 +95,8 @@
] ]
}, },
# The following configures logging. It assumes that messages with at least // The following configures logging. It assumes that messages with at least
# informational level (info, warn, error and fatal) should be logged to stdout. // informational level (info, warn, error and fatal) should be logged to stdout.
"Logging": { "Logging": {
"loggers": [ "loggers": [
{ {

72
doc/examples/kea4/classify.json
View File

@@ -1,30 +1,30 @@
# This is an example configuration file for the DHCPv4 server in Kea. // This is an example configuration file for the DHCPv4 server in Kea.
# The purpose of this example is to showcase how clients can be classified. // The purpose of this example is to showcase how clients can be classified.
{ "Dhcp4": { { "Dhcp4": {
# Kea is told to listen on ethX interface only. // Kea is told to listen on ethX interface only.
"interfaces-config": { "interfaces-config": {
"interfaces": [ "ethX" ] "interfaces": [ "ethX" ]
}, },
# Let's use the simplest backend: memfile and use some reasonable values // Let's use the simplest backend: memfile and use some reasonable values
# for timers. They are of no concern for the classification demonstration. // for timers. They are of no concern for the classification demonstration.
"lease-database": { "type": "memfile" }, "lease-database": { "type": "memfile" },
"renew-timer": 1000, "renew-timer": 1000,
"rebind-timer": 2000, "rebind-timer": 2000,
"valid-lifetime": 4000, "valid-lifetime": 4000,
# This list defines several classes that incoming packets can be assigned to. // This list defines several classes that incoming packets can be assigned to.
# One packet can belong to zero or more classes. // One packet can belong to zero or more classes.
"client-classes": [ "client-classes": [
# The first class attempts to match the whole hardware address to a specific // The first class attempts to match the whole hardware address to a specific
# value. All incoming packets with that MAC address will get a special // value. All incoming packets with that MAC address will get a special
# value of the option. If there are many hosts that require special // value of the option. If there are many hosts that require special
# treatment, it is much better to use host reservations. However, doing // treatment, it is much better to use host reservations. However, doing
# tricks with MAC addresses may prove useful in some cases, e.g. // tricks with MAC addresses may prove useful in some cases, e.g.
# by matching OUI to known values we can detect certain vendors. // by matching OUI to known values we can detect certain vendors.
{ {
"name": "special_snowflake", "name": "special_snowflake",
"test": "pkt4.mac == 0x010203040506", "test": "pkt4.mac == 0x010203040506",
@@ -34,27 +34,27 @@
}] }]
}, },
# Let's classify all incoming DISCOVER (message type 1) to a separate // Let's classify all incoming DISCOVER (message type 1) to a separate
# class. // class.
{ {
"name": "discovers", "name": "discovers",
"test": "pkt4.msgtype == 1" "test": "pkt4.msgtype == 1"
}, },
# Clients are supposed to set the transaction-id field to a random value. // Clients are supposed to set the transaction-id field to a random value.
# Clients that send it with 0 are most likely broken. Let's mark them // Clients that send it with 0 are most likely broken. Let's mark them
# as such. // as such.
{ {
"name": "broken", "name": "broken",
"test": "pkt4.transid == 0" "test": "pkt4.transid == 0"
}, },
# Let's pick VoIP phones. Those that send their class identifiers // Let's pick VoIP phones. Those that send their class identifiers
# as Aastra, should belong to VoIP class. For a list of all options, // as Aastra, should belong to VoIP class. For a list of all options,
# see www.iana.org/assignments/bootp-dhcp-parameters/. // see www.iana.org/assignments/bootp-dhcp-parameters/.
# In this particular class, we want to set specific values // In this particular class, we want to set specific values
# of certain DHCPv4 fields. If the incoming packet matches the // of certain DHCPv4 fields. If the incoming packet matches the
# test, those fields will be set in outgoing responses. // test, those fields will be set in outgoing responses.
{ {
"name": "VoIP", "name": "VoIP",
"test": "substring(option[60].hex,0,6) == 'Aastra'", "test": "substring(option[60].hex,0,6) == 'Aastra'",
@@ -65,23 +65,23 @@
], ],
# The following list defines subnets. For some subnets we defined // The following list defines subnets. For some subnets we defined
# a class that is allowed in that subnet. If not specified, // a class that is allowed in that subnet. If not specified,
# everyone is allowed. When a class is specified, only packets belonging // everyone is allowed. When a class is specified, only packets belonging
# to that class are allowed for that subnet. // to that class are allowed for that subnet.
"subnet4": [ "subnet4": [
{ {
# This one is for VoIP devices only. // This one is for VoIP devices only.
"pools": [ { "pool": "192.0.2.1 - 192.0.2.200" } ], "pools": [ { "pool": "192.0.2.1 - 192.0.2.200" } ],
"subnet": "192.0.2.0/24", "subnet": "192.0.2.0/24",
"client-class": "VoIP", "client-class": "VoIP",
"interface": "ethX" "interface": "ethX"
}, },
# This one doesn't have any client-class specified, so everyone // This one doesn't have any client-class specified, so everyone
# is allowed in. The normal subnet selection rules still apply, // is allowed in. The normal subnet selection rules still apply,
# though. There is also a static class reservation for a client // though. There is also a static class reservation for a client
# using MAC address 1a:1b:1c:1d:1e:1f. This client will always // using MAC address 1a:1b:1c:1d:1e:1f. This client will always
# be assigned to this class. // be assigned to this class.
{ {
"pools": [ { "pool": "192.0.3.1 - 192.0.3.200" } ], "pools": [ { "pool": "192.0.3.1 - 192.0.3.200" } ],
"subnet": "192.0.3.0/24", "subnet": "192.0.3.0/24",
@@ -95,8 +95,8 @@
] ]
}, },
# The following configures logging. It assumes that messages with at least // The following configures logging. It assumes that messages with at least
# informational level (info, warn, error and fatal) should be logged to stdout. // informational level (info, warn, error and fatal) should be logged to stdout.
"Logging": { "Logging": {
"loggers": [ "loggers": [
{ {

10
doc/examples/kea4/dhcpv4-over-dhcpv6.json
View File

@@ -1,9 +1,9 @@
# This is an example configuration file for the DHCPv4 server of // This is an example configuration file for the DHCPv4 server of
# DHCPv4-over-DHCPv6 tests in Kea. // DHCPv4-over-DHCPv6 tests in Kea.
{ {
# DHCPv4 conf // DHCPv4 conf
"Dhcp4": "Dhcp4":
{ {
"interfaces-config": { "interfaces-config": {
@@ -20,13 +20,13 @@
"subnet4": [ "subnet4": [
{ "subnet": "10.10.10.0/24", { "subnet": "10.10.10.0/24",
# Don't forget the "4o6-" before "interface" here! // Don't forget the "4o6-" before "interface" here!
"4o6-interface": "eno33554984", "4o6-interface": "eno33554984",
"4o6-subnet": "2001:db8:1:1::/64", "4o6-subnet": "2001:db8:1:1::/64",
"pools": [ { "pool": "10.10.10.100 - 10.10.10.199" } ] } "pools": [ { "pool": "10.10.10.100 - 10.10.10.199" } ] }
], ],
# This enables DHCPv4-over-DHCPv6 support // This enables DHCPv4-over-DHCPv6 support
"dhcp4o6-port": 6767 "dhcp4o6-port": 6767
}, },

22
doc/examples/kea4/hooks.json
View File

@@ -1,23 +1,23 @@
# This is an example configuration file for the DHCPv4 server in Kea // This is an example configuration file for the DHCPv4 server in Kea
# illustrating the configuration of hooks libraries. It uses a basic scenario // illustrating the configuration of hooks libraries. It uses a basic scenario
# of one IPv4 subnet configured with the default values for all parameters. // of one IPv4 subnet configured with the default values for all parameters.
{"Dhcp4": {"Dhcp4":
{ {
# Kea is told to listen on the ethX interface only. // Kea is told to listen on the ethX interface only.
"interfaces-config": { "interfaces-config": {
"interfaces": [ "ethX" ] "interfaces": [ "ethX" ]
}, },
# Set up the storage for leases. // Set up the storage for leases.
"lease-database": { "lease-database": {
"type": "memfile" "type": "memfile"
}, },
"valid-lifetime": 1800, "valid-lifetime": 1800,
# Define a single subnet. // Define a single subnet.
"subnet4": [ "subnet4": [
{ {
"pools": [ { "pool": "192.0.2.1 - 192.0.2.200" } ], "pools": [ { "pool": "192.0.2.1 - 192.0.2.200" } ],
@@ -26,11 +26,11 @@
} }
], ],
# Set up the hooks libraries. For this example, we assume that two libraries // Set up the hooks libraries. For this example, we assume that two libraries
# are loaded, called "security" and "charging". Note that order is important: // are loaded, called "security" and "charging". Note that order is important:
# "security" is specified first so if both libraries supply a hook function // "security" is specified first so if both libraries supply a hook function
# for a given hook, the function in "security" will be called before that in // for a given hook, the function in "security" will be called before that in
# "charging". // "charging".
"hooks-libraries": [ "hooks-libraries": [
{ {

42
doc/examples/kea4/leases-expiration.json
View File

@@ -1,32 +1,32 @@
# This is an example configuration file for the DHCPv4 server in Kea. // This is an example configuration file for the DHCPv4 server in Kea.
# It provides parameters controlling processing of expired leases, // It provides parameters controlling processing of expired leases,
# a.k.a. leases reclamation. // a.k.a. leases reclamation.
{ "Dhcp4": { "Dhcp4":
{ {
# Kea is told to listen on ethX interface only. // Kea is told to listen on ethX interface only.
"interfaces-config": { "interfaces-config": {
"interfaces": [ "ethX" ] "interfaces": [ "ethX" ]
}, },
# We need to specify the the database used to store leases. As of // We need to specify the the database used to store leases. As of
# September 2016, four database backends are supported: MySQL, // September 2016, four database backends are supported: MySQL,
# PostgreSQL, Cassandra, and the in-memory database, Memfile. // PostgreSQL, Cassandra, and the in-memory database, Memfile.
# We'll use memfile because it doesn't require any prior set up. // We'll use memfile because it doesn't require any prior set up.
"lease-database": { "lease-database": {
"type": "memfile", "type": "memfile",
"lfc-interval": 3600 "lfc-interval": 3600
}, },
# The following parameters control processing expired leases. Expired leases // The following parameters control processing expired leases. Expired leases
# will be reclaimed periodically according to the "reclaim-timer-wait-time" // will be reclaimed periodically according to the "reclaim-timer-wait-time"
# parameter. Reclaimed leases will be held in the database for 1800s to // parameter. Reclaimed leases will be held in the database for 1800s to
# facilitate lease affinity. After this period the leases will be removed. // facilitate lease affinity. After this period the leases will be removed.
# The frequency of removal is controlled by the "flush-reclaimed-timer-wait-time" // The frequency of removal is controlled by the "flush-reclaimed-timer-wait-time"
# parameter. The lease reclamation routine will process at most 500 leases // parameter. The lease reclamation routine will process at most 500 leases
# or will last for at most 100ms, during a single run. If there are still // or will last for at most 100ms, during a single run. If there are still
# some unreclaimed leases after 10 attempts, a warning message is issued. // some unreclaimed leases after 10 attempts, a warning message is issued.
"expired-leases-processing": { "expired-leases-processing": {
"reclaim-timer-wait-time": 5, "reclaim-timer-wait-time": 5,
"hold-reclaimed-time": 1800, "hold-reclaimed-time": 1800,
@@ -36,11 +36,11 @@
"unwarned-reclaim-cycles": 10 "unwarned-reclaim-cycles": 10
}, },
# Addresses will be assigned with a lifetime of 4000 seconds. // Addresses will be assigned with a lifetime of 4000 seconds.
"valid-lifetime": 4000, "valid-lifetime": 4000,
# The following list defines subnets. We have only one subnet // The following list defines subnets. We have only one subnet
# here. We tell Kea that it is directly available over local interface. // here. We tell Kea that it is directly available over local interface.
"subnet4": [ "subnet4": [
{ {
"pools": [ { "pool": "192.0.2.1 - 192.0.2.200" } ], "pools": [ { "pool": "192.0.2.1 - 192.0.2.200" } ],
@@ -50,8 +50,8 @@
] ]
}, },
# The following configures logging. It assumes that messages with at least // The following configures logging. It assumes that messages with at least
# informational level (info, warn, error and fatal) should be logged to stdout. // informational level (info, warn, error and fatal) should be logged to stdout.
"Logging": { "Logging": {
"loggers": [ "loggers": [
{ {

84
doc/examples/kea4/mysql-reservations.json
View File

@@ -1,58 +1,58 @@
# This is an example configuration file for the DHCPv4 server in Kea. // This is an example configuration file for the DHCPv4 server in Kea.
# It contains configuration of the MySQL host database backend, used // It contains configuration of the MySQL host database backend, used
# to retrieve reserved addresses, host names, DHCPv4 message fields // to retrieve reserved addresses, host names, DHCPv4 message fields
# and DHCP options from MySQL database. // and DHCP options from MySQL database.
{ "Dhcp4": { "Dhcp4":
{ {
# Kea is told to listen on ethX interface only. // Kea is told to listen on ethX interface only.
"interfaces-config": { "interfaces-config": {
"interfaces": [ "ethX" ] "interfaces": [ "ethX" ]
}, },
# We need to specify the the database used to store leases. As of // We need to specify the the database used to store leases. As of
# September 2016, four database backends are supported: MySQL, // September 2016, four database backends are supported: MySQL,
# PostgreSQL, Cassandra, and the in-memory database, Memfile. // PostgreSQL, Cassandra, and the in-memory database, Memfile.
# We'll use memfile because it doesn't require any prior set up. // We'll use memfile because it doesn't require any prior set up.
"lease-database": { "lease-database": {
"type": "memfile", "type": "memfile",
"lfc-interval": 3600 "lfc-interval": 3600
}, },
# Addresses will be assigned with a lifetime of 4000 seconds. // Addresses will be assigned with a lifetime of 4000 seconds.
"valid-lifetime": 4000, "valid-lifetime": 4000,
# Renew and rebind timers are commented out. This implies that options // Renew and rebind timers are commented out. This implies that options
# 58 and 59 will not be sent to the client. In this case it is up to // 58 and 59 will not be sent to the client. In this case it is up to
# the client to pick the timer values according to RFC2131. Uncomment the // the client to pick the timer values according to RFC2131. Uncomment the
# timers to send these options to the client. // timers to send these options to the client.
# "renew-timer": 1000, // "renew-timer": 1000,
# "rebind-timer": 2000, // "rebind-timer": 2000,
# Kea supports reservations by several different types of identifiers: // Kea supports reservations by several different types of identifiers:
# hw-address (hardware/MAC address of the client), duid (DUID inserted by the // hw-address (hardware/MAC address of the client), duid (DUID inserted by the
# client), client-id (client identifier inserted by the client) and circuit-id // client), client-id (client identifier inserted by the client) and circuit-id
# (circuit identifier inserted by the relay agent). When told to do so, Kea can // (circuit identifier inserted by the relay agent). When told to do so, Kea can
# check for all of those identifier types, but it takes a costly database lookup // check for all of those identifier types, but it takes a costly database lookup
# to do so. It is therefore useful from a performance perspective to use only // to do so. It is therefore useful from a performance perspective to use only
# the reservation types that are actually used in a given network. // the reservation types that are actually used in a given network.
# The example below is not optimal from a performance perspective, but it // The example below is not optimal from a performance perspective, but it
# nicely showcases the host reservation capabilities. Please use the minimum // nicely showcases the host reservation capabilities. Please use the minimum
# set of identifier types used in your network. // set of identifier types used in your network.
"host-reservation-identifiers": [ "circuit-id", "hw-address", "duid", "client-id" ], "host-reservation-identifiers": [ "circuit-id", "hw-address", "duid", "client-id" ],
# Specify connection to the database holding host reservations. The type // Specify connection to the database holding host reservations. The type
# specifies that the MySQL database is used. user and password are the // specifies that the MySQL database is used. user and password are the
# credentials used to connect to the database. host and name specify // credentials used to connect to the database. host and name specify
# location of the host where the database instance is running, and the // location of the host where the database instance is running, and the
# name of the database to use. The server processing a packet will first // name of the database to use. The server processing a packet will first
# check if there are any reservations specified for this client in the // check if there are any reservations specified for this client in the
# reservations list, within the subnet (configuration file). If there are // reservations list, within the subnet (configuration file). If there are
# no reservations there, the server will try to retrieve reservations // no reservations there, the server will try to retrieve reservations
# from this database. // from this database.
"hosts-database": { "hosts-database": {
"type": "mysql", "type": "mysql",
"name": "kea", "name": "kea",
@@ -62,11 +62,11 @@
"port": 3306 "port": 3306
}, },
# Define a subnet with a single pool of dynamic addresses. Addresses from // Define a subnet with a single pool of dynamic addresses. Addresses from
# this pool will be assigned to clients which don't have reservations in the // this pool will be assigned to clients which don't have reservations in the
# database. Subnet identifier is equal to 1. If this subnet is selected for // database. Subnet identifier is equal to 1. If this subnet is selected for
# the client, this subnet id will be used to search for the reservations // the client, this subnet id will be used to search for the reservations
# within the database. // within the database.
"subnet4": [ "subnet4": [
{ {
"pools": [ { "pool": "192.0.2.10 - 192.0.2.200" } ], "pools": [ { "pool": "192.0.2.10 - 192.0.2.200" } ],
@@ -77,8 +77,8 @@
] ]
}, },
# The following configures logging. It assumes that messages with at least // The following configures logging. It assumes that messages with at least
# informational level (info, warn, error and fatal) should be logged to stdout. // informational level (info, warn, error and fatal) should be logged to stdout.
"Logging": { "Logging": {
"loggers": [ "loggers": [
{ {

84
doc/examples/kea4/pgsql-reservations.json
View File

@@ -1,57 +1,57 @@
# This is an example configuration file for the DHCPv4 server in Kea. // This is an example configuration file for the DHCPv4 server in Kea.
# It contains configuration of the PostgreSQL host database backend, used // It contains configuration of the PostgreSQL host database backend, used
# to retrieve reserved addresses, host names, DHCPv4 message fields // to retrieve reserved addresses, host names, DHCPv4 message fields
# and DHCP options from PostgreSQL database. // and DHCP options from PostgreSQL database.
{ "Dhcp4": { "Dhcp4":
{ {
# Kea is told to listen on ethX interface only. // Kea is told to listen on ethX interface only.
"interfaces-config": { "interfaces-config": {
"interfaces": [ "ethX" ] "interfaces": [ "ethX" ]
}, },
# We need to specify the the database used to store leases. As of // We need to specify the the database used to store leases. As of
# September 2016, four database backends are supported: MySQL, // September 2016, four database backends are supported: MySQL,
# PostgreSQL, Cassandra, and the in-memory database, Memfile. // PostgreSQL, Cassandra, and the in-memory database, Memfile.
# We'll use memfile because it doesn't require any prior set up. // We'll use memfile because it doesn't require any prior set up.
"lease-database": { "lease-database": {
"type": "memfile" "type": "memfile"
}, },
# Addresses will be assigned with a lifetime of 4000 seconds. // Addresses will be assigned with a lifetime of 4000 seconds.
"valid-lifetime": 4000, "valid-lifetime": 4000,
# Renew and rebind timers are commented out. This implies that options // Renew and rebind timers are commented out. This implies that options
# 58 and 59 will not be sent to the client. In this case it is up to // 58 and 59 will not be sent to the client. In this case it is up to
# the client to pick the timer values according to RFC2131. Uncomment the // the client to pick the timer values according to RFC2131. Uncomment the
# timers to send these options to the client. // timers to send these options to the client.
# "renew-timer": 1000, // "renew-timer": 1000,
# "rebind-timer": 2000, // "rebind-timer": 2000,
# Kea supports reservations by several different types of identifiers: // Kea supports reservations by several different types of identifiers:
# hw-address (hardware/MAC address of the client), duid (DUID inserted by the // hw-address (hardware/MAC address of the client), duid (DUID inserted by the
# client), client-id (client identifier inserted by the client) and circuit-id // client), client-id (client identifier inserted by the client) and circuit-id
# (circuit identifier inserted by the relay agent). When told to do so, Kea can // (circuit identifier inserted by the relay agent). When told to do so, Kea can
# check for all of those identifier types, but it takes a costly database lookup // check for all of those identifier types, but it takes a costly database lookup
# to do so. It is therefore useful from a performance perspective to use only // to do so. It is therefore useful from a performance perspective to use only
# the reservation types that are actually used in a given network. // the reservation types that are actually used in a given network.
# The example below is not optimal from a performance perspective, but it // The example below is not optimal from a performance perspective, but it
# nicely showcases the host reservation capabilities. Please use the minimum // nicely showcases the host reservation capabilities. Please use the minimum
# set of identifier types used in your network. // set of identifier types used in your network.
"host-reservation-identifiers": [ "circuit-id", "hw-address", "duid", "client-id" ], "host-reservation-identifiers": [ "circuit-id", "hw-address", "duid", "client-id" ],
# Specify connection to the database holding host reservations. The type // Specify connection to the database holding host reservations. The type
# specifies that the PostgreSQL database is used. user and password are the // specifies that the PostgreSQL database is used. user and password are the
# credentials used to connect to the database. host and name specify // credentials used to connect to the database. host and name specify
# location of the host where the database instance is running, and the // location of the host where the database instance is running, and the
# name of the database to use. The server processing a packet will first // name of the database to use. The server processing a packet will first
# check if there are any reservations specified for this client in the // check if there are any reservations specified for this client in the
# reservations list, within the subnet (configuration file). If there are // reservations list, within the subnet (configuration file). If there are
# no reservations there, the server will try to retrieve reservations // no reservations there, the server will try to retrieve reservations
# from this database. // from this database.
"hosts-database": { "hosts-database": {
"type": "postgresql", "type": "postgresql",
"name": "kea", "name": "kea",
@@ -60,11 +60,11 @@
"host": "localhost" "host": "localhost"
}, },
# Define a subnet with a single pool of dynamic addresses. Addresses from // Define a subnet with a single pool of dynamic addresses. Addresses from
# this pool will be assigned to clients which don't have reservations in the // this pool will be assigned to clients which don't have reservations in the
# database. Subnet identifier is equal to 1. If this subnet is selected for // database. Subnet identifier is equal to 1. If this subnet is selected for
# the client, this subnet id will be used to search for the reservations // the client, this subnet id will be used to search for the reservations
# within the database. // within the database.
"subnet4": [ "subnet4": [
{ {
"pools": [ { "pool": "192.0.2.10 - 192.0.2.200" } ], "pools": [ { "pool": "192.0.2.10 - 192.0.2.200" } ],
@@ -75,8 +75,8 @@
] ]
}, },
# The following configures logging. It assumes that messages with at least // The following configures logging. It assumes that messages with at least
# informational level (info, warn, error and fatal) should be logged to stdout. // informational level (info, warn, error and fatal) should be logged to stdout.
"Logging": { "Logging": {
"loggers": [ "loggers": [
{ {

54
doc/examples/kea4/several-subnets.json
View File

@@ -1,54 +1,54 @@
# This is an example configuration file for DHCPv4 server in Kea. // This is an example configuration file for DHCPv4 server in Kea.
# It's a basic scenario with three IPv4 subnets configured. In each // It's a basic scenario with three IPv4 subnets configured. In each
# subnet, there's a smaller pool of dynamic addresses. // subnet, there's a smaller pool of dynamic addresses.
{ "Dhcp4": { "Dhcp4":
{ {
# Kea is told to listen on ethX interface only. // Kea is told to listen on ethX interface only.
"interfaces-config": { "interfaces-config": {
"interfaces": [ "ethX" ] "interfaces": [ "ethX" ]
}, },
# We need to specify the the database used to store leases. As of // We need to specify the the database used to store leases. As of
# September 2016, four database backends are supported: MySQL, // September 2016, four database backends are supported: MySQL,
# PostgreSQL, Cassandra, and the in-memory database, Memfile. // PostgreSQL, Cassandra, and the in-memory database, Memfile.
# We'll use memfile because it doesn't require any prior set up. // We'll use memfile because it doesn't require any prior set up.
"lease-database": { "lease-database": {
"type": "memfile" "type": "memfile"
}, },
# Addresses will be assigned with a lifetime of 4000 seconds. // Addresses will be assigned with a lifetime of 4000 seconds.
# The client is told to start renewing after 1000 seconds. If the server // The client is told to start renewing after 1000 seconds. If the server
# does not respond within 2000 seconds of the lease being granted, client // does not respond within 2000 seconds of the lease being granted, client
# is supposed to start REBIND procedure (emergency renewal that allows // is supposed to start REBIND procedure (emergency renewal that allows
# switching to a different server). // switching to a different server).
"valid-lifetime": 4000, "valid-lifetime": 4000,
"renew-timer": 1000, "renew-timer": 1000,
"rebind-timer": 2000, "rebind-timer": 2000,
# RFC6842 says that the server is supposed to echo back client-id option. // RFC6842 says that the server is supposed to echo back client-id option.
# However, some older clients do not support this and are getting confused // However, some older clients do not support this and are getting confused
# when they get their own client-id. Kea can disable RFC6842 support. // when they get their own client-id. Kea can disable RFC6842 support.
"echo-client-id": false, "echo-client-id": false,
# Some clients don't use stable client identifier, but rather generate them // Some clients don't use stable client identifier, but rather generate them
# during each boot. This may cause a client that reboots frequently to get // during each boot. This may cause a client that reboots frequently to get
# multiple leases, which may not be desirable. As such, sometimes admins // multiple leases, which may not be desirable. As such, sometimes admins
# prefer to tell their DHCPv4 server to ignore client-id value altogether // prefer to tell their DHCPv4 server to ignore client-id value altogether
# and rely exclusively on MAC address. This is a parameter that is defined // and rely exclusively on MAC address. This is a parameter that is defined
# globally, but can be overridden on a subnet level. // globally, but can be overridden on a subnet level.
"match-client-id": true, "match-client-id": true,
# The following list defines subnets. Each subnet consists of at // The following list defines subnets. Each subnet consists of at
# least subnet and pool entries. // least subnet and pool entries.
"subnet4": [ "subnet4": [
{ {
"pools": [ { "pool": "192.0.2.1 - 192.0.2.200" } ], "pools": [ { "pool": "192.0.2.1 - 192.0.2.200" } ],
"subnet": "192.0.2.0/24" "subnet": "192.0.2.0/24"
}, },
{ {
# This particular subnet has match-client-id value changed. // This particular subnet has match-client-id value changed.
"pools": [ { "pool": "192.0.3.100 - 192.0.3.200" } ], "pools": [ { "pool": "192.0.3.100 - 192.0.3.200" } ],
"subnet": "192.0.3.0/24", "subnet": "192.0.3.0/24",
"match-client-id": false "match-client-id": false
@@ -59,8 +59,8 @@
} ] } ]
}, },
# The following configures logging. It assumes that messages with at least // The following configures logging. It assumes that messages with at least
# informational level (info, warn, error and fatal) should be logged to stdout. // informational level (info, warn, error and fatal) should be logged to stdout.
"Logging": { "Logging": {
"loggers": [ "loggers": [
{ {

38
doc/examples/kea4/single-subnet.json
View File

@@ -1,36 +1,36 @@
# This is an example configuration file for the DHCPv4 server in Kea. // This is an example configuration file for the DHCPv4 server in Kea.
# It is a basic scenario with one IPv4 subnet configured. The subnet // It is a basic scenario with one IPv4 subnet configured. The subnet
# contains a single pool of dynamically allocated addresses. // contains a single pool of dynamically allocated addresses.
{ "Dhcp4": { "Dhcp4":
{ {
# Kea is told to listen on ethX interface only. // Kea is told to listen on ethX interface only.
"interfaces-config": { "interfaces-config": {
"interfaces": [ "ethX" ] "interfaces": [ "ethX" ]
}, },
# We need to specify the the database used to store leases. As of // We need to specify the the database used to store leases. As of
# September 2016, four database backends are supported: MySQL, // September 2016, four database backends are supported: MySQL,
# PostgreSQL, Cassandra, and the in-memory database, Memfile. // PostgreSQL, Cassandra, and the in-memory database, Memfile.
# We'll use memfile because it doesn't require any prior set up. // We'll use memfile because it doesn't require any prior set up.
"lease-database": { "lease-database": {
"type": "memfile", "type": "memfile",
"lfc-interval": 3600 "lfc-interval": 3600
}, },
# Addresses will be assigned with a lifetime of 4000 seconds. // Addresses will be assigned with a lifetime of 4000 seconds.
"valid-lifetime": 4000, "valid-lifetime": 4000,
# Renew and rebind timers are commented out. This implies that options // Renew and rebind timers are commented out. This implies that options
# 58 and 59 will not be sent to the client. In this case it is up to // 58 and 59 will not be sent to the client. In this case it is up to
# the client to pick the timer values according to RFC2131. Uncomment the // the client to pick the timer values according to RFC2131. Uncomment the
# timers to send these options to the client. // timers to send these options to the client.
# "renew-timer": 1000, // "renew-timer": 1000,
# "rebind-timer": 2000, // "rebind-timer": 2000,
# The following list defines subnets. We have only one subnet // The following list defines subnets. We have only one subnet
# here. We tell Kea that it is directly available over local interface. // here. We tell Kea that it is directly available over local interface.
"subnet4": [ "subnet4": [
{ {
"pools": [ { "pool": "192.0.2.1 - 192.0.2.200" } ], "pools": [ { "pool": "192.0.2.1 - 192.0.2.200" } ],
@@ -40,8 +40,8 @@
] ]
}, },
# The following configures logging. It assumes that messages with at least // The following configures logging. It assumes that messages with at least
# informational level (info, warn, error and fatal) should be logged to stdout. // informational level (info, warn, error and fatal) should be logged to stdout.
"Logging": { "Logging": {
"loggers": [ "loggers": [
{ {

40
doc/examples/kea4/with-ddns.json
View File

@@ -1,36 +1,36 @@
# This is an example configuration file for the DHCPv4 server in Kea. // This is an example configuration file for the DHCPv4 server in Kea.
# It is a basic scenario with one IPv4 subnet configured but with DDNS // It is a basic scenario with one IPv4 subnet configured but with DDNS
# enabled. // enabled.
{ "Dhcp4": { "Dhcp4":
{ {
# Kea is told to listen on ethX interface only. // Kea is told to listen on ethX interface only.
"interfaces-config": { "interfaces-config": {
"interfaces": [ "ethX" ] "interfaces": [ "ethX" ]
}, },
# We need to specify the the database used to store leases. As of // We need to specify the the database used to store leases. As of
# September 2016, four database backends are supported: MySQL, // September 2016, four database backends are supported: MySQL,
# PostgreSQL, Cassandra, and the in-memory database, Memfile. // PostgreSQL, Cassandra, and the in-memory database, Memfile.
# We'll use memfile because it doesn't require any prior set up. // We'll use memfile because it doesn't require any prior set up.
"lease-database": { "lease-database": {
"type": "memfile", "type": "memfile",
"lfc-interval": 3600 "lfc-interval": 3600
}, },
# Addresses will be assigned with a lifetime of 4000 seconds. // Addresses will be assigned with a lifetime of 4000 seconds.
"valid-lifetime": 4000, "valid-lifetime": 4000,
# Renew and rebind timers are commented out. This implies that options // Renew and rebind timers are commented out. This implies that options
# 58 and 59 will not be sent to the client. In this case it is up to // 58 and 59 will not be sent to the client. In this case it is up to
# the client to pick the timer values according to RFC2131. Uncomment the // the client to pick the timer values according to RFC2131. Uncomment the
# timers to send these options to the client. // timers to send these options to the client.
# "renew-timer": 1000, // "renew-timer": 1000,
# "rebind-timer": 2000, // "rebind-timer": 2000,
# The following list defines subnets. We have only one subnet // The following list defines subnets. We have only one subnet
# here. We tell Kea that it is directly available over local interface. // here. We tell Kea that it is directly available over local interface.
"subnet4": [ "subnet4": [
{ {
"pools": [ { "pool": "192.0.2.1 - 192.0.2.200" } ], "pools": [ { "pool": "192.0.2.1 - 192.0.2.200" } ],
@@ -39,7 +39,7 @@
} }
], ],
# Enable dynamic DNS updates // Enable dynamic DNS updates
"dhcp-ddns" : { "dhcp-ddns" : {
"enable-updates" : true, "enable-updates" : true,
"server-ip" : "192.0.2.0", "server-ip" : "192.0.2.0",
@@ -58,8 +58,8 @@
} }
}, },
# The following configures logging. It assumes that messages with at least // The following configures logging. It assumes that messages with at least
# informational level (info, warn, error and fatal) should be logged to stdout. // informational level (info, warn, error and fatal) should be logged to stdout.
"Logging": { "Logging": {
"loggers": [ "loggers": [
{ {

14
doc/examples/kea6/dhcpv4-over-dhcpv6.json
View File

@@ -1,13 +1,13 @@
# This is an example configuration file for the DHCPv6 server of // This is an example configuration file for the DHCPv6 server of
# DHCPv4-over-DHCPv6 tests in Kea. // DHCPv4-over-DHCPv6 tests in Kea.
{ {
# DHCPv6 conf // DHCPv6 conf
"Dhcp6": "Dhcp6":
{ {
"interfaces-config": { "interfaces-config": {
# Enable unicast // Enable unicast
"interfaces": [ "eno33554984/2001:db8:1:1::1" ] "interfaces": [ "eno33554984/2001:db8:1:1::1" ]
}, },
@@ -27,16 +27,16 @@
"pools": [ { "pool": "2001:db8:1:1::1:0/112" } ] } "pools": [ { "pool": "2001:db8:1:1::1:0/112" } ] }
], ],
# This enables DHCPv4-over-DHCPv6 support // This enables DHCPv4-over-DHCPv6 support
"dhcp4o6-port": 6767, "dhcp4o6-port": 6767,
# Required by DHCPv4-over-DHCPv6 clients // Required by DHCPv4-over-DHCPv6 clients
"option-data": [ "option-data": [
{ "name": "dhcp4o6-server-addr", { "name": "dhcp4o6-server-addr",
"code": 88, "code": 88,
"space": "dhcp6", "space": "dhcp6",
"csv-format": true, "csv-format": true,
# Put the server address here // Put the server address here
"data": "2001:db8:1:1::1" } "data": "2001:db8:1:1::1" }
] ]
}, },

24
doc/examples/kea6/hooks.json
View File

@@ -1,27 +1,27 @@
# This is an example configuration file for the DHCPv6 server in Kea // This is an example configuration file for the DHCPv6 server in Kea
# illustrating the configuration of hooks libraries. It uses a basic scenario // illustrating the configuration of hooks libraries. It uses a basic scenario
# of one IPv6 subnet configured with the default values for all parameters. // of one IPv6 subnet configured with the default values for all parameters.
{"Dhcp6": {"Dhcp6":
{ {
# Kea is told to listen on the ethX interface only. // Kea is told to listen on the ethX interface only.
"interfaces-config": { "interfaces-config": {
"interfaces": [ "ethX" ] "interfaces": [ "ethX" ]
}, },
# Set up the storage for leases. // Set up the storage for leases.
"lease-database": { "lease-database": {
"type": "memfile" "type": "memfile"
}, },
# Set values to mandatory timers // Set values to mandatory timers
"renew-timer": 900, "renew-timer": 900,
"rebind-timer": 1200, "rebind-timer": 1200,
"preferred-lifetime": 1800, "preferred-lifetime": 1800,
"valid-lifetime": 2700, "valid-lifetime": 2700,
# Define a single subnet. // Define a single subnet.
"subnet6": [ "subnet6": [
{ {
"pools": [ "pools": [
@@ -34,11 +34,11 @@
} }
], ],
# Set up the hooks libraries. For this example, we assume that two libraries // Set up the hooks libraries. For this example, we assume that two libraries
# are loaded, called "security" and "charging". Note that order is important: // are loaded, called "security" and "charging". Note that order is important:
# "security" is specified first so if both libraries supply a hook function // "security" is specified first so if both libraries supply a hook function
# for a given hook, the function in "security" will be called before that in // for a given hook, the function in "security" will be called before that in
# "charging". // "charging".
"hooks-libraries": [ "hooks-libraries": [
{ {

62
doc/examples/kea6/pgsql-reservations.json
View File

@@ -1,45 +1,45 @@
# This is an example configuration file for the DHCPv6 server in Kea. // This is an example configuration file for the DHCPv6 server in Kea.
# It contains configuration of the PostgreSQL host database backend, used // It contains configuration of the PostgreSQL host database backend, used
# to retrieve reserved addresses, host names, DHCPv4 message fields // to retrieve reserved addresses, host names, DHCPv4 message fields
# and DHCP options from PostgreSQL database. // and DHCP options from PostgreSQL database.
{ "Dhcp6": { "Dhcp6":
{ {
# Kea is told to listen on ethX interface only. // Kea is told to listen on ethX interface only.
"interfaces-config": { "interfaces-config": {
"interfaces": [ "ethX" ] "interfaces": [ "ethX" ]
}, },
# We need to specify the the database used to store leases. As of // We need to specify the the database used to store leases. As of
# September 2016, four database backends are supported: MySQL, // September 2016, four database backends are supported: MySQL,
# PostgreSQL, Cassandra, and the in-memory database, Memfile. // PostgreSQL, Cassandra, and the in-memory database, Memfile.
# We'll use memfile because it doesn't require any prior set up. // We'll use memfile because it doesn't require any prior set up.
"lease-database": { "lease-database": {
"type": "memfile" "type": "memfile"
}, },
# This is pretty basic stuff, it has nothing to do with reservations. // This is pretty basic stuff, it has nothing to do with reservations.
"preferred-lifetime": 3000, "preferred-lifetime": 3000,
"valid-lifetime": 4000, "valid-lifetime": 4000,
"renew-timer": 1000, "renew-timer": 1000,
"rebind-timer": 2000, "rebind-timer": 2000,
# Kea supports two types of identifiers in DHCPv6: hw-address (hardware/MAC address // Kea supports two types of identifiers in DHCPv6: hw-address (hardware/MAC address
# of the client) and duid (DUID inserted by the client). When told to do so, Kea can // of the client) and duid (DUID inserted by the client). When told to do so, Kea can
# check for each of these identifier types, but it takes a costly database lookup // check for each of these identifier types, but it takes a costly database lookup
# to do so. It is therefore useful from a performance perspective to use only // to do so. It is therefore useful from a performance perspective to use only
# the reservation types that are actually used in a given network. // the reservation types that are actually used in a given network.
"host-reservation-identifiers": [ "duid", "hw-address" ], "host-reservation-identifiers": [ "duid", "hw-address" ],
# Specify connection to the database holding host reservations. The type // Specify connection to the database holding host reservations. The type
# specifies that the PostgreSQL database is used. user and password are the // specifies that the PostgreSQL database is used. user and password are the
# credentials used to connect to the database. host and name specify // credentials used to connect to the database. host and name specify
# location of the host where the database instance is running, and the // location of the host where the database instance is running, and the
# name of the database to use. The server processing a packet will first // name of the database to use. The server processing a packet will first
# check if there are any reservations specified for this client in the // check if there are any reservations specified for this client in the
# reservations list, within the subnet (configuration file). If there are // reservations list, within the subnet (configuration file). If there are
# no reservations there, the server will try to retrieve reservations // no reservations there, the server will try to retrieve reservations
# from this database. // from this database.
"hosts-database": { "hosts-database": {
"type": "postgresql", "type": "postgresql",
"name": "kea", "name": "kea",
@@ -48,11 +48,11 @@
"host": "localhost" "host": "localhost"
}, },
# Define a subnet with a pool of dynamic addresses and a pool of dynamic // Define a subnet with a pool of dynamic addresses and a pool of dynamic
# prefixes. Addresses and prefixes from those pools will be assigned to // prefixes. Addresses and prefixes from those pools will be assigned to
# clients which don't have reservations in the database. Subnet identifier // clients which don't have reservations in the database. Subnet identifier
# is equal to 1. If this subnet is selected for the client, this subnet // is equal to 1. If this subnet is selected for the client, this subnet
# id will be used to search for the reservations within the database. // id will be used to search for the reservations within the database.
"subnet6": [ "subnet6": [
{ {
"subnet": "2001:db8:1::/48", "subnet": "2001:db8:1::/48",
@@ -72,8 +72,8 @@
] ]
}, },
# The following configures logging. It assumes that messages with at least // The following configures logging. It assumes that messages with at least
# informational level (info, warn, error and fatal) should be logged to stdout. // informational level (info, warn, error and fatal) should be logged to stdout.
"Logging": { "Logging": {
"loggers": [ "loggers": [
{ {

36
doc/examples/kea6/several-subnets.json
View File

@@ -1,36 +1,36 @@
# This is an example configuration file for DHCPv6 server in Kea. // This is an example configuration file for DHCPv6 server in Kea.
# It's a basic scenario with four IPv6 subnets configured. In each // It's a basic scenario with four IPv6 subnets configured. In each
# subnet, there's a smaller pool of dynamic addresses. // subnet, there's a smaller pool of dynamic addresses.
{ "Dhcp6": { "Dhcp6":
{ {
# Kea is told to listen on ethX interface only. // Kea is told to listen on ethX interface only.
"interfaces-config": { "interfaces-config": {
"interfaces": [ "ethX" ] "interfaces": [ "ethX" ]
}, },
# We need to specify the the database used to store leases. As of // We need to specify the the database used to store leases. As of
# September 2016, four database backends are supported: MySQL, // September 2016, four database backends are supported: MySQL,
# PostgreSQL, Cassandra, and the in-memory database, Memfile. // PostgreSQL, Cassandra, and the in-memory database, Memfile.
# We'll use memfile because it doesn't require any prior set up. // We'll use memfile because it doesn't require any prior set up.
"lease-database": { "lease-database": {
"type": "memfile" "type": "memfile"
}, },
# Addresses will be assigned with preferred and valid lifetimes // Addresses will be assigned with preferred and valid lifetimes
# being 3000 and 4000, respectively. Client is told to start // being 3000 and 4000, respectively. Client is told to start
# renewing after 1000 seconds. If the server does not respond // renewing after 1000 seconds. If the server does not respond
# after 2000 seconds since the lease was granted, client is supposed // after 2000 seconds since the lease was granted, client is supposed
# to start REBIND procedure (emergency renewal that allows switching // to start REBIND procedure (emergency renewal that allows switching
# to a different server). // to a different server).
"preferred-lifetime": 3000, "preferred-lifetime": 3000,
"valid-lifetime": 4000, "valid-lifetime": 4000,
"renew-timer": 1000, "renew-timer": 1000,
"rebind-timer": 2000, "rebind-timer": 2000,
# The following list defines subnets. Each subnet consists of at // The following list defines subnets. Each subnet consists of at
# least subnet and pool entries. // least subnet and pool entries.
"subnet6": [ "subnet6": [
{ "pools": [ { "pool": "2001:db8:1::/80" } ], { "pools": [ { "pool": "2001:db8:1::/80" } ],
"subnet": "2001:db8:1::/64" }, "subnet": "2001:db8:1::/64" },
@@ -42,8 +42,8 @@
"subnet": "2001:db8:4::/64" } ] "subnet": "2001:db8:4::/64" } ]
}, },
# The following configures logging. It assumes that messages with at least // The following configures logging. It assumes that messages with at least
# informational level (info, warn, error and fatal) should be logged to stdout. // informational level (info, warn, error and fatal) should be logged to stdout.
"Logging": { "Logging": {
"loggers": [ "loggers": [
{ {

44
doc/examples/kea6/softwire46.json
View File

@@ -1,50 +1,50 @@
# This is an example configuration file for DHCPv6 server in Kea. // This is an example configuration file for DHCPv6 server in Kea.
# It demonstrates how user can specify values for Softwire options // It demonstrates how user can specify values for Softwire options
# defined in RFC 7598 for Lightweight 4over6 architecture. // defined in RFC 7598 for Lightweight 4over6 architecture.
{ "Dhcp6": { "Dhcp6":
{ {
# Kea is told to listen on ethX interface only. // Kea is told to listen on ethX interface only.
"interfaces-config": { "interfaces-config": {
"interfaces": [ "ethX" ] "interfaces": [ "ethX" ]
}, },
# Let's use a Memfile backend to store leases. // Let's use a Memfile backend to store leases.
"lease-database": { "lease-database": {
"type": "memfile" "type": "memfile"
}, },
# Addresses will be assigned with preferred and valid lifetimes // Addresses will be assigned with preferred and valid lifetimes
# being 3000 and 4000, respectively. Client is told to start // being 3000 and 4000, respectively. Client is told to start
# renewing after 1000 seconds. If the server does not respond // renewing after 1000 seconds. If the server does not respond
# after 2000 seconds since the lease was granted, client is supposed // after 2000 seconds since the lease was granted, client is supposed
# to start REBIND procedure (emergency renewal that allows switching // to start REBIND procedure (emergency renewal that allows switching
# to a different server). // to a different server).
"preferred-lifetime": 3000, "preferred-lifetime": 3000,
"valid-lifetime": 4000, "valid-lifetime": 4000,
"renew-timer": 1000, "renew-timer": 1000,
"rebind-timer": 2000, "rebind-timer": 2000,
# The following list defines subnets. Each subnet consists of at // The following list defines subnets. Each subnet consists of at
# least subnet and pool entries. // least subnet and pool entries.
"subnet6": [ "subnet6": [
{ {
"pools": [ { "pool": "2001:db8:1::/80" } ], "pools": [ { "pool": "2001:db8:1::/80" } ],
"subnet": "2001:db8:1::/64", "subnet": "2001:db8:1::/64",
"interface": "ethX", "interface": "ethX",
# Include MAP-E Container option for hosts connected to this subnet. // Include MAP-E Container option for hosts connected to this subnet.
"option-data": [ "option-data": [
{ {
"name": "s46-cont-mape" "name": "s46-cont-mape"
} }
], ],
# Send host specific softwire options. // Send host specific softwire options.
"reservations": [ "reservations": [
{ {
"duid": "01:02:03:04:05:06:07:08:09:0A", "duid": "01:02:03:04:05:06:07:08:09:0A",
"option-data": [ "option-data": [
# These two options will be included in the MAP-E Container // These two options will be included in the MAP-E Container
{ {
"space": "s46-cont-mape-options", "space": "s46-cont-mape-options",
"name": "s46-rule", "name": "s46-rule",
@@ -55,10 +55,10 @@
"name": "s46-br", "name": "s46-br",
"data": "2001:db8:cafe::1" "data": "2001:db8:cafe::1"
}, },
# This option will be included in the S46 Rule option. It includes // This option will be included in the S46 Rule option. It includes
# PSID/PSID length value in a user friendly form. The PSID length // PSID/PSID length value in a user friendly form. The PSID length
# specifies the number of bits on which PSID is coded. The PSID // specifies the number of bits on which PSID is coded. The PSID
# value 3 is a 4th value that is coded on these 4 bits: "0011b". // value 3 is a 4th value that is coded on these 4 bits: "0011b".
{ {
"space": "s46-rule-options", "space": "s46-rule-options",
"name": "s46-portparams", "name": "s46-portparams",
@@ -71,8 +71,8 @@
] ]
}, },
# The following configures logging. Kea will log all debug messages // The following configures logging. Kea will log all debug messages
# to /var/log/kea-debug.log file. // to /var/log/kea-debug.log file.
"Logging": { "Logging": {
"loggers": [ "loggers": [
{ {

40
doc/examples/kea6/with-ddns.json
View File

@@ -1,38 +1,38 @@
# This is an example configuration file for DHCPv6 server in Kea. // This is an example configuration file for DHCPv6 server in Kea.
# It's a basic scenario with one IPv6 subnet configured. It is // It's a basic scenario with one IPv6 subnet configured. It is
# assumed that one subnet (2001:db8:1::/64 is available directly // assumed that one subnet (2001:db8:1::/64 is available directly
# over ethX interface. // over ethX interface.
{ "Dhcp6": { "Dhcp6":
{ {
# Kea is told to listen on ethX interface only. // Kea is told to listen on ethX interface only.
"interfaces-config": { "interfaces-config": {
"interfaces": [ "ethX" ] "interfaces": [ "ethX" ]
}, },
# We need to specify the the database used to store leases. As of // We need to specify the the database used to store leases. As of
# September 2016, four database backends are supported: MySQL, // September 2016, four database backends are supported: MySQL,
# PostgreSQL, Cassandra, and the in-memory database, Memfile. // PostgreSQL, Cassandra, and the in-memory database, Memfile.
# We'll use memfile because it doesn't require any prior set up. // We'll use memfile because it doesn't require any prior set up.
"lease-database": { "lease-database": {
"type": "memfile", "type": "memfile",
"lfc-interval": 3600 "lfc-interval": 3600
}, },
# Addresses will be assigned with preferred and valid lifetimes // Addresses will be assigned with preferred and valid lifetimes
# being 3000 and 4000, respectively. Client is told to start // being 3000 and 4000, respectively. Client is told to start
# renewing after 1000 seconds. If the server does not respond // renewing after 1000 seconds. If the server does not respond
# after 2000 seconds since the lease was granted, client is supposed // after 2000 seconds since the lease was granted, client is supposed
# to start REBIND procedure (emergency renewal that allows switching // to start REBIND procedure (emergency renewal that allows switching
# to a different server). // to a different server).
"preferred-lifetime": 3000, "preferred-lifetime": 3000,
"valid-lifetime": 4000, "valid-lifetime": 4000,
"renew-timer": 1000, "renew-timer": 1000,
"rebind-timer": 2000, "rebind-timer": 2000,
# The following list defines subnets. Each subnet consists of at // The following list defines subnets. Each subnet consists of at
# least subnet and pool entries. // least subnet and pool entries.
"subnet6": [ "subnet6": [
{ {
"pools": [ { "pool": "2001:db8:1::/80" } ], "pools": [ { "pool": "2001:db8:1::/80" } ],
@@ -41,7 +41,7 @@
} }
], ],
# Enable dynamic DNS updates // Enable dynamic DNS updates
"dhcp-ddns" : { "dhcp-ddns" : {
"enable-updates" : true, "enable-updates" : true,
"server-ip" : "3001::1", "server-ip" : "3001::1",
@@ -61,8 +61,8 @@
}, },
# The following configures logging. It assumes that messages with at least // The following configures logging. It assumes that messages with at least
# informational level (info, warn, error and fatal) should be logged to stdout. // informational level (info, warn, error and fatal) should be logged to stdout.
"Logging": { "Logging": {
"loggers": [ "loggers": [
{ {

897
src/bin/keactrl/kea.conf.pre
View File

@@ -1,108 +1,730 @@
# This is a basic configuration for the Kea DHCPv4 and DHCPv6 servers. // This is a basic configuration for the Kea DHCPv4 and DHCPv6 servers. Subnet
# Subnet declarations are commented out and no interfaces are listed. // declarations are mostly commented out and no interfaces are listed.
# Therefore, the servers will not listen or respond to any queries. // Therefore, the servers will not listen or respond to any queries. The basic
# The basic configuration must be extended to specify interfaces on // configuration must be extended to specify interfaces on which the servers
# which the servers should listen. Also, subnets and options must be // should listen. There are a number of example options defined. These probably
# declared. // don't make any sense in your network. Make sure you at least update the
// following, before running this example in your network:
// - change the network interface names
// - change the subnets to match your actual network
// - change the option values to match your network
//
// This is just a very basic configuration. Kea comes with large suite (over 30)
// of configuration examples and extensive Kea User's Guide. Please refer to
// those materials to get better understanding of what this software is able to
// do. Comments in this configuration file sometimes refer to sections for more
// details. These are section numbers in Kea User's Guide. The version matching
// your software should come with your Kea package, but it is also available
// on Kea web page (http://kea.isc.org, click User's Guide, direct link for
// stable version is http://kea.isc.org/docs/kea-guide.html).
{ {
# DHCPv4 configuration starts here. // DHCPv4 configuration starts here. This section will be read by DHCPv4 server
"Dhcp4": // and will be ignored by other components.
{ "Dhcp4": {
# Add names of interfaces to listen on. // Add names of your network interfaces to listen on.
"interfaces-config": { "interfaces-config": {
"interfaces": [ ] // See section 8.2.4 for more details. You probably want to add just
}, // interface name (e.g. "eth0" or specific IPv4 address on that
// interface name (e.g. "eth0/192.0.2.1").
"interfaces": [ ]
# Use Memfile lease database backend to store leases in a CSV file. // Kea DHCPv4 server by default listens using raw sockets. This ensures
"lease-database": { // all packets, including those sent by directly connected clients
"type": "memfile" // that don't have IPv4 address yet, are received. However, if your
}, // traffic is always relayed, it is often better to use regular
// UDP sockets. If you want to do that, uncomment this line:
// "dhcp-socket-type": "udp"
},
# Setup reclamation of the expired leases and leases affinity. // Kea support control channel, which is a way to receive management
# Expired leases will be reclaimed every 10 seconds. Every 25 // commands while the server is running. This is a Unix domain socket that
# seconds reclaimed leases, which have expired more than 3600 // receives commands formatted in JSON, e.g. config-set (which sets new
# seconds ago, will be removed. The limits for leases reclamation // configuration), config-reload (which tells Kea to reload its
# are 100 leases or 250 ms for a single cycle. A warning message // configuration from file), statistic-get (to retrieve statistics) and many
# will be logged if there are still expired leases in the // more. For detailed description, see Sections 8.8, 16 and 15.
# database after 5 consecutive reclamation cycles. "control-socket": {
"expired-leases-processing": { "socket-type": "unix",
"reclaim-timer-wait-time": 10, "socket-name": "/tmp/kea4-ctrl-socket.sock"
"flush-reclaimed-timer-wait-time": 25, },
"hold-reclaimed-time": 3600,
"max-reclaim-leases": 100,
"max-reclaim-time": 250,
"unwarned-reclaim-cycles": 5
},
# Global (inherited by all subnets) lease lifetime is mandatory parameter. // Use Memfile lease database backend to store leases in a CSV file.
"valid-lifetime": 4000, // Depending on how Kea was compiled, it may also support SQL databases
// (MySQL and/or PostgreSQL) and even Cassandra. Those database backends
// require more parameters, like name, host and possibly user and password.
// There are dedicated examples for each backend. See Section 7.2.2 "Lease
// Storage" for details.
"lease-database": {
// Memfile is the simplest and easiest backend to use. It's a in-memory
// C++ database that stores its state in CSV file.
"type": "memfile"
},
# Below an example of the simple subnet declaration. Uncomment to // Kea allows storing host reservations in a database. If your network is
# enable it. This is a list, denoted with [ ], of structure, denoted // small or you have few reservations, it's probably easier to keep them
# with { }. Each structure describes a single subnet and may have // in the configuration file. If your network is large, it's usually better
# several parameters. One of those parameters is "pools" that is // to use database for it. To enable it, uncomment the following:
# also a list of structures. // "hosts-database": {
"subnet4": [ // "type": "mysql",
# { "subnet": "192.0.2.0/24", // "name": "kea",
# "pools": [ { "pool": "192.0.2.1 - 192.0.2.200" } ] } // "user": "kea",
] // "password": "kea",
// "host": "localhost",
// "port": 3306
// },
// See Section 7.2.3 "Hosts storage" for details.
// Setup reclamation of the expired leases and leases affinity.
// Expired leases will be reclaimed every 10 seconds. Every 25
// seconds reclaimed leases, which have expired more than 3600
// seconds ago, will be removed. The limits for leases reclamation
// are 100 leases or 250 ms for a single cycle. A warning message
// will be logged if there are still expired leases in the
// database after 5 consecutive reclamation cycles.
"expired-leases-processing": {
"reclaim-timer-wait-time": 10,
"flush-reclaimed-timer-wait-time": 25,
"hold-reclaimed-time": 3600,
"max-reclaim-leases": 100,
"max-reclaim-time": 250,
"unwarned-reclaim-cycles": 5
},
// Global timers specified here apply to all subnets, unless there are
// subnet specific values defined in particular subnets.
"renew-timer": 900,
"rebind-timer": 1800,
"valid-lifetime": 3600,
// Many additional parameters can be specified here:
// - option definitions (if you want to define vendor options, your own
// custom options or perhaps handle standard options
// that Kea does not support out of the box yet)
// - client classes
// - hooks
// - ddns information (how the DHCPv4 component can reach a DDNS daemon)
//
// Some of them have examples below, but there are other parameters.
// Consult Kea User's Guide to find out about them.
// These are global options. They are going to be sent when a client
// requests them, unless overwritten with values in more specific scopes.
// The scope hierarchy is:
// - global (most generic, can be overwritten by class, subnet or host)
// - class (can be overwritten by subnet or host)
// - subnet (can be overwritten by host)
// - host (most specific, overwrites any other scopes)
//
// Not all of those options make sense. Please configure only those that
// are actually useful in your network.
//
// For a complete list of options currently supported by Kea, see
// Section 7.2.8 "Standard DHCPv4 Options". Kea also supports
// vendor options (see Section 7.2.10) and allows users to define their
// own custom options (see Section 7.2.9).
"option-data": [
// When specifying options, you typically need to specify
// one of (name or code) and data. The full option specification
// covers name, code, space, csv-format and data.
// space defaults to "dhcp4" which is usually correct, unless you
// use encapsulate options. csv-format defaults to "true", so
// this is also correct, unless you want to specify the whole
// option value as long hex string. For example, to specify
// domain-name-servers you could do this:
// {
// "name": "domain-name-servers",
// "code": 6,
// "csv-format": "true",
// "space": "dhcp4",
// "data": "192.0.2.1, 192.0.2.2"
// }
// but it's a lot of writing, so it's easier to do this instead:
{
"name": "domain-name-servers",
"data": "192.0.2.1, 192.0.2.2"
},
// Typically people prefer to refer to options by their names, so they
// don't need to remember the code names. However, some people like
// to use numerical values. For example, option "domain-name" uses
// option code 15, so you can reference to it either by
// "name": "domain-name" or "code": 15.
{
"code": 15,
"data": "example.org"
},
// Domain search is also a popular option. It tells the client to
// attempt to resolve names within those specified domains. For
// example, name "foo" would be attempted to be resolved as
// foo.mydomain.example.com and if it fails, then as foo.example.com
{
"name": "domain-search",
"data": "mydomain.example.com, example.com"
},
// String options that have a comma in their values need to have
// it escaped (i.e. each comma is preceded by two backslashes).
// That's because commas are reserved for separating fields in
// compound options. At the same time, we need to be conformant
// with JSON spec, that does not allow "\,". Therefore the
// slightly uncommon double backslashes notation is needed.
// Legal JSON escapes are \ followed by "\/bfnrt character
// or \u followed by 4 hexadecimal numbers (currently Kea
// supports only \u0000 to \u00ff code points).
// CSV processing translates '\\' into '\' and '\,' into ','
// only so for instance '\x' is translated into '\x'. But
// as it works on a JSON string value each of these '\'
// characters must be doubled on JSON input.
{
"name": "boot-file-name",
"data": "EST5EDT4\\,M3.2.0/02:00\\,M11.1.0/02:00"
},
// Options that take integer values can either be specified in
// dec or hex format. Hex format could be either plain (e.g. abcd)
// or prefixed with 0x (e.g. 0xabcd).
{
"name": "default-ip-ttl",
"data": "0xf0"
}
// Note that Kea provides some of the options on its own. In particular,
// it sends IP Address lease type (code 51, based on valid-lifetime
// parameter, Subnet mask (code 1, based on subnet definition), Renewal
// time (code 58, based on renew-timer parameter), Rebind time (code 59,
// based on rebind-timer parameter).
],
// Other global parameters that can be defined here are option definitions
// (this is useful if you want to use vendor options, your own custom
// options or perhaps handle options that Kea does not handle out of the box
// yet).
// You can also define classes. If classes are defined, incoming packets
// may be assigned to specific classes. A client class can represent any
// group of devices that share some common characteristic, e.g. Windows
// devices, iphones, broken printers that require special options, etc.
// Based on the class information, you can then allow or reject clients
// to use certain subnets, add special options for them or change values
// of some fixed fields.
"client-classes": [
{
// This specifies a name of this class. It's useful if you need to
// reference this class.
"name": "voip",
// This is a test. It is an expression that is being evaluated on
// each incoming packet. It is supposed to evaluate to either
// true or false. If it's true, the packet is added to specified
// class. See Section 12 for a list of available expressions. There
// are several dozens. Section 8.2.14 for more details for DHCPv4
// classification and Section 9.2.19 for DHCPv6.
"test": "substring(option[60].hex,0,6) == 'Aastra'",
// If a client belongs to this class, you can define extra behavior.
// For example, certain fields in DHCPv4 packet will be set to
// certain values.
"next-server": "192.0.2.254",
"server-hostname": "hal9000",
"boot-file-name": "/dev/null"
// You can also define option values here if you want devices from
// this class to receive special options.
}
],
// Another thing possible here are hooks. Kea supports a powerful mechanism
// that allows loading external libraries that can extract information and
// even influence how the server processes packets. Those libraries include
// additional forensic logging capabilities, ability to reserve hosts in
// more flexible ways, and even add extra commands. For a list of available
// hook libraries, see http://kea.isc.org/wiki/Hooks.
//"hooks-libraries": [
// {
// // Forensic Logging library generates forensic type of audit trail
// // of all devices serviced by Kea, including their identifiers
// // (like MAC address), their location in the network, times
// // when they were active etc.
// "library": "@localstatedir@/kea/libdhcp_legal_log.so"
// "parameters": {
// "path": "/var/kea/var",
// "base-name": "kea-forensic4"
// }
// },
// {
// // Flexible identifier (flex-id). Kea software provides a way to
// // handle host reservations that include addresses, prefixes,
// // options, client classes and other features. The reservation can
// // be based on hardware address, DUID, circuit-id or client-id in
// // DHCPv4 and using hardware address or DUID in DHCPv6. However,
// // there are sometimes scenario where the reservation is more
// // complex, e.g. uses other options that mentioned above, uses part
// // of specific options or perhaps even a combination of several
// // options and fields to uniquely identify a client. Those scenarios
// // are addressed by the Flexible Identifiers hook application.
// "library": "@localstatedir@/kea/libdhcp_flex_id.so",
// "parameters": {
// "identifier-expression": "substring(relay6[0].option[18],0,8)"
// }
// }
//],
// Below an example of a simple IPv4 subnet declaration. Uncomment to enable
// it. This is a list, denoted with [ ], of structures, each denoted with
// { }. Each structure describes a single subnet and may have several
// parameters. One of those parameters is "pools" that is also a list of
// structures.
"subnet4": [
{
// This defines the whole subnet. Kea will use this information to
// determine where the clients are connected. This is the whole
// subnet in your network. This is mandatory parameter for each
// subnet.
"subnet": "192.0.2.0/24",
// Pools define the actual part of your subnet that is governed
// by Kea. Technically this is optional parameter, but it's
// almost always needed for DHCP to do its job. If you omit it,
// clients won't be able to get addresses, unless there are
// host reservations defined for them.
"pools": [ { "pool": "192.0.2.1 - 192.0.2.200" } ],
// These are options that are subnet specific. In most cases,
// you need to define at least routers option, as without this
// option your clients will not be able to reach their default
// gateway and will not have Internet connectivity.
"option-data": [
{
// For each IPv4 subnet you most likely need to specify at
// least one router.
"name": "routers",
"data": "192.0.2.1"
}
],
// Kea offers host reservations mechanism. Kea supports reservations
// by several different types of identifiers: hw-address
// (hardware/MAC address of the client), duid (DUID inserted by the
// client), client-id (client identifier inserted by the client) and
// circuit-id (circuit identifier inserted by the relay agent).
//
// Kea also support flexible identifier (flex-id), which lets you
// specify an expression that is evaluated for each incoming packet.
// Resulting value is then used for as an identifier.
//
// Note that reservations are subnet-specific in Kea. This is
// different than ISC DHCP. Keep that in mind when migrating
// your configurations.
"reservations": [
// This is a reservation for a specific hardware/MAC address.
// It's a rather simple reservation: just an address and nothing
// else.
{
"hw-address": "1a:1b:1c:1d:1e:1f",
"ip-address": "192.0.2.201"
},
// This is a reservation for a specific client-id. It also shows
// the this client will get a reserved hostname. A hostname can
// be defined for any identifier type, not just client-id.
{
"client-id": "01:11:22:33:44:55:66",
"ip-address": "192.0.2.202",
"hostname": "special-snowflake"
},
// The third reservation is based on DUID. This reservation defines
// a special option values for this particular client. If the
// domain-name-servers option would have been defined on a global,
// subnet or class level, the host specific values take preference.
{
"duid": "01:02:03:04:05",
"ip-address": "192.0.2.203",
"option-data": [ {
"name": "domain-name-servers",
"data": "10.1.1.202, 10.1.1.203"
} ]
},
// The fourth reservation is based on circuit-id. This is an option
// inserted by the relay agent that forwards the packet from client
// to the server. In this example the host is also assigned vendor
// specific options.
//
// When using reservations, it is useful to configure
// reservation-mode (subnet specific parameter) and
// host-reservation-identifiers (global parameter).
{
"client-id": "01:12:23:34:45:56:67",
"ip-address": "192.0.2.204",
"option-data": [
{
"name": "vivso-suboptions",
"data": "4491"
},
{
"name": "tftp-servers",
"space": "vendor-4491",
"data": "10.1.1.202, 10.1.1.203"
}
]
},
// This reservation is for a client that needs specific DHCPv4
// fields to be set. Three supported fields are next-server,
// server-hostname and boot-file-name
{
"client-id": "01:0a:0b:0c:0d:0e:0f",
"ip-address": "192.0.2.205",
"next-server": "192.0.2.1",
"server-hostname": "hal9000",
"boot-file-name": "/dev/null"
},
// This reservation is using flexible identifier. Instead of
// relying on specific field, sysadmin can define an expression
// similar to what is used for client classification,
// e.g. substring(relay[0].option[17],0,6). Then, based on the
// value of that expression for incoming packet, the reservation
// is matched. Expression can be specified either as hex or
// plain text using single quotes.
//
// Note: flexible identifier requires flex_id hook library to be
// loaded to work.
{
"flex-id": "'s0mEVaLue'",
"ip-address": "192.0.2.206"
}
// You can add more reservations here.
]
// You can add more subnets there.
}
]
// There are many, many more parameters that DHCPv4 server is able to use.
// They were not added here to not overwhelm people with too much
// information at once.
}, },
# DHCPv6 configuration starts here. // DHCPv6 configuration starts here. This section will be read by DHCPv6 server
"Dhcp6": // and will be ignored by other components.
{ "Dhcp6": {
# Add names of interfaces to listen on. // Add names of your network interfaces to listen on.
"interfaces-config": { "interfaces-config": {
"interfaces": [ ] // You typically want to put specific interface names here, e.g. eth0
}, // but you can also specify unicast addresses (e.g. eth0/2001:db8::1) if
// you want your server to handle unicast traffic in addition to
// multicast. (DHCPv6 is a multicast based protocol).
"interfaces": [ ]
},
# Use Memfile lease database backend to store leases in a CSV file. // Kea support control channel, which is a way to receive management commands
"lease-database": { // while the server is running. This is a Unix domain socket that receives
"type": "memfile" // commands formatted in JSON, e.g. config-set (which sets new configuration),
}, // config-reload (which tells Kea to reload its configuration from file),
// statistic-get (to retrieve statistics) and many more. For detailed
// description, see Sections 9.12, 16 and 15.
"control-socket": {
"socket-type": "unix",
"socket-name": "/tmp/kea6-ctrl-socket.sock"
},
# Setup reclamation of the expired leases and leases affinity. // Use Memfile lease database backend to store leases in a CSV file.
# Expired leases will be reclaimed every 10 seconds. Every 25 // Depending on how Kea was compiled, it may also support SQL databases
# seconds reclaimed leases, which have expired more than 3600 // (MySQL and/or PostgreSQL) and even Cassandra. Those database backends
# seconds ago, will be removed. The limits for leases reclamation // require more parameters, like name, host and possibly user and password.
# are 100 leases or 250 ms for a single cycle. A warning message // There are dedicated examples for each backend. See Section 8.2.2 "Lease
# will be logged if there are still expired leases in the // Storage" for details.
# database after 5 consecutive reclamation cycles. "lease-database": {
"expired-leases-processing": { "type": "memfile"
"reclaim-timer-wait-time": 10, },
"flush-reclaimed-timer-wait-time": 25,
"hold-reclaimed-time": 3600,
"max-reclaim-leases": 100,
"max-reclaim-time": 250,
"unwarned-reclaim-cycles": 5
},
# Addresses will be assigned with preferred and valid lifetimes // Kea allows storing host reservations in a database. If your network is
# being 3000 and 4000, respectively. Client is told to start // small or you have few reservations, it's probably easier to keep them
# renewing after 1000 seconds. If the server does not respond // in the configuration file. If your network is large, it's usually better
# after 2000 seconds since the lease was granted, client is supposed // to use database for it. To enable it, uncomment the following:
# to start REBIND procedure (emergency renewal that allows switching // "hosts-database": {
# to a different server). // "type": "mysql",
"preferred-lifetime": 3000, // "name": "kea",
"valid-lifetime": 4000, // "user": "kea",
"renew-timer": 1000, // "password": "kea",
"rebind-timer": 2000, // "host": "localhost",
// "port": 3306
// },
// See Section 8.2.3 "Hosts storage" for details.
// Setup reclamation of the expired leases and leases affinity.
// Expired leases will be reclaimed every 10 seconds. Every 25
// seconds reclaimed leases, which have expired more than 3600
// seconds ago, will be removed. The limits for leases reclamation
// are 100 leases or 250 ms for a single cycle. A warning message
// will be logged if there are still expired leases in the
// database after 5 consecutive reclamation cycles.
"expired-leases-processing": {
"reclaim-timer-wait-time": 10,
"flush-reclaimed-timer-wait-time": 25,
"hold-reclaimed-time": 3600,
"max-reclaim-leases": 100,
"max-reclaim-time": 250,
"unwarned-reclaim-cycles": 5
},
// These parameters govern global timers. Addresses will be assigned with
// preferred and valid lifetimes being 3000 and 4000, respectively. Client
// is told to start renewing after 1000 seconds. If the server does not
// respond after 2000 seconds since the lease was granted, a client is
// supposed to start REBIND procedure (emergency renewal that allows
// switching to a different server).
"renew-timer": 1000,
"rebind-timer": 2000,
"preferred-lifetime": 3000,
"valid-lifetime": 4000,
// These are global options. They are going to be sent when a client requests
// them, unless overwritten with values in more specific scopes. The scope
// hierarchy is:
// - global
// - subnet
// - class
// - host
//
// Not all of those options make sense. Please configure only those that
// are actually useful in your network.
//
// For a complete list of options currently supported by Kea, see
// Section 8.2.9 "Standard DHCPv6 Options". Kea also supports
// vendor options (see Section 7.2.10) and allows users to define their
// own custom options (see Section 7.2.9).
"option-data": [
// When specifying options, you typically need to specify
// one of (name or code) and data. The full option specification
// covers name, code, space, csv-format and data.
// space defaults to "dhcp6" which is usually correct, unless you
// use encapsulate options. csv-format defaults to "true", so
// this is also correct, unless you want to specify the whole
// option value as long hex string. For example, to specify
// domain-name-servers you could do this:
// {
// "name": "dns-servers",
// "code": 23,
// "csv-format": "true",
// "space": "dhcp6",
// "data": "2001:db8:2::45, 2001:db8:2::100"
// }
// but it's a lot of writing, so it's easier to do this instead:
{
"name": "dns-servers",
"data": "2001:db8:2::45, 2001:db8:2::100"
},
// Typically people prefer to refer to options by their names, so they
// don't need to remember the code names. However, some people like
// to use numerical values. For example, DHCPv6 can optionally use
// server unicast communication, if extra option is present. Option
// "unicast" uses option code 12, so you can reference to it either
// by "name": "unicast" or "code": 12. If you enable this option,
// you really should also tell the server to listen on that address
// (see interfaces-config/interfaces list above).
{
"code": 12,
"data": "2001:db8::1"
},
// String options that have a comma in their values need to have
// it escaped (i.e. each comma is preceded by two backslashes).
// That's because commas are reserved for separating fields in
// compound options. At the same time, we need to be conformant
// with JSON spec, that does not allow "\,". Therefore the
// slightly uncommon double backslashes notation is needed.
// Legal JSON escapes are \ followed by "\/bfnrt character
// or \u followed by 4 hexadecimal numbers (currently Kea
// supports only \u0000 to \u00ff code points).
// CSV processing translates '\\' into '\' and '\,' into ','
// only so for instance '\x' is translated into '\x'. But
// as it works on a JSON string value each of these '\'
// characters must be doubled on JSON input.
{
"name": "new-posix-timezone",
"data": "EST5EDT4\\,M3.2.0/02:00\\,M11.1.0/02:00"
},
// Options that take integer values can either be specified in
// dec or hex format. Hex format could be either plain (e.g. abcd)
// or prefixed with 0x (e.g. 0xabcd).
{
"name": "preference",
"data": "0xf0"
},
// A few options are encoded in (length, string) tuples
// which can be defined using only strings as the CSV
// processing computes lengths.
{
"name": "bootfile-param",
"data": "root=/dev/sda2, quiet, splash"
}
],
// Below an example of a simple IPv6 subnet declaration. Uncomment to enable
// it. This is a list, denoted with [ ], of structures, each denoted with
// { }. Each structure describes a single subnet and may have several
// parameters. One of those parameters is "pools" that is also a list of
// structures.
"subnet6": [
{
// This defines the whole subnet. Kea will use this information to
// determine where the clients are connected. This is the whole
// subnet in your network. This is mandatory parameter for each
// subnet.
"subnet": "2001:db8:1::/64",
// Pools define the actual part of your subnet that is governed
// by Kea. Technically this is optional parameter, but it's
// almost always needed for DHCP to do its job. If you omit it,
// clients won't be able to get addresses, unless there are
// host reservations defined for them.
"pools": [ { "pool": "2001:db8:1::/80" } ],
// Kea supports prefix delegation (PD). This mechanism delegates
// whole prefixes, instead of single addresses. You need to specify
// a prefix and then size of the delegated prefixes that it will
// be split into. This example below tells Kea to use
// 2001:db8:1::/56 prefix as pool and split it into /64 prefixes.
// This will give you 256 (2^(64-56)) prefixes.
"pd-pools": [
{
"prefix": "2001:db8:8::",
"prefix-len": 56,
"delegated-len": 64
// Kea also supports excluded prefixes. This advanced option
// is explained in Section 9.2.9. Please make sure your
// excluded prefix matches the pool it is defined in.
// "excluded-prefix": "2001:db8:8:0:80::",
// "excluded-prefix-len": 72
}
],
"option-data": [
// You can specify additional options here that are subnet
// specific. Also, you can override global options here.
{
"name": "dns-servers",
"data": "2001:db8:2::dead:beef, 2001:db8:2::cafe:babe"
}
],
// Host reservations can be defined for each subnet.
//
// Note that reservations are subnet-specific in Kea. This is
// different than ISC DHCP. Keep that in mind when migrating
// your configurations.
"reservations": [
// This is a simple host reservation. The host with DUID matching
// the specified value will get an address of 2001:db8:1::100.
{
"duid": "01:02:03:04:05:0A:0B:0C:0D:0E",
"ip-addresses": [ "2001:db8:1::100" ]
},
// This is similar to the previous one, but this time the
// reservation is done based on hardware/MAC address. The server
// will do its best to extract the hardware/MAC address from
// received packets (see 'mac-sources' directive for
// details). This particular reservation also specifies two
// extra options to be available for this client. If there are
// options with the same code specified in a global, subnet or
// class scope, the values defined at host level take
// precedence.
{
"hw-address": "00:01:02:03:04:05",
"ip-addresses": [ "2001:db8:1::101" ],
"option-data": [
{
"name": "dns-servers",
"data": "3000:1::234"
},
{
"name": "nis-servers",
"data": "3000:1::234"
}],
// This client will be automatically added to certain
// classes.
"client-classes": [ "special_snowflake", "office" ]
},
// This is a bit more advanced reservation. The client with the
// specified DUID will get a reserved address, a reserved prefix
// and a hostname. This reservation is for an address that it
// not within the dynamic pool. Finally, this reservation
// features vendor specific options for CableLabs, which happen
// to use enterprise-id 4491. Those particular values will be
// returned only to the client that has a DUID matching this
// reservation.
{
"duid": "01:02:03:04:05:06:07:08:09:0A",
"ip-addresses": [ "2001:db8:1:cafe::1" ],
"prefixes": [ "2001:db8:2:abcd::/64" ],
"hostname": "foo.example.com",
"option-data": [
{
"name": "vendor-opts",
"data": "4491"
},
{
"name": "tftp-servers",
"space": "vendor-4491",
"data": "3000:1::234"
}
]
},
// This reservation is using flexible identifier. Instead of
// relying on specific field, sysadmin can define an expression
// similar to what is used for client classification,
// e.g. substring(relay[0].option[17],0,6). Then, based on the
// value of that expression for incoming packet, the reservation
// is matched. Expression can be specified either as hex or
// plain text using single quotes.
// Note: flexible identifier requires flex_id hook library to be
// loaded to work.
{
"flex-id": "'somevalue'",
"ip-addresses": [ "2001:db8:1:cafe::2" ]
}
]
}
// More subnets can be defined here.
// {
// "subnet": "2001:db8:2::/64",
// "pools": [ { "pool": "2001:db8:2::/80" } ]
// },
// {
// "subnet": "2001:db8:3::/64",
// "pools": [ { "pool": "2001:db8:3::/80" } ]
// },
// {
// "subnet": "2001:db8:4::/64",
// "pools": [ { "pool": "2001:db8:4::/80" } ]
// }
]
// Client-clesses can be defined here. See "client-classes" in Dhcp4 for
// an example.
// Hook libraries can be defined here. See "hooks-libraries" example in
// Dhcp4.
// DDNS information (how the DHCPv6 component can reach a DDNS daemon)
# The following list defines subnets. Uncomment to enable them.
"subnet6": [
# { "subnet": "2001:db8:1::/64",
# "pools": [ { "pool": "2001:db8:1::/80" } ] },
# { "subnet": "2001:db8:2::/64",
# "pools": [ { "pool": "2001:db8:2::/80" } ] },
# { "subnet": "2001:db8:3::/64",
# "pools": [ { "pool": "2001:db8:3::/80" } ] },
# { "subnet": "2001:db8:4::/64",
# "pools": [ { "pool": "2001:db8:4::/80" } ] }
]
}, },
# DHCP DDNS configuration starts here. // DHCP DDNS configuration starts here. This is a very simple configuration
// that simply starts the DDNS daemon, but will not do anything useful.
// See Section 11 for examples and details description.
"DhcpDdns": "DhcpDdns":
{ {
"ip-address": "127.0.0.1", "ip-address": "127.0.0.1",
@@ -112,43 +734,74 @@
"reverse-ddns" : {} "reverse-ddns" : {}
}, },
# Logging configuration starts here. It tells Kea servers to store // Logging configuration starts here. Kea uses different loggers to log various
# all log messages (on severity INFO or more) in a file. // activities. For details (e.g. names of loggers), see Chapter 18.
# debuglevel variable is used on DEBUG level only.
"Logging": "Logging":
{ {
"loggers": [ "loggers": [
{ {
"name": "kea-dhcp4", // This section affects kea-dhcp4, which is the base logger for DHCPv4
"output_options": [ // component. It tells DHCPv4 server to write all log messages (on
{ // severity INFO or more) to a file.
"output": "@localstatedir@/log/kea-dhcp4.log" "name": "kea-dhcp4",
} "output_options": [
], {
"severity": "INFO", // Specifies the output file. There are several special values
"debuglevel": 0 // supported:
// - stdout (prints on standard output)
// - stderr (prints on standard error)
// - syslog (logs to syslog)
// - syslog:name (logs to syslog using specified name)
// Any other value is considered a name of a time
"output": "@localstatedir@/log/kea-dhcp4.log"
// This governs whether the log output is flushed to disk after
// every write.
// "flush": false,
// This specifies the maximum size of the file before it is
// rotated.
// "maxsize": 1048576,
// This specifies the maximum number of rotated files to keep.
// "maxver": 8
}
],
// This specifies the severity of log messages to keep. Supported values
// are: FATAL, ERROR, WARN, INFO, DEBUG
"severity": "INFO",
// If DEBUG level is specified, this value is used. 0 is least verbose,
// 99 is most verbose. Be cautious, Kea can generate lots and lots
// of logs if told to do so.
"debuglevel": 0
}, },
{ {
"name": "kea-dhcp6", // This specifies the logging for kea-dhcp6 logger, i.e. all logs
"output_options": [ // generated by Kea DHCPv6 server.
{ "name": "kea-dhcp6",
"output": "@localstatedir@/log/kea-dhcp6.log" "output_options": [
} {
], "output": "@localstatedir@/log/kea-dhcp6.log"
"severity": "INFO", }
"debuglevel": 0 ],
}, "severity": "INFO",
{ "debuglevel": 0
"name": "kea-dhcp-ddns", },
"output_options": [ {
{ // This specifies the logging for D2 (DHCP-DDNS) daemon.
"output": "@localstatedir@/log/kea-ddns.log" "name": "kea-dhcp-ddns",
} "output_options": [
], {
"severity": "INFO", "output": "@localstatedir@/log/kea-ddns.log"
"debuglevel": 0 }
} ],
"severity": "INFO",
"debuglevel": 0
}
] ]
} }
// In the future releases, also Control Agent configuration will be kept here.
// However, for the time being, it is kept in a separate file.
} }