]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#2078] Update for new commands
authorFrancis Dupont <fdupont@isc.org>
Sun, 5 Sep 2021 21:55:43 +0000 (23:55 +0200)
committerRazvan Becheriu <razvan@isc.org>
Tue, 7 Sep 2021 09:45:43 +0000 (12:45 +0300)
doc/sphinx/arm/ext-gss-tsig.rst
src/share/api/api_files.mk
src/share/api/gss-tsig-get-all.json
src/share/api/gss-tsig-list.json [new file with mode: 0644]
src/share/api/gss-tsig-purge-all.json [new file with mode: 0644]
src/share/api/gss-tsig-purge.json [new file with mode: 0644]

index 81a0015d3715cd1d4ebc8461e294ebb109540f3a..7d37a253695fda8deadada72eae2c998036c59c1 100644 (file)
@@ -406,6 +406,11 @@ The gss-tsig-get-all Command
 The gss-tsig-get Command
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
+.. _command-gss-tsig-list:
+
+The gss-tsig-list Command
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
 .. _command-gss-tsig-key-get:
 
 The gss-tsig-key-get Command
@@ -421,3 +426,13 @@ The gss-tsig-key-expire Command
 The gss-tsig-key-del Command
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+.. _command-gss-tsig-purge-all:
+
+The gss-tsig-purge-all Command
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. _command-gss-tsig-purge:
+
+The gss-tsig-purge Command
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
index 0603c845085a71de02fa13452e756aa7462f1fb5..19e708a8b8e3ae266a2a4837ecada9ad7fc6927b 100644 (file)
@@ -26,6 +26,9 @@ 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/gss-tsig-list.json
+api_files += $(top_srcdir)/src/share/api/gss-tsig-purge-all.json
+api_files += $(top_srcdir)/src/share/api/gss-tsig-purge.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
index 8ef2bf94e794ce06a579b57fe4b777d71d7430c4..56350a453fed12b45248c1a55c1aa48a0e30d95d 100644 (file)
@@ -1,7 +1,7 @@
 {
     "access": "read",
     "avail": "2.0.0",
-    "brief": [ "This command lists GSS-TSIG servers." ],
+    "brief": [ "This command lists GSS-TSIG servers and keys." ],
     "cmd-syntax": [
         "{",
         "    \"command\": \"gss-tsig-get-all\"",
diff --git a/src/share/api/gss-tsig-list.json b/src/share/api/gss-tsig-list.json
new file mode 100644 (file)
index 0000000..c2f5946
--- /dev/null
@@ -0,0 +1,31 @@
+{
+    "access": "read",
+    "avail": "2.0.0",
+    "brief": [ "This command lists GSS-TSIG server IDs and key names." ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"gss-tsig-list\"",
+        "}"
+    ],
+    "description": [ "See <xref linkend=\"command-gss-tsig-list\"/>" ],
+    "hook": "gss_tsig",
+    "name": "gss-tsig-list",
+    "support": [ "kea-dhcp-ddns" ],
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"2 GSS-TSIG servers and 3 keys\",",
+        "    \"arguments\": {",
+        "        \"gss-tsig-servers\": [",
+        "            \"foo\",",
+        "            \"bar\"",
+        "        ],",
+        "        \"gss-tsig-keys\": [",
+        "            \"1234.example.com.\",",
+        "            \"5678.example.com.\",",
+        "            \"43888.example.org.\"",
+        "        ]",
+        "    }",
+        "}"
+    ]
+}
diff --git a/src/share/api/gss-tsig-purge-all.json b/src/share/api/gss-tsig-purge-all.json
new file mode 100644 (file)
index 0000000..7527537
--- /dev/null
@@ -0,0 +1,20 @@
+{
+    "access": "write",
+    "avail": "2.0.0",
+    "brief": [ "This command removes not usable GSS-TSIG keys." ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"gss-tsig-purge-all\"",
+        "}"
+    ],
+    "description": [ "See <xref linkend=\"command-gss-tsig--purge-all\"/>" ],
+    "hook": "gss_tsig",
+    "name": "gss-tsig-purge-all",
+    "support": [ "kea-dhcp-ddns" ],
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"2 purged GSS-TSIG keys\"",
+        "}"
+    ]
+}
diff --git a/src/share/api/gss-tsig-purge.json b/src/share/api/gss-tsig-purge.json
new file mode 100644 (file)
index 0000000..64ffd78
--- /dev/null
@@ -0,0 +1,24 @@
+{
+    "access": "write",
+    "avail": "2.0.0",
+    "brief": [ "This command removes not usable GSS-TSIG keys for the specified server."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"gss-tsig-purge\",",
+        "    \"arguments\": {",
+        "        \"id\": \"foo\"",
+        "    }",
+        "}"
+    ],
+    "description": [ "See <xref linkend=\"command-gss-tsig-purge\"/>" ],
+    "hook": "gss_tsig",
+    "name": "gss-tsig-purge",
+    "support": [ "kea-dhcp-ddns" ],
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"2 purged keys for GSS-TSIG server[foo]\"",
+        "}"
+    ]
+}