Developer Documentation
ADC CLI Commands
Current Release 13.1 13.0 12.1

dns-nameServer

May 28, 2024
Contributed by: 
C

The following operations can be performed on “dns-nameServer”:

add set enable disable show unset rm

add dns nameServer

Adds a name server to the appliance. Following are the two types of name servers that can be added:

  • IP address-based name server - An external name server to contact for domain name resolution. If multiple IP address-based name servers are configured on the appliance, and the local parameter is not set on any of them, incoming DNS queries are load balanced across all the name servers, in round robin fashion.
  • Virtual server-based name server - A DNS virtual server configured in the Citrix ADC. If you want more fine-grained control on how external DNS name servers are load balanced (for example, you want a load balancing method other than round robin), you configure a DNS virtual server on the appliance, bind the external name servers as its services, and then specify the name of the virtual server in this command.

Synopsis

add dns nameServer (( \[-local]) | ) \[-state \( ENABLED | DISABLED )] \[-type ] \[-dnsProfileName ]

Arguments

IP IP address of an external name server or, if the Local parameter is set, IP address of a local DNS server (LDNS).

dnsVserverName Name of a DNS virtual server. Overrides any IP address-based name servers configured on the Citrix ADC.

local Mark the IP address as one that belongs to a local recursive DNS server on the Citrix ADC. The appliance recursively resolves queries received on an IP address that is marked as being local. For recursive resolution to work, the global DNS parameter, Recursion, must also be set.

If no name server is marked as being local, the appliance functions as a stub resolver and load balances the name servers.

state Administrative state of the name server.

Possible values: ENABLED, DISABLED Default value: ENABLED

type Protocol used by the name server. UDP_TCP is not valid if the name server is a DNS virtual server configured on the appliance.

Possible values: UDP, TCP, UDP_TCP Default value: UDP

dnsProfileName Name of the DNS profile to be associated with the name server

Example

Adding an-IP based nameserver IP: add nameserver 10.102.4.1, Adding a vserver-based name server: add nameserver dns_vsvr where dns_vsvr is the name of a DNS vserver created in the system.

set dns nameServer

Modifies the attributes of a DNS name server. Only IP based name server entities can be modified using this command. If the DNS name server is an LB VServer, modification to any of the attributes should be done using set lb vserver command

Synopsis

set dns nameServer [-dnsProfileName ] [-type ]

Arguments

IP IP address of an external name server or, if the Local parameter is set, IP address of a local DNS server (LDNS).

dnsProfileName Name of the DNS profile to be associated with the name server

type Protocol used by the name server. UDP_TCP is not valid if the name server is a DNS virtual server configured on the appliance.

Possible values: UDP, TCP, UDP_TCP Default value: UDP

Example

set dns nameserver 1.1.1.1 -dnsprofilename test2

enable dns nameServer

Enables a name server.

Synopsis

enable dns nameServer ( | | -type )

Arguments

IP IP address of the name server.

dnsVserverName Name of the DNS virtual server.

type Protocol used by the name server. UDP_TCP is not valid if the name server is a DNS virtual server configured on the appliance.

Possible values: UDP, TCP, UDP_TCP Default value: UDP

Example

enable dns nameserver 10.14.43.149

disable dns nameServer

Disables a name server.

Synopsis

disable dns nameServer ( | | -type )

Arguments

IP IP address of the name server.

dnsVserverName Name of the DNS virtual server.

type Protocol used by the name server. UDP_TCP is not valid if the name server is a DNS virtual server configured on the appliance.

Possible values: UDP, TCP, UDP_TCP Default value: UDP

Example

disable dns nameserver 10.14.43.149

show dns nameServer

Displays the name servers configured on the Citrix ADC, along with their administrative states.

Synopsis

show dns nameServer [ | ]

Arguments

IP IP address of the name server.

dnsVserverName Name of the DNS virtual server.

Output

serviceName The name of the dns vserver.

port Port of the service.

type Protocol used by the name server. UDP_TCP is not valid if the name server is a DNS virtual server configured on the appliance.

state Administrative state of the name server.

nameserverstate State of the server.

local ip is a local recursive nameserver.

adminState ClMonOwner Tells the mon owner of the service.

ClMonView Tells the view id by which state of the service is updated.

dnsProfileName Name of the DNS profile to be associated with the name server

devno count stateflag

unset dns nameServer

Use this command to remove dns nameServer settings.Refer to the set dns nameServer command for meanings of the arguments.

Synopsis

unset dns nameServer [-dnsProfileName] [-type ]

rm dns nameServer

Removes a name server from the Citrix ADC. If the name server is an IP-address based external name server, the name server entry is removed. If the name server is a DNS virtual server on the appliance, the virtual server is not removed, but it is no longer used to resolve domain names.

Synopsis

rm dns nameServer ( | | -type )

Arguments

IP IP address of the name server.

dnsVserverName Name of the DNS virtual server.

type Protocol used by the name server. UDP_TCP is not valid if the name server is a DNS virtual server configured on the appliance.

Possible values: UDP, TCP, UDP_TCP Default value: UDP

Example

Deleting an IP-based nameserver: rm nameserver 10.102.4.1, Deleting a vserver-based nameserver: rm nameserver dns_vsvr

dns-nameServer
May 28, 2024
Contributed by: 
C
May 28, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.