mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-29 04:57:52 +00:00
Code Issues Releases Wiki Activity

[4626] Documentation for fixed fields in classification written.

Browse Source
This commit is contained in:
Tomek Mrugalski 2016-08-24 19:41:31 +02:00
parent 524830e575
commit 07e080c8cb
1 changed files with 47 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
doc/guide/dhcp4-srv.xml
View File

@ -1638,9 +1638,7 @@ It is merely echoed by the server
<section id="dhcp4-client-classifier">
<title>Client Classification in DHCPv4</title>
<para>
The DHCPv4 server includes support for client classification. At the
current time the capabilities of the classification process are limited
but it is expected they will be expanded in the future. For a deeper
The DHCPv4 server includes support for client classification. For a deeper
discussion of the classification process see <xref linkend="classify"/>.
</para>
@ -1690,6 +1688,52 @@ It is merely echoed by the server
clients that do not meet class criteria to be denied any service altogether.
</para></note>
<section>
<title>Setting fixed fields in Classification</title>
<para>
It is possible to specify that clients belonging to a particular class
should receive packets with specific values in certain fixed fields.
In particular, three fixed fields are supported:
<command>next-server</command> (that conveys an IPv4 address, which is
set in the siaddr field), <command>server-hostname</command> (that
conveys a server hostname, can be up to 64 bytes long and will be sent
in the sname field) and <command>boot-file-name</command> (that
conveys the configuration file, can be up to 128 bytes long and will
be sent using file field).
</para>
<para>
Obviously, there are many ways to assign clients to specific classes,
but for the iPXE clients the client architecture type option (code 93,
defined in RFC4578, Section 2.1) seems to be particularly suited to
make the distinction. The following example checks if the client
identifies itself as PXE device with architecture EFI x86-64, and
sets several fields if it does. See Section 2.1 of the RFC4578 or
documentation of your client for specific values.
</para>
<screen>
"Dhcp4": {
"client-classes": [
{
"name": "ipxe_efi_x64",
"test": "option[93].hex == 0x0009",
<userinput>"next-server": "192.0.2.254",
"server-hostname": "hal9000",
"boot-file-name": "/dev/null"</userinput>
},
...
],
...
}</screen>
<para>
If there are multiple classes defined and incoming packet is matched
to multiple classes, then the classes are processed in the order in
which they're defined. In this case the last matching class
"overwrites" any values that may have been set by earlier matched
classes.
</para>
</section>
<section>
<title>Using Vendor Class Information in Classification</title>
<para>