table of contents
PERFDHCP(8) | Kea | PERFDHCP(8) |
NAME¶
perfdhcp - DHCP benchmarking toolSYNOPSIS¶
perfdhcp [-1] [-4|-6] [-A encapsulation-level] [-a aggressivity] [-b base] [-B] [-c] [-d drop-time] [-D max-drop] [-e lease-type] [-E time-offset] [-f renew-rate] [-F release-rate] [-h] [-i] [-I ip-offset] [-l local-address|interface] [-L local-port] [-M mac-list-file] [-n num-request] [-O random-offset] [-p test-period] [-P preload] [-r rate] [-R num-clients] [-s seed] [-S srvid-offset] [-t report] [-T template-file] [-v] [-W wrapped] [-x diagnostic-selector] [-X xid-offset] [server]
DESCRIPTION¶
perfdhcp is a DHCP benchmarking tool. It provides a way of measuring the performance of DHCP servers by generating large amounts of traffic from simulated multiple clients. It is able to test both IPv4 and IPv6 servers, and provides statistics concerning response times and the number of requests that are dropped.By default, tests are run using the full four-packet exchange sequence (DORA for DHCPv4, SARR for DHCPv6). An option is provided to run tests using the initial two-packet exchange (DO and SA) instead. It is also possible to configure perfdhcp to send DHCPv6 RENEW and RELEASE messages at a specified rate in parallel with the DHCPv6 four-way exchanges.
When running a performance test, perfdhcp will exchange packets with the server under test as fast as possible unless the -r is given to limit the request rate. The length of the test can be limited by setting a threshold on any or all of the number of requests made by perfdhcp, the elapsed time, or the number of requests dropped by the server.
TEMPLATES¶
To allow the contents of packets sent to the server to be customized, perfdhcp allows the specification of template files that determine the contents of the packets. For example, the customized packet may contain a DHCPv6 ORO to request a set of options to be returned by the server, or it may contain the Client FQDN option to request that server performs DNS updates. This may be used to discover performance bottlenecks for different server configurations (e.g. DDNS enabled or disabled).Up to two template files can be specified on the command line, each file representing the contents of a particular type of packet, the type being determined by the test being carried out. For example, if testing DHCPv6:
(Similar determination applies to DHCPv4's DISCOVER and REQUEST packets.)
The template file holds the DHCP packet represented as a stream of ASCII hexadecimal digits and it excludes any IP/UDP stack headers. The template file must not contain any characters other than hexadecimal digits and spaces. Spaces are discarded when the template file is parsed (so in the file, '12B4' is the same as '12 B4' which is the same as '1 2 B 4')
The template files should be used in conjunction with the command line parameters which specify offsets of the data fields being modified in outbound packets. For example, the -E time-offset switch specifies the offset of the DHCPv6 Elapsed Time option in the packet template. If the offset is specified, perfdhcp will inject the current elapsed time value into this field before sending the packet to the server.
In many scenarios, perfdhcp needs to simulate multiple clients (having unique client identifier). Since packets for each client are generated from the same template file, it is necessary to randomize the client identifier (or HW address in DHCPv4) in the packet created from it. The -O random-offset option allows specification of the offset in the template where randomization should be performed. It is important to note that this offset points to the end (not the beginning) of the client identifier (or HW address field). The number of bytes being randomized depends on the number of simulated clients. If the number of simulated clients is between 1 and 255, only one byte (to which randomization offset points) will be randomized. If the number of simulated clients is between 256 and 65535, two bytes will be randomized. Note, that two last bytes of the client identifier will be randomized in this case: the byte which randomization offset parameter 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.
Templates may be currently 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 being sent.
OPTIONS¶
-1-4
-6
-a aggressivity
-b basetype=value
-d drop-time
-e lease-type
address-only
prefix-only
address-and-prefix
The -e prefix-only and -e address-and-prefix forms may not be used with the -4 option.
-f renew-rate
-h
-i
-i is incompatible with the following options: -1, -d, -D, -E, -S, -I and -F. In addition, it cannot be used with multiple instances of -O, -T and -X.
-l local-addr|interface
-L local-port
-M mac-list-file
-P preload
-r rate
-R num-clients
-s seed
-T template-file
-v
-w wrapped
-x diagnostic-selector
a
e
i
s
t
T
DHCPv4-Only Options¶
The following options only apply for DHCPv4 (i.e. when -4 is given).-B
DHCPv6-Only Options¶
The following options only apply for DHCPv6 (i.e. when -6 is given).-c
-F release-rate
-A encapsulation-level
Template-Related Options¶
The following options may only be used in conjunction with -T and control how perfdhcp modifies the template. The options may be specified multiple times on the command line; each occurrence affects the corresponding template file (see "TEMPLATES" above).-E time-offset
-I ip-offset
-O random-offset
-S srvid-offset
-X xid-offset
Options Controlling a Test¶
The following options may only be used in conjunction with -r and control both the length of the test and the frequency of reports.-D max-drop
-n num-requests
-p test-period
-t interval
Arguments¶
serverERRORS¶
perfdhcp can report the following errors in the packet exchange:tooshort
orphans
locallimit
EXIT STATUS¶
perfdhcp can exit with one of the following status codes:0
1
2
3
MAILING LISTS AND SUPPORT¶
There are two mailing lists available for Kea project. kea-users (kea-users at lists.isc.org) is intended for Kea users, while kea-dev (kea-dev at lists.isc.org) is intended for Kea developers, prospective contributors and other advanced users. Both lists are available at http://lists.isc.org. The community provides best effort type of support on both of those lists.ISC provides professional support for Kea services. See https://www.isc.org/kea/ for details.
HISTORY¶
The perfdhcp tool was initially coded in October 2011 by John DuBois, Francis Dupont and Marcin Siodelski of ISC. Kea 1.0.0 that included perfdhcp was released in December 2015.SEE ALSO¶
kea-dhcp4(8), kea-dhcp6(8), kea-dhcp-ddns(8), kea-admin(8), keactrl(8), kea-lfc(8), Kea Administrator's Guide.AUTHOR¶
The Kea software has been written by a number of engineers working for ISC: Tomek Mrugalski, Stephen Morris, Marcin Siodelski, Thomas Markwalder, Francis Dupont, Jeremy C. Reed, Wlodek Wencel and Shawn Routhier. That list is roughly in the chronological order in which the authors made their first contribution. For a complete list of authors and contributors, see AUTHORS file.
COPYRIGHT¶
Copyright © 2016 Internet Systems Consortium, Inc. ("ISC")Sep. 28, 2016 | ISC Kea 1.1.0 |