Jagornet DHCP Server User Guide - Community Edition v2.0.5

Copyright © 2016 Jagornet Technologies, LLC

07/06/2016

• Jagornet Technologies Website: http://www.jagornet.com

• Jagornet DHCP Community Server on Github: https://github.com/jagornet/dhcp

• Certified IPv6 Phase II DHCPv6 server - IPv6 Ready Logo

• Core DHCPv6 RFCs:

  • Stateful DHCPv6 - RFC 3315

  • Prefix Delegation - RFC 3633

  • DNS Options - RFC 3646

  • Stateless DHCPv6 - RFC 3736

• Core DHCPv4 RFCs:

  • DHCPv4 - RFC 2131

  • DHCPv4 Options - RFC 2132

• Other

  • Dynamic DNS for DHCPv6/v4 - RFC 4703, RFC 4704

  • Highly-scalable, multithreaded architecture using Netty

  • Flexible, XML configuration file format - Schema

  • Java Management Extensions (JMX) support - JDK 6 JMX

1. Create the installation directory on the host system and expand the compressed installation file for your target platform.

   • Linux/Unix/Mac

     • Installation folder: /opt/jagornet

     • Compressed install file: jagornet-dhcpserver-2.0.5.tar.gz

     • JAGORNET_DHCP_HOME=/opt/jagornet/jagornet-dhcpserver-2.0.5

   • Windows

     • Installation folder: C:\jagornet

     • Compressed install file: jagornet-dhcpserver-2.0.5.zip

     • JAGORNET_DHCP_HOME=C:\jagornet\jagornet-dhcpserver-2.0.5

2. After extracting the compressed files, a jagornet-dhcpserver-2.0.5 directory will be created in the installation folder, with the following contents.

   • JAGORNET_DHCP_HOME/bin - executable command line files. See the section on Running the Server.

   • JAGORNET_DHCP_HOME/conf - configuration files. See the section on Configuration.

   • JAGORNET_DHCP_HOME/db - database directory. See the section on Binding Database.

   • JAGORNET_DHCP_HOME/docs - documentation files.

   • JAGORNET_DHCP_HOME/lib - Java library files.

   • JAGORNET_DHCP_HOME/log - server output files. See the section on Logging.

Note

To start the Jagornet DHCP Server, you must have superuser or administrator access rights on the host system because the server must bind to privileged port numbers 67 for DHCPv4 and 547 for DHCPv6 to service client requests. Optionally, the server can be instructed to bind to a different port numbers for testing purposes only. See the Startup Options for more information.

Please also note that your host system's firewall must be configured to enable inbound and outbound traffic for the UDP ports of the DHCPv4 and DHCPv6 server.

The main Java class of the Jagornet DHCP Server supports the following usage:

usage: com.jagornet.dhcp.server.JagornetDhcpServer [options]
Jagornet DHCP Server Community Edition 2.0.5
Copyright Jagornet Technologies, LLC 2009-2016.  All Rights Reserved.  
-4b,--v4bcast <interface>         DHCPv4 broadcast support (default = none).
                                    Use this option to specify the interface for
                                    the server to receive and send broadcast
                                    DHCPv4 packets. Only one interface may be
                                    specified. All other interfaces on the host
                                    will only receive and send unicast traffic.
                                    The default IPv4 address on the specified
                                    interface will be used for determining the
                                    DHCPv4 client link within the server
                                    configuration file.
-4p,--v4port <portnum>            DHCPv4 Port number (default = 67).
-4u,--v4ucast <addresses>         DHCPv4 Unicast addresses (default = all IPv4
                                    addresses). Use this option to instruct the
                                    server to bind to a specific list of IPv4
                                    addresses, separated by spaces. These
                                    addresses should be configured on one or
                                    more DHCPv4 relay agents connected to DHCPv4
                                    client links.
-6m,--v6mcast <interfaces>        DHCPv6 Multicast support (default = none).
                                    Use this option without arguments to
                                    instruct the server to bind to all
                                    multicast-enabled IPv6 interfaces on the
                                    host. Optionally, use arguments to list
                                    specific interfaces, separated by spaces.
