The Domain Name System (DNS) is essential internet functionality used for resolving domain names to IP addresses. When the target of a network or web path is identified by a domain name rather than by an IP address, the source monitoring point uses DNS to resolve the target’s IP address.

Typically, the IP addresses of DNS name servers are configured within DHCP so, if the monitoring point uses DHCP, those name servers are available to it. Additional name server addresses can also be configured directly on a per address basis on monitoring point interfaces.

When a network or web path is initiated from a monitoring point, a DNS request is made. The source monitoring point must determine which name servers to pass the DNS request to. If there are one or more name servers configured on the address the path is initiated from (either configured directly on the interface address or returned via DHCP), only those servers are used. If no name servers are configured on the interface address or returned by a DHCP server servicing the interface, then all name servers known to the monitoring point are used.

From a monitoring point perspective, all name servers are considered equivalent. So, when a name resolution is required, the request is forwarded to the appropriate name servers. The first response received is used.

In cases where name servers are not equivalent (typically when providing sub-domain name resolution), this behavior may result in an incorrect name resolution. For example, a name server that cannot resolve a name may respond first with a negative result. This result is used by the monitoring point despite it receiving a positive result later on. In these instances, you want to associate a name server with a DNS Search Domain so that all requests for a given domain are forwarded to a specific name server (or set of servers).

On monitoring points where the DNS Search Domain is configured on a specific interface address, when a network or web path is initiated from that address, only the name servers configured directly (or supplied by DHCP) on that address are used to resolve domain names matching the DNS Search Domain. If no DNS Search Domains are configured on the address, then all search domains known to the monitoring point are used.

View DNS configuration

Web admin

To view name servers and/or DNS search domains configured on a dynamic address or the first configured address on an interface:

  1. Log in to Web Admin.
  2. Navigate to Network Settings > Network Interfaces.
  3. For the interface you want to view, select > Edit.
  4. The DNS Configuration section shows the name servers and/or DNS search domains configured on the dynamic address (if used) or the first static address shown in the Interface Addresses section. To view the name servers and/or DNS search domains for other addresses configured on the interface, use the Admin API.

Admin API - view name server

You can view name servers configured on a dynamic address or the first configured address or on a specific address on an interface.

To view name servers configured on a dynamic address or the first configured address on an interface:

  1. Access the Admin API.
  2. Navigate to DNS > GET /interface/{interface_name}/dns_nameserver/.
  3. Click Try it out.
  4. In the Parameters section, in the interface_name field, enter the name of the interface you are viewing.
  5. Click Execute.
    • The Server response section should show Code “200”.
    • The name servers are shown in the Response body.

To view name servers configured on a specific address on an interface:

  1. Access the Admin API.
  2. Navigate to DNS > GET /interface/{interface_name}/{address}/dns_nameserver/.
  3. Click Try it out.
  4. In the Parameters section:
    1. In the interface_name field, enter the name of the interface you are viewing.
    2. In the address field, enter the address whose configuration you are viewing.
  5. Click Execute.
    • The Server response section should show Code “200”.
    • The name servers are shown in the Response body.

Admin API - view DNS search domain

You can view DNS search domains configured on a dynamic address or the first configured address or on a specific address on an interface.

To view DNS search domains configured on a dynamic address or the first configured address on an interface:

  1. Access the Admin API.
  2. Navigate to DNS > GET /interface/{interface_name}/dns_search/.
  3. Click Try it out.
  4. In the Parameters section, in the interface_name field, enter the name of the interface you are viewing.
  5. Click Execute.
    • The Server response section should show Code “200”.
    • The DNS search domains are shown in the Response body.

To view DNS search domains configured on a specific address on an interface:

  1. Access the Admin API.
  2. Navigate to DNS > GET /interface/{interface_name}/{address}/dns_search/.
  3. Click Try it out.
  4. In the Parameters section:
    1. In the interface_name field, enter the name of the interface you are viewing.
    2. In the address field, enter the address whose configuration you are viewing.
  5. Click Execute.
    • The Server response section should show Code “200”.
    • The DNS search domains are shown in the Response body.

Web admin

  1. Log in to Web Admin.
  2. Click Network Configuration.
    • The DNS configuration is displayed in the DNS section.

Add/Edit DNS configuration

Web admin

To add/edit name servers and/or DNS search domains on the dynamic address or the first configured address on an interface:

  1. Log in to Web Admin.
  2. Navigate to Network Settings > Network Interfaces.
  3. For the interface you want to edit, select > Edit.
  4. In the DNS Configuration section, make your changes to the DNS configuration.
    • Note that the changes apply to the dynamic address (if used) or the first static address shown in the Interface Addresses section. To configure name servers and/or DNS search domains for other addresses configured on the interface, use the Admin API.
  5. Restart networking.
    • The DNS configuration changes take effect.

Admin API - add name server

You can add name servers to a dynamic address or the first configured address or to a specific address on an interface.

To add name servers to a dynamic address or the first configured address on an interface:

  1. Access the Admin API.
  2. Navigate to DNS > POST /interface/{interface_name}/dns_nameserver/.
  3. Click Try it out.
  4. In the Parameters section:
    1. In the interface_name field, enter the name of the interface you are configuring.
    2. In the body field, replace “string” with the IP address of the name server you are adding.
      • You can enter additional name server addresses on separate lines. All but the last should have a “,” at the end.
  5. Click Execute.
    • The Server response section should show Code “200”.
    • The name servers are added.
  6. Restart networking. You will briefly lose connectivity to the Admin API.
    • The DNS configuration changes take effect.

