dhcplt

command module
v0.5.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 20, 2023 License: BSD-2-Clause Imports: 35 Imported by: 0

README

dhcplt

Build Status

dhcplt is a DHCPv4/DHCPv6 load tester for Linux with following features:

  • Using any source mac address and VLAN tags for DHCP packets without provisioning them in OS, this is achieved via using etherconn

  • DHCPv4

    - Support DORA and Release
    - Following DHCPv4 options could be included in request:
          - Client Id
          - Vendor Class
          - Option82 Circuit-Id
          - Option82 Remote-Id
          - Custom option
    
  • DHCPv6:

    - Request for IA_NA and/or IA_PD prefix
    - Send request in relay-forward message to simulate a relayed message, and handle the relay-reply message
    - following DHCPv6 options could be included in request:
          - BBF circuit-id/remote-id (only in relay message)
          - client id 
    - option of sending Router Solicit and expect Router Advertisement with M bit, before starting DHCPv6 
    
  • Flapping: dhcplt support flapping, which repeatly establish and release DHCP leases.

  • performant: test shows that it could do 4k DORA per sec on a single core VM

Usage Example

Note: using dhcplt requires root privilege

  1. 10000 DHCPv4 clients doing DORA on interface eth1, no VLAN, starting MAC address is the eth1 interface mac, increase by 1 for each client
dhcplt -i eth1 -n 10000
  1. on top of example #1, using VLAN tag 100 and SVLAN tag 200, all clients use same VLAN tags
dhcplt -i eth1 -n 10000 -vlan 100 -svlan 200
  1. on top of example #1, specifing starting MAC is aa:bb:cc:11:22:33
dhcplt -i eth1 -n 10000 -mac aa:bb:cc:11:22:33
  1. on top of example #2, starting VLAN tags is 200.100, but each client increase VLAN tag by 1, e.g 2nd is 200.101, 3rd is 200.102..etc
dhcplt -i eth1 -n 10000 -vlan 100 -svlan 200 -vlanstep 1
  1. on top of example #2, launch all clients at once, without waiting interval
dhcplt -i eth1 -n 10000 -vlan 100 -svlan 200 -interval 0s
  1. on top of example #2, include Client-Id option, note "@ID" will be replaced by client index, e.g. first client is "Client-0", 2nd "Client-1", 3rd "Client-2" ..etc;
dhcplt -i eth1 -n 10000 -vlan 100 -svlan 200 -clntid "Client-@ID"
  1. example 1 version for DHCPv6
dhcplt -i eth1 -n 10000 -v4=false -v6=true
  1. example 8 variant, request both IA_NA and IA_PD
dhcplt -i eth1 -n 10000 -v4=false -v6=true -iapd=true -iana=true
  1. example 9 variant, sending RS first
dhcplt -i eth1 -n 10000 -v4=false -v6=true -iapd=true -iana=true -sendrs
  1. example 8 variant, simulating relay
dhcplt -i eth1 -n 10000 -v4=false -v6=true -v6msgtype relay
  1. example 1 variant, 5000 clients flapping
dhcplt -i eth1 -n 10000 -flap 5000 

DORA Result Summary

With action DORA, dhcplt will display a summary of results after it s done like following:

Result Summary
total trans: 500
Success dial:500
Success release:0
Failed trans:0
Duration:815.173804ms
Interval:1ms
Setup rate:613.3661282373594
Fastest dial success:69.320291ms
dial Success within a second:500
Slowest dial success:173.38359ms
Avg dial success time:135.940204ms
  • Total trans: number of DHCPv4 or DHCPv6 transatctions, one DORA or one release is counted as one transaction.
  • Success dial/release: number of success DORA or release transactions.
  • Duration: between launch 1st client and stop of last client
  • Interval: launch interval, specified by "-interval"
  • Setup rate: the number of success DORA / duration in second
  • Fastest/Slowest dial success/Success within a second/slowest success/Avg dial success time: these are amount time of a client complete DORA, e.g fastest dial success means least amount of time a client took to complete DORA

Command Line Parameters

a DHCP load tester
  - applylease: apply assigned address on the interface if true
        default:false
  - cid: BBF circuit-id
  - clntid: client-id
  - customv4option: custom DHCPv4 option, code:value format
  - customv6option: custom DHCPv6 option, code:value format
  - d: enable debug output
        default:false
  - driver: etherconn forward engine
        default:afpkt
  - excludedvlans: a list of excluded VLAN IDs
  - flapmaxinterval: minimal flapping interval
        default:5s
  - flapmininterval: max flapping interval
        default:30s
  - flapnum: number of client flapping
        default:0
  - flapstaydowndur: duriation of stay down
        default:10s
  - i: interface name
  - interval: interval between setup of sessions
        default:1s
  - mac: starting MAC address
  - macstep: amount of increase between two consecutive MAC address
        default:1
  - n: number of clients
        default:1
  - needna: request DHCPv6 IANA if true
        default:false
  - needpd: request DHCPv6 IAPD if true
        default:false
  - profiling: enable profiling, dev use only
        default:false
  - retry: number of setup retry
        default:1
  - rid: BBF remote-id
  - savelease: save the lease if true
        default:false
  - sendrsfirst: send Router Solict first if true
        default:false
  - stackdelay: delay between setup v4 and v6, postive value means setup v4 first, negative means v6 first
        default:0s
  - timeout: setup timout
        default:5s
  - v4: do DHCPv4 if true
        default:true
  - v6: do DHCPv6 if true
        default:false
  - v6msgtype: DHCPv6 exchange type, solict|relay|auto
        default:auto
  - vendorclass: vendor class
  - vlan: starting VLAN ID, Dot1Q or QinQ
  - vlanetype: EthernetType for the vlan tag
        default:33024
  - vlanstep: amount of increase between two consecutive VLAN ID
        default:1

  -cfgfromfile: load configuration from the specified file
        default:dhcplt.conf

  • interval: this is wait interval between launch client DORA
  • all duration type could use syntax that can be parsed by GOlang flag.Duration, like "1s", "1ms"
  • vlanetype are EtherType for the tag as uint16 number
  • customv4option/customv6option: format is ":" for example "60:dhcplt" means include an Option 60 with value as "dhcplt"
  • -v6msgtype: setting the DHCPv6 message type: - solicit - relay - auto: if rid or cid is specified, then it is relay; otherwise solict
  • flapnum: the number of clients flapping
  • flapmaxinterval, flapmininterval: the duration a flapping client stay connected, it is random value between min and max
  • flapstaydowndur: the duration a flapping client stay disconnected.
Config File

Thanks to shouchan, beside using CLI parameters, a YAML config file could also be used via "-f <conf_file>", the content of YAML is the testSetup struct

Documentation

Overview

dhcplt

ndproxy

Directories

Path Synopsis
common
common
conpair
conpair
relay
relay

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL