# Role `kea_dhcp`

Install and manage Kea DHCP and [Stork Agent](https://stork.readthedocs.io/en/latest/man/stork-agent.8.html).

## Supported Distributions

Should work on Debian-based distributions.

## Required Arguments

None.

## Optional Arguments

- `kea_dhcp__stork_agent.enable`: Enable Kea DHCP stork agent.
  Defaults to `false`.
- `kea_dhcp__stork_agent.prometheus_only`: Only enable the prometheus endpoint in stork agent.
  Defaults to `true`.
- `kea_dhcp__dns_servers.v4`: List of IPv4 DNS Servers in DHCP response.
  Defaults to FUX DNS Servers.
- `kea_dhcp__dns_servers.v6`: List of IPv6 DNS Servers in DHCP response.
  Defaults to FUX DNS Servers.
- `kea_dhcp__include_vars`: Path to YAML File to separately load VARs for Kea config templating.
- `kea_dhcp__dhcp4.enable`: Enable Kea DHCP4 Service.
  Defaults to `false`.
- `kea_dhcp__dhcp4.interfaces`: List of interfaces the DHCP4 Server should listen to and serve.
  Defaults to the empty list (`[ ]`).
- `kea_dhcp__dhcp4.control-sockets`: List of Kea DHCP4 control sockets.
  Defaults to the list with one entry (see below).
- `kea_dhcp__dhcp4.control-sockets.*.socket-name`: Control socket name.
  Defaults to `kea_dhcp__dhcp4.control-sockets.0.socket-name: /var/run/kea-dhcp4-ctrl-agent.sock`.
- `kea_dhcp__dhcp4.control-sockets.*.socket-type`: Control socket type.
  Defaults to `kea_dhcp__dhcp4.control-sockets.0.socket-type: unix`.
- `kea_dhcp__dhcp4.lease-database.type`: Type of lease database.
  Defaults to `memfile`.
- `kea_dhcp__dhcp4.lease-database.persist`: Persist the lease database.
  Defaults to `true`.
- `kea_dhcp__dhcp4.option-data`: List of DHCP4 Options.
  Defaults to a list with one entry (see below).
- `kea_dhcp__dhcp4.option-data.*.name`: Name of DHCP4 Option.
  Defaults to `kea_dhcp__dhcp4.option-data.0.name: "domain-name-servers"`.
- `kea_dhcp__dhcp4.option-data.*.code`: DHCP4 Option code.
  Defaults to `kea_dhcp__dhcp4.option-data.0.code: 6`.
- `kea_dhcp__dhcp4.option-data.*.csv-format`: DHCP4 Option as csv format.
  Defaults to `kea_dhcp__dhcp4.option-data.0.csv-format: true`.
- `kea_dhcp__dhcp4.option-data.*.data`: DHCP4 Option data.
  Defaults to `kea_dhcp__dhcp4.option-data.0.data: "{{ kea_dhcp__dns_servers.v4 | join(',') }}"`.
- `kea_dhcp__dhcp4.subnets`: List of subnets the DHCP4 server should manage.
  Defaults to the empty list (`[ ]`).
- `kea_dhcp__dhcp4.subnets.*.id`: ID of interface (starts with 1).
- `kea_dhcp__dhcp4.subnets.*.subnet`: Subnet on interface.
- `kea_dhcp__dhcp4.subnets.*.pools`: List of DHCP pools in subnet.
- `kea_dhcp__dhcp4.subnets.*.pools.*.pool`: DHCP pool in range format.
- `kea_dhcp__dhcp4.subnets.*.reservations`: List of DHCP lease reservations.
- `kea_dhcp__dhcp4.subnets.*.reservations.*.ip-address`: IP address of reservation.
- `kea_dhcp__dhcp4.subnets.*.reservations.*.hostname`: Hostname of reservation.
- `kea_dhcp__dhcp4.subnets.*.reservations.*.hw-address`: Hardware address of reservation.
- `kea_dhcp__dhcp4.subnets.*.option-data`: List of DHCP lease reservations.
- `kea_dhcp__dhcp4.subnets.*.option-data.*.name`: Name of DHCP4 Option.
- `kea_dhcp__dhcp4.subnets.*.option-data.*.code`: DHCP4 Option code.
- `kea_dhcp__dhcp4.subnets.*.option-data.*.csv-format`: DHCP4 Option as csv format.
- `kea_dhcp__dhcp4.subnets.*.option-data.*.data`: DHCP4 Option data.
- `kea_dhcp__dhcp6.enable`: Enable Kea DHCP6 Service.
  Defaults to `false`.
- `kea_dhcp__dhcp6.interfaces`: List of interfaces the DHCP6 Server should listen to and serve.
  Defaults to the empty list (`[ ]`).
- `kea_dhcp__dhcp6.control-sockets`: List of Kea DHCP6 control sockets.
  Defaults to the list with one entry (see below).
- `kea_dhcp__dhcp6.control-sockets.*.socket-name`: Control socket name.
  Defaults to `kea_dhcp__dhcp6.control-sockets.0.socket-name: /var/run/kea-dhcp6-ctrl-agent.sock`.
- `kea_dhcp__dhcp6.control-sockets.*.socket-type`: Control socket type.
  Defaults to `kea_dhcp__dhcp6.control-sockets.0.socket-type: unix`.
- `kea_dhcp__dhcp6.lease-database.type`: Type of lease database.
  Defaults to `memfile`.
- `kea_dhcp__dhcp6.lease-database.persist`: Persist the lease database.
  Defaults to `true`.
- `kea_dhcp__dhcp6.option-data`: List of DHCP6 Options.
  Defaults to a list with one entry (see below).
- `kea_dhcp__dhcp6.option-data.*.name`: Name of DHCP6 Option.
  Defaults to `kea_dhcp__dhcp6.option-data.0.name: "domain-name-servers"`.
- `kea_dhcp__dhcp6.option-data.*.code`: DHCP6 Option code.
  Defaults to `kea_dhcp__dhcp6.option-data.0.code: 6`.
- `kea_dhcp__dhcp6.option-data.*.csv-format`: DHCP6 Option as csv format.
  Defaults to `kea_dhcp__dhcp6.option-data.0.csv-format: true`.
- `kea_dhcp__dhcp6.option-data.*.data`: DHCP6 Option data.
  Defaults to `kea_dhcp__dhcp6.option-data.0.data: "{{ kea_dhcp__dns_servers.v6 | join(',') }}"`.
- `kea_dhcp__dhcp6.subnets`: List of subnets the DHCP6 server should manage.
  Defaults to the empty list (`[ ]`).
- `kea_dhcp__dhcp6.subnets.*.id`: ID of interface (starts with 1).
- `kea_dhcp__dhcp6.subnets.*.subnet`: Subnet on interface.
- `kea_dhcp__dhcp6.subnets.*.pools`: List of DHCP pools in subnet.
- `kea_dhcp__dhcp6.subnets.*.pools.*.pool`: DHCP pool in range format.
- `kea_dhcp__dhcp6.subnets.*.reservations`: List of DHCP lease reservations.
- `kea_dhcp__dhcp6.subnets.*.reservations.*.ip-address`: IP address of reservation.
- `kea_dhcp__dhcp6.subnets.*.reservations.*.hostname`: Hostname of reservation.
- `kea_dhcp__dhcp6.subnets.*.reservations.*.hw-address`: Hardware address of reservation.
- `kea_dhcp__dhcp6.subnets.*.option-data`: List of DHCP lease reservations.
- `kea_dhcp__dhcp6.subnets.*.option-data.*.name`: Name of DHCP6 Option.
- `kea_dhcp__dhcp6.subnets.*.option-data.*.code`: DHCP6 Option code.
- `kea_dhcp__dhcp6.subnets.*.option-data.*.csv-format`: DHCP6 Option as csv format.
- `kea_dhcp__dhcp6.subnets.*.option-data.*.data`: DHCP6 Option data.