From: Tomek Mrugalski Date: Tue, 5 Jul 2016 12:27:25 +0000 (+0200) Subject: [4518] Changes after review: X-Git-Tag: trac4551_base~31^2~2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=cba07cb92b7e84c3d8ca69f19c65a0ef03d447c5;p=thirdparty%2Fkea.git [4518] Changes after review: - added vendor options example and made it out-of-pool in kea6/reservations.json - fixed couple indents in dhcp{4,6}-srv.xml - added enclosing subnet4 where it was missing in examples - renamed section dedicated to option reservations - default value of host-reservation-identifiers presented differently --- diff --git a/doc/examples/kea6/reservations.json b/doc/examples/kea6/reservations.json index 9f568fa666..79bf115575 100644 --- a/doc/examples/kea6/reservations.json +++ b/doc/examples/kea6/reservations.json @@ -84,11 +84,25 @@ }, # 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::102" ], + "ip-addresses": [ "2001:db8:1:cafe::1" ], "prefixes": [ "2001:db8:2:abcd::/64" ], - "hostname": "foo.example.com" + "hostname": "foo.example.com", + "option-data": [ { + "name": "vendor-opts", + "data": "4491" + }, + { + "name": "tftp-servers", + "space": "vendor-4491", + "data": "3000:1::234" + } ] + } ] } diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml index 3eddc4fec0..81a36533aa 100644 --- a/doc/guide/dhcp4-srv.xml +++ b/doc/guide/dhcp4-srv.xml @@ -10,13 +10,11 @@
Starting and Stopping the DHCPv4 Server - - - It is recommended that the Kea DHCPv4 server be started and stopped - using keactrl (described in ). - However, it is also possible to run the server directly: it accepts - the following command-line switches: + It is recommended that the Kea DHCPv4 server be started and stopped + using keactrl (described in ). + However, it is also possible to run the server directly: it accepts + the following command-line switches: @@ -64,25 +62,25 @@ - The -V command returns the versions of the - external libraries dynamically linked. + The -V command returns the versions of the + external libraries dynamically linked. - The -W command describes the environment used - to build Kea. This command displays a copy of the - config.report file produced by - ./configure that is embedded in the - executable binary. + The -W command describes the environment used + to build Kea. This command displays a copy of the + config.report file produced by + ./configure that is embedded in the + executable binary. - The config.report may also be accessed more - directly. The following command may be used to extract this - information. The binary path may be found - in the install directory or in the .libs - subdirectory in the source tree. For example - kea/src/bin/dhcp4/.libs/kea-dhcp4. + The config.report may also be accessed more + directly. The following command may be used to extract this + information. The binary path may be found + in the install directory or in the .libs + subdirectory in the source tree. For example + kea/src/bin/dhcp4/.libs/kea-dhcp4. strings path/kea-dhcp4 | sed -n 's/;;;; //p' @@ -90,9 +88,9 @@ strings path/kea-dhcp4 | sed -n 's/;;;; //p' - When running in a console, the server can be shut down by - pressing ctrl-c. It detects the key combination and shuts - down gracefully. + When running in a console, the server can be shut down by + pressing ctrl-c. It detects the key combination and shuts + down gracefully. @@ -2493,7 +2491,7 @@ It is merely echoed by the server 192.0.2.204 for a client that uses a client identifier with value 01:11:22:33:44:55:66. - Note that the above example is used for ilustrational purposes only + The above example is used for ilustrational purposes only and in actual deployments it is recommended to use as few types as possible (preferably just one). See for detailed discussion. @@ -2675,7 +2673,7 @@ It is merely echoed by the server
- Reserving specific options + Including specific DHCPv4 options in reservations Kea 1.1.0 introduced the ability to specify options on a per host basis. The options follow the same rules as any other options. These can be standard options (see -"reservations": [ { - "hw-address": "aa:bb:cc:dd:ee:ff", - "ip-address": "192.0.2.1", - "option-data": [ - { - "name": "cookie-servers", - "data": "10.1.1.202,10.1.1.203" - }, - { - "name": "log-servers", - "data": "10.1.1.200,10.1.1.201" - } ] -} ] + "subnet4": [ { + "reservations": [ + { + "hw-address": "aa:bb:cc:dd:ee:ff", + "ip-address": "192.0.2.1", + "option-data": [ + { + "name": "cookie-servers", + "data": "10.1.1.202,10.1.1.203" + }, + { + "name": "log-servers", + "data": "10.1.1.200,10.1.1.201" + } ] + } ] + } ] +} Vendor specific options can be reserved in a similar manner: @@ -2852,10 +2854,17 @@ It is merely echoed by the server ] -If not specified, the default value is: hw-address, duid, -circuit-id. + + +
diff --git a/doc/guide/dhcp6-srv.xml b/doc/guide/dhcp6-srv.xml index 975c807c86..6cdee0b6bf 100644 --- a/doc/guide/dhcp6-srv.xml +++ b/doc/guide/dhcp6-srv.xml @@ -11,10 +11,10 @@ Starting and Stopping the DHCPv6 Server - It is recommended that the Kea DHCPv6 server be started and stopped - using keactrl (described in ). - However, it is also possible to run the server directly: it accepts - the following command-line switches: + It is recommended that the Kea DHCPv6 server be started and stopped + using keactrl (described in ). + However, it is also possible to run the server directly: it accepts + the following command-line switches: @@ -62,25 +62,25 @@ - The -V command returns the versions of the - external libraries dynamically linked. + The -V command returns the versions of the + external libraries dynamically linked. - The -W command describes the environment used - to build Kea. This command displays a copy of the - config.report file produced by - ./configure that is embedded in the - executable binary. + The -W command describes the environment used + to build Kea. This command displays a copy of the + config.report file produced by + ./configure that is embedded in the + executable binary. - The config.report may also be accessed more - directly. The following command may be used to extract this - information. The binary path may be found - in the install directory or in the .libs - subdirectory in the source tree. For example - kea/src/bin/dhcp6/.libs/kea-dhcp6. + The config.report may also be accessed more + directly. The following command may be used to extract this + information. The binary path may be found + in the install directory or in the .libs + subdirectory in the source tree. For example + kea/src/bin/dhcp6/.libs/kea-dhcp6. strings path/kea-dhcp6 | sed -n 's/;;;; //p' @@ -88,9 +88,9 @@ strings path/kea-dhcp6 | sed -n 's/;;;; //p' - When running in a console, the server can be shut down by - pressing ctrl-c. It detects the key combination and shuts - down gracefully. + When running in a console, the server can be shut down by + pressing ctrl-c. It detects the key combination and shuts + down gracefully. @@ -2404,7 +2404,7 @@ should include options from the isc option space:
- Reserving specific options + Including specific DHCPv6 options in reservations Kea 1.1.0 introduced the ability to specify options on a per host basis. The options follow the same rules as any other @@ -2583,7 +2583,11 @@ should include options from the isc option space: - If not specified, the default value is: hw-address,duid. + If not specified, the default value is: + +"host-reservation-identifiers": [ "hw-address", "duid" ] + +