-6p,--v6port <portnum>            DHCPv6 Port number (default = 547).
-6u,--v6ucast <addresses>         DHCPv6 Unicast addresses (default = all IPv6
                                    addresses). Use this option to instruct the
                                    server to bind to a specific list of global
                                    IPv6 addresses, separated by spaces. These
                                    addresses should be configured on one or
                                    more DHCPv6 relay agents connected to DHCPv6
                                    client links.
-?,--help                         Show this help page.
-c,--configfile <filename>        Configuration file (default = 
                                    $JAGORNET_DHCP_HOME/conf/dhcpserver.xml).
-li,--list-interfaces             Show detailed host interface list, then
                                    exit.
-tc,--test-configfile <filename>  Test configuration file, then exit.
-v,--version                      Show version information, then exit.

The $JAGORNET_DHCP_HOME/bin/dhcpserver script can be used to operate the server from a command shell. This script supports the following options:

Startup examples:

• global policies and options

• global filters

  • filter policies and options

• links

  • link policies and options

  • v6address/v6prefix/v4 pools

    • pool policies and options

    • pool filters

      • pool filter policies and options

  • link filters

    • link filter policies and options

    • link filter v6address/v6prefix/v4 pools

      • link filter pool policies and options

Table 3.1. Policies

The Server Identifier Option is required by the DHCPv6 protocol for the server to include in reply packets. The v6ServerIdOption must be specified in the conf/dhcpserver.xml file. The default conf/dhcpserver.xml file supplied with the Jagornet DHCP server specifies an empty DHCPv6 server identifier option as follows:

<?xml version="1.0" encoding="UTF-8"?>

<dhc:dhcpServerConfig xmlns:dhc="http://jagornet.com/dhcp/xml">

    <v6ServerIdOption>
        <opaqueData>
            <hexValue/>
        </opaqueData>
    </v6ServerIdOption>

</dhc:dhcpServerConfig>

Using this default configuration, a DUID-LLT, as defined by section 9.2 of RFC 3315, will be automatically generated by the Jagornet DHCP server upon initial startup. This will cause the conf/dhcpserver.xml file to be rewritten with the generated serverIdOption, for example:

<?xml version="1.0" encoding="UTF-8"?>

<dhc:dhcpServerConfig xmlns:dhc="http://jagornet.com/dhcp/xml">

  <v6ServerIdOption>
    <opaqueData>
        <hexValue>0001000149EFC509001E52C94D49</hexValue>
    </opaqueData>
  </v6ServerIdOption>

</dhc:dhcpServerConfig>

This is the recommended way to create a server identifier. Optionally, the v6ServerIdOption can be specified using the asciiValue of an opaque data option type, for example:

<?xml version="1.0" encoding="UTF-8"?>

<dhc:dhcpServerConfig xmlns:dhc="http://jagornet.com/dhcp/xml">

    <v6ServerIdOption>
        <opaqueData>
            <asciiValue>Jagornet-DHCPv6</asciiValue>
        </opaqueData>
    </v6ServerIdOption>

</dhc:dhcpServerConfig>

Whichever method is chosen to create the server identifier, it should not be changed once it has been created.

The Server Identifier Option is required by the DHCPv4 protocol for the server to include in reply packets. The identifier is an IPv4 address which DHCPv4 clients will send unicast requests to. The v4ServerIdOption must be specified in the conf/dhcpserver.xml file. The default conf/dhcpserver.xml file supplied with the Jagornet DHCP server specifies an empty DHCPv4 server identifier option as follows:

<?xml version="1.0" encoding="UTF-8"?>

<dhc:dhcpServerConfig xmlns:dhc="http://jagornet.com/dhcp/xml">

    <v4ServerIdOption>
        <ipAddress/>
    </v4ServerIdOption>

</dhc:dhcpServerConfig>

Using this default configuration, the default IP address of the host will be set for the DHCPv4 server identifier by the Jagornet DHCP server upon initial startup. This will cause the conf/dhcpserver.xml file to be rewritten with the populated v4ServerIdOption, for example:

