]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
Add new file
authorSuzanne Goldlust <sgoldlust@isc.org>
Wed, 3 Oct 2018 19:27:42 +0000 (15:27 -0400)
committerTomek Mrugalski <tomasz@isc.org>
Tue, 29 Oct 2019 17:57:13 +0000 (18:57 +0100)
doc/api/config-test.json [new file with mode: 0644]

diff --git a/doc/api/config-test.json b/doc/api/config-test.json
new file mode 100644 (file)
index 0000000..dd4632b
--- /dev/null
@@ -0,0 +1,22 @@
+{
+    "name": "config-test",
+    "brief": "The config-test command instructs the server to check whether the new configuration supplied in the command's arguments can be loaded.",
+    "description": "See <xref linkend=\"command-config-test\"/>",
+    "support": [ "kea-dhcp4", "kea-dhcp6" ],
+    "avail": "1.2.0",
+    "cmd-syntax": "{
+    \"command\": \"config-test\",
+    \"arguments\":  {
+        \"<server>\": {
+        },
+        \"Logging\": {
+        }
+     }
+}",
+    "cmd-comment": "where <server> is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\"",
+    "resp-syntax": "{\"result\": 0, \"text\": \"Configuration seems sane...\" }
+
+    or
+
+    {\"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }",
+}
\ No newline at end of file