diff options
author | Thomas Markwalder <tmark@isc.org> | 2024-11-20 15:53:25 +0100 |
---|---|---|
committer | Thomas Markwalder <tmark@isc.org> | 2024-12-16 16:15:09 +0100 |
commit | fef0c59f45de2380da41e260721d6218a3f72960 (patch) | |
tree | e322df65d050e1d58d8db4477a21be5bd097be4b | |
parent | [#2819] kea-dhcp6 support implemented (diff) | |
download | kea-fef0c59f45de2380da41e260721d6218a3f72960.tar.xz kea-fef0c59f45de2380da41e260721d6218a3f72960.zip |
[#2819] Updated ARM
modified: doc/sphinx/arm/dhcp4-srv.rst
modified: doc/sphinx/arm/dhcp6-srv.rst
-rw-r--r-- | doc/sphinx/arm/dhcp4-srv.rst | 34 | ||||
-rw-r--r-- | doc/sphinx/arm/dhcp6-srv.rst | 37 |
2 files changed, 55 insertions, 16 deletions
diff --git a/doc/sphinx/arm/dhcp4-srv.rst b/doc/sphinx/arm/dhcp4-srv.rst index 3a7788544b..bddc73566b 100644 --- a/doc/sphinx/arm/dhcp4-srv.rst +++ b/doc/sphinx/arm/dhcp4-srv.rst @@ -3588,7 +3588,10 @@ DDNS-related parameters are split into two groups: - ``ddns-qualifying-suffix`` - ``ddns-update-on-renew`` - ``ddns-conflict-resolution-mode`` + - ``ddns-ttl`` - ``ddns-ttl-percent`` + - ``ddns-ttl-min`` + - ``ddns-ttl-max`` - ``hostname-char-set`` - ``hostname-char-replacement`` @@ -3739,16 +3742,33 @@ offers four modes of conflict resolution-related behavior: to generate DNS removal requests to D2. The DNS entries Kea creates contain a value for TTL (time to live). -The :iscman:`kea-dhcp4` server calculates that value based on +By default, the :iscman:`kea-dhcp4` server calculates that value based on `RFC 4702, Section 5 <https://tools.ietf.org/html/rfc4702#section-5>`__, which suggests that the TTL value be 1/3 of the lease's lifetime, with -a minimum value of 10 minutes. +a minimum value of 10 minutes. There are four optional parameters which +may be used to influence the TTL calculation: -The parameter ``ddns-ttl-percent``, when specified, -causes the TTL to be calculated as a simple percentage of the lease's -lifetime, using the parameter's value as the percentage. It is specified -as a decimal percent (e.g. .25, .75, 1.00) and may be specified at the -global, shared-network, and subnet levels. By default it is unspecified. + + - ``ddns-ttl`` - If specified and greater than 0 use it as the value of TTL + unconditionally. It is specified in seconds. By default it is unspecified. + + - ``ddns-ttl-percent`` - If specified and greater than zero use it as the + percentage of the lease life time otherwise use 1/3 (per RFC 4702) of the + lease life time. It is specified as a decimal percentage (e.g. 0.75, 0.50) + and is unspecified by default. + + - ``ddns-ttl-min`` - If specified and greater than 0 use it the minimum + otherwise use a minimum of 600 seconds (per RFC 4702). If the calculated TTL + is less than the minimum return the minimum. It is specified in seconds. By + default it is unspecified. + + - ``ddns-ttl-max`` - If specified and greater than zero limit the calculated TTL + to its value. It is specified in seconds. By default it is unspecified. + +.. note:: + + A value of zero for any of the TTL parameters can be used to suppress (i.e. "unspecify") + the value of that parameter inherited from a higher scope. .. _dhcpv4-d2-io-config: diff --git a/doc/sphinx/arm/dhcp6-srv.rst b/doc/sphinx/arm/dhcp6-srv.rst index 53b390d018..abf91d2983 100644 --- a/doc/sphinx/arm/dhcp6-srv.rst +++ b/doc/sphinx/arm/dhcp6-srv.rst @@ -3286,7 +3286,10 @@ DDNS-related parameters are split into two groups: - ``ddns-qualifying-suffix`` - ``ddns-update-on-renew`` - ``ddns-conflict-resolution-mode`` + - ``ddns-ttl`` - ``ddns-ttl-percent`` + - ``ddns-ttl-min`` + - ``ddns-ttl-max`` - ``hostname-char-set`` - ``hostname-char-replacement`` @@ -3437,16 +3440,32 @@ offers four modes of conflict resolution-related behavior: to generate DNS removal requests to D2. The DNS entries Kea creates contain a value for TTL (time to live). -The :iscman:`kea-dhcp6` server calculates that value based on +By default, the :iscman:`kea-dhcp4` server calculates that value based on `RFC 4702, Section 5 <https://tools.ietf.org/html/rfc4702#section-5>`__, -which suggests that the TTL value be 1/3 of the lease's lifetime, with -a minimum value of 10 minutes. - -The parameter ``ddns-ttl-percent``, when specified, -causes the TTL to be calculated as a simple percentage of the lease's -lifetime, using the parameter's value as the percentage. It is specified -as a decimal percent (e.g. .25, .75, 1.00) and may be specified at the -global, shared-network, and subnet levels. By default it is unspecified. +which suggests that the TTL value be 1/3 of the lease's life time, with +a minimum value of 10 minutes. There are four optional parameters which +may be used to influence the TTL calculation: + + - ``ddns-ttl`` - If specified and greater than 0 use it as the value of TTL + unconditionally. It is specified in seconds. By default it is unspecified. + + - ``ddns-ttl-percent`` - If specified and greater than zero use it as the + percentage of the lease life time otherwise use 1/3 (per RFC 4702) of the + lease life time. It is specified as a decimal percentage (e.g. 0.75, 0.50) + and is unspecified by default. + + - ``ddns-ttl-min`` - If specified and greater than 0 use it the minimum + otherwise use a minimum of 600 seconds (per RFC 4702). If the calculated TTL + is less than the minimum return the minimum. It is specified in seconds. By + default it is unspecified. + + - ``ddns-ttl-max`` - If specified and greater than zero limit the calculated TTL + to its value. It is specified in seconds. By default it is unspecified. + +.. note:: + + A value of zero for any of the TTL parameters can be used to suppress (i.e. "unspecify") + the value of that parameter inherited from a higher scope. .. _dhcpv6-d2-io-config: |