From: Tomek Mrugalski <tomasz@isc.org>
Date: Mon, 22 Jun 2015 14:17:54 +0000 (+0200)
Subject: [3917] Missing Management API section added in DHCPv6 chapter.
X-Git-Tag: trac3858a_base~5
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a012ca42dc0783ed23972bdb59d59aa6e7ad146d;p=thirdparty%2Fkea.git

[3917] Missing Management API section added in DHCPv6 chapter.
---

diff --git a/doc/guide/dhcp6-srv.xml b/doc/guide/dhcp6-srv.xml
index 38a0fac357..d111006351 100644
--- a/doc/guide/dhcp6-srv.xml
+++ b/doc/guide/dhcp6-srv.xml
@@ -2839,6 +2839,45 @@ should include options from the isc option space:
         </table>
     </section>
 
+    <section id="dhcp6-ctrl-channel">
+      <title>Management API for the DHCPv6 server</title>
+      <para>
+        Management API has been introduced in Kea 0.9.2. It allows issuing specific
+        management commands, like statistics retrieval, reconfiguration or shutdown.
+        For more details, see <xref linkend="ctrl-channel" />. Currently the only
+        supported communication channel type is UNIX stream socket. By default there
+        are no sockets open. To instruct Kea to open a socket, the following entry
+        in the configuration file can be used:
+<screen>
+"Dhcp6": {
+    "control-socket": {
+        "socket-type": "unix",
+        "socket-name": <userinput>"/path/to/the/unix/socket"</userinput>
+    },
+
+    "subnet6": [
+        ...
+    ],
+    ...
+}
+</screen>
+      </para>
+
+      <para>
+        Communication over control channel is conducted using JSON structures.
+        See the Control Channel section in the Kea Developer's Guide for more details.
+      </para>
+
+      <para>DHCPv4 server supports <command>statistic-get</command>,
+      <command>statistic-reset</command>, <command>statistic-remove</command>,
+      <command>statistic-get-all</command>, <command>statistic-reset-all</command>
+      and <command>statistic-remove-all</command>, specified in
+      <xref linkend="command-stats"/>. It also supports
+      <command>list-commands</command> and <command>shutdown</command>,
+      specified in <xref linkend="command-list-commands" /> and
+      <xref linkend="command-shutdown" />, respectively.</para>
+    </section>
+
     <section id="dhcp6-std">
       <title>Supported DHCPv6 Standards</title>
       <para>The following standards are currently