summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorFrancis Dupont <fdupont@isc.org>2020-11-14 16:46:27 +0100
committerFrancis Dupont <fdupont@isc.org>2021-01-11 16:05:46 +0100
commitb27118b5f89dea1ddeaae42920294ffa6853d1c6 (patch)
tree9c8fb02391e6594bf6ee56a0b543c8385444eaf9 /doc
parent[#1418] Updated v6 tests and doc (diff)
downloadkea-b27118b5f89dea1ddeaae42920294ffa6853d1c6.tar.xz
kea-b27118b5f89dea1ddeaae42920294ffa6853d1c6.zip
[#1418] Addressed first comments
Diffstat (limited to 'doc')
-rw-r--r--doc/sphinx/arm/dhcp4-srv.rst23
-rw-r--r--doc/sphinx/arm/dhcp6-srv.rst19
2 files changed, 22 insertions, 20 deletions
diff --git a/doc/sphinx/arm/dhcp4-srv.rst b/doc/sphinx/arm/dhcp4-srv.rst
index a2f021a0b5..2a43fe8306 100644
--- a/doc/sphinx/arm/dhcp4-srv.rst
+++ b/doc/sphinx/arm/dhcp4-srv.rst
@@ -3998,12 +3998,12 @@ Lease Caching
-------------
Clients that attempt renewal frequently can cause the server to update
-and write the database frequently resulting in a performance impact on
-the server. The cache parameters instructs the DHCP server to avoid
+and write to the database frequently resulting in a performance impact
+on the server. The cache parameters instruct the DHCP server to avoid
updating leases too frequently thus avoiding this behavior. Instead
the server assigns the same lease (i.e. reuses it) with no
-modifications except for CLTT (Client Last Transmission Time)
-which does not require disk operations.
+modifications except for CLTT (Client Last Transmission Time) which
+does not require disk operations.
The two parameters are the ``cache-threshold`` double and the
``cache-max-age`` integer and have no default, i.e. the lease caching
@@ -4019,7 +4019,7 @@ as last resort. For example:
"pools": [ { "pool": "192.0.2.1 - 192.0.2.200" } ],
"subnet": "192.0.2.0/24",
"cache-threshold": .25,
- "cache-max-age": 600,
+ "cache-max-age": 600,
"valid-lifetime": 2000,
...
}
@@ -4040,16 +4040,17 @@ When an already assigned lease can fulfill a client query:
- if the ``cache-threshold`` is configured and is between 0. and 1.
it expresses the percentage of the lease valid lifetime which is
allowed for the lease age. Values below and including 0. and
- values greater than 1. disables the lease cache feature.
-
+ values greater than 1. disable the lease cache feature.
+
In the example a lease with a valid lifetime of 2000 seconds can be
reused if it was committed less than 500 seconds ago. With a lifetime
of 3000 seconds the maximum age of 600 seconds applies.
-In responses the ``dhcp-lease-time`` option is set to the remaining
-valid lifetime i.e. the expiration date does not change. Other options
-based on the valid lifetime e.g. ``dhcp-renewal-time`` and
-``dhcp-rebinding-time`` also use the remaining lifetime.
+In outbound client responses (e.g. DHCPACK messages) the
+``dhcp-lease-time`` option is set to the remaining valid lifetime
+i.e. the expiration date does not change. Other options based on the
+valid lifetime e.g. ``dhcp-renewal-time`` and ``dhcp-rebinding-time``
+also use the remaining lifetime.
.. _host-reservation-v4:
diff --git a/doc/sphinx/arm/dhcp6-srv.rst b/doc/sphinx/arm/dhcp6-srv.rst
index 1268a63f57..e921a8f101 100644
--- a/doc/sphinx/arm/dhcp6-srv.rst
+++ b/doc/sphinx/arm/dhcp6-srv.rst
@@ -3471,12 +3471,12 @@ Lease Caching
-------------
Clients that attempt renewal frequently can cause the server to update
-and write the database frequently resulting in a performance impact on
-the server. The cache parameters instructs the DHCP server to avoid
+and write to the database frequently resulting in a performance impact
+on the server. The cache parameters instruct the DHCP server to avoid
updating leases too frequently thus avoiding this behavior. Instead
the server assigns the same lease (i.e. reuses it) with no
-modifications except for CLTT (Client Last Transmission Time)
-which does not require disk operations.
+modifications except for CLTT (Client Last Transmission Time) which
+does not require disk operations.
The two parameters are the ``cache-threshold`` double and the
``cache-max-age`` integer and have no default, i.e. the lease caching
@@ -3492,7 +3492,7 @@ as last resort. For example:
"subnet": "2001:db8:1:1::/64",
"pools": [ { "pool": "2001:db8:1:1::1:0/112" } ],
"cache-threshold": .25,
- "cache-max-age": 600,
+ "cache-max-age": 600,
"valid-lifetime": 2000,
...
}
@@ -3513,14 +3513,15 @@ When an already assigned lease can fulfill a client query:
- if the ``cache-threshold`` is configured and is between 0. and 1.
it expresses the percentage of the lease valid lifetime which is
allowed for the lease age. Values below and including 0. and
- values greater than 1. disables the lease cache feature.
-
+ values greater than 1. disable the lease cache feature.
+
In the example a lease with a valid lifetime of 2000 seconds can be
reused if it was committed less than 500 seconds ago. With a lifetime
of 3000 seconds the maximum age of 600 seconds applies.
-In responses used preferred and valid lifetimes are the remaining
-values i.e. the expiration dates do not change.
+In outbound client responses (e.g. DHCPV6_REPLY messages) used
+preferred and valid lifetimes are the remaining values i.e. the
+expiration dates do not change.
.. _host-reservation-v6: