summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRazvan Becheriu <razvan@isc.org>2024-01-26 00:22:46 +0100
committerRazvan Becheriu <razvan@isc.org>2024-01-26 13:19:54 +0100
commit063be34a9dfb060c62929e045aa5565c154258e5 (patch)
tree471637b62cff1569d0e0252b7d831b349aa8fc74 /doc
parent[#1790] addressed review comments (diff)
downloadkea-063be34a9dfb060c62929e045aa5565c154258e5.tar.xz
kea-063be34a9dfb060c62929e045aa5565c154258e5.zip
[#1790] added parameters to ARM
Diffstat (limited to 'doc')
-rw-r--r--doc/sphinx/arm/dhcp4-srv.rst78
-rw-r--r--doc/sphinx/arm/dhcp6-srv.rst80
2 files changed, 158 insertions, 0 deletions
diff --git a/doc/sphinx/arm/dhcp4-srv.rst b/doc/sphinx/arm/dhcp4-srv.rst
index fd2fdb1b57..0ccf62308c 100644
--- a/doc/sphinx/arm/dhcp4-srv.rst
+++ b/doc/sphinx/arm/dhcp4-srv.rst
@@ -7924,6 +7924,84 @@ at which it is currently supported.
at the particular level of the hierarchy or that the
server does not support the parameter at that level.
+Some scalar parameters contained by top level global maps are supported by the Configuration Backend.
+
+.. table:: List of DHCPv4 map parameters supported by the Configuration Backend
+
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | Parameter name (flat naming format) | Global map | Parameter name |
+ +==================================================================+==============================+==================================+
+ | compatibility.ignore-dhcp-server-identifier | compatibility | ignore-dhcp-server-identifier |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | compatibility.ignore-rai-link-selection | compatibility | ignore-rai-link-selection |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | compatibility.lenient-option-parsing | compatibility | lenient-option-parsing |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | compatibility.exclude-first-last-24 | compatibility | exclude-first-last-24 |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | control-socket.socket-name | control-socket | socket-name |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | control-socket.socket-type | control-socket | socket-type |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.enable-updates | dhcp-ddns | enable-updates |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.max-queue-size | dhcp-ddns | max-queue-size |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.ncr-format | dhcp-ddns | ncr-format |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.ncr-protocol | dhcp-ddns | ncr-protocol |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.sender-ip | dhcp-ddns | sender-ip |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.sender-port | dhcp-ddns | sender-port |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.server-ip | dhcp-ddns | server-ip |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.server-port | dhcp-ddns | server-port |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.generated-prefix | dhcp-ddns | generated-prefix |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.hostname-char-replacement | dhcp-ddns | hostname-char-replacement |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.hostname-char-set | dhcp-ddns | hostname-char-set |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.override-client-update | dhcp-ddns | override-client-update |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.override-no-update | dhcp-ddns | override-no-update |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.qualifying-suffix | dhcp-ddns | qualifying-suffix |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.replace-client-name | dhcp-ddns | replace-client-name |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | expired-leases-processing.flush-reclaimed-timer-wait-time | expired-leases-processing | flush-reclaimed-timer-wait-time |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | expired-leases-processing.hold-reclaimed-time | expired-leases-processing | hold-reclaimed-time |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | expired-leases-processing.max-reclaim-leases | expired-leases-processing | max-reclaim-leases |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | expired-leases-processing.max-reclaim-time | expired-leases-processing | max-reclaim-time |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | expired-leases-processing.reclaim-timer-wait-time | expired-leases-processing | reclaim-timer-wait-time |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | expired-leases-processing.unwarned-reclaim-cycles | expired-leases-processing | unwarned-reclaim-cycles |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | multi-threading.enable-multi-threading | multi-threading | enable-multi-threading |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | multi-threading.thread-pool-size | multi-threading | thread-pool-size |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | multi-threading.packet-queue-size | multi-threading | packet-queue-size |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | sanity-checks.lease-checks | sanity-checks | lease-checks |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | sanity-checks.extended-info-checks | sanity-checks | extended-info-checks |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-queue-control.enable-queue | dhcp-queue-control | enable-queue |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-queue-control.queue-type | dhcp-queue-control | queue-type |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-queue-control.capacity | dhcp-queue-control | capacity |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+
.. _dhcp4-cb-json:
Enabling the Configuration Backend
diff --git a/doc/sphinx/arm/dhcp6-srv.rst b/doc/sphinx/arm/dhcp6-srv.rst
index a2f0fbc038..cdd3442474 100644
--- a/doc/sphinx/arm/dhcp6-srv.rst
+++ b/doc/sphinx/arm/dhcp6-srv.rst
@@ -7669,6 +7669,86 @@ at which it is currently supported.
at the particular level of the hierarchy or that the
server does not support the parameter at that level.
+Some scalar parameters contained by top level global maps are supported by the Configuration Backend.
+
+.. table:: List of DHCPv6 map parameters supported by the Configuration Backend
+
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | Parameter name (flat naming format) | Global map | Parameter name |
+ +==================================================================+==============================+==================================+
+ | compatibility.lenient-option-parsing | compatibility | lenient-option-parsing |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | control-socket.socket-name | control-socket | socket-name |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | control-socket.socket-type | control-socket | socket-type |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.enable-updates | dhcp-ddns | enable-updates |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.max-queue-size | dhcp-ddns | max-queue-size |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.ncr-format | dhcp-ddns | ncr-format |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.ncr-protocol | dhcp-ddns | ncr-protocol |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.sender-ip | dhcp-ddns | sender-ip |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.sender-port | dhcp-ddns | sender-port |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.server-ip | dhcp-ddns | server-ip |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.server-port | dhcp-ddns | server-port |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.generated-prefix | dhcp-ddns | generated-prefix |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.hostname-char-replacement | dhcp-ddns | hostname-char-replacement |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.hostname-char-set | dhcp-ddns | hostname-char-set |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.override-client-update | dhcp-ddns | override-client-update |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.override-no-update | dhcp-ddns | override-no-update |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.qualifying-suffix | dhcp-ddns | qualifying-suffix |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-ddns.replace-client-name | dhcp-ddns | replace-client-name |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | expired-leases-processing.flush-reclaimed-timer-wait-time | expired-leases-processing | flush-reclaimed-timer-wait-time |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | expired-leases-processing.hold-reclaimed-time | expired-leases-processing | hold-reclaimed-time |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | expired-leases-processing.max-reclaim-leases | expired-leases-processing | max-reclaim-leases |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | expired-leases-processing.max-reclaim-time | expired-leases-processing | max-reclaim-time |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | expired-leases-processing.reclaim-timer-wait-time | expired-leases-processing | reclaim-timer-wait-time |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | expired-leases-processing.unwarned-reclaim-cycles | expired-leases-processing | unwarned-reclaim-cycles |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | multi-threading.enable-multi-threading | multi-threading | enable-multi-threading |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | multi-threading.thread-pool-size | multi-threading | thread-pool-size |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | multi-threading.packet-queue-size | multi-threading | packet-queue-size |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | sanity-checks.lease-checks | sanity-checks | lease-checks |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | sanity-checks.extended-info-checks | sanity-checks | extended-info-checks |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | server-id.type | server-id | type |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | server-id.enterprise-id | server-id | enterprise-id |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | server-id.identifier | server-id | identifier |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | server-id.persist | server-id | persist |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-queue-control.enable-queue | dhcp-queue-control | enable-queue |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-queue-control.queue-type | dhcp-queue-control | queue-type |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+ | dhcp-queue-control.capacity | dhcp-queue-control | capacity |
+ +------------------------------------------------------------------+------------------------------+----------------------------------+
+
.. _dhcp6-cb-json:
Enabling the Configuration Backend