<?xml version="1.0" encoding="UTF-8"?>

<dhc:dhcpServerConfig xmlns:dhc="http://jagornet.com/dhcp/xml">

  <v4ServerIdOption>
    <ipAddress>10.10.10.10</ipAddress>
  </v4ServerIdOption>

</dhc:dhcpServerConfig>

This is the recommended way to create a server identifier. Optionally, the V4ServerIdOption can be specified using the ipAddress element, for example:

<?xml version="1.0" encoding="UTF-8"?>

<dhc:dhcpServerConfig xmlns:dhc="http://jagornet.com/dhcp/xml">

    <v4ServerIdOption>
        <ipAddress>11.11.11.11<ipAddress>
    </v4ServerIdOption>

</dhc:dhcpServerConfig>

Whichever method is chosen to create the server identifier, it should not be changed once it has been created because this address will be used by clients when renewing their lease.

Configuration Options are those options that can be configured for the server to return to clients in reply messages. For example, most network clients will need to know the address of one or more Domain Name System (DNS) servers.

<v6PreferenceOption>
  <unsignedByte>10</unsignedByte>
</v6PreferenceOption>

<v6ServerUnicastOption>
  <ipAddress>2001:db8::1</ipAddress>
</v6ServerUnicastOption>

<v6StatusCodeOption>
  <code>5</code>
  <message>UseMulticast</message>
</v6StatusCodeOption>

<v6VendorInfoOption>
  <enterpriseNumber>999</enterpriseNumber>
  <subOptionList>
    <optionDef code="1" name="VendorSubopt1">
      <stringOption>
        <string>VendorSpecial</string>
      </stringOption>
    </optionDef>
    <optionDef code="2" name="VendorSubopt2">
      <ipAddressOption>
        <ipAddress>2001:db8::999</ipAddress>
      </ipAddressOption>
    </optionDef>
  </subOptionList>
</v6VendorInfoOption>

<v6SipServerDomainNamesOption>
  <domainName>sip.foo.com.</domainName>
  <domainName>sip.bar.com.</domainName>
</v6SipServerDomainNamesOption>

<v6SipServerAddressesOption>
  <ipAddress>2001:db8::1</ipAddress>
  <ipAddress>2001:db8::2</ipAddress>
</v6SipServerAddressesOption>

<v6DnsServersOption>
  <ipAddress>2001:db8::1</ipAddress>
  <ipAddress>2001:db8::2</ipAddress>
</v6DnsServersOption>

<v6DomainSearchListOption>
  <domainName>foo.com.</domainName>
  <domainName>bar.com.</domainName>
</v6DomainSearchListOption>

<v6NisServersOption>
  <ipAddress>2001:db8::1</ipAddress>
  <ipAddress>2001:db8::2</ipAddress>
</v6NisServersOption>

<v6NisPlusServersOption>
  <ipAddress>2001:db8::1</ipAddress>
  <ipAddress>2001:db8::2</ipAddress>
</v6NisPlusServersOption>

<v6NisDomainNameOption>
  <domainName>foo.com.</domainName>
</v6NisDomainNameOption>

<v6NisPlusDomainNameOption>
  <domainName>foo.com.</domainName>
</v6NisPlusDomainNameOption>

<v6SntpServersOption>
  <ipAddress>2001:db8::1</ipAddress>
  <ipAddress>2001:db8::2</ipAddress>
</v6SntpServersOption>

<v6InfoRefreshTimeOption>
  <unsignedInt>3600</unsignedInt>
</v6InfoRefreshTimeOption>

<v6BcmcsDomainNamesOption>
  <domainName>bcmcs.foo.com.</domainName>
  <domainName>bcmcs.bar.com.</domainName>
</v6BcmcsDomainNamesOption>

<v6BcmcsAddressesOption>
  <ipAddress>2001:db8::1</ipAddress>
  <ipAddress>2001:db8::2</ipAddress>
