mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-31 14:05:33 +00:00
Code Issues Releases Wiki Activity

[#1460] DHCPv4 options table updated

Browse Source
This commit is contained in:
Tomek Mrugalski
2020-10-23 11:47:27 +02:00
parent b78d901f46
commit 95159638d9
1 changed files with 31 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
doc/sphinx/arm/dhcp4-srv.rst
View File

@@ -1782,49 +1782,40 @@ currently has no means to validate it.
Kea supports more options than the listed above. The following list is mostly useful for readers who
want to understand whether Kea is able to support certain options. The following options are
returned by the Kea engine itself and in general should not be configured manually. The
`subnet-mask` is calculated based on subnet definition. The `host-name` is generally governed by the
DNS configuration. The `dhcp-requested-address` may be sent by the client and the server should not
set it. The `dhcp-lease-time` is set by Kea automatically based on the `valid-lifetime` parameter.
The `dhcp-message-type` is set by the Kea engine depending on the situation and should never be
configured explicitly by sysadmin. The `dhcp-parameter-request-list` is sent by clients and should
never be sent by the server. The `dhcp-renewal-time` and `dhcp-rebinding-time` are governed by
`renew-timer` and `rebind-timer` parameters. The `dhcp-client-identifier` is echoed back with the
value sent by the client. The `fqdn` option is part of the DDNS and D2 configuration. The `dhcp-agent-options`
is being sent by the relay agent. The `subnet-selection` option, if present in client's messages, will
be used in the subnet selection process.
returned by the Kea engine itself and in general should not be configured manually.
.. table:: List of standard DHCPv4 options managed by Kea on its own and not directly configurable by an administrator
+----------------------------------------+------+---------------------------+-------------+-------------+
| Name | Code | Type | Array? | Returned if |
| | | | | not |
| | | | | requested? |
+========================================+======+===========================+=============+=============+
| subnet-mask | 1 | ipv4-address | false | true |
+----------------------------------------+------+---------------------------+-------------+-------------+
| host-name | 12 | string | false | false |
+----------------------------------------+------+---------------------------+-------------+-------------+
| dhcp-requested-address | 50 | ipv6-address | false | true |
+----------------------------------------+------+---------------------------+-------------+-------------+
| dhcp-lease-time | 51 | uint32 | false | true |
+----------------------------------------+------+---------------------------+-------------+-------------+
| dhcp-message-type | 53 | string | false | true |
+----------------------------------------+------+---------------------------+-------------+-------------+
| dhcp-parameter-request-list | 55 | uint8 | true | false |
+----------------------------------------+------+---------------------------+-------------+-------------+
| dhcp-renewal-time | 58 | uint32 | false | true |
+----------------------------------------+------+---------------------------+-------------+-------------+
| dhcp-rebinding-time | 59 | uint32 | false | true |
+----------------------------------------+------+---------------------------+-------------+-------------+
| dhcp-client-identifier | 61 | hex | false | true |
+----------------------------------------+------+---------------------------+-------------+-------------+
| fqdn | 81 | fqdn | false | true |
+----------------------------------------+------+---------------------------+-------------+-------------+
| dhcp-agent-options | 82 | empty | false | true |
+----------------------------------------+------+---------------------------+-------------+-------------+
| subnet-selection | 118 | ipv4-address | false | false |
+----------------------------------------+------+---------------------------+-------------+-------------+
+----------------------------+------+--------------+----------------------------------------------------------------+
| Name | Code | Type | Description |
+============================+======+==============+================================================================+
| subnet-mask | 1 | ipv4-address | calculated automatically, based on subnet definition. |
+----------------------------+------+--------------+----------------------------------------------------------------+
| host-name | 12 | string | sent by client, generally governed by the DNS configuration. |
+----------------------------+------+--------------+----------------------------------------------------------------+
| dhcp-requested-address | 50 | ipv6-address | may be sent by the client and the server should not set it. |
+----------------------------+------+--------------+----------------------------------------------------------------+
| dhcp-lease-time | 51 | uint32 | set automatically based on the ``valid-lifetime`` parameter. |
+----------------------------+------+--------------+----------------------------------------------------------------+
| dhcp-message-type | 53 | string | sent by clients and servers. Set by the Kea engine depending on|
| | | | the situation and should never be configured explicitly. |
+----------------------------+------+--------------+----------------------------------------------------------------+
| dhcp-parameter-request-list| 55 | uint8 array | sent by clients and should never be sent by the server. |
+----------------------------+------+--------------+----------------------------------------------------------------+
| dhcp-renewal-time | 58 | uint32 | governed by ``renew-timer`` parameter. |
+----------------------------+------+--------------+----------------------------------------------------------------+
| dhcp-rebinding-time | 59 | uint32 | governed by ``rebind-timer`` parameter. |
+----------------------------+------+--------------+----------------------------------------------------------------+
| dhcp-client-identifier | 61 | binary | send by client, echoed back with the value sent by the client. |
+----------------------------+------+--------------+----------------------------------------------------------------+
| fqdn | 81 | fqdn | it's part of the DDNS and D2 configuration. |
+----------------------------+------+--------------+----------------------------------------------------------------+
| dhcp-agent-options | 82 | empty | sent by the relay agent. It's an empty container option, see |
| | | | RAI option detail in later part of this section. |
+----------------------------+------+--------------+----------------------------------------------------------------+
| subnet-selection | 118 | ipv4-address | if present in client's messages, will be used in the subnet |
| | | | selection process. |
+----------------------------+------+--------------+----------------------------------------------------------------+
The following table lists all option types used in the previous two tables with a description of
what values are accepted for them.