Name

dhcp-server — format of dhcp-server component configuration

DESCRIPTION

General syntax rules of Kernun Firewall configuration files are described in configuration(7). This man page describes types, sections and items specific for the dhcp-server component configuration.

Repeatable sections/items are marked by the '*' before section/item name.

TYPES

Configuration directives have attributes of several value-types. For the basic types description, see configuration(7).

ITEMS AND SECTIONS

Configuration of dhcp-server library component consists of following prototypes:


* peer-spec ... ;
  dhcp-server-common { ... }
  dhcp-server { ... }
  dhcp6-server { ... }
    

Description:

peer-spec host;

Peer host offered by DHCP to clients.

host (type: host)

dhcp-server-common {


  phase ... ;
* tag ... ;
  lease-file ... ;
  default-lease-time ... ;
  max-lease-time ... ;
}

        

DHCP server configuration.

Global parameters are defined here, MAC to IP address assignment and special options are set within HOSTS-TABLE section. There are separate servers for IPv4 (section DHCP-SERVER) and IPv6 (section DHCP6-SERVER)

For configuration attributes details, see dhcpd.conf(5).

Items & subsections:

phase [number];

Application Startup Phase.

number (type: uint8, optional, default: 40)

Phase number; the lower one, the earlier start.

tag value;

Configuration factorization tag.

This feature allows admin to create groups of Kernun applications (specially proxies and servers) according to various aspects (belonging to one customer, applications of particular network traffic etc.).

Each application can have several tag attributes and the KAT tool can run some commands (like 'ps', 'start' atc.) for applications with or without given tag.

value (type: str)

Constraints:

Tag must contain letters, digits, hyphens and dots, only.

lease-file [name];

Lease file location.

name (type: str, optional, default: "/var/db/dhcpd.leases")

default-lease-time seconds;

Default lease time.

seconds (type: uint32)

max-lease-time seconds;

Maximum lease time.

seconds (type: uint32)

[End of section dhcp-server-common description.]

dhcp-server {


  phase ... ;
* tag ... ;
  lease-file ... ;
  default-lease-time ... ;
  max-lease-time ... ;
  domain ... ;
* name-server ... ;
* time-server ... ;
* router ... ;
* subnet name { ... }
}

        

The dhcp-server section is derived from dhcp-server-common section prototype. For detail description of it, see above.

Added items & subsections:

domain name;

Server domain name (option DOMAIN-NAME).

If omitted, SYSTEM.DOMAIN used.

name (type: str)

name-server host;

Nameserver (option DOMAIN-NAME-SERVERS).

host (type: host)

time-server host;

Time server (option TIME-SERVERS).

host (type: host)

router host;

Router (option ROUTERS).

host (type: host)

subnet name {


  address ... ;
  range ... ;
  domain ... ;
* name-server ... ;
* time-server ... ;
* router ... ;
}

            

Subnet definition.

Constraints:

Address must be specified.

Items & subsections:

address net;

net (type: net)

range lo hi;

lo (type: host)

hi (type: host)

domain name;

Domain name (option DOMAIN-NAME).

name (type: str)

name-server host;

Nameserver (option DOMAIN-NAME-SERVERS).

host (type: host)

time-server host;

Time server (option TIME-SERVERS).

host (type: host)

router host;

Router (option ROUTERS).

host (type: host)

[End of section dhcp-server.subnet description.]

[End of section dhcp-server description.]

dhcp6-server {


  phase ... ;
* tag ... ;
  lease-file ... ;
  default-lease-time ... ;
  max-lease-time ... ;
* domain-search ... ;
* name-server ... ;
* subnet name { ... }
}

        

The dhcp6-server section is derived from dhcp-server-common section prototype. For detail description of it, see above.

Item lease-file (see above)

Element name is optional, default: "/var/db/dhcpd6.leases".

Added items & subsections:

domain-search name;

A domain from the search list (option DHCP6.DOMAIN-SEARCH). If omitted, SYSTEM.DOMAIN is used.

name (type: str)

name-server host;

Nameserver (option DHCP6.NAME-SERVERS).

host (type: host)

subnet name {


  address ... ;
  range ... ;
* domain-search ... ;
* name-server ... ;
}

            

Subnet definition.

Constraints:

Address must be specified.

Items & subsections:

address net;

net (type: net)

range lo hi;

lo (type: host)

hi (type: host)

domain-search name;

A domain from the search list (option DHCP6.DOMAIN-SEARCH).

name (type: str)

name-server host;

Nameserver (option DHCP6.NAME-SERVERS).

host (type: host)

[End of section dhcp6-server.subnet description.]

[End of section dhcp6-server description.]

SEE ALSO

configuration(7), dhcpd.conf(5), dhcpd(8)