The Domain Name System (DNS) is essential Internet functionality used for resolving domain names to IP addresses. DNS name servers implement the DNS functionality. Typically, name server IP addresses are configured within DHCP so, if the monitoring point is configured to use DHCP, those name server addresses are available to it. Additional name server addresses can also be configured directly on the monitoring point.

From a monitoring point perspective, all known name servers are considered equivalent. So, when a name resolution is required, the request is forwarded to all those 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, only the name servers configured (or supplied by DHCP) for that interface will be used to resolve FQDNs matching the DNS Search Domain.

View DNS configuration

Web admin

  1. Log in to Web Admin.
  2. Navigate to Network Settings > Network Interfaces.
    • The configuration of each interface is displayed.

Admin API - view name server

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

Admin API - view DNS search domain

  1. Access the Admin API.
  2. Navigate to DNS > GET /interface/{interface_name}/dns_search/.
  3. In the Parameters section, in the interface_name field, enter the name of the interface you are viewing.
  4. Click Submit.
    • The Response Code section should show “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.

Edit DNS configuration

Web admin

  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.
  5. Restart networking.
    • The DNS configuration changes take effect.

Admin API - add/edit name server

  1. Access the Admin API.
  2. Navigate to DNS > POST /interface/{interface_name}/dns_nameserver/.
  3. In the Parameters section, in the interface_name field, enter the name of the interface you are configuring.
  4. Click the box under Model Schema.
    • Content of the Model Schema is copied to the body field.
  5. 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.
  6. Click Submit.
    • The Response Code section should show “200”.
    • The name servers are added/edited.
  7. Restart networking. You will briefly lose connectivity to the Admin API.
    • The DNS configuration changes take effect.

Admin API - delete name server

  1. Access the Admin API.
  2. Navigate to DNS > DELETE /interface/{interface_name}/dns_nameserver/.
  3. In the Parameters section, in the interface_name field, enter the name of the interface you are deleting.
  4. Click Submit.
    • The Response Code section should show “200”.
    • The name servers are deleted.
  5. Restart networking. You will briefly lose connectivity to the Admin API.
    • The DNS configuration changes take effect.

Admin API - add/edit DNS search domain

  1. Access the Admin API.
  2. Navigate to DNS > POST /interface/{interface_name}/dns_search/.
  3. In the Parameters section, in the interface_name field, enter the name of the interface you are configuring.
  4. Click the box under Model Schema.
    • Content of the Model Schema is copied to the body field.
  5. 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.
  6. Click Submit.
    • The Response Code section should show “200”.
    • The DNS search domains are added/edited.
  7. Restart networking. You will briefly lose connectivity to the Admin API.
    • The DNS configuration changes take effect.

Admin API - delete DNS search domain

  1. Access the Admin API.
  2. Navigate to DNS > DELETE /interface/{interface_name}/dns_search/.
  3. In the Parameters section, in the interface_name field, enter the name of the interface you are configuring.
  4. Click Submit.
    • The Response Code section should show “200”.
    • The DNS search domains are deleted.
  5. 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.