// This is an example configuration file for the DHCPv4 server in Kea.
-// It contains one subnet and two global reservations for the clients
-// identified by the MAC addresses.
+// It demonstrates how global host reservations can be configured.
+// The global reservations are not associated with any subnet. They
+// are assigned regardless of the subnet to which the DHCP client belongs.
+// Global reservations are assigned to the DHCP clients using the
+// same host identifier types as subnet specific reservations. This file
+// contains multiple examples of host reservations using different
+// identifier types, e.g. MAC address, client identifier etc.
{ "Dhcp4":
{
"interfaces": [ "ethX" ]
},
-// We need to specify the the database used to store leases. As of September
+// We need to specify the database used to store leases. As of September
// 2016, four database backends are supported: MySQL, PostgreSQL, Cassandra, and
// the in-memory database, Memfile. We'll use memfile because it doesn't
// require any prior set up.
// The example below is not optimal from a performance perspective, but it
// nicely showcases the host reservation capabilities. Please use the minimum
// set of identifier types used in your network.
-"host-reservation-identifiers": [ "circuit-id", "hw-address", "duid",
- "client-id", "flex-id" ],
+ "host-reservation-identifiers": [ "circuit-id", "hw-address", "duid",
+ "client-id", "flex-id" ],
-// This directive tells Kea that reservations are global.
-"reservation-mode": "global",
+// This directive tells Kea that reservations are global. Note that this
+// can also be specified at shared network and/or subnet level.
+ "reservation-mode": "global",
-// Define some reservations at the global scope.
-"reservations": [
+// Define several global host reservations.
+ "reservations": [
// This is a reservation for a specific hardware/MAC address. It's a very
// simple reservation: just an address and nothing else.
// the global scope: as it breaks the link between the reservation and
// the subnet it can lead to a client localized in another subnet than
// its address belongs to.
- {
- "hw-address": "1a:1b:1c:1d:1e:1f",
- "ip-address": "192.0.2.201"
- },
+ {
+ "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. Either a hostname or
// an address is required.
- {
- "client-id": "01:11:22:33:44:55:66",
- "hostname": "special-snowflake"
- },
+ {
+ "client-id": "01:11:22:33:44:55:66",
+ "hostname": "special-snowflake"
+ },
// The third reservation is based on DUID. This reservation also
// defines 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"
- } ]
- },
+// subnet or class level, the host specific values take precedence for
+// this particular DHCP client.
+ {
+ "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.
- {
- "circuit-id": "01:11:22:33:44:55:66",
- "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"
- }
- ]
- },
+ {
+ "circuit-id": "01:11:22:33:44:55:66",
+ "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"
- },
+ {
+ "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
// quotes.
// Note: flexible identifier requires flex_id hook library to be
// loaded to work.
- {
- "flex-id": "s0mEVaLue",
- "ip-address": "192.0.2.206"
- }
-],
+ {
+ "flex-id": "s0mEVaLue",
+ "ip-address": "192.0.2.206"
+ }
+ ],
+
// Define a subnet.
"subnet4": [
{
-// This is an example configuration file for DHCPv6 server in Kea
-// that showcases how to do globalhost reservations. It is
-// assumed that one subnet (2001:db8:1::/64) is available directly
-// over ethX interface.
-
+// This is an example configuration file for the DHCPv6 server in Kea.
+// It demonstrates how global host reservations can be configured.
+// The global reservations are not associated with any subnet. They
+// are assigned regardless of the subnet to which the DHCP client belongs.
+// Global reservations are assigned to the DHCP clients using the
+// same host identifier types as subnet specific reservations. This file
+// contains multiple examples of host reservations using different
+// identifier types, e.g. DUID, MAC address etc.
{ "Dhcp6":
{
"interfaces": [ "ethX" ]
},
-// We need to specify the the database used to store leases. As of
+// We need to specify the database used to store leases. As of
// September 2016, four database backends are supported: MySQL,
// PostgreSQL, Cassandra, and the in-memory database, Memfile.
// We'll use memfile because it doesn't require any prior set up.
// given network.
"host-reservation-identifiers": [ "duid", "hw-address", "flex-id" ],
-// This directive tells Kea that reservations are global.
+// This directive tells Kea that reservations are global. Note that this
+// can also be specified at shared network and/or subnet level.
"reservation-mode": "global",
-// Host reservations. Define several reservations.
+// Define several global host reservations.
"reservations": [
// This is a simple host reservation. The host with DUID matching
// the global scope: as it breaks the link between the reservation and
// the subnet it can lead to a client localized in another subnet than
// its address belongs to.
- {
- "duid": "01:02:03:04:05:0A:0B:0C:0D:0E",
- "ip-addresses": [ "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
// '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"
- }],
- "client-classes": [ "special_snowflake", "office" ]
- },
+// class scope, the values defined at host level take precedence for
+// this particular DHCP client.
+ {
+ "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"
+ }
+ ],
+ "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.
// 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"
- } ]
- },
+ {
+ "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
// 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" ]
- }
- ],
+// loaded to work.
+ {
+ "flex-id": "'somevalue'",
+ "ip-addresses": [ "2001:db8:1:cafe::2" ]
+ }
+ ],
// The following list defines subnets. Subnet, pools and interface definitions
// are the same as in the regular scenario.
- "subnet6": [
- {
- "subnet": "2001:db8::/47",
+ "subnet6": [
+ {
+ "subnet": "2001:db8::/47",
- "pools": [ { "pool": "2001:db8::/64" } ],
+ "pools": [ { "pool": "2001:db8::/64" } ],
- "pd-pools": [
- {
- "prefix": "2001:db8:1:8000::",
- "prefix-len": 56,
- "delegated-len": 64
- }
- ],
- "interface": "ethX"
- }
- ]
+ "pd-pools": [
+ {
+ "prefix": "2001:db8:1:8000::",
+ "prefix-len": 56,
+ "delegated-len": 64
+ }
+ ],
+ "interface": "ethX"
+ }
+ ]
},
// The following configures logging. It assumes that messages with at
projects / thirdparty / kea.git / commitdiff
