Adding failover relationships for Kea DHCP - User Guide - Micetro - 26.1.0

Micetro Admin Guide
ft:locale
en-US
Product name
Micetro
Version
26.1.0

For each Kea DHCP server, it's possible to add one DHCPv4 and one DHCPv6 failover relationship. Micetro supports two failover server types in a relationship: one primary and one secondary. Therefore, creating failover relationships with backup servers is not supported.

Note: If a Kea DHCP server functions as a secondary server in a failover relationship, it is not possible to create additional failover relationships with that server as the primary server.

Before adding a failover relationship, you need to enable failover by having two Hooks Libraries on the file system. For more information, refer to High Availability Hooks Library.

You can add a failover relationship either in the Web Application or through the API.

Adding a Kea failover relationship in Micetro

To create a failover relationship in Micetro:

  1. On the Admin page, select the Service management tab.
  2. In the left sidebar, under DHCP services, select Kea.
  3. Select the Kea DHCP server housing the scope for which you want to establish failover configuration, and then use the Action menu or Row … menu to select Manage failover.
  4. In the dialog, select + Add relationship.
  5. Enter the necessary information in the provided form:
    The Initial setup step of the Add relationship dialog for a Kea DHCP server.
    • Failover name: Specify the name of the failover peer.
    • Failover mode: Select the DHCP failover mode to use, such as load balance or hot standby.
    • Partner server: Select the partner server for the failover configuration.
    • Specify the DHCP version by selecting either DHCPv4 or DHCPv6. Only required if you are using a server with the Kea Control Agent.
    • Use dedicated HTTP endpoints for HA peer-to-peer communication: Check the box to enable the use of dedicated HTTP endpoints for peer communication. If enabled, Micetro automatically selects server port + 1 as the port for the peer-to-peer communication when creating a failover relationship. Since the default port is 8000, this means the default peer-to-peer port is 8001.
    Note: For servers using HTTPS, meaning they require TLS certificates, Micetro assumes that the same certificates are used for all servers using the same agent. If your setup requires a different configuration, you will need to manually edit the high-availability sections in the server configuration.

    Then select Next.

  6. Review the failover relationship configuration in the Summary step, and then select Add.
  7. Select Save.

Adding a failover relationship through API

To create a failover relationship through the API:

The API supports the creation of a failover relationship with the AddDHCPFailoverRelationship command, which uses the following parameters:

  • Name: The name of the DHCP failover relationship to be created.
  • PrimaryServer: The name of the primary DHCP server as it appears in Micetro.
  • SecondaryServer: The name of the secondary DHCP server as it appears in Micetro.
  • FailoverMode: The DHCP failover mode to use.
  • ServiceType: DHCPv4 or DHCPv6. Only required if you are using a server with the Kea Control Agent.