Browse Source

[3979] Added description of leases-reclaim command to User Guide.

Marcin Siodelski 9 years ago
parent
commit
702b77ce47
2 changed files with 35 additions and 0 deletions
  1. 27 0
      doc/guide/ctrl-channel.xml
  2. 8 0
      doc/guide/lease-expiration.xml

+ 27 - 0
doc/guide/ctrl-channel.xml

@@ -112,6 +112,33 @@ configuration file.</para>
     <section id="commands-common">
     <section id="commands-common">
       <title>Commands supported by both DHCPv4 and DHCPv6 servers</title>
       <title>Commands supported by both DHCPv4 and DHCPv6 servers</title>
 
 
+      <section id="command-leases-reclaim">
+        <title>leases-reclaim command</title>
+        <para>
+          <emphasis>leases-reclaim</emphasis> command instructs the server to
+          reclaim all expired leases immediately. The command has the following
+          JSON syntax:
+<screen>
+{
+    "command": "leases-reclaim",
+    "arguments": {
+        "remove": true
+    }
+}
+</screen>
+        </para>
+
+        <para>The <emphasis>remove</emphasis> boolean parameter is mandatory
+        and it indicates whether the reclaimed leases should be removed from
+        the lease database (if true), or they should be left in the
+        <emphasis>expired-reclaimed</emphasis> state (if false). The latter
+        facilitates lease affinity, i.e. ability to re-assign expired lease to
+        the same client which used this lease before. See the
+        <xref linkend="lease-affinity"/> for the details. Also, see the
+        <xref linkend="lease-reclamation"/> for the general information
+        about the processing of expired leases (leases reclamation).</para>
+      </section>
+
       <section id="command-list-commands">
       <section id="command-list-commands">
       <title>list-commands command</title>
       <title>list-commands command</title>
 
 

+ 8 - 0
doc/guide/lease-expiration.xml

@@ -336,4 +336,12 @@
 
 
   </section>
   </section>
 
 
+  <section id="leases-reclamation-using-command">
+    <title>Reclaiming Expired Leases with Command</title>
+    <para>The <emphasis>leases-reclaim</emphasis> command can be used to trigger
+    leases reclamation at any time. Please consult the
+    <xref linkend="command-leases-reclaim"/> for the details about using this
+    command.</para>
+  </section>
+
 </chapter>
 </chapter>