From: Andrei Pavel <andrei@isc.org>
Date: Fri, 25 Nov 2022 09:33:21 +0000 (+0200)
Subject: [#2472] update flex-id ignore-iaid documentation
X-Git-Tag: Kea-2.3.3~35
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=e61f66efe42b71f6cd218636747219ffbf478052;p=thirdparty%2Fkea.git

[#2472] update flex-id ignore-iaid documentation
---

diff --git a/doc/sphinx/arm/hooks-flex-id.rst b/doc/sphinx/arm/hooks-flex-id.rst
index ca407e8ac0..664d9c1729 100644
--- a/doc/sphinx/arm/hooks-flex-id.rst
+++ b/doc/sphinx/arm/hooks-flex-id.rst
@@ -131,6 +131,9 @@ for non-printable characters and do not require the use of the
        ]
    }
 
+The ``replace-client-id`` Flag
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 When ``replace-client-id`` is set to ``false`` (which is the default setting),
 the ``flex-id`` hook library uses the evaluated flexible identifier solely for
 identifying host reservations, i.e. searching for reservations within a
@@ -225,18 +228,28 @@ In DHCPv6, the corresponding query looks something like this:
        }
    }
 
+The ``ignore-iaid`` Flag
+~~~~~~~~~~~~~~~~~~~~~~~~
+
 When ``ignore-iaid`` is set to ``true`` (default value is ``false``), the
 ``flex-id`` hooks library will make the Kea DHCPv6 server ignore IAID value
 from incoming IPv6 packets. This parameter is ignored by the Kea DHCPv4 server.
 
+If the packet contains only one IA_NA, the IAID value will be changed to ``0``
+and stored as such in the lease storage. Similarly if the packet contains only
+one IA_PD, the IAID value will be changed to ``0`` and stored as such in the
+lease storage. The IAID is restored to its intitial value in the response back
+to the client. The change is visible in the identifier expression if the IAID is
+part of the expression.
+
 .. note::
 
+   To avoid lease conflicts, if the incoming packet contains more than one
+   IA_NA, the IAID value will not be changed on any of the IA_NAs. Similarly,
+   if the incoming packet contains more than one IA_PD, the IAID value will not
+   be changed on any of the IA_PDs.
+
+.. warning::
+
    This functionality breaks RFC compliance and should be enabled only if
    required. When enabled, a warning message is issued at configure time.
-   If the incoming packet contains more than one IANA, the IAID value will not
-   be changed on any of the IANAs. Similarly if the incoming packet contains
-   more than one IAPD, the IAID value will not be changed on any of the IAPDs.
-   If the packet contains only one IANA the IAID value will be changed to 0 and
-   stored as such in the lease storage. Similarly if the packet contains only
-   one IAPD the IAID value will be changed to 0 and stored as such in the lease
-   storage.