From: Tomek Mrugalski <tomasz@isc.org>
Date: Tue, 2 Oct 2018 11:18:45 +0000 (+0200)
Subject: [#10,!3] Three more commands documented.
X-Git-Tag: 176-update-to-sysrepo-0-7-6-release_base~170
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f77ae9c9ee5dcf7dd09b2224af556ae3dca46407;p=thirdparty%2Fkea.git

[#10,!3] Three more commands documented.
---

diff --git a/doc/api/build-report.json b/doc/api/build-report.json
new file mode 100644
index 0000000000..4abc5fb374
--- /dev/null
+++ b/doc/api/build-report.json
@@ -0,0 +1,16 @@
+{
+    "name": "build-report",
+    "brief": "returns a list of compilition options that this particular binary was built with",
+    "support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ],
+    "avail": "1.2.0",
+
+    "cmd-syntax": "{
+    \"command\": \"build-report\"
+}",
+
+    "resp-syntax": "{
+    \"result\": 0,
+    \"text\": <string with build details>
+}",
+    "resp-comment": ""
+}
diff --git a/doc/api/cache-write.json b/doc/api/cache-write.json
new file mode 100644
index 0000000000..635fe666e7
--- /dev/null
+++ b/doc/api/cache-write.json
@@ -0,0 +1,13 @@
+{
+    "name": "cache-write",
+    "brief": "Instructs Kea to write its host cache content to disk.",
+    "support": [ "kea-dhcp4", "kea-dhcp6" ],
+    "avail": "1.4.0",
+    "hook": "host_cache",
+
+    "cmd-syntax": "{
+    \"command\": \"cache-write\",
+    \"arguments\": \"/path/to/the/file.json\"
+}",
+    "cmd-comment": "The command takes one mandatory argument that specifies a filename path of a file to be written."
+}
diff --git a/doc/api/config-get.json b/doc/api/config-get.json
new file mode 100644
index 0000000000..30233b5e8b
--- /dev/null
+++ b/doc/api/config-get.json
@@ -0,0 +1,20 @@
+{
+    "name": "config-get",
+    "brief": "retrieves the current configurationa used by the server. The configuration
+              is roughtly equal to the configuration file, but includes additional
+              changes made by other commands and due to parameters inheritance.",
+    "support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ],
+    "avail": "1.2.0",
+
+    "cmd-syntax": "{
+    \"command\": \"config-get\"
+}",
+    "cmd-comment": "<command>config-get</command> takes no parameters.",
+
+    "resp-syntax": "{
+    \"result\": <integer>,
+    \"arguments\": {
+        <JSON configuration here, starting with Dhcp4, Dhcp6, or Control-agent object>
+    }
+}"
+}