summaryrefslogtreecommitdiffstats
path: root/src/share/api/config-test.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/share/api/config-test.json')
-rw-r--r--src/share/api/config-test.json34
1 files changed, 34 insertions, 0 deletions
diff --git a/src/share/api/config-test.json b/src/share/api/config-test.json
new file mode 100644
index 0000000..39aa367
--- /dev/null
+++ b/src/share/api/config-test.json
@@ -0,0 +1,34 @@
+{
+ "access": "write",
+ "avail": "1.2.0",
+ "brief": [
+ "This command instructs the server to check whether the new configuration supplied in the command's arguments can be loaded."
+ ],
+ "cmd-comment": [
+ "In the example below, '<server>' is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\"."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"config-test\",",
+ " \"arguments\": {",
+ " \"'<server>'\": {",
+ " }",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-config-test\"/>",
+ "name": "config-test",
+ "resp-syntax": [
+ "{ \"result\": 0, \"text\": \"Configuration seems sane.\" }",
+ "",
+ "or",
+ "",
+ "{ \"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
+ ],
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6",
+ "kea-dhcp-ddns",
+ "kea-ctrl-agent"
+ ]
+}