</v6BcmcsAddressesOption>

<v6GeoconfCivicOption>
  <what>1</what>
  <countryCode>US</countryCode>
  <civicAddressElement>
    <caType>0</caType>
    <caValue>de</caValue>
  </civicAddressElement>
  <civicAddressElement>
    <caType>128</caType>
    <caValue>Latn</caValue>
  </civicAddressElement>
  <civicAddressElement>
    <caType>1</caType>
    <caValue>Bayern</caValue>
  </civicAddressElement>
</v6GeoconfCivicOption>

<v6PanaAgentAddressesOption>
  <ipAddress>2001:db8::1</ipAddress>
  <ipAddress>2001:db8::2</ipAddress>
</v6PanaAgentAddressesOption>

<v6NewPosixTimezoneOption>
  <string>EST5EDT4,M3.2.0/02:00,M11.1.0/02:00</string>
</v6NewPosixTimezoneOption>

<v6NewTzdbTimezoneOption>
  <string>Europe/Zurich</string>
</v6NewTzdbTimezoneOption>

<v6LostServerDomainNameOption>
  <domainName>lost.foo.com.</domainName>
</v6LostServerDomainNameOption>

<v4SubnetMaskOption>
  <ipAddress>255.255.255.0</ipAddress>
</v4SubnetMaskOption>

<v4TimeOffsetOption>
  <unsignedInt>5000</unsignedInt>
</v4TimeOffsetOption>

<v4RoutersOption>
  <ipAddress>10.0.0.1</ipAddress>
  <ipAddress>10.0.0.2</ipAddress>
</v4RoutersOption>

<v4TimeServersOption>
  <ipAddress>10.0.0.1</ipAddress>
  <ipAddress>10.0.0.2</ipAddress>
</v4TimeServersOption>

<v4DomainServersOption>
  <ipAddress>10.0.0.1</ipAddress>
  <ipAddress>10.0.0.2</ipAddress>
</v4DomainServersOption>

<v4DomainNameOption>
  <domainName>foo.com.</domainName>
</v4DomainNameOption>

<v4VendorSpecificOption>
  <subOptionList>
    <optionDef code="1" name="VendorSubopt1">
      <stringOption>
        <string>VendorSpecial</string>
      </stringOption>
    </optionDef>
    <optionDef code="2" name="VendorSubopt2">
      <ipAddressOption>
        <ipAddress>10.11.12.13</ipAddress>
      </ipAddressOption>
    </optionDef>
  </subOptionList>
</v4VendorSpecificOption>

<v4NetbiosNameServersOption>
  <ipAddress>10.0.0.1</ipAddress>
  <ipAddress>10.0.0.2</ipAddress>
</v4NetbiosNameServersOption>

<v4NetbiosNodeTypeOption>
  <unsignedByte>8</unsignedByte>
</v4NetbiosNodeTypeOption>

<v4TftpServerNameOption>
  <string>tftp.foo.com.</string>
</v4TftpServerNameOption>

<v4BootFileNameOption>
  <string>bootfile-name</string>
</v4BootFileNameOption>

Generic options are used to define new option types for experimental or future options. Generic options are defined using the optionDef element. The otherOptions element of the configuration options can be used to add one or more new or experimental options to the options that will be sent by the server to the client. Generic options are also used when defining the suboptionList of the Vendor Information Option as shown in the table above.

<optionDef code="99" name="MyOption">
  <nilOption/>
</optionDef>

<optionDef code="99" name="MyOption">
  <uByteOption>
    <unsignedByte>255</unsignedByte>
  </uByteOption>
</optionDef>

<optionDef code="99" name="MyOption">
  <uByteListOption>
    <unsignedByte>1</unsignedByte>
    <unsignedByte>10</unsignedByte>
    <unsignedByte>255</unsignedByte>
  </uByteListOption>
</optionDef>

<optionDef code="99" name="MyOption">
  <uShortOption>
    <unsignedShort>65535</unsignedShort>
  </uShortOption>
</optionDef>

