[#2757] Updated doc part

diff --git a/doc/sphinx/api-files.txt b/doc/sphinx/api-files.txt
index 8d903e8c6f6431fc9a7992c2e0993eafdce50e89..b4b602e3b4793257def9168ed6acf44863e8662c 100644 (file)
--- a/doc/sphinx/api-files.txt
+++ b/doc/sphinx/api-files.txt
@@ -21,6 +21,7 @@ src/share/api/config-test.json
 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/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 75b13e37376e0f4ea52af16e8ff64f4c49e25763..1de6d3168d539d1674d6eaf2eb03fd64030d541f 100644 (file)
--- a/doc/sphinx/arm/hooks-lease-query.rst
+++ b/doc/sphinx/arm/hooks-lease-query.rst
@@ -446,6 +446,16 @@ defined in RFC 6607.
 
    The new query types are only supported with the memfile lease backend.
 
+.. _command-extended-info4-upgrade:
+
+The ``extended-info4-upgrade`` Command
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+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.
+
 .. _bulk-lease-query-dhcpv6:
 
 DHCPv6 Bulk Leasequery

diff --git a/src/share/api/api_files.mk b/src/share/api/api_files.mk
index e3b3d4c09e77fdfdb326f30bc47382dee91aa55c..f10286bdb0ed0eda0233bcff1d189a31f63b201c 100644 (file)
--- a/src/share/api/api_files.mk
+++ b/src/share/api/api_files.mk
@@ -21,6 +21,7 @@ api_files += $(top_srcdir)/src/share/api/config-test.json
 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/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
new file mode 100644 (file)
index 0000000..fdac0c5
--- /dev/null
+++ b/src/share/api/extended-info4-upgrade.json
@@ -0,0 +1,30 @@
+{
+    "access": "write",
+    "avail": "2.3.8",
+    "brief": [
+        "This command sanitizes extended info of all IPv4 leases and fills relay and remote ID columns in the SQL lease database."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"extended-info4-upgrade\"",
+        "    }",
+        "}"
+    ],
+    "description": "See <xref linkend=\"command-extended-info4-upgrade\"/>",
+    "hook": "lease_query",
+    "name": "extended-info4-upgrade",
+    "resp-comment": [
+        "This command should be used when some old leases are present in the lease database using a SQL backend."
+    ],
+    "resp-syntax": [
+        "{",
+        "  \"arguments\": {",
+        "  },",
+        "  \"result\": 0,",
+        "  \"text\": \"to be done\"",
+        "}"
+    ],
+    "support": [
+        "kea-dhcp6"
+    ]
+}