]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#1745] document vivso options
authorAndrei Pavel <andrei@isc.org>
Fri, 8 Oct 2021 13:59:30 +0000 (16:59 +0300)
committerAndrei Pavel <andrei@isc.org>
Wed, 20 Oct 2021 14:49:11 +0000 (14:49 +0000)
doc/sphinx/arm/dhcp4-srv.rst
doc/sphinx/arm/dhcp6-srv.rst
src/lib/dhcp/dhcp6.h

index c4c20c2161e5ff472127598dc9964eba2deccd09..d4322cc5a699f1316d2d99a6976e4e2cfc1c7043 100644 (file)
@@ -2432,12 +2432,24 @@ Alternatively, the option can be specified using its code.
 
 Another popular option that is often somewhat imprecisely called the "vendor
 option" is option 125. Its proper name is the "vendor-independent
-vendor-specific information option" or "vivso". The idea behind vivso
-options is that each vendor has its own unique set of options with their
-own custom formats. The vendor is identified by a 32-bit unsigned integer
-called `enterprise-id` or `vendor-id`. For example, vivso with vendor-id
-4491 represents DOCSIS options, and they are often seen
-when dealing with cable modems.
+vendor-specific information option" or "vivso". The idea behind vivso options
+is that each vendor has its own unique set of options with their own custom
+formats. The vendor is identified by a 32-bit unsigned integer called
+`enterprise-number` or `vendor-id`.
+
+
+The standard spaces defined in Kea and their options are:
+
+- ``vendor-4491``: Cable Television Laboratories, Inc. for DOCSIS3 options:
+
++-------------+--------------+------------------------------------------------------------------------+
+| option code | option name  | option description                                                     |
++=============+==============+========================================================================+
+| 1           | oro          | ORO (or Option Request Option) is used by clients to request a list of |
+|             |              | options they are interested in.                                        |
++-------------+--------------+------------------------------------------------------------------------+
+| 2           | tftp-servers | a list of IPv4 addresses of TFTP servers to be used by the cable modem |
++-------------+--------------+------------------------------------------------------------------------+
 
 In Kea each vendor is represented by its own vendor space. Since there
 are hundreds of vendors and sometimes they use different option
index 01821ebd79ec599935485b3fdcad978d13549b6e..9cc9749c00a26f61a9452f8d731ae2f9350f7e1c 100644 (file)
@@ -1975,7 +1975,37 @@ DHCPv6 Vendor-Specific Options
 ------------------------------
 
 Vendor options in DHCPv6 are carried in the Vendor-Specific
-Information option (code 17). The following examples show how to
+Information option (code 17). The idea behind option 17
+is that each vendor has its own unique set of options with their own custom
+formats. The vendor is identified by a 32-bit unsigned integer called
+`enterprise-number` or `vendor-id`.
+
+The standard spaces defined in Kea and their options are:
+
+- ``vendor-2495``: Internet Systems Consortium, Inc. for 4o6 options:
+
++-------------+--------------------+------------------------------------------------------------------------+
+| option code | option name        | option description                                                     |
++=============+====================+========================================================================+
+| 60000       | 4o6-interface      | the name of the 4o6 server's client-facing interface                   |
++-------------+--------------------+------------------------------------------------------------------------+
+| 60001       | 4o6-source-address | the address that the 4o6 server uses to send packets to the client     |
++-------------+--------------------+------------------------------------------------------------------------+
+| 60002       | 4o6-source-port    | the port that the 4o6 server opens to send packets to the client       |
++-------------+--------------------+------------------------------------------------------------------------+
+
+- ``vendor-4491``: Cable Television Laboratories, Inc. for DOCSIS3 options:
+
++-------------+--------------------+------------------------------------------------------------------------+
+| option code | option name        | option description                                                     |
++=============+====================+========================================================================+
+| 1           | oro                | ORO (or Option Request Option) is used by clients to request a list of |
+|             |                    | options they are interested in.                                        |
++-------------+--------------------+------------------------------------------------------------------------+
+| 2           | tftp-servers       | a list of IPv4 addresses of TFTP servers to be used by the cable modem |
++-------------+--------------------+------------------------------------------------------------------------+
+
+The following examples show how to
 define an option "foo" with code 1 that consists of an IPv6 address,
 an unsigned 16-bit integer, and a string.  The "foo" option is
 conveyed in a Vendor-Specific Information option, which comprises a
index fbe4067ca337335e44e8fe9a5fbefe996bef7362..0e53aff353403b8dcf66c9c22e07e7b6c23e660f 100644 (file)
@@ -263,7 +263,7 @@ static const uint16_t HWTYPE_INFINIBAND = 0x0020;
 #define SHA_512                 2
 #define RSASSA_PKCS1v1_5        1
 
-// Taken from http://www.iana.org/assignments/enterprise-numbers
+// Taken from https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers
 static const uint32_t ENTERPRISE_ID_ISC = 2495;
 
 /* DHCPv4-over-DHCPv6 (RFC 7341) inter-process communication. These are option