[5535] Updated admin guide

diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml
index 9629f67b950c0dc1e2a37507df972ec86e9db8f5..b17cd80b86117fedd68b91284c83cd98057149c0 100644 (file)
--- a/doc/guide/dhcp4-srv.xml
+++ b/doc/guide/dhcp4-srv.xml
@@ -3995,20 +3995,20 @@ for each subnet. Here's an example:
     {
         "name": "kakapo",
         <userinput>"relay": {
-            "ip-address": "192.3.5.6"
+            "ip-addresses": [ "192.3.5.6" ]
         }</userinput>,
         "subnet4": [
             {
                 "subnet": "192.0.2.0/26",
                 <userinput>"relay": {
-                    "ip-address": "192.1.1.1"
+                    "ip-addresses": [ "192.1.1.1" ]
                 }</userinput>,
                 "pools": [ { "pool": "192.0.2.63 - 192.0.2.63" } ]
             },
             {
                 "subnet": "10.0.0.0/24",
                 <userinput>"relay": {
-                    "ip-address": "192.2.2.2"
+                    "ip-addresses": [ "192.2.2.2" ]
                 }</userinput>,
                 "pools": [ { "pool": "10.0.0.16 - 10.0.0.16" } ]
             }
@@ -4138,7 +4138,6 @@ desired outcome if one desires to service only clients of known properties
       "interface" or "relay" parameter. All subnets belonging to this shared
       network will inherit those parameters.
     </para>
-
     </section>
 
     <section>
@@ -4311,7 +4310,7 @@ autogenerated IDs are not stable across configuration changes.</para>
             "subnet": "192.0.2.0/24",
             "pools": [ { "pool": "192.0.2.10 - 192.0.2.20" } ],
             <userinput>"relay": {
-                "ip-address": "10.0.0.1"
+                "ip-addresses": [ "10.0.0.1" ]
             }</userinput>,
             ...
         }
@@ -4321,8 +4320,17 @@ autogenerated IDs are not stable across configuration changes.</para>
 </screen>
       </para>
 
-      <para>If "relay" is specified, the "ip-address" parameter within
+      <para>If "relay" is specified, the "ip-addresses" parameter within
       it is mandatory.</para>
+   
+      <note> 
+      <para>
+      As of Kea 1.4, the "ip-address" parameter has been deprecated in favor 
+      of "ip-addresses" which supports specifying a list of addresses.  
+      Configuration parsing, will honor the singular form for now but users are
+      encouraged to migrate.
+      </para>
+      </note> 
 
     </section>
 
@@ -4351,14 +4359,14 @@ autogenerated IDs are not stable across configuration changes.</para>
             "pools":  [ { "pool": "10.1.1.2 - 10.1.1.20" } ],
             <userinput>"client-class" "docsis3.0",
             "relay": {
-                "ip-address": "10.1.1.1"
+                "ip-addresses": [ "10.1.1.1 ]"
             }</userinput>
         },
         {
             "subnet": "192.0.2.0/24",
             "pools": [ { "pool": "192.0.2.10 - 192.0.2.20" } ],
             <userinput>"relay": {
-                "ip-address": "10.1.1.1"
+                "ip-addresses": [ "10.1.1.1" ]
             }</userinput>
         }
     ],

diff --git a/doc/guide/dhcp6-srv.xml b/doc/guide/dhcp6-srv.xml
index a7bd2902d6a3172f816fa7dbdeb5590c4bf998c6..f1e8d8b3da10d3ea2a1abfe7bfa3a7c388994e12 100644 (file)
--- a/doc/guide/dhcp6-srv.xml
+++ b/doc/guide/dhcp6-srv.xml
@@ -3496,7 +3496,7 @@ If not specified, the default value is:
             // Subnets from this shared network will be selected for clients
             // communicating via relay agent having the specified IP address.
             "relay": {
-                "ip-address": "2001:db8:2:34::1"
+                "ip-addresses": [ "2001:db8:2:34::1" ]
             },
 
             // This starts a list of subnets in this shared network.
