summaryrefslogtreecommitdiffstats
path: root/doc/guide/ctrl-channel.xml
diff options
context:
space:
mode:
authorFrancis Dupont <fdupont@isc.org>2018-12-28 00:09:53 +0100
committerFrancis Dupont <fdupont@isc.org>2019-01-03 10:05:03 +0100
commitfe841603f57c47aa69bc337ab1bbc9051c804927 (patch)
tree88531cb837c6377b3d80c427b6f654b69791f55e /doc/guide/ctrl-channel.xml
parent[#99,!176] Improved unit tests as a result of the second review. (diff)
downloadkea-fe841603f57c47aa69bc337ab1bbc9051c804927.tar.xz
kea-fe841603f57c47aa69bc337ab1bbc9051c804927.zip
[30-implement-control-socket-for-ddns-2] Reported doc updates
Diffstat (limited to 'doc/guide/ctrl-channel.xml')
-rw-r--r--doc/guide/ctrl-channel.xml34
1 files changed, 32 insertions, 2 deletions
diff --git a/doc/guide/ctrl-channel.xml b/doc/guide/ctrl-channel.xml
index 0fdf8e8340..213d80db97 100644
--- a/doc/guide/ctrl-channel.xml
+++ b/doc/guide/ctrl-channel.xml
@@ -19,14 +19,14 @@
the server may refuse to start, which will further extend the
downtime period until the issue is resolved.</para>
- <para>To avoid such problems, both the DHCPv4 and DHCPv6 servers
+ <para>To avoid such problems, the DHCPv4, DHCPv6 and D2 servers
include support for a mechanism that allows
on-line reconfiguration without requiring server shutdown.
Both servers can be instructed to open control sockets, which
is a communication channel. The server is able to receive
commands on that channel, act on them and report back status.</para>
- <para>The DHCPv4 and DHCPv6 servers receive commands over the
+ <para>The DHCPv4, DHCPv6 and D2 servers receive commands over the
unix domain sockets. The details how to configure these sockets,
see <xref linkend="dhcp4-ctrl-channel"/> and <xref linkend="dhcp6-ctrl-channel"/>. While it is possible control
the servers directly using unix domain sockets it requires that
@@ -613,6 +613,36 @@ $ curl -X POST -H "Content-Type: application/json" -d '{ "command": "config-get"
</section> <!-- end of commands supported by both servers -->
+ <section>
+ <title>Commands Supported by D2 Server</title>
+ <para>The D2 server supports only a subset of DHCPv4 / DHCPv6 server
+ commands:
+ <itemizedlist>
+ <listitem>
+ <simpara>build-report</simpara>
+ </listitem>
+ <listitem>
+ <simpara>config-get</simpara>
+ </listitem>
+ <listitem>
+ <simpara>config-test</simpara>
+ </listitem>
+ <listitem>
+ <simpara>config-write</simpara>
+ </listitem>
+ <listitem>
+ <simpara>list-commands</simpara>
+ </listitem>
+ <listitem>
+ <simpara>shutdown</simpara>
+ </listitem>
+ <listitem>
+ <simpara>version-get</simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+
<section xml:id="agent-commands">
<title>Commands Supported by Control Agent</title>
<para>The following commands listed in <xref linkend="commands-common"/>