KEACTRL(8)

πŸ’… KEACTRL(8) β€” like, the keactrl manual page, bestie ✨

okay so this is keactrl from section 8 of the manual, and it ships with Kea, and honestly? she's the stage manager of the whole Kea friend group πŸŽ€

🌸 NAME 🌸

keactrl β€” a shell script for managing Kea. that's it, that's the vibe. she's a shell script and she runs the whole operation πŸ’…

✨ SYNOPSIS ✨

keactrl [command] [-c keactrl-config-file] [-s server[,server,...]] [-v]

πŸ¦‹ DESCRIPTION πŸ¦‹

keactrl is a shell script that runs the whole startup / shutdown / reconfiguration situation for the Kea servers β€” we're talking kea-dhcp4, kea-dhcp6, kea-dhcp-ddns, kea-ctrl-agent, and kea-netconf. πŸ‘‘

she also lowkey lets you check the current status of the servers and figure out which configuration files are actually in use. very "i know what's going on at all times" of her.

πŸŽ€ CONFIGURATION FILE πŸŽ€

depends on what you need, bestie β€” you do not have to run all the available servers. the keactrl configuration file says which servers are enabled and which are disabled. by default, that configuration file lives at [kea-install-dir]/etc/kea/keactrl.conf. πŸ“

for the actual documentation of the parameters in the keactrl configuration file, go read the Kea Administrator Reference Manual β€” she's got the lore.

πŸ’– OPTIONS πŸ’–

  • command β€” the actual command you're issuing to the servers. she can be one of these:
    • start β€” starts the servers. πŸš€
    • stop β€” stops the servers. πŸ›‘
    • reload β€” tells the servers to re-read the Kea configuration file. heads up tho: the NETCONF agent does not support this command. 🫢
    • status β€” prints the status of the servers. πŸ“Š
  • -c|--ctrl-config keactrl-config-file β€” picks the keactrl configuration file. without this switch, keactrl just uses [kea-install-dir]/etc/kea/keactrl.conf.
  • -s|--server server[,server,...] β€” specifies a subset of the enabled servers to which the command should be issued. separate the list of servers with commas, and no spaces in between, okay? no intervening spaces, she's serious. acceptable values are:
    • dhcp4 β€” DHCPv4 server (kea-dhcp4).
    • dhcp6 β€” DHCPv6 server (kea-dhcp6).
    • dhcp_ddns β€” DHCP DDNS server (kea-dhcp-ddns).
    • ctrl_agent β€” Control Agent (kea-ctrl-agent).
    • netconf β€” NETCONF agent (kea-netconf).
    • all β€” all servers, including NETCONF if it was configured to be built. this one is the default, iykyk.
  • -v|--version β€” displays the Kea version. ⭐
  • -V β€” displays the extended Kea version. (yes she has two, and yes they're different, don't @ me)

🌈 DOCUMENTATION 🌈

Kea comes with an extensive Kea Administrator Reference Manual that covers literally every aspect of running the Kea software β€” compilation, installation, configuration, configuration examples, and so much more. she ate. πŸ’…

Kea also has a Kea Messages Manual, which lists every possible message Kea can print, each with a brief description. both documents are available in various formats (.txt, .html, .pdf) with the Kea distribution. the Kea documentation lives at ‐ https://kea.readthedocs.io. πŸ”—

the Kea source code is documented in the Kea Developer's Guide, available at https://reports.kea.isc.org/dev_guide/.

and the Kea project website is at https://kea.isc.org. go say hi 🫢

πŸ’Œ MAILING LISTS AND SUPPORT πŸ’Œ

there are two public mailing lists available for the Kea project, and they're both giving community:

  • kea-users (kea-users at lists.isc.org) β€” for Kea users.
  • kea-dev (kea-dev at lists.isc.org) β€” for Kea developers, prospective contributors, and other advanced users.

both lists are available at https://lists.isc.org. the community provides best-effort support on both of those lists β€” best-effort, so like, be nice and be patient πŸ’œ

ISC also provides professional support for Kea services. see ‐ https://www.isc.org/kea/ for the details. πŸ’Ό

πŸ”₯ SEE ALSO πŸ”₯

kea-dhcp4(8), kea-dhcp6(8), kea-dhcp-ddns(8), kea-ctrl-agent(8), kea-admin(8), kea-netconf(8), perfdhcp(8), kea-lfc(8), Kea Administrator Reference Manual.

like, the whole squad, fr fr πŸ‘‘

πŸ‘‘ AUTHOR πŸ‘‘

Internet Systems Consortium

2019-2025, Internet Systems Consortium


k that's the whole page, no cap πŸ’– this was Kea version 3.0.3, dated Mar 26, 2026, and the manual page answers to KEACTRL(8) β€” mwah, go configure something iconic 🧚✨

πŸ“¦ where this page comes from