[#2078] Updated doc

10 files changed, 178 insertions, 6 deletions

diff --git a/src/share/api/api_files.mk b/src/share/api/api_files.mk
index eaec3142f8..0603c84508 100644
--- a/src/share/api/api_files.mk
+++ b/src/share/api/api_files.mk
@@ -21,6 +21,11 @@ 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/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
+api_files += $(top_srcdir)/src/share/api/gss-tsig-key-expire.json
+api_files += $(top_srcdir)/src/share/api/gss-tsig-key-get.json
 api_files += $(top_srcdir)/src/share/api/ha-continue.json
 api_files += $(top_srcdir)/src/share/api/ha-heartbeat.json
 api_files += $(top_srcdir)/src/share/api/ha-maintenance-cancel.json
@@ -67,12 +72,12 @@ api_files += $(top_srcdir)/src/share/api/network6-list.json
 api_files += $(top_srcdir)/src/share/api/network6-subnet-add.json
 api_files += $(top_srcdir)/src/share/api/network6-subnet-del.json
 api_files += $(top_srcdir)/src/share/api/remote-class4-del.json
-api_files += $(top_srcdir)/src/share/api/remote-class4-get.json
 api_files += $(top_srcdir)/src/share/api/remote-class4-get-all.json
+api_files += $(top_srcdir)/src/share/api/remote-class4-get.json
 api_files += $(top_srcdir)/src/share/api/remote-class4-set.json
 api_files += $(top_srcdir)/src/share/api/remote-class6-del.json
-api_files += $(top_srcdir)/src/share/api/remote-class6-get.json
 api_files += $(top_srcdir)/src/share/api/remote-class6-get-all.json
+api_files += $(top_srcdir)/src/share/api/remote-class6-get.json
 api_files += $(top_srcdir)/src/share/api/remote-class6-set.json
 api_files += $(top_srcdir)/src/share/api/remote-global-parameter4-del.json
 api_files += $(top_srcdir)/src/share/api/remote-global-parameter4-get-all.json
diff --git a/src/share/api/gss-tsig-get-all.json b/src/share/api/gss-tsig-get-all.json
new file mode 100644
index 0000000000..bb3d33f513
--- /dev/null
+++ b/src/share/api/gss-tsig-get-all.json
@@ -0,0 +1,42 @@
+{
+    "access": "read",
+    "avail": "2.0.0",
+    "brief": [ "This command lists GSS-TSIG servers." ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"gss-tsig-get-all\"",
+        "}"
+    ],
+    "description": [ "See <xref linkend=\"command-gss-tsig-get-all\"/>" ],
+    "hook": "gss_tsig",
+    "name": "gss-tsig-get-all",
+    "support": [ "kea-dhcp-ddns" ],
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"1 GSS-TSIG servers\",",
+        "    \"arguments\": {",
+        "        \"gss-tsig-servers\": [",
+        "            {",
+        "                \"id\": \"foo\",",
+        "                \"ip-address\": \"192.1.2.3\",",
+        "                \"port\": 53,",
+        "                \"server-principal\": \"DNS/foo.com@FOO.COM\",",
+        "                \"key-name-suffix\": \"foo.com.\",",
+        "                \"tkey-lifetime\": 3600,",
+        "                \"tkey-protocol\": \"TCP\",",
+        "                \"keys\": [",
+        "                    \"{",
+        "                        \"name\": \"1234.sig-foo.com.\",",
+        "                        \"inception-date\": \"2021-09-05 12:23:36.281176\",",
+        "                        \"expire-date\": \"2021-09-05 13:23:36.281176\",",
+        "                        \"status\": \"not yet ready\",",
+        "                        \"tkey-exchange\": true",
+        "                    }",
+        "                ]",
+        "            }",
+        "        ]",
+        "    }",
+        "}"
+    ]
+}
diff --git a/src/share/api/gss-tsig-get.json b/src/share/api/gss-tsig-get.json
new file mode 100644
index 0000000000..563767c2ab
--- /dev/null
+++ b/src/share/api/gss-tsig-get.json
@@ -0,0 +1,43 @@
+{
+    "access": "read",
+    "avail": "2.0.0",
+    "brief": [
+        "This command retrieves information about the specified GSS-TSIG server."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"gss-tsig-get\",",
+        "    \"arguments\": {",
+        "        \"id\": \"foo\"",
+        "    }",
+        "}"
+    ],
+    "description": [ "See <xref linkend=\"command-gss-tsig-get\"/>" ],
+    "hook": "gss_tsig",
+    "name": "gss-tsig-get",
+    "support": [ "kea-dhcp-ddns" ],
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"GSS-TSIG server[foo] found\",",
+        "    \"arguments\": {",
+        "        \"id\": \"foo\",",
+        "        \"ip-address\": \"192.1.2.3\",",
+        "        \"port\": 53,",
+        "        \"server-principal\": \"DNS/foo.com@FOO.COM\",",
+        "        \"key-name-suffix\": \"foo.com.\",",
+        "        \"tkey-lifetime\": 3600,",
+        "        \"tkey-protocol\": \"TCP\",",
+        "        \"keys\": [",
+        "            \"{",
+        "                \"name\": \"1234.sig-foo.com.\",",
+        "                \"inception-date\": \"2021-09-05 12:23:36.281176\",",
+        "                \"expire-date\": \"2021-09-05 13:23:36.281176\",",
+        "                \"status\": \"not yet ready\",",
+        "                \"tkey-exchange\": true",
+        "            }",
+        "        ]",
+        "    }",
+        "]"
+    ]
+}
diff --git a/src/share/api/gss-tsig-key-del.json b/src/share/api/gss-tsig-key-del.json
new file mode 100644
index 0000000000..115f56c2f8
--- /dev/null
+++ b/src/share/api/gss-tsig-key-del.json
@@ -0,0 +1,23 @@
+{
+    "access": "write",
+    "avail": "2.0.0",
+    "brief": [ "This command deletes the specified GSS-TSIG key." ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"gss-tsig-key-del\",",
+        "    \"arguments\": {",
+        "        \"key-name\": \"1234.sig-foo.com.\"",
+        "    }",
+        "}"
+    ],
+    "description": [ "See <xref linkend=\"command-gss-tsig-key-del\"/>" ],
+    "hook": "gss_tsig",
+    "name": "gss-tsig-key-del",
+    "support": [ "kea-dhcp-ddns" ],
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"GSS-TSIG key '1234.sig-foo.com.' deleted\"",
+        "}"
+    ]
+}
diff --git a/src/share/api/gss-tsig-key-expire.json b/src/share/api/gss-tsig-key-expire.json
new file mode 100644
index 0000000000..7dff6e5192
--- /dev/null
+++ b/src/share/api/gss-tsig-key-expire.json
@@ -0,0 +1,23 @@
+{
+    "access": "write",
+    "avail": "2.0.0",
+    "brief": [ "This command expires the specified GSS-TSIG key." ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"gss-tsig-key-expire\",",
+        "    \"arguments\": {",
+        "        \"key-name\": \"1234.sig-foo.com.\"",
+        "    }",
+        "}"
+    ],
+    "description": [ "See <xref linkend=\"command-gss-tsig-key-expire\"/>" ],
+    "hook": "gss_tsig",
+    "name": "gss-tsig-key-expire",
+    "support": [ "kea-dhcp-ddns" ],
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"GSS-TSIG key '1234.sig-foo.com.' expired\"",
+        "}"
+    ]
+}
diff --git a/src/share/api/gss-tsig-key-get.json b/src/share/api/gss-tsig-key-get.json
new file mode 100644
index 0000000000..480579ef5f
--- /dev/null
+++ b/src/share/api/gss-tsig-key-get.json
@@ -0,0 +1,32 @@
+{
+    "access": "read",
+    "avail": "2.0.0",
+    "brief": [
+        "This command retrieves information about the specified GSS-TSIG key."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"gss-tsig-key-get\",",
+        "    \"arguments\": {",
+        "        \"key-name\": \"1234.sig-foo.com.\"",
+        "    }",
+        "}"
+    ],
+    "description": [ "See <xref linkend=\"command-gss-tsig-key-get\"/>" ],
+    "hook": "gss_tsig",
+    "name": "gss-tsig-key-get",
+    "support": [ "kea-dhcp-ddns" ],
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"GSS-TSIG key '1234.sig-foo.com.' found\"",
+        "    \"arguments\": {",
+        "        \"name\": \"1234.sig-foo.com.\",",
+        "        \"inception-date\": \"2021-09-05 12:23:36.281176\",",
+        "        \"expire-date\": \"2021-09-05 13:23:36.281176\",",
+        "        \"status\": \"not yet ready\",",
+        "        \"tkey-exchange\": true",
+        "    }",
+        "}"
+    ]
+}
diff --git a/src/share/api/statistic-get-all.json b/src/share/api/statistic-get-all.json
index f7c15768f0..821d052989 100644
--- a/src/share/api/statistic-get-all.json
+++ b/src/share/api/statistic-get-all.json
@@ -35,6 +35,7 @@
     "name": "statistic-get-all",
     "support": [
         "kea-dhcp4",
-        "kea-dhcp6"
+        "kea-dhcp6",
+        "kea-dhcp-ddns"
     ]
 }