<optionDef code="99" name="MyOption">
  <uShortListOption>
    <unsignedShort>1</unsignedShort>
    <unsignedShort>999</unsignedShort>
    <unsignedShort>65535</unsignedShort>
  </uShortListOption>
</optionDef>

<optionDef code="99" name="MyOption">
  <uIntOption>
    <unsignedInt>4294697295</unsignedInt>
  </uIntOption>
</optionDef>

<optionDef code="99" name="MyOption">
  <stringOption>
    <string>myOptionStringValue</string>
  </stringOption>
</optionDef>

<optionDef code="99" name="MyOption">
  <ipAddressOption>
    <ipAddress>2001:db8::1</ipAddress>
  </ipAddressOption>
</optionDef>

<optionDef code="99" name="MyOption">
  <ipAddressListOption>
    <ipAddress>2001:db8::1</ipAddress>
    <ipAddress>2001:db8::2</ipAddress>
    <ipAddress>2001:db8::3</ipAddress>
  </ipAddressListOption>
</optionDef>

<optionDef code="99" name="MyOption">
  <domainNameOption>
    <domainName>my.foo.com.</domainName>
  </domainNameOption>
</optionDef>

<optionDef code="99" name="MyOption">
  <domainNameListOption>
    <domainName>my.foo.com.</domainName>
    <domainName>my.bar.com.</domainName>
    <domainName>my.yuk.com.</domainName>
  </domainNameListOption>
</optionDef>

<optionDef code="99" name="MyOption">
  <opaqueDataOption>
    <opaqueData>
      <hexValue>0123456789abcdef</hexValue>
    </opaqueData>
  </opaqueDataOption>
</optionDef>

<optionDef code="99" name="MyOption">
  <opaqueDataListOption>
    <opaqueData>
      <hexValue>0123456789abcdef</hexValue>
    </opaqueData>
    <opaqueData>
      <asciiValue>HelloWorld</asciiValue>
    </opaqueData>
    <opaqueData>
      <hexValue>0a1b2c3d4e5f</hexValue>
    </opaqueData>
  </opaqueDataListOption>
</optionDef>

If more than one filter expression is defined in a filter, then the client request must match all of the expressions. That is, multiple filter expressions are logically anded together to form the match criteria. Each filter expression must contain at least one client class, option or custom expression.

<filter>
  <name>DHCPv6 UserClass Filter</name>
  <filterExpressions>
    <filterExpression>
      <clientClassExpression operator="equals">
        <v6UserClassOption>
          <opaqueData>
            <asciiValue>MyUserClass</asciiValue>
          </opaqueData>
        </v6UserClassOption>
      </clientClassExpression>
    </filterExpression>
  </filterExpressions>
  <v6MsgConfigOptions>
    <v6DomainSearchListOption>
      <domainName>filter.com.</domainName>
    </v6DomainSearchListOption>
  </v6MsgConfigOptions>
</filter>

<filter>
  <name>DHCPv6 VendorClass Filter</name>
  <filterExpressions>
    <filterExpression>
      <clientClassExpression operator="equals">
        <v6VendorClassOption>
          <opaqueData>
            <asciiValue>VendorXYZ</asciiValue>
          </opaqueData>
          <enterpriseNumber>12345</enterpriseNumber>
        </v6VendorClassOption>
      </clientClassExpression>
    </filterExpression>
  </filterExpressions>
  <v6MsgConfigOptions>
    <v6VendorInfoOption>
      <enterpriseNumber>12345</enterpriseNumber>
      <suboptionList>
        <optionDef code="1">
          <stringOption>
            <string>hello</string>
          </stringOption>
        </optionDef>
        <optionDef code="2">
          <ipAddressOption>
            <ipAddress>2001:db8::1</ipAddress>
          </ipAddressOption>
        </optionDef>
      </suboptionList>
    </v6VendorInfoOption>
  </v6MsgConfigOptions>
</filter>

