From: Thomas Markwalder <tmark@isc.org>
Date: Tue, 23 May 2023 13:47:47 +0000 (-0400)
Subject: [#2757] Revamped ARM on new command
X-Git-Tag: Kea-2.3.8~98
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=80a289f949d67b3116cf63a93d69173b37bfdfc5;p=thirdparty%2Fkea.git

[#2757] Revamped ARM on new command

modified:
    doc/sphinx/arm/hooks-lease-query.rst
---

diff --git a/doc/sphinx/arm/hooks-lease-query.rst b/doc/sphinx/arm/hooks-lease-query.rst
index 1de6d3168d..3e37dea3c1 100644
--- a/doc/sphinx/arm/hooks-lease-query.rst
+++ b/doc/sphinx/arm/hooks-lease-query.rst
@@ -446,15 +446,56 @@ defined in RFC 6607.
 
    The new query types are only supported with the memfile lease backend.
 
+.. _updating-existing-leases:
+
+Updating existing leases in SQL lease backends
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Bulk Lease Query required additions to the lease data stored. With SQL lease
+backends, leases created prior to the server being configured for Bulk Lease
+Query will not contain the new data required. In order to populate this data
+it is necessary to run an API command:
+
 .. _command-extended-info4-upgrade:
 
-The ``extended-info4-upgrade`` Command
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+For DHCPv4 lease data, the command is:
+
+::
+
+    {
+        "command": "extended-info4-upgrade"
+    }
+
+For DHCPv6 lease data, the command is (TO BE IMPLEMENTED):
+
+::
+
+    {
+        "command": "extended-info6-upgrade"
+    }
+
+
+In either case the response will indicate whether it succeeded or failed
+and include either the count of leases updated or the nature of the failure:
+
+::
+
+    {
+        "result": 0,
+        "text": "Upgraded 1000 leases"
+    }
+
+
+The command's operation is governed by ``extended-info-checks`` parameter
+under the sanity-checks element. Please see :ref:`sanity-checks4` or
+:ref:`sanity-checks6`.
+
+For large numbers of leases this command may take some time to complete.
+
+.. note::
 
-With SQL lease database backends the relay and remote IDs are in new columns
-so to make old leases (old means from an older Kea version) visible to
-the hook library the lease database must be upgraded. This is the function
-of the ``extended-info4-upgrade`` command.
+   Existing leases must have been created by Kea with ``store-extended-info``
+   enabled in order for the new data to be extracted and stored.
 
 .. _bulk-lease-query-dhcpv6: