From: Piotrek Zadroga <piotrek@isc.org>
Date: Tue, 23 May 2023 12:35:31 +0000 (+0200)
Subject: [#2834] Doc and ChangeLog update
X-Git-Tag: Kea-2.3.8~21
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=56d954353575403629521fab555a5a6cc44a66a9;p=thirdparty%2Fkea.git

[#2834] Doc and ChangeLog update
---

diff --git a/AUTHORS b/AUTHORS
index becdc33284..9e2e25f36d 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -32,7 +32,7 @@ Primary developers:
  - Slawek Figiel (documentation)
  - Dan Theisen (documentation, option handling, shell scripts)
  - Marcin Godzina (documentation, release engineering, testing)
- - Piotrek Zadroga (documentation, options handling)
+ - Piotrek Zadroga (documentation, options handling, perfdhcp)
 
 Former developers who are no longer active:
  - Stephen Morris (Hooks, MySQL)
diff --git a/ChangeLog b/ChangeLog
index 68dce91759..6bf3810b56 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2142.	[func]		piotrek
+	New command option was added to perfdhcp: --or.
+    It allows to insert extra option(s) to relayed DHCPv6 message
+    at given level of encapsulation. For now only first level of
+    encapsulation is supported.
+    (Gitlab #2834)
+
+
 2141.	[bug]		razvan
 	The High Availability hook library is sending the 'origin'
 	parameter set to 'ha-partner' when sending lease update
@@ -1303,7 +1311,7 @@ Kea 2.0.0 (stable) released on September 29, 2021
 	(Gitlab #2085)
 
 1947.	[bug]		marcin
-	Corrected a bug in the High Availability hooks library that could
+	Corrected a bug in the High Availablity hooks library that could
 	cause a standby server not to synchronize its lease database
 	after a temporary communication interruption with its partner.
 	(Gitlab #1959)
diff --git a/doc/sphinx/man/perfdhcp.8.rst b/doc/sphinx/man/perfdhcp.8.rst
index 222486d3fc..82f41482d9 100644
--- a/doc/sphinx/man/perfdhcp.8.rst
+++ b/doc/sphinx/man/perfdhcp.8.rst
@@ -15,7 +15,7 @@
 Synopsis
 ~~~~~~~~
 
-:program:`perfdhcp` [**-1**] [**-4** | **-6**] [**-A** encapsulation-level] [**-b** base] [**-B**] [**-c**] [**-C** separator] [**-d** drop-time] [**-D** max-drop] [-e lease-type] [**-E** time-offset] [**-f** renew-rate] [**-F** release-rate] [**-g** thread-mode] [**-h**] [**-i**] [**-I** ip-offset] [**-J** remote-address-list-file] [**-l** local-address|interface] [**-L** local-port] [**-M** mac-list-file] [**-n** num-request] [**-N** remote-port] [**-O** random-offset] [**-o** code,hexstring] [**-p** test-period] [**-P** preload] [**-r** rate] [**-R** num-clients] [**-s** seed] [**-S** srvid-offset] [**--scenario** name] [**-t** report] [**-T** template-file] [**-u**] [**-v**] [**-W** exit-wait-time] [**-w** script_name] [**-x** diagnostic-selector] [**-X** xid-offset] [server]
+:program:`perfdhcp` [**-1**] [**-4** | **-6**] [**-A** encapsulation-level] [**-b** base] [**-B**] [**-c**] [**-C** separator] [**-d** drop-time] [**-D** max-drop] [-e lease-type] [**-E** time-offset] [**-f** renew-rate] [**-F** release-rate] [**-g** thread-mode] [**-h**] [**-i**] [**-I** ip-offset] [**-J** remote-address-list-file] [**-l** local-address|interface] [**-L** local-port] [**-M** mac-list-file] [**-n** num-request] [**-N** remote-port] [**-O** random-offset] [**-o** code,hexstring] [**--o1r** code,hexstring] [**-p** test-period] [**-P** preload] [**-r** rate] [**-R** num-clients] [**-s** seed] [**-S** srvid-offset] [**--scenario** name] [**-t** report] [**-T** template-file] [**-u**] [**-v**] [**-W** exit-wait-time] [**-w** script_name] [**-x** diagnostic-selector] [**-X** xid-offset] [server]
 
 Description
 ~~~~~~~~~~~
@@ -357,6 +357,19 @@ The following options only apply for DHCPv6 (i.e. when ``-6`` is given).
    1, which means that the generated traffic is equivalent to the amount of
    traffic passing through a single relay agent.
 
+``--o1r code,hexstring``
+   This option is very similar to ``-o``, only that it forces ``perfdhcp``
+   to insert the specified extra option (or options if used several times)
+   into relayed DHCPv6 message at 1st level of encapsulation. The code
+   specifies the option code and the hexstring is a hexadecimal string that
+   defines the content of the option. Care should be taken as ``perfdhcp``
+   does not offer any kind of logic behind those options; they are simply
+   inserted into packets and sent as is. Be careful not to duplicate
+   options that are already inserted. For example, to insert client
+   class identifier (option code 60) with a string "docsis", use
+   "--o1r 60,646f63736973". The ``--o1r`` may be used multiple times. It must
+   be used together with ``-A``.
+
 Template-Related Options
 ~~~~~~~~~~~~~~~~~~~~~~~~