Kea DHCP : Use Kea Control Agent2026/04/24 |
|
To start Kea control agent, it allows you to manage Kea DHCP via API. |
|
| [1] | Install and Start Kea control agent. |
|
root@dlp:~#
apt -y install kea-ctrl-agent # select [configured_password] +---------+ Configuring kea-ctrl-agent +----------+ | Kea control agent authentication configuration | | | | do_nothing | | configured_random_password | | configured_password | | | | | | <Ok> | | | +-------------------------------------------------+ # set admin password for kea-ctrl-agent +--------------------+ Configuring kea-ctrl-agent +--------------------+ | This password will be stored in the /etc/kea/kea-api-password file. | | | | NOTE: if the password is empty, no action will be taken. | | | | New password for the kea control agent "kea_api" user: | | | | ********____________________________________________________________ | | | | <Ok> | | | +----------------------------------------------------------------------+
root@dlp:~#
vi /etc/kea/kea-dhcp4.conf
"Dhcp4": {
# add follows
"control-socket": {
"socket-type": "unix",
"socket-name": "/run/kea/kea4-ctrl-socket"
},
.....
.....
root@dlp:~#
vi /etc/kea/kea-ctrl-agent.conf
# line 20 : listening IP address
"http-host": "127.0.0.1",
# line 27 : listening port
"http-port": 8000,
root@dlp:~# systemctl restart kea-dhcp4-server kea-ctrl-agent |
| [2] | This is an example of using command via API. |
|
root@dlp:~# curl -u kea-api -s -H "Content-Type: application/json" -d '{"command": "list-commands", "service": ["dhcp4"]}' localhost:8000 | jq
Enter host password for user 'kea-api': # enter the admin password you set during the installation
[
{
"arguments": [
"build-report",
"config-backend-pull",
"config-get",
"config-hash-get",
"config-reload",
"config-set",
"config-test",
"config-write",
"dhcp-disable",
"dhcp-enable",
"leases-reclaim",
"list-commands",
"server-tag-get",
"shutdown",
"statistic-get",
"statistic-get-all",
"statistic-remove",
"statistic-remove-all",
"statistic-reset",
"statistic-reset-all",
"statistic-sample-age-set",
"statistic-sample-age-set-all",
"statistic-sample-count-set",
"statistic-sample-count-set-all",
"status-get",
"subnet4-select-test",
"subnet4o6-select-test",
"version-get"
],
"result": 0
}
]
root@dlp:~# curl -u kea-api -s -H "Content-Type: application/json" -d '{"command": "config-get", "service": ["dhcp4"]}' localhost:8000 | jq
Enter host password for user 'kea-api':
[
{
"arguments": {
"Dhcp4": {
"allocator": "iterative",
"authoritative": false,
"boot-file-name": "",
"cache-threshold": 0.25,
"calculate-tee-times": false,
"control-sockets": [
{
"socket-name": "/run/kea/kea4-ctrl-socket",
"socket-type": "unix"
}
],
.....
.....
root@dlp:~# curl -u kea-api -s -H "Content-Type: application/json" -d '{"command": "statistic-get-all", "service": ["dhcp4"]}' localhost:8000 | jq
Enter host password for user 'kea-api':
[
{
"arguments": {
"cumulative-assigned-addresses": [
[
0,
"2026-04-24 10:34:10.576390"
]
],
"declined-addresses": [
[
0,
"2026-04-24 10:34:10.576388"
]
],
"pkt4-ack-received": [
[
0,
"2026-04-24 10:34:10.570109"
]
],
.....
.....
|
| Sponsored Link |
|
|