From: Tomek Mrugalski <tomasz@isc.org>
Date: Fri, 14 Apr 2017 12:03:28 +0000 (+0200)
Subject: [5213] config-reload documented.
X-Git-Tag: trac5187_base~2^2~1^2~5
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=725862d780adaf4e845149153731fa596737f477;p=thirdparty%2Fkea.git

[5213] config-reload documented.
---

diff --git a/doc/guide/ctrl-channel.xml b/doc/guide/ctrl-channel.xml
index 2dcfd09431..c73a0c0a9d 100644
--- a/doc/guide/ctrl-channel.xml
+++ b/doc/guide/ctrl-channel.xml
@@ -272,6 +272,35 @@ $ curl -X POST -H "Content-Type: application/json" -d '{ "command": "config-get"
         </para>
       </section> <!-- end of command-config-get -->
 
+      <section id="command-config-reload">
+        <title>config-reload</title>
+
+        <para>The <emphasis>config-reload</emphasis> command instructs
+        Kea to load again the configuration file that was used
+        previously. This operation is useful if the configuration file
+        has been changed by some external sources. For example, a
+        sysadmin can tweak the configuration file and use this command
+        to force Kea pick up the changes.</para>
+
+        <para>Caution should be taken when mixing this with config-set
+        commands. Kea remembers the location of the configuration file
+        it was started with. This configuration can be significantly
+        changed using config-set command. When config-reload is issued
+        after config-set, Kea will attempt to reload its original
+        configuration from the file, possibly losing all changes
+        introduced using config-set or other commands.</para>
+
+        <para><emphasis>config-reload</emphasis> does not take any parameters.
+        An example command invocation looks like this:
+<screen>
+{
+    "command": "config-reload"
+}
+</screen>
+        </para>
+      </section> <!-- end of command-config-reload -->
+
+
       <section id="command-config-test">
         <title>config-test</title>
 
@@ -491,8 +520,7 @@ $ curl -X POST -H "Content-Type: application/json" -d '{ "command": "config-get"
         command may look like this:
 <screen>
 {
-    "command": "shutdown",
-    "arguments": { }
+    "command": "shutdown"
 }
 </screen>
       </para>
diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml
index f9095d0c1d..9a3f8519a5 100644
--- a/doc/guide/dhcp4-srv.xml
+++ b/doc/guide/dhcp4-srv.xml
@@ -3725,6 +3725,7 @@ src/lib/dhcpsrv/cfg_host_operations.cc -->
         <itemizedlist>
             <listitem>build-report</listitem>
             <listitem>config-get</listitem>
+            <listitem>config-reload</listitem>
             <listitem>config-set</listitem>
             <listitem>config-test</listitem>
             <listitem>config-write</listitem>
diff --git a/doc/guide/dhcp6-srv.xml b/doc/guide/dhcp6-srv.xml
index d69e109a81..5b4665b6f8 100644
--- a/doc/guide/dhcp6-srv.xml
+++ b/doc/guide/dhcp6-srv.xml
@@ -3944,6 +3944,7 @@ If not specified, the default value is:
         <itemizedlist>
             <listitem>build-report</listitem>
             <listitem>config-get</listitem>
+            <listitem>config-reload</listitem>
             <listitem>config-set</listitem>
             <listitem>config-test</listitem>
             <listitem>config-write</listitem>