]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#1132] updating perfdhcp manual with newest options
authorWlodek Wencel <wlodek@isc.org>
Thu, 23 Apr 2020 13:19:06 +0000 (15:19 +0200)
committerFrancis Dupont <fdupont@isc.org>
Thu, 23 Apr 2020 13:37:29 +0000 (15:37 +0200)
doc/sphinx/man/perfdhcp.8.rst

index 6e3d31340d138c9614e026d9cd67fccfa1ad328c..8a011cd5d310acd0359b274536d4559d520a2772 100644 (file)
@@ -116,6 +116,13 @@ points to, and the one which precedes it (random-offset - 1). If the
 number of simulated clients exceeds 65535, three bytes will be
 randomized, and so on.
 
+Perfdhcp can now simulate traffic from multiple subnets by enabling option
+-J and passing path to file that contains v4 addresses that will be used as
+giaddr in generated messages. That enable testing of vast numbers of Kea shared
+networks. Kea should be started with KEA_TEST_SEND_RESPONSES_TO_SOURCE
+environment variable to force Kea to send generated messages to source
+address of incoming packet. Feature is not available in kea-dhcp6.
+
 Templates may currently be used to generate packets being sent to the
 server in 4-way exchanges, i.e. SOLICIT, REQUEST (DHCPv6) and DISCOVER,
 REQUEST (DHCPv4). They cannot be used when RENEW or RELEASE packets are
@@ -134,6 +141,11 @@ Options
 ``-6``
    Establishes DHCPv6 operation. This is incompatible with the ``-4`` option.
 
+``-u``
+   Enable checking address uniqueness. Lease valid lifetime should not be shorter
+   than test duration and clients should not request address more than once without
+   releasing it first.
+
 ``-b basetype=value``
    Indicates the base MAC or DUID used to simulate different clients. The basetype
    may be "mac" or "duid". (The keyword "ether" may alternatively used
@@ -304,6 +316,13 @@ The following options only apply for DHCPv4 (i.e. when ``-4`` is given).
 ``-B``
    Forces broadcast handling.
 
+``-J<giaddr-list-file>``
+    Text file that include multiple addresses. If provided perfdhcp will choose
+    randomly one of addresses for each exchange. This is used to generate traffic
+    from multiple subnets. Designed to test shared-networks in kea-dhcp4. Kea should
+    be started with KEA_TEST_SEND_RESPONSES_TO_SOURCE=ENABLE env variable otherwise
+    perfdhcp will not be able to receive responses.
+
 DHCPv6-Only Options
 ~~~~~~~~~~~~~~~~~~~
 
@@ -384,6 +403,11 @@ Options Controlling a Test
 ``-t interval``
    Sets the delay (in seconds) between two successive reports.
 
+``-C<separator>``
+    Output reduced, an argument is a separator for periodic (-t) reports
+    generated in easy parsable mode. Data output won't be changed,
+    remain identical as in -t option.
+
 Arguments
 ~~~~~~~~~