<filter>
  <name>DHCPv4 VendorClass Filter</name>
  <filterExpressions>
    <filterExpression>
      <clientClassExpression operator="startsWith">
        <v4VendorClassOption>
          <opaqueData>
            <asciiValue>MyVendorPrefix</asciiValue>
          </opaqueData>
        </v4VendorClassOption>
      </clientClassExpression>
    </filterExpression>
  </filterExpressions>
  <v4ConfigOptions>
    <v4VendorSpecificOption>
      <opaqueData>
        <hexValue>01020304</hexValue>
      </opaqueData>
    </v4VendorSpecificOption>
  </v4ConfigOptions>
</filter>

<filterExpressions>
  <filterExpression>
    <optionExpression code="99" operator="equals">
      <uByteOption>
        <unsignedByte>255</unsignedByte>
      </uByteOption>
    </optionExpression>
  </filterExpression>
</filterExpressions>

<filterExpressions>
  <filterExpression>
    <optionExpression code="99" operator="equals">
      <uByteListOption>
        <unsignedByte>1</unsignedByte>
        <unsignedByte>255</unsignedByte>
      </uByteListOption>
    </optionExpression>
  </filterExpression>
</filterExpressions>

<filterExpressions>
  <filterExpression>
    <optionExpression code="99" operator="lessThan">
      <uShortOption>
        <unsignedShort>65535</unsignedShort>
      </uShortOption>
    </optionExpression>
  </filterExpression>
</filterExpressions>

<filterExpressions>
  <filterExpression>
    <optionExpression code="99" operator="equals">
      <uShortListOption>
        <unsignedShort>1</unsignedShort>
        <unsignedShort>65535</unsignedShort>
      </uShortListOption>
    </optionExpression>
  </filterExpression>
</filterExpressions>

<filterExpressions>
  <filterExpression>
    <optionExpression code="99" operator="lessThan">
      <uIntOption>
        <unsignedInt>10000</unsignedInt>
      </uIntOption>
    </optionExpression>
  </filterExpression>
</filterExpressions>

<filterExpressions>
  <filterExpression>
    <optionExpression code="99" operator="endsWith">
      <stringOption>
        <string>mySuffix</string>
      </stringOption>
    </optionExpression>
  </filterExpression>
</filterExpressions>

<filterExpressions>
  <filterExpression>
    <optionExpression code="99" operator="equals">
      <ipAddressOption>
        <ipAddress>2001:db8::1</ipAddress>
      </ipAddressOption>
    </optionExpression>
  </filterExpression>
</filterExpressions>

<filterExpressions>
  <filterExpression>
    <optionExpression code="99" operator="contains">
      <ipAddressListOption>
        <ipAddress>2001:db8::1</ipAddress>
      </ipAddressListOption>
    </optionExpression>
  </filterExpression>
</filterExpressions>

<filterExpressions>
  <filterExpression>
    <optionExpression code="99" operator="equals">
      <domainNameOption>
        <domainName>foo.com.</domainName>
      </domainNameOption>
    </optionExpression>
  </filterExpression>
</filterExpressions>

<filterExpressions>
  <filterExpression>
    <optionExpression code="99" operator="contains">
      <domainNameListOption>
        <domainName>foo.com.</domainName>
      </domainNameListOption>
    </optionExpression>
  </filterExpression>
</filterExpressions>

<filterExpressions>
  <filterExpression>
    <optionExpression code="99" operator="regExp">
      <opaqueDataOption>
        <opaqueData>
          <asciiValue>myRegularExpression</asciiValue>
        </opaqueData>
      </opaqueDataOption>
    </optionExpression>
  </filterExpression>
</filterExpressions>

<filterExpressions>
  <filterExpression>
    <optionExpression code="99" operator="equals">
      <opaqueDataOption>
        <opaqueData>
          <asciiValue>opaqueAsciiData</asciiValue>
        </opaqueData>
      </opaqueDataOption>
    </optionExpression>
  </filterExpression>
</filterExpressions>

<filterExpressions>
  <filterExpression>
    <optionExpression v4="true" code="99" operator="equals">
      <uByteOption>
        <unsignedByte>255</unsignedByte>
      </uByteOption>
    </optionExpression>
  </filterExpression>