To add name servers to a specific address on an interface:

  1. Access the Admin API.
  2. Navigate to DNS > POST /interface/{interface_name}/{address}/dns_nameserver/.
  3. Click Try it out.
  4. In the Parameters section:
    1. In the interface_name field, enter the name of the interface you are configuring.
    2. In the address field, enter the address you are configuring.
    3. In the body field, replace “string” with the IP address of the name server you are adding.
      • You can enter additional name server addresses on separate lines. All but the last should have a “,” at the end.
  5. Click Execute.
    • The Server response section should show Code “200”.
    • The name servers are added.
  6. Restart networking. You will briefly lose connectivity to the Admin API.
    • The DNS configuration changes take effect.

Admin API - add DNS search domain

You can add DNS search domains to a dynamic address or the first configured address or to a specific address on an interface.

To add DNS search domains to a dynamic address or the first configured address on an interface:

  1. Access the Admin API.
  2. Navigate to DNS > POST /interface/{interface_name}/dns_search/.
  3. Click Try it out.
  4. In the Parameters section:
    1. In the interface_name field, enter the name of the interface you are configuring.
    2. In the body field, replace “string” with the search domain.
      • You can enter additional search domains on separate lines. All but the last should have a “,” at the end.
  5. Click Execute.
    • The Server response section should show Code “200”.
    • The DNS search domains are added.
  6. Restart networking. You will briefly lose connectivity to the Admin API.
    • The DNS configuration changes take effect.

To add DNS search domains to a specific address on an interface:

  1. Access the Admin API.
  2. Navigate to DNS > POST /interface/{interface_name}/{address}/dns_search/.
  3. Click Try it out.
  4. In the Parameters section:
    1. In the interface_name field, enter the name of the interface you are configuring.
    2. In the address field, enter the address you are configuring.
    3. In the body field, replace “string” with the search domain.
      • You can enter additional search domains on separate lines. All but the last should have a “,” at the end.
  5. Click Execute.
    • The Server response section should show Code “200”.
    • The DNS search domains are added.
  6. Restart networking. You will briefly lose connectivity to the Admin API.
    • The DNS configuration changes take effect.

Web admin

  1. Log in to Web Admin.
  2. Click Network Configuration.
  3. Click on Configure DNS.
  4. Update the configuration as appropriate.
  5. Click Save.
  6. Restart networking.

Delete DNS configuration

Web admin

To delete name servers and/or DNS search domains from a dynamic address or from the first configured address on an interface:

  1. Log in to Web Admin.
  2. Navigate to Network Settings > Network Interfaces.
  3. For the interface you want to delete from, select > Edit.
  4. In the DNS Configuration section, make your changes to the DNS configuration.
    • Note that the changes apply to the dynamic address (if used) or the first static address shown in the Interface Addresses section. To delete name servers and/or DNS search domains for other addresses configured on the interface, use the Admin API.
  5. Restart networking.
    • The DNS configuration changes take effect.

Admin API - delete name servers

You can delete all user-defined name servers from a dynamic address or the first configured address or from a specific address on an interface.

To delete all user-defined name servers from a dynamic address or the first configured address on an interface:

  1. Access the Admin API.
  2. Navigate to DNS > DELETE /interface/{interface_name}/dns_nameserver/.
  3. Click Try it out.
  4. In the Parameters section, in the interface_name field, enter the name of the interface you are deleting name servers from.
  5. Click Execute.
    • The Server response section should show Code “200”.
    • The name servers are deleted from the dynamic address or the first configured address on an interface.
  6. Restart networking. You will briefly lose connectivity to the Admin API.
    • The DNS configuration changes take effect.

To delete all user-defined name servers from a specific address on an interface:

  1. Access the Admin API.
  2. Navigate to DNS > DELETE /interface/{interface_name}/{address}/dns_nameserver/.
  3. Click Try it out.
  4. In the Parameters section:
    1. In the interface_name field, enter the name of the interface you are deleting name servers from.
    2. In the address field, enter the address you are deleting name servers from.
  5. Click Execute.
    • The Server response section should show Code “200”.
    • The name servers are deleted from the specified address.
  6. Restart networking. You will briefly lose connectivity to the Admin API.
    • The DNS configuration changes take effect.

Admin API - delete DNS search domain

You can delete all user-defined DNS search domains from a dynamic address or the first configured address or from a specific address on an interface.

To delete all user-defined DNS search domains from a dynamic address or the first configured address on an interface:

  1. Access the Admin API.
  2. Navigate to DNS > DELETE /interface/{interface_name}/dns_search/.
  3. Click Try it out.
  4. In the Parameters section, in the interface_name field, enter the name of the interface you are deleting DNS search domains from.
  5. Click Execute.
    • The Server response section should show Code “200”.
    • The DNS search domains are deleted.
  6. Restart networking. You will briefly lose connectivity to the Admin API.
    • The DNS configuration changes take effect.

To delete all user-defined DNS search domains from a specific address on an interface:

  1. Access the Admin API.
  2. Navigate to DNS > DELETE /interface/{interface_name}/{address}/dns_search/.
  3. Click Try it out.
  4. In the Parameters section:
    1. In the interface_name field, enter the name of the interface you are deleting DNS search domains from.
    2. In the address field, enter the address you are deleting DNS search domains from.
  5. Click Execute.
    • The Server response section should show Code “200”.
    • The DNS search domains are deleted.
  6. Restart networking. You will briefly lose connectivity to the Admin API.
    • The DNS configuration changes take effect.

Web admin

  1. Log in to Web Admin.
  2. Click Network Configuration.
  3. Click on Configure DNS.
  4. Update the configuration as appropriate.
  5. Click Save.
  6. Restart networking.