From: Tomek Mrugalski <tomasz@isc.org>
Date: Tue, 31 Jul 2018 13:25:38 +0000 (+0200)
Subject: [5683] Corrected text to mention subnet-id = 0 case.
X-Git-Tag: ha_phase2~3
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ded5f6634d4ab4922c2bb043a3abb8e5f5f06687;p=thirdparty%2Fkea.git

[5683] Corrected text to mention subnet-id = 0 case.
---

diff --git a/doc/guide/hooks-lease-cmds.xml b/doc/guide/hooks-lease-cmds.xml
index f88e062f0b..352d7e59f4 100644
--- a/doc/guide/hooks-lease-cmds.xml
+++ b/doc/guide/hooks-lease-cmds.xml
@@ -134,10 +134,11 @@
           administratively. The <command>lease4-add</command> command requires
           at least two parameters: an IPv4 address, and an identifier: hardware
           (MAC) address. A third parameter, subnet-id, used to be mandatory in
-          Kea 1.4.0, but since 1.5.0 it is optional. If not specified, Kea will
-          try to figure its value out on its own by running a subnet selection
-          procedure. If specified, however, its value much match existing
-          subnet. The simplest successful call might look as follows:
+          Kea 1.4.0, but since 1.5.0 it is optional. If not specified or
+          specified value is 0, Kea will try to figure its value out on its own
+          by running a subnet selection procedure. If specified, however, its
+          value much match existing subnet. The simplest successful call might
+          look as follows:
 <screen>
 {
     "command": "lease4-add",
@@ -152,9 +153,10 @@
         <para><command>lease6-add</command> command requires four parameters: an
         IPv6 address, and IAID value (identity association identifier, a value
         sent by clients) and a DUID. The same principle for subnet-id as in
-        lease4-add applies.  If not specified, Kea will try to figure its value
-        out on its own by running a subnet selection procedure. If specified,
-        however, its value much match existing subnet. For example:
+        lease4-add applies.  If not specified or specified value is 0, Kea will
+        try to figure its value out on its own by running a subnet selection
+        procedure. If specified, however, its value much match existing
+        subnet. For example:
 <screen>
 {
     "command": "lease6-add",
@@ -667,9 +669,10 @@ An example IPv4 lease deletion by "hw-address" looks as follows:
           <command>leaseX-add</command> commands.</para>
 
           <para>Subnet-id parameter, used to be mandatory in Kea 1.4.0, but it
-          is optional since 1.5.0. If not specified, Kea will try to figure its
-          value out on its own by running a subnet selection procedure. If
-          specified, however, its value much match existing subnet.</para>
+          is optional since 1.5.0. If not specified or specified value is 0, Kea
+          will try to figure its value out on its own by running a subnet
+          selection procedure. If specified, however, its value much match
+          existing subnet.</para>
 
           <para>The optional boolean parameter "force-create" specifies
           if the lease should be created if it doesn't exist in the database.