</filterExpressions>

For DHCPv6, the link is determined by the server according to section 11 of RFC 3315. If the message is received directly and the source address is link-local, then the client is on the link attached to the server interface which received the message. If the message is received directly and the source address is not link-local, then the client is on the link identified by the source address. If the message is received from a relay agent, then the client is on the link identified by the link-address of the Relay-Forward message. Therefore, DHCPv6 link definitions are either local or remote.

<link>
  <name>Local IPv6 Client Link (Multicast traffic)</name>
  <!-- Local DHCPv6 links are defined by interface name -->
  <interface>eth2</interface>
  ...
</link>

<link>
  <name>Remote IPv6 Client Link (Unicast/Multicast traffic)</name>
  <!-- Remote DHCPv6 links are defined in CIDR notation -->
  <address>2001:db8:2::/48</address>
  ...
</link>

For DHCPv4, the link is determined by the 'giAddr' field of the DHCPv4 request header. If the 'giAddr' field is zero, then the link is determined by the IP address assigned to the IPv4 broadcast interface provided to the server at startup.

<link>
  <name>IPv4 Client Link 1</name>
  <!-- All DHCPv4 links are defined in CIDR notation.
       For local links, specify the interface as a
       startup command-line option, and configure the
       subnet for that interface's IPv4 address. -->
    <address>10.0.0.0/24</address>
  ...
</link>

1. v6NaAddrPools - DHCPv6 Non-temporary address (NA) pools

2. v6TaAddrPools - DHCPv6 Temporary address (TA) pools

3. v6PrefixPools - DHCPv6 Prefix delegation (PD) pools

4. v4AddrPools - DHCPv4 address (V4) pools

Non-temporary and temporary address pools are defined by the addressPool type. The address pool must contain a range element to define the addresses available for allocation in the pool. The range is specified using the start and end address of a range of addresses, or a prefix and length. For example:

<link>
    <name>Client Link 2</name>
    <address>2001:DB8:2::/48</address>
    <v6IaNaConfigOptions>
        <v6DnsServersOption>
            <ipAddress>2001:DB8:2::1</ipAddress>
        </v6DnsServersOption>
    </v6IaNaConfigOptions>
    <v6NaAddrPools>
        <pool>
            <range>2001:DB8:2::0A-2001:DB8:2::FF</range>
            <addrConfigOptions>
                <v6SipServerAddressesOption>
                    <ipAddress>2001:DB8:2::1:1</ipAddress>
                </v6SipServerAddressesOption>
            </addrConfigOptions>
        </pool>
        <pool>
            <range>2001:DB8:2:1::/64</range>
            <addrConfigOptions>
                <v6SipServerAddressesOption>
                    <ipAddress>2001:DB8:2:1::1:1</ipAddress>
                </v6SipServerAddressesOption>
            </addrConfigOptions>
        </pool>
    </v6NaAddrPools>
</link>

Prefix delegation pools are defined by the prefixPool type. The prefix pool must contain a range element to define the prefix available for delegation, and the prefixLength element to define the size of the prefixes to allocate to requesting routers. For example:

<link>
    <name>Prefix Delegation Link</name>
    <address>2001:DB8:1::/48</address>
    <v6IaPdConfigOptions>
        <v6DnsServersOption>
            <ipAddress>2001:DB8:2::1</ipAddress>
        </v6DnsServersOption>
    </v6IaPdConfigOptions>
    <v6PrefixPools>
        <pool>
            <range>2001:DB8:2::/48</range>
            <prefixLength>64</prefixLength>
            <prefixConfigOptions>
                <sipServerAddressesOption>
                    <ipAddress>2001:DB8:2:1::1:1</ipAddress>
                </sipServerAddressesOption>
            </prefixConfigOptions>
        </pool>
    </v6PrefixPools>
</link>

DHCPv4 address pools are defined by the v4AddressPool type. The address pool must contain a range element to define the addresses available for allocation in the pool. The range is specified using the start and end address of a range of addresses. For example:

