summaryrefslogtreecommitdiffstats
path: root/doc/sphinx
diff options
context:
space:
mode:
authorWlodek Wencel <wlodek@isc.org>2024-10-29 12:53:12 +0100
committerWlodek Wencel <wlodek@isc.org>2024-10-29 12:53:12 +0100
commit3d0a05c38cb9ffacb6534e5e35e3905df7c5005b (patch)
tree0471b435f1a045fa364de57c787a9855c4b63dec /doc/sphinx
parent[#3587] use CHANGE instead of RENAME in MySQL (diff)
downloadkea-3d0a05c38cb9ffacb6534e5e35e3905df7c5005b.tar.xz
kea-3d0a05c38cb9ffacb6534e5e35e3905df7c5005b.zip
[#3646] release changes
Diffstat (limited to 'doc/sphinx')
-rw-r--r--doc/sphinx/conf.py2
-rw-r--r--doc/sphinx/debug-messages.rst12
-rw-r--r--doc/sphinx/grammar/grammar-dhcp4-parser.rst17
-rw-r--r--doc/sphinx/grammar/grammar-dhcp6-parser.rst18
-rw-r--r--doc/sphinx/kea-messages.rst212
-rw-r--r--doc/sphinx/umls.rst2
6 files changed, 151 insertions, 112 deletions
diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py
index 8ebe94ca59..9d22903b35 100644
--- a/doc/sphinx/conf.py
+++ b/doc/sphinx/conf.py
@@ -26,7 +26,7 @@ import api2doc # noqa # pylint: disable=wrong-import-position
# -- Project information -----------------------------------------------------
project = 'Kea'
-copyright = '2019-2024, Internet Systems Consortium' # pylint: disable=redefined-builtin
+copyright = '2019-2024, Internet Systems Consortium'
author = 'Internet Systems Consortium'
# get current kea version
diff --git a/doc/sphinx/debug-messages.rst b/doc/sphinx/debug-messages.rst
index 4ceac072a3..349b6ae469 100644
--- a/doc/sphinx/debug-messages.rst
+++ b/doc/sphinx/debug-messages.rst
@@ -163,13 +163,13 @@ Messages printed on debuglevel 40
- DDNS_TUNING6_SKIPPING_DDNS
- DDNS_TUNING_SUBNET_EXPRESSION_PARSE
- DDNS_TUNING_SUBNET_EXPR_CACHED
+- DHCP4_ADDITIONAL_CLASS_NO_TEST
+- DHCP4_ADDITIONAL_CLASS_UNDEFINED
- DHCP4_BUFFER_RECEIVED
- DHCP4_CLASSES_ASSIGNED
- DHCP4_CLASSES_ASSIGNED_AFTER_SUBNET_SELECTION
- DHCP4_CLASS_ASSIGNED
- DHCP4_CLASS_UNCONFIGURED
-- DHCP4_CLASS_UNDEFINED
-- DHCP4_CLASS_UNTESTABLE
- DHCP4_DHCP4O6_HOOK_SUBNET4_SELECT_DROP
- DHCP4_DHCP4O6_HOOK_SUBNET4_SELECT_SKIP
- DHCP4_DHCP4O6_PACKET_RECEIVED
@@ -188,13 +188,13 @@ Messages printed on debuglevel 40
- DHCP4_PACKET_QUEUE_FULL
- DHCP4_SHUTDOWN
- DHCP4_SHUTDOWN_REQUEST
+- DHCP6_ADDITIONAL_CLASS_NO_TEST
+- DHCP6_ADDITIONAL_CLASS_UNDEFINED
- DHCP6_BUFFER_RECEIVED
- DHCP6_CLASSES_ASSIGNED
- DHCP6_CLASSES_ASSIGNED_AFTER_SUBNET_SELECTION
- DHCP6_CLASS_ASSIGNED
- DHCP6_CLASS_UNCONFIGURED
-- DHCP6_CLASS_UNDEFINED
-- DHCP6_CLASS_UNTESTABLE
- DHCP6_DHCP4O6_PACKET_RECEIVED
- DHCP6_FLEX_ID
- DHCP6_HOOK_BUFFER_SEND_SKIP
@@ -902,6 +902,7 @@ Messages printed on debuglevel 50
- ALLOC_ENGINE_V6_EXTEND_LEASE
- ASIODNS_READ_TIMEOUT
+- DHCP4_ADDITIONAL_CLASS_EVAL_RESULT
- DHCP4_BUFFER_UNPACK
- DHCP4_BUFFER_WAIT_SIGNAL
- DHCP4_CLIENTID_IGNORED_FOR_LEASES
@@ -929,10 +930,10 @@ Messages printed on debuglevel 50
- DHCP4_RELEASE_FAIL_NO_LEASE
- DHCP4_RELEASE_FAIL_WRONG_CLIENT
- DHCP4_REQUEST
-- DHCP4_REQUIRED_CLASS_EVAL_RESULT
- DHCP4_RESPONSE_HOSTNAME_GENERATE
- DHCP4_SUBNET_SELECTION_FAILED
- DHCP4_UNKNOWN_ADDRESS_REQUESTED
+- DHCP6_ADDITIONAL_CLASS_EVAL_RESULT
- DHCP6_ADD_GLOBAL_STATUS_CODE
- DHCP6_ADD_STATUS_CODE_FOR_IA
- DHCP6_BUFFER_UNPACK
@@ -964,7 +965,6 @@ Messages printed on debuglevel 50
- DHCP6_PROCESS_IA_PD_REQUEST
- DHCP6_PROCESS_IA_PD_SOLICIT
- DHCP6_RAPID_COMMIT
-- DHCP6_REQUIRED_CLASS_EVAL_RESULT
- DHCP6_SUBNET_SELECTION_FAILED
- DHCPSRV_DHCP_DDNS_NCR_SENT
- DHCPSRV_EVAL_RESULT
diff --git a/doc/sphinx/grammar/grammar-dhcp4-parser.rst b/doc/sphinx/grammar/grammar-dhcp4-parser.rst
index f2c7a45923..256bb72138 100644
--- a/doc/sphinx/grammar/grammar-dhcp4-parser.rst
+++ b/doc/sphinx/grammar/grammar-dhcp4-parser.rst
@@ -337,11 +337,7 @@ This grammar is generated from ``dhcp4_parser.yy``. See :ref:`dhcp4` for more de
| cipher_list
| unknown_map_entry
- database_type ::= "type" ":" db_type
-
- db_type ::= "memfile"
- | "mysql"
- | "postgresql"
+ database_type ::= "type" ":" STRING
user ::= "user" ":" STRING
@@ -509,6 +505,7 @@ This grammar is generated from ``dhcp4_parser.yy``. See :ref:`dhcp4` for more de
| id
| client_class
| require_client_classes
+ | evaluate_additional_classes
| reservations
| reservations_global
| reservations_in_subnet
@@ -560,6 +557,8 @@ This grammar is generated from ``dhcp4_parser.yy``. See :ref:`dhcp4` for more de
require_client_classes ::= "require-client-classes" ":" list_strings
+ evaluate_additional_classes ::= "evaluate-additional-classes" ":" list_strings
+
reservations_global ::= "reservations-global" ":" BOOLEAN
reservations_in_subnet ::= "reservations-in-subnet" ":" BOOLEAN
@@ -600,6 +599,7 @@ This grammar is generated from ``dhcp4_parser.yy``. See :ref:`dhcp4` for more de
| reservations_out_of_pool
| client_class
| require_client_classes
+ | evaluate_additional_classes
| valid_lifetime
| min_valid_lifetime
| max_valid_lifetime
@@ -707,6 +707,7 @@ This grammar is generated from ``dhcp4_parser.yy``. See :ref:`dhcp4` for more de
| option_data_never_send
| user_context
| comment
+ | option_data_client_classes
| unknown_map_entry
option_data_name ::= name
@@ -723,6 +724,8 @@ This grammar is generated from ``dhcp4_parser.yy``. See :ref:`dhcp4` for more de
option_data_never_send ::= "never-send" ":" BOOLEAN
+ option_data_client_classes ::= "client-classes" ":" list_strings
+
pools_list ::= "pools" ":" "[" pools_list_content "]"
pools_list_content ::=
@@ -745,6 +748,7 @@ This grammar is generated from ``dhcp4_parser.yy``. See :ref:`dhcp4` for more de
| option_data_list
| client_class
| require_client_classes
+ | evaluate_additional_classes
| user_context
| comment
| unknown_map_entry
@@ -840,6 +844,7 @@ This grammar is generated from ``dhcp4_parser.yy``. See :ref:`dhcp4` for more de
| client_class_test
| client_class_template_test
| only_if_required
+ | only_in_additional_list
| option_def_list
| option_data_list
| next_server
@@ -861,6 +866,8 @@ This grammar is generated from ``dhcp4_parser.yy``. See :ref:`dhcp4` for more de
only_if_required ::= "only-if-required" ":" BOOLEAN
+ only_in_additional_list ::= "only-in-additional-list" ":" BOOLEAN
+
dhcp4o6_port ::= "dhcp4o6-port" ":" INTEGER
control_socket ::= "control-socket" ":" "{" control_socket_params "}"
diff --git a/doc/sphinx/grammar/grammar-dhcp6-parser.rst b/doc/sphinx/grammar/grammar-dhcp6-parser.rst
index 22d8402329..63c33e391a 100644
--- a/doc/sphinx/grammar/grammar-dhcp6-parser.rst
+++ b/doc/sphinx/grammar/grammar-dhcp6-parser.rst
@@ -314,11 +314,7 @@ This grammar is generated from ``dhcp6_parser.yy``. See :ref:`dhcp6` for more de
| cipher_list
| unknown_map_entry
- database_type ::= "type" ":" db_type
-
- db_type ::= "memfile"
- | "mysql"
- | "postgresql"
+ database_type ::= "type" ":" STRING
user ::= "user" ":" STRING
@@ -512,6 +508,7 @@ This grammar is generated from ``dhcp6_parser.yy``. See :ref:`dhcp6` for more de
| rapid_commit
| client_class
| require_client_classes
+ | evaluate_additional_classes
| reservations
| reservations_global
| reservations_in_subnet
@@ -551,6 +548,8 @@ This grammar is generated from ``dhcp6_parser.yy``. See :ref:`dhcp6` for more de
require_client_classes ::= "require-client-classes" ":" list_strings
+ evaluate_additional_classes ::= "evaluate-additional-classes" ":" list_strings
+
reservations_global ::= "reservations-global" ":" BOOLEAN
reservations_in_subnet ::= "reservations-in-subnet" ":" BOOLEAN
@@ -589,6 +588,7 @@ This grammar is generated from ``dhcp6_parser.yy``. See :ref:`dhcp6` for more de
| reservations_out_of_pool
| client_class
| require_client_classes
+ | evaluate_additional_classes
| preferred_lifetime
| min_preferred_lifetime
| max_preferred_lifetime
@@ -700,6 +700,7 @@ This grammar is generated from ``dhcp6_parser.yy``. See :ref:`dhcp6` for more de
| option_data_never_send
| user_context
| comment
+ | option_data_client_classes
| unknown_map_entry
option_data_name ::= name
@@ -716,6 +717,8 @@ This grammar is generated from ``dhcp6_parser.yy``. See :ref:`dhcp6` for more de
option_data_never_send ::= "never-send" ":" BOOLEAN
+ option_data_client_classes ::= "client-classes" ":" list_strings
+
pools_list ::= "pools" ":" "[" pools_list_content "]"
pools_list_content ::=
@@ -738,6 +741,7 @@ This grammar is generated from ``dhcp6_parser.yy``. See :ref:`dhcp6` for more de
| option_data_list
| client_class
| require_client_classes
+ | evaluate_additional_classes
| user_context
| comment
| unknown_map_entry
@@ -774,6 +778,7 @@ This grammar is generated from ``dhcp6_parser.yy``. See :ref:`dhcp6` for more de
| option_data_list
| client_class
| require_client_classes
+ | evaluate_additional_classes
| excluded_prefix
| excluded_prefix_len
| user_context
@@ -862,6 +867,7 @@ This grammar is generated from ``dhcp6_parser.yy``. See :ref:`dhcp6` for more de
| client_class_test
| client_class_template_test
| only_if_required
+ | only_in_additional_list
| option_data_list
| user_context
| comment
@@ -881,6 +887,8 @@ This grammar is generated from ``dhcp6_parser.yy``. See :ref:`dhcp6` for more de
only_if_required ::= "only-if-required" ":" BOOLEAN
+ only_in_additional_list ::= "only-in-additional-list" ":" BOOLEAN
+
server_id ::= "server-id" ":" "{" server_id_params "}"
server_id_params ::= server_id_param
diff --git a/doc/sphinx/kea-messages.rst b/doc/sphinx/kea-messages.rst
index fd14d4e15b..12b49cfd61 100644
--- a/doc/sphinx/kea-messages.rst
+++ b/doc/sphinx/kea-messages.rst
@@ -3623,6 +3623,52 @@ cached version.
DHCP4
*****
+DHCP4_ADDITIONAL_CLASS_EVAL_ERROR
+=================================
+
+.. code-block:: text
+
+ %1: Expression '%2' evaluated to %3
+
+This error message indicates that a problem was encountered while
+evaluating the expression of an additional client class.
+A description of the problem is printed.
+
+DHCP4_ADDITIONAL_CLASS_EVAL_RESULT
+==================================
+
+.. code-block:: text
+
+ %1: Expression '%2' evaluated to %3
+
+Logged at debug log level 50.
+This debug message indicates that the expression of an additional client class has
+been successfully evaluated. The client class name and the result value of the
+evaluation are printed.
+
+DHCP4_ADDITIONAL_CLASS_NO_TEST
+==============================
+
+.. code-block:: text
+
+ additional class %1 has no test expression, adding it to client's classes unconditionally
+
+Logged at debug log level 40.
+This debug message informs that a class was listed for additional evaluation but
+its definition does not include a test expression to evaluate. The class is
+unconditionally added to the query.
+
+DHCP4_ADDITIONAL_CLASS_UNDEFINED
+================================
+
+.. code-block:: text
+
+ additional class %1 has no definition
+
+Logged at debug log level 40.
+This debug message informs that a class is listed for additional evaluation but
+has no definition. The class is ignored.
+
DHCP4_ALREADY_RUNNING
=====================
@@ -5506,52 +5552,6 @@ about the address that the client would like to have allocated.
If there is no hint, the argument should provide the text indicating
that the hint hasn't been sent.
-DHCP4_REQUIRED_CLASS_EVAL_ERROR
-===============================
-
-.. code-block:: text
-
- %1: Expression '%2' evaluated to %3
-
-This error message indicates that there a problem was encountered while
-evaluating an expression of a required client class that was marked as required.
-A description of the problem is printed.
-
-DHCP4_REQUIRED_CLASS_EVAL_RESULT
-================================
-
-.. code-block:: text
-
- %1: Expression '%2' evaluated to %3
-
-Logged at debug log level 50.
-This debug message indicates that the expression of a required client class has
-been successfully evaluated. The client class name and the result value of the
-evaluation are printed.
-
-DHCP4_REQUIRED_CLASS_NO_TEST
-============================
-
-.. code-block:: text
-
- required class %1 has no test expression, adding it to client's classes unconditionally
-
-Logged at debug log level 40.
-This debug message informs that a class was listed for required evaluation but
-its definition does not include a test expression to evaluate. The class is
-unconditionally added to the query.
-
-DHCP4_REQUIRED_CLASS_UNDEFINED
-==============================
-
-.. code-block:: text
-
- required class %1 has no definition
-
-Logged at debug log level 40.
-This debug message informs that a class is listed for required evaluation but
-has no definition. The class is ignored.
-
DHCP4_RESERVATIONS_LOOKUP_FIRST_ENABLED
=======================================
@@ -5900,6 +5900,52 @@ expected: the erroneous response is dropped, the request query is displayed.
DHCP6
*****
+DHCP6_ADDITIONAL_CLASS_EVAL_ERROR
+=================================
+
+.. code-block:: text
+
+ %1: Expression '%2' evaluated to %3
+
+This error message indicates that a problem was encountered while
+evaluating the expression of an additional client class.
+A description of the problem is printed.
+
+DHCP6_ADDITIONAL_CLASS_EVAL_RESULT
+==================================
+
+.. code-block:: text
+
+ %1: Expression '%2' evaluated to %3
+
+Logged at debug log level 50.
+This debug message indicates that the expression of an additional client class has
+been successfully evaluated. The client class name and the result value of the
+evaluation are printed.
+
+DHCP6_ADDITIONAL_CLASS_NO_TEST
+==============================
+
+.. code-block:: text
+
+ additional class %1 has no test expression, adding it to client's classes unconditionally
+
+Logged at debug log level 40.
+This debug message informs that a class was listed for additional evaluation but
+its definition does not include a test expression to evaluate. The class is
+unconditionally added to the query.
+
+DHCP6_ADDITIONAL_CLASS_UNDEFINED
+================================
+
+.. code-block:: text
+
+ additional class %1 has no definition
+
+Logged at debug log level 40.
+This debug message informs that a class is listed for additional evaluation but
+has no definition. The class is ignored.
+
DHCP6_ADD_GLOBAL_STATUS_CODE
============================
@@ -7790,52 +7836,6 @@ client and transaction identification information. The second and third
argument identify the prefix. The fourth and fifth argument hold the
expected IAID and IAID found respectively.
-DHCP6_REQUIRED_CLASS_EVAL_ERROR
-===============================
-
-.. code-block:: text
-
- %1: Expression '%2' evaluated to %3
-
-This error message indicates that there a problem was encountered while
-evaluating an expression of a required client class that was marked as required.
-A description of the problem is printed.
-
-DHCP6_REQUIRED_CLASS_EVAL_RESULT
-================================
-
-.. code-block:: text
-
- %1: Expression '%2' evaluated to %3
-
-Logged at debug log level 50.
-This debug message indicates that the expression of a required client class has
-been successfully evaluated. The client class name and the result value of the
-evaluation are printed.
-
-DHCP6_REQUIRED_CLASS_NO_TEST
-============================
-
-.. code-block:: text
-
- required class %1 has no test expression, adding it to client's classes unconditionally
-
-Logged at debug log level 40.
-This debug message informs that a class was listed for required evaluation but
-its definition does not include a test expression to evaluate. The class is
-unconditionally added to the query.
-
-DHCP6_REQUIRED_CLASS_UNDEFINED
-==============================
-
-.. code-block:: text
-
- required class %1 has no definition
-
-Logged at debug log level 40.
-This debug message informs that a class is listed for required evaluation but
-has no definition. The class is ignored.
-
DHCP6_REQUIRED_OPTIONS_CHECK_FAIL
=================================
@@ -8648,7 +8648,7 @@ DHCPSRV_EVAL_ERROR
%1: Expression '%2' evaluated to %3
-This error message indicates that there a problem was encountered while
+This error message indicates that a problem was encountered while
evaluating an expression of a client class.
A description of the problem is printed.
@@ -9669,6 +9669,18 @@ This warning message is issued when the current server configuration specifies
no interfaces that the server should listen on, or when the specified interfaces are not
configured to receive the traffic.
+DHCPSRV_ONLY_IF_REQUIRED_DEPRECATED
+===================================
+
+.. code-block:: text
+
+ The parameter 'only-if-required' is deprecated. Use 'only-in-additional-list' instead
+
+This warning message is emitted when configuration parsing detects
+the use of the deprecated 'only-if-required' parameter. It has
+been replaced by 'only-in-additional-list'. Users should migrate
+to the new parameter.
+
DHCPSRV_OPEN_SOCKET_FAIL
========================
@@ -9720,6 +9732,18 @@ reverse update is disabled for this lease or the DNS updates are disabled
in the configuration. The first argument includes the client identification
information. The second argument includes the leased address.
+DHCPSRV_REQUIRE_CLIENT_CLASSES_DEPRECATED
+=========================================
+
+.. code-block:: text
+
+ The parameter 'require-client-classes' is deprecated. Use 'evaluate-additional-classes' instead
+
+This warning message is emitted when configuration parsing detects
+the use of the deprecated 'require-client-classes' parameter. It has
+been replaced by 'evaluate-additional-classes'. Users should migrate
+to the new parameter.
+
DHCPSRV_SUBNET4O6_SELECT_FAILED
===============================
@@ -9837,7 +9861,7 @@ DHCPSRV_TEMPLATE_EVAL_ERROR
%1: Expression '%2' evaluated to %3
-This error message indicates that there a problem was encountered while
+This error message indicates that a problem was encountered while
evaluating an expression of a template client class.
A description of the problem is printed.
diff --git a/doc/sphinx/umls.rst b/doc/sphinx/umls.rst
index c31bcb4cf0..0fb695255e 100644
--- a/doc/sphinx/umls.rst
+++ b/doc/sphinx/umls.rst
@@ -1,5 +1,5 @@
..
- Copyright (C) 2020-2023 Internet Systems Consortium, Inc. ("ISC")
+ Copyright (C) 2020-2024 Internet Systems Consortium, Inc. ("ISC")
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this