diff --git a/src/share/api/statistic-get.json b/src/share/api/statistic-get.json
index 57ad9aa8c9..b6c9cca08f 100644
--- a/src/share/api/statistic-get.json
+++ b/src/share/api/statistic-get.json
@@ -27,6 +27,7 @@
     "name": "statistic-get",
     "support": [
         "kea-dhcp4",
-        "kea-dhcp6"
+        "kea-dhcp6",
+        "kea-dhcp-ddns"
     ]
 }
diff --git a/src/share/api/statistic-reset-all.json b/src/share/api/statistic-reset-all.json
index 708eefd214..c8347de77e 100644
--- a/src/share/api/statistic-reset-all.json
+++ b/src/share/api/statistic-reset-all.json
@@ -17,6 +17,7 @@
     "name": "statistic-reset-all",
     "support": [
         "kea-dhcp4",
-        "kea-dhcp6"
+        "kea-dhcp6",
+        "kea-dhcp-ddns"
     ]
 }
diff --git a/src/share/api/statistic-reset.json b/src/share/api/statistic-reset.json
index 95f1ea7a55..8a758f62d4 100644
--- a/src/share/api/statistic-reset.json
+++ b/src/share/api/statistic-reset.json
@@ -19,6 +19,7 @@
     "name": "statistic-reset",
     "support": [
         "kea-dhcp4",
-        "kea-dhcp6"
+        "kea-dhcp6",
+        "kea-dhcp-ddns"
     ]
 }