<link>
    <name>DHCPv4 Client Subnet</name>
    <address>10.0.0.0/24</address>
    <v4ConfigOptions>
        <v4SubnetMaskOption>
            <ipAddress>255.255.255.0</ipAddress>s
        </v4SubnetMaskOption>
        <v4RoutersOption>
            <ipAddress>10.0.0.1</ipAddress>
            <ipAddress>10.0.0.2</ipAddress>
        </v4RoutersOption>
    <v4ConfigOptions>
    <v4AddrPools>
        <pool>
            <range>10.0.0.100-10.0.0.199</range>
            <v4ConfigOptions>
                <v4DomainNameOption>
                    <domainName>foo.com.</domainName>
                </v4DomainNameOption>
            </v4ConfigOptions>
        </pool>
        <pool>
            <range>10.0.0.200-10.0.0.254</range>
            <v4ConfigOptions>
                <v4DomainNameOption>
                    <domainName>bar.com.</domainName>
                </v4DomainNameOption>
            </v4ConfigOptions>
        </pool>
    </naAddrPools>
</link>

1. v6NaAddrBindings - DHCPv6 Non-temporary address (NA) bindings

2. v6TaAddrBindings - DHCPv6 Temporary address (TA) bindings

3. v6PrefixBindings - DHCPv6 Prefix delegation (PD) bindings

4. v4AddrBindings - DHCPv4 address (V4) bindings

Non-temporary and temporary static address bindings are defined by the addressBinding type. The address binding must contain the ipAddress element to specify the IP address reserved for the client. The address binding must also contain the duid element to identify the client. Note that the client's DUID is a calculated value which is generally not predictable in all situations. Therefore, static address bindings for DHCPv6 should be considered an experimental feature for controlled environments only. In addition to the DUID, a static address binding may further identify the client request by specifying the optional iaid element. Again, the client's IA_ID is generally unpredictable. However, if the IA_ID is not specified, then all client requests for the given DUID will be assigned the specified IP address. This may be acceptable if the clients are known to have a single network interface. If the administrator understands the inherent risks with this configuration feature, it may be used with caution. For example:

<v6NaAddrBindings>
  <binding>
    <ipAddress>2001:db8:1::100</ipAddress>
    <!-- DHCPv6 "binding" is not really supported yet
         because clients do not send a MAC address, but
         if the DUID is known, then a binding can be made. -->
    <duid>
      <hexValue>0a1b2c3d4e5f</hexValue>
    </duid>
    <!-- The IA_ID is almost definitely unpredictable, so
         it is an optional element for a DHCPv6 binding.  If
         left undefined, then ANY IA_ID will match.
    <iaid>0</iaid>
    -->
    ...
  </binding>
  ...
</v6NaAddrBindings>

Prefix delegation static prefix bindings are defined by the prefixBinding type. The prefix binding must contain the prefix element to define the prefix available for delegation, and the prefixLength element to define the size of the prefixes to allocate to requesting router. The same caveats and cautions as DHCPv6 address bindings apply for prefix bindings as well. For example:

<v6PrefixBindings>
  <binding>
    <prefix>2001:db8:1::</prefix>
    <prefixLength>64</prefixLength>
    <!-- DHCPv6 "binding" is not really supported yet
         because clients do not send a MAC address, but
         if the DUID is known, then a binding can be made. -->
    <duid>
      <hexValue>0a1b2c3d4e5f</hexValue>
    </duid>
    ...
  </binding>
  ...
</v6PrefixBindings>

DHCPv4 static address bindings are defined by the v4AddressBinding type. The address binding must contain a ipAddress element to specify the IP address reserved for the client. The address binding must also contain the chAddr element to identify the client from the corresponding field in the DHCPv4 request header. For example:

<v4AddrBindings>
  <binding>
    <!-- Binding addresses should NOT be inside a pool -->
    <ipAddress>10.0.0.200</ipAddress>
    <chaddr>0a1b2c3d4e5f</chaddr>
    ...
  </binding>
  ...
</v4AddrBindings>