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:


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

Description:

dhcp-peer host;

Peer host offered by DHCP to clients.

host (type: host)

dhcp-domain name;

Domain name search (option DOMAIN-NAME/DHCP6.DOMAIN-SEARCH).

name (type: str)

dhcp-server-common {


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

        

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 path;

Lease file location.

path (type: str)

default-lease-time seconds;

Default lease time.

seconds (type: uint32)

max-lease-time seconds;

Maximum lease time.

seconds (type: uint32)

domain name;

Domain name search (option DOMAIN-NAME/DHCP6.DOMAIN-SEARCH).

If omitted the system domain name is used.

name (type: str)

name-server host;

Nameserver (option DOMAIN-NAME-SERVERS/DHCP6.NAME-SERVERS).

host (type: host)

time-server host;

Time server (option TIME-SERVERS).

host (type: host)

router host;

Router (option ROUTERS).

host (type: host)

raw line;

Raw global line.

line (type: str)

subnet name {


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

            

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 search (option DOMAIN-NAME/DHCP6.DOMAIN-SEARCH).

If omitted the system domain name is used.

name (type: str)

name-server host;

Nameserver (option DOMAIN-NAME-SERVERS/DHCP6.NAME-SERVERS).

host (type: host)

time-server host;

Time server (option TIME-SERVERS).

host (type: host)

router host;

Router (option ROUTERS).

host (type: host)

disable-failover;

Disable DHCP failover.

raw line;

Raw subnet line.

line (type: str)

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

failover {


  primary ... ;
  secondary ... ;
  max-response-delay ... ;
  max-unacked-updates ... ;
  mclt ... ;
  split ... ;
  lbms ... ;
* raw ... ;
}

            

DHCP failover parameters.

Constraints:

PRIMARY and SECONDARY must be specified.

Items & subsections:

primary addr [port port];

Primary server definition.

addr (type: host)

Listening address of primary server.

port port (type: port, optional, default: 519)

Listening port of secondary server.

secondary addr [port port];

Secondary server definition.

addr (type: host)

Listening address of secondary server.

port port (type: port, optional, default: 520)

Listening port of secondary server.

max-response-delay [sec];

Peer dead timeout (local parameter).

sec (type: uint16, optional, default: 60)

max-unacked-updates [number];

Unresponded messges limit (remote parameter).

number (type: uint16, optional, default: 10)

mclt [sec];

Maximum client lead time (primary parameter).

sec (type: uint16, optional, default: 3600)

split [ratio];

Load balancing split (primary parameter).

ratio (type: uint16, optional, default: 128)

Constraints:

Maximum value 256 is allowed.

lbms [sec];

Load balance maximum seconds.

sec (type: uint16, optional, default: 3)

raw line;

Raw failover line.

line (type: str)

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

[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 ... ;
* raw ... ;
* subnet name { ... }
  failover { ... }
}

        

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

Item lease-file (see above)

Element path is optional, default: "/data/var/db/dhcpd.leases".

dhcp6-server {


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

        

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

Changes to the dhcp6-server section:

Item time-server is not valid.

Item router is not valid.

Section failover is not valid.

Item lease-file (see above)

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

Section subnet (see above)

Item time-server is not valid.

Item router is not valid.

Item disable-failover is not valid.

SEE ALSO

configuration(7), dhcpd.conf(5)