From: Marcin Siodelski <marcin@isc.org>
Date: Sat, 3 Sep 2016 11:08:38 +0000 (+0200)
Subject: [4765] Updated User's Guide with the static class assignments.
X-Git-Tag: trac5006_base~14^2~4
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0ea9bca367e2d202efe4fb98efc234d3512d3853;p=thirdparty%2Fkea.git

[4765] Updated User's Guide with the static class assignments.
---

diff --git a/doc/guide/classify.xml b/doc/guide/classify.xml
index 765daf71d2..3ddfab98c7 100644
--- a/doc/guide/classify.xml
+++ b/doc/guide/classify.xml
@@ -94,6 +94,14 @@
       </note>
   </section>
 
+  <section id="classification-using-host-reservations">
+    <title>Using Static Host Reservations In Classification</title>
+    <para>Classes can be statically assigned to the clients using techniques described
+    in <xref linkend="reservation4-client-classes"/> and
+    <xref linkend="reservation6-client-classes"/>.
+    </para>
+  </section>
+
   <section id="classification-using-vendor">
     <title>Using Vendor Class Information In Classification</title>
       <para>
diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml
index dd14d8af7c..5dddeca938 100644
--- a/doc/guide/dhcp4-srv.xml
+++ b/doc/guide/dhcp4-srv.xml
@@ -2926,6 +2926,61 @@ It is merely echoed by the server
     them can be omitted.</para>
     </section>
 
+    <section id="reservation4-client-classes">
+      <title>Reserving Client Classes in DHCPv4</title>
+      <para>The <xref linkend="classification-using-expressions"/> explains how
+      to configure the server to assign classes to a client based on the content
+      of the options that this client sends to the server. Host reservations
+      mechanisms also allow for statically assigning classes to the clients.
+      The definitions of these classes must exist in the Kea
+      configuration. The following configuration snippet shows how to specify
+      that the client belongs to classes <command>reserved-class1</command>
+      and <command>reserved-class2</command>. Those classes are associated with
+      specific options being sent to the clients which belong to them.
+      </para>
+
+<screen>
+{
+    "client-classes": [
+    {
+       "name": "reserved-class1",
+       "option-data": [
+       {
+           "name": "routers",
+           "data": "10.0.0.200"
+       }
+       ]
+    },
+    {
+       "name": "reserved-class2",
+       "option-data": [
+       {
+           "name": "domain-name-servers",
+           "data": "10.0.0.201"
+       }
+       ]
+    }
+    ],
+    "subnet4": [ {
+        "subnet": "10.0.0.0/24",
+        "pools": [ { "pool": "10.0.0.10-10.0.0.100" } ],
+        "reservations": [
+        {
+            "hw-address": "aa:bb:cc:dd:ee:ff",
+            <userinput>
+            "client-classes": [ "reserved-class1", "reserved-class2" ]
+            </userinput>
+        }
+        ]
+    } ]
+}
+
+</screen>
+
+    <para>Static class assignments, as shown above, can be used in conjuction
+    with classification using expressions.</para>
+    </section>
+
     <section id="reservations4-mysql-pgsql">
       <title>Storing host reservations in MySQL or PostgreSQL</title>
 
diff --git a/doc/guide/dhcp6-srv.xml b/doc/guide/dhcp6-srv.xml
index 96300c8801..62f696fcac 100644
--- a/doc/guide/dhcp6-srv.xml
+++ b/doc/guide/dhcp6-srv.xml
@@ -2591,6 +2591,58 @@ should include options from the isc option space:
 
     </section>
 
+    <section id="reservation6-client-classes">
+      <title>Reserving Client Classes in DHCPv6</title>
+      <para>The <xref linkend="classification-using-expressions"/> explains how
+      to configure the server to assign classes to a client based on the content
+      of the options that this client sends to the server. Host reservations
+      mechanisms also allow for statically assigning classes to the clients.
+      The definitions of these classes must exist in the Kea
+      configuration. The following configuration snippet shows how to specify
+      that the client belongs to classes <command>reserved-class1</command>
+      and <command>reserved-class2</command>. Those classes are associated with
+      specific options being sent to the clients which belong to them.
+      </para>
+<screen>
+{
+    "client-classes": [
+    {
+       "name": "reserved-class1",
+       "option-data": [
+       {
+           "name": "dns-servers",
+           "data": "2001:db8:1::50"
+       }
+       ]
+   },
+   {
+       "name": "reserved-class2",
+       "option-data": [
+       {
+           "name": "nis-servers",
+           "data": "2001:db8:1::100"
+       }
+       ]
+    }
+    ],
+    "subnet6": [
+    {   "pools": [ { "pool": "2001:db8:1::/64" } ],
+        "subnet": "2001:db8:1::/48",
+        "reservations": [
+        {
+            "duid": "01:02:03:04:05:06:07:08",
+            <userinput>
+            "client-classes": [ "reserved-class1", "reserved-class2" ]
+            </userinput>
+         } ]"
+     } ]"
+ }"
+
+</screen>
+    <para>Static class assignments, as shown above, can be used in conjuction
+    with classification using expressions.</para>
+    </section>
+
     <section id="reservations6-mysql-pgsql">
       <title>Storing host reservations in MySQL or PostgreSQL</title>