]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#1790] added parameters to ARM
authorRazvan Becheriu <razvan@isc.org>
Thu, 25 Jan 2024 23:22:46 +0000 (01:22 +0200)
committerRazvan Becheriu <razvan@isc.org>
Fri, 26 Jan 2024 12:19:54 +0000 (14:19 +0200)
doc/sphinx/arm/dhcp4-srv.rst
doc/sphinx/arm/dhcp6-srv.rst

index fd2fdb1b57791c4848bc417294070fb122f5d560..0ccf62308c8711cacba6e4b787eaba70df664a66 100644 (file)
@@ -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
index a2f0fbc03871035603881c074a2ed7142a8f3d7c..cdd3442474913019be3301694194f73b9698c9b0 100644 (file)
@@ -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