@@ -3523,7 +3523,7 @@ If not specified, the default value is:
             "subnet": "2001:db9::/48",
             "pools": [ { "pool":  "2001:db9::/64" } ],
             "relay": {
-                "ip-address": "2001:db8:1:2::1"
+                "ip-addresses": [ "2001:db8:1:2::1" ]
             }
         }
     ]
@@ -3555,7 +3555,7 @@ If not specified, the default value is:
     {
         "name": "lab-network3",
         "relay": {
-             "ip-address": "2001:db8:2:34::1"
+             "ip-addresses": [ "2001:db8:2:34::1" ]
         },
 
         // This applies to all subnets in this shared network, unless
@@ -3671,13 +3671,13 @@ for each subnet. Here's an example:
     {
         "name": "kakapo",
         <userinput>"relay": {
-            "ip-address": "2001:db8::abcd"
+            "ip-addresses":  [ "2001:db8::abcd" ]
         }</userinput>,
         "subnet6": [
             {
                 "subnet": "2001:db8::/64",
                 <userinput>"relay": {
-                    "ip-address": "2001:db8::1234"
+                    "ip-addresses": [ "2001:db8::1234" ]
                 }</userinput>,
                 "pools": [ { "pool":  "2001:db8::1 - 2001:db8::ffff" } ]
             },
@@ -3685,7 +3685,7 @@ for each subnet. Here's an example:
                  "subnet": "3ffe:abcd::/64",
                  "pools": [ { "pool":  "3ffe:abcd::1 - 3ffe:abcd::ffff" } ],
                  <userinput>"relay": {
-                    "ip-address": "3ffe:abcd::cafe"
+                    "ip-addresses": [ "3ffe:abcd::cafe" ]
                  }</userinput>
             }
         ]
@@ -3730,7 +3730,7 @@ as long as it is valid IPv6 address.</para>
         {
             "name": "galah",
             "relay": {
-                "ip-address": "2001:db8:2:34::1"
+                "ip-address": [ "2001:db8:2:34::1" ]
             },
             "subnet6": [
                 {
@@ -3781,7 +3781,7 @@ as long as it is valid IPv6 address.</para>
         {
             "name": "galah",
             "relay": {
-                "ip-address": "2001:db8:2:34::1"
+                "ip-addresses":  [ "2001:db8:2:34::1" ]
             },
             "subnet6": [
                 {
@@ -3833,7 +3833,7 @@ desired outcome if one desires to service only clients of known properties
     {
         "name": "frog",
         "relay": {
-            "ip-address": "2001:db8:2:34::1"
+            "ip-addresses": [ "2001:db8:2:34::1" ]
         },
         "subnet6": [
             {
@@ -4252,7 +4252,7 @@ autogenerated IDs are not stable across configuration changes.
                  }
              ],
              <userinput>"relay": {
-                 "ip-address": "3000::1"
+                 "ip-addresses": [ "3000::1" ]
              }</userinput>
         }
     ]
@@ -4260,9 +4260,18 @@ autogenerated IDs are not stable across configuration changes.
 </screen>
       </para>
 
-      <para>If "relay" is specified, the "ip-address" parameter within
+      <para>If "relay" is specified, the "ip-addresses" parameter within
       it is mandatory.</para>
 
+      <note>
+      <para>
+      As of Kea 1.4, the "ip-address" parameter in "relay" has been deprecated
+      in favor of "ip-addresses" which supports specifying a list of addresses.
+      Configuration parsing, will honor the singular form for now but users are
+      encouraged to migrate.
+      </para>
+      </note>
+
     </section>
 
       <section xml:id="dhcp6-client-class-relay">
@@ -4293,7 +4302,7 @@ autogenerated IDs are not stable across configuration changes.
             ],
             <userinput>"client-class": "VENDOR_CLASS_docsis3.0",
             "relay": {
-                "ip-address": "3000::1"
+                "ip-addresses": [ "3000::1" ]
             }</userinput>
         },
 
@@ -4305,7 +4314,7 @@ autogenerated IDs are not stable across configuration changes.
                  }
              ],
              <userinput>"relay": {
-                 "ip-address": "3000::1"
+                 "ip-addresses": [ "3000::1" ]
              }</userinput>
         }
     ]