summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRazvan Becheriu <razvan@isc.org>2020-10-27 19:46:33 +0100
committerRazvan Becheriu <razvan@isc.org>2020-11-18 14:55:23 +0100
commitf1ad634e354e4016a177d3220f671bd5c71cb5b2 (patch)
tree9e45fb4f085aa592002f83dde9d754b7af7ade83 /doc
parent[#1405] in-subnet is equivalent to all (diff)
downloadkea-f1ad634e354e4016a177d3220f671bd5c71cb5b2.tar.xz
kea-f1ad634e354e4016a177d3220f671bd5c71cb5b2.zip
[#1405] added more tests and documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/sphinx/arm/dhcp4-srv.rst38
-rw-r--r--doc/sphinx/arm/dhcp6-srv.rst38
2 files changed, 76 insertions, 0 deletions
diff --git a/doc/sphinx/arm/dhcp4-srv.rst b/doc/sphinx/arm/dhcp4-srv.rst
index d4a6456dc6..ca7aa663b1 100644
--- a/doc/sphinx/arm/dhcp4-srv.rst
+++ b/doc/sphinx/arm/dhcp4-srv.rst
@@ -4690,6 +4690,44 @@ To activate both ``global`` and ``all``, the following combination can be used:
...
}
+ To activate both ``global`` and ``out-of-pool``, the following combination
+can be used:
+
+::
+
+ "Dhcp4": {
+
+ "reservations-global": true,
+ "reservations-in-subnet": true,
+ "reservations-out-of-pool": true,
+ ...
+ }
+
+Note that enabling ``out-of-pool`` and disabling ``in-subnet`` in not a valid
+configuration, as ``out-of-pool`` are also ``in-subnet``.
+
+::
+
+ "Dhcp4": {
+
+ "reservations-global": true,
+ // "reservations-in-subnet": false, <-config error
+ "reservations-out-of-pool": true,
+ ...
+ }
+
+
+For this reason, the ``in-subnet`` can be omitted when ``out-of-pool`` is set.
+
+::
+
+ "Dhcp4": {
+
+ "reservations-global": true,
+ "reservations-out-of-pool": true,
+ ...
+ }
+
The parameter can be specified at global, subnet, and shared-network
levels.
diff --git a/doc/sphinx/arm/dhcp6-srv.rst b/doc/sphinx/arm/dhcp6-srv.rst
index 5c277fa612..44274996cf 100644
--- a/doc/sphinx/arm/dhcp6-srv.rst
+++ b/doc/sphinx/arm/dhcp6-srv.rst
@@ -4135,6 +4135,44 @@ To activate both ``global`` and ``all``, the following combination can be used:
...
}
+ To activate both ``global`` and ``out-of-pool``, the following combination
+can be used:
+
+::
+
+ "Dhcp6": {
+
+ "reservations-global": true,
+ "reservations-in-subnet": true,
+ "reservations-out-of-pool": true,
+ ...
+ }
+
+Note that enabling ``out-of-pool`` and disabling ``in-subnet`` in not a valid
+configuration, as ``out-of-pool`` are also ``in-subnet``.
+
+::
+
+ "Dhcp6": {
+
+ "reservations-global": true,
+ // "reservations-in-subnet": false, <-config error
+ "reservations-out-of-pool": true,
+ ...
+ }
+
+
+For this reason, the ``in-subnet`` can be omitted when ``out-of-pool`` is set.
+
+::
+
+ "Dhcp4": {
+
+ "reservations-global": true,
+ "reservations-out-of-pool": true,
+ ...
+ }
+
The parameter can be specified at global, subnet, and shared-network
levels.