config: set RFC defaults for preferred lifetime
[project/odhcpd.git] / README
diff --git a/README b/README
index 1bcc08777f2bf12e49b62f834f342d559704f626..c8f2eb4234abe2628dba240f844fdb4a0db07dd5 100644 (file)
--- a/README
+++ b/README
@@ -64,6 +64,7 @@ maindhcp      bool    0                       Use odhcpd as the main DHCPv4
                                                service
 leasefile      string                          DHCP/v6 lease/hostfile
 leasetrigger   string                          Lease trigger script
+hostsfile      string                          DHCP/v6 hostfile
 loglevel       integer 6                       Syslog level priority (0-7)
 
 
@@ -73,9 +74,6 @@ Option                        Type    Default                 Description
 interface              string  <name of UCI section>   logical OpenWrt interface
 ifname                 string  <resolved from logical> physical network interface
 networkid              string  same as ifname          compat. alias for ifname
-ignore                 bool    0                       do not serve this interface
-                                                       unless overridden by ra, ndp,
-                                                       dhcpv4 or dhcpv6 options
 master                 bool    0                       is a master interface
                                                        for relaying
 
@@ -90,20 +88,42 @@ ndp                 string  disabled                Neighbor Discovery Proxy
 
 dynamicdhcp            bool    1                       Dynamically create leases
                                                        for DHCPv4 and DHCPv6
+dhcpv4_forcereconf     bool    0                       Force reconfiguration by sending
+                                                       force renew message even if the client
+                                                       did not include the force renew nonce
+                                                       capability option (RFC6704)
+dhcpv6_assignall       bool    1                       Assign all viable DHCPv6 addresses
+                                                       in statefull mode; if disabled
+                                                       only the DHCPv6 address having the
+                                                       longest preferred lifetime is assigned
+dhcpv6_hostidlength    integer 12                      Host ID length of dynamically created leases,
+                                                       allowed values: 12 - 64 (bits).
+dhcpv6_na              bool    1                       DHCPv6 stateful addressing hands out IA_NA -
+                                                               Internet Address - Network Address
+dhcpv6_pd              bool    1                       DHCPv6 stateful addressing hands out IA_PD -
+                                                               Internet Address - Prefix Delegation
+dhcpv6_pd_min_len      integer -                       Minimum prefix length to delegate with IA_PD
+                                                       (value is adjusted if needed to be greater
+                                                       than the interface prefix length).  Range [1,62]
 router                 list    <local address>         Routers to announce
                                                        accepts IPv4 only
 dns                    list    <local address>         DNS servers to announce
                                                        accepts IPv4 and IPv6
+dns_service            bool    1                       Announce the address of interface as DNS service
+                                                       if the list of dns is empty
 domain                 list    <local search domain>   Search domains to announce
 
 leasetime              string  12h                     DHCPv4 address leasetime
 start                  integer 100                     DHCPv4 pool start
 limit                  integer 150                     DHCPv4 pool size
-
+preferred_lifetime     string  7d                      Value for the preferred lifetime
+                                                       for a prefix
 ra_default             integer 0                       Override default route
                        0: default, 1: ignore no public address, 2: ignore all
-ra_management          integer 1                       RA management mode
-                       0: no M-Flag but A-Flag, 1: both M and A, 2: M but not A
+ra_flags               list    other-config            List of RA flags to be
+                                                       advertised in RA messages
+                       [managed-config other-config home-agent none]
+ra_slaac               bool    1                       Announce slaac for a prefix
 ra_offlink             bool    0                       Announce prefixes off-link
 ra_preference          string  medium                  Route(r) preference
                        [medium|high|low]
@@ -118,12 +138,23 @@ ra_useleasetime           bool    0                       Use configured leasetime as
                                                        valid lifetime of a prefix
 ra_reachabletime       integer 0                       Reachable Time in milliseconds to be
                                                        advertised in RA messages
+ra_retranstime         integer 0                       Retransmit Time in milliseconds to be
+                                                       advertised in RA messages
 ra_hoplimit            integer 0                       Current hoplimit to be advertised
                                                        in RA messages
-ra_mtu                 integer 0                       MTU to be advertised in
+ra_mtu                 integer -                       MTU to be advertised in
                                                        RA messages
+ra_dns                 bool    1                       Announce DNS configuration in
+                                                       RA messages (RFC8106)
+ra_pref64              string                          Announce PREF64 option
+                       [IPv6 prefix]                   for NAT64 prefix (RFC8781)
 ndproxy_routing                bool    1                       Learn routes from NDP
 ndproxy_slave          bool    0                       NDProxy external slave
+prefix_filter          string  ::/0                    Only advertise on-link prefixes within
+                       [IPv6 prefix]                   the provided IPv6 prefix; others are
+                                                       filtered out.
+ntp                    list    <local address>         NTP servers to announce
+                                                       accepts IPv4 and IPv6
 
 
 Sections of type host (static leases)