From: Francis Dupont <fdupont@isc.org>
Date: Wed, 31 May 2023 19:52:39 +0000 (+0200)
Subject: [#2869] Updated doc
X-Git-Tag: Kea-2.5.0~26
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3e5ec6cb7a20e441baf7e0152155f125185c3d2d;p=thirdparty%2Fkea.git

[#2869] Updated doc
---

diff --git a/doc/sphinx/api-files.txt b/doc/sphinx/api-files.txt
index 537292b86b..e0019f13ef 100644
--- a/doc/sphinx/api-files.txt
+++ b/doc/sphinx/api-files.txt
@@ -23,6 +23,7 @@ src/share/api/config-write.json
 src/share/api/dhcp-disable.json
 src/share/api/dhcp-enable.json
 src/share/api/extended-info4-upgrade.json
+src/share/api/extended-info6-upgrade.json
 src/share/api/gss-tsig-get-all.json
 src/share/api/gss-tsig-get.json
 src/share/api/gss-tsig-key-del.json
diff --git a/doc/sphinx/arm/hooks-lease-query.rst b/doc/sphinx/arm/hooks-lease-query.rst
index 56f9742a47..046001f8ff 100644
--- a/doc/sphinx/arm/hooks-lease-query.rst
+++ b/doc/sphinx/arm/hooks-lease-query.rst
@@ -630,8 +630,7 @@ For DHCPv6 lease data, the command is:
 .. isccmd:: extended-info6-upgrade
 .. _command-extended-info6-upgrade:
 
-for extended info used for by relay id and by remote id the command is
-(TO BE IMPLEMENTED):
+for extended info used for by relay id and by remote id the command is:
 
 ::
 
@@ -651,6 +650,17 @@ and include either the count of leases updated or the nature of the failure:
     }
 
 
+This ``extended-info6-upgrade`` command must be called when:
+
+- the database schema was upgraded from a previous version
+
+- Bulk Lease Query was not enabled (tables are maintained only when v6 BLQ is
+  enabled)
+
+- data in tables do not seem to be consistent (tables are not maintained in
+  an atomic way so consistency is not guaranteed. For instance when a database
+  is shared between several servers races can happen between updates)
+
 The operation of extended info command is governed by ``extended-info-checks``
 parameter under the sanity-checks element. Please see :ref:`sanity-checks4`
 or :ref:`sanity-checks6`.
diff --git a/src/share/api/api_files.mk b/src/share/api/api_files.mk
index bb3f761abc..01faab16a8 100644
--- a/src/share/api/api_files.mk
+++ b/src/share/api/api_files.mk
@@ -23,6 +23,7 @@ api_files += $(top_srcdir)/src/share/api/config-write.json
 api_files += $(top_srcdir)/src/share/api/dhcp-disable.json
 api_files += $(top_srcdir)/src/share/api/dhcp-enable.json
 api_files += $(top_srcdir)/src/share/api/extended-info4-upgrade.json
+api_files += $(top_srcdir)/src/share/api/extended-info6-upgrade.json
 api_files += $(top_srcdir)/src/share/api/gss-tsig-get-all.json
 api_files += $(top_srcdir)/src/share/api/gss-tsig-get.json
 api_files += $(top_srcdir)/src/share/api/gss-tsig-key-del.json
diff --git a/src/share/api/extended-info4-upgrade.json b/src/share/api/extended-info4-upgrade.json
index 4205628a6d..1b926b43c4 100644
--- a/src/share/api/extended-info4-upgrade.json
+++ b/src/share/api/extended-info4-upgrade.json
@@ -21,7 +21,7 @@
         "  \"arguments\": {",
         "  },",
         "  \"result\": 0,",
-        "  \"text\": \"to be done\"",
+        "  \"text\": \"Upgraded 1000 leases\"",
         "}"
     ],
     "support": [
diff --git a/src/share/api/extended-info6-upgrade.json b/src/share/api/extended-info6-upgrade.json
new file mode 100644
index 0000000000..907b1bfb9d
--- /dev/null
+++ b/src/share/api/extended-info6-upgrade.json
@@ -0,0 +1,30 @@
+{
+    "access": "write",
+    "avail": "2.3.9",
+    "brief": [
+        "This command sanitizes extended info of all IPv6 leases and rebuilds when they are enabled relay and remote ID tables in the SQL lease database."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"extended-info6-upgrade\"",
+        "    }",
+        "}"
+    ],
+    "description": "See <xref linkend=\"command-extended-info6-upgrade\"/>",
+    "hook": "lease_query",
+    "name": "extended-info6-upgrade",
+    "resp-comment": [
+        "This command should be used when some old IPv6 leases are present in the lease database using a SQL backend to make them visible to the ."
+    ],
+    "resp-syntax": [
+        "{",
+        "  \"arguments\": {",
+        "  },",
+        "  \"result\": 0,",
+        "  \"text\": \"Upgraded 1000 leases\"",
+        "}"
+    ],
+    "support": [
+        "kea-dhcp6"
+    ]
+}