From: Marcin Siodelski <marcin@isc.org>
Date: Tue, 5 Dec 2017 10:06:23 +0000 (+0100)
Subject: [5442] Described dhcp-enable and dhcp-disable in the User's Guide.
X-Git-Tag: trac5443_base~3
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a100b44b3ed08bfc76465bdbd5e8cdcc6911db2b;p=thirdparty%2Fkea.git

[5442] Described dhcp-enable and dhcp-disable in the User's Guide.
---

diff --git a/doc/guide/ctrl-channel.xml b/doc/guide/ctrl-channel.xml
index 04907a0573..2b37e9660c 100644
--- a/doc/guide/ctrl-channel.xml
+++ b/doc/guide/ctrl-channel.xml
@@ -557,6 +557,42 @@ $ curl -X POST -H "Content-Type: application/json" -d '{ "command": "config-get"
       </para>
     </section> <!-- end of command-shutdown -->
 
+    <section id="command-dhcp-disable">
+      <title>dhcp-disable</title>
+      <para>
+        The <emphasis>dhcp-disable</emphasis> command globally disables the DHCP
+        service. The server continues to operate, but it drops all received DHCP
+        messages. This command is useful when the server's maintenance requires that
+        the server temporarily stops allocating new leases and renew existing leases.
+        It is also useful in failover like configurations during a synchronization of
+        the lease databases at startup or recovery after a failure. The optional parameter
+        <emphasis>max-period</emphasis> specifies the time in seconds after which the
+        DHCP service should be automatically re-enabled if the
+        <emphasis>dhcp-enable</emphasis> command is not sent before this time elapses.
+      </para>
+<screen>
+{
+    "command": "dhcp-disable",
+    "arguments": {
+        "max-period": 20
+    }
+}
+</screen>
+    </section> <!-- end of command-dhcp-disable -->
+
+    <section id="command-dhcp-enable">
+      <title>dhcp-enable</title>
+      <para>
+        The <emphasis>dhcp-enable</emphasis> command globally enables the DHCP
+        service.
+      </para>
+<screen>
+{
+    "command": "dhcp-enable"
+}
+</screen>
+    </section> <!-- end of command-dhcp-disable -->
+
       <section id="command-version-get">
         <title>version-get</title>
         <para>
diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml
index b0070184be..4fcc3fc6a5 100644
--- a/doc/guide/dhcp4-srv.xml
+++ b/doc/guide/dhcp4-srv.xml
@@ -4556,6 +4556,8 @@ autogenerated IDs are not stable across configuration changes.</para>
             <listitem>config-set</listitem>
             <listitem>config-test</listitem>
             <listitem>config-write</listitem>
+            <listitem>dhcp-disable</listitem>
+            <listitem>dhcp-enable</listitem>
             <listitem>leases-reclaim</listitem>
             <listitem>list-commands</listitem>
             <listitem>shutdown</listitem>
diff --git a/doc/guide/dhcp6-srv.xml b/doc/guide/dhcp6-srv.xml
index 06d5717aed..1eaeaa73cc 100644
--- a/doc/guide/dhcp6-srv.xml
+++ b/doc/guide/dhcp6-srv.xml
@@ -4558,6 +4558,8 @@ autogenerated IDs are not stable across configuration changes.
             <listitem>config-set</listitem>
             <listitem>config-test</listitem>
             <listitem>config-write</listitem>
+            <listitem>dhcp-disable</listitem>
+            <listitem>dhcp-enable</listitem>
             <listitem>leases-reclaim</listitem>
             <listitem>list-commands</listitem>
             <listitem>shutdown</listitem>