.. _slb_template_dns_recursive_dns_resolution:

slb template dns recursive-dns-resolution
=========================================

Recursive DNS resolver configuration


recursive-dns-resolution Specification
--------------------------------------

	===================================== =========================================================================================
	 **Parameter**                         **Value** 

	===================================== =========================================================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      recursive-dns-resolution

	 **Element URI**                       /axapi/v3/slb/template/dns/{name}/recursive-dns-resolution

	 **Element Attributes**                recursive-dns-resolution_attributes

	 **Partition Visibility**              shared

	 **Operational Data URI**              /axapi/v3/slb/template/dns/{name}/recursive-dns-resolution/oper

	 **Schema**                             :download:`recursive-dns-resolution schema <slb-template-dns-recursive-dns-resolution/slb-template-dns-recursive-dns-resolution.txt>`
	===================================== =========================================================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/slb/template/dns/{name}/recursive-dns-resolution



.. raw:: html

   </td><td valign = 'top'>


:ref:`2979_recursive-dns-resolution_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/slb_template_dns_recursive_dns_resolution_POST.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/slb/template/dns/{name}/recursive-dns-resolution



.. raw:: html

   </td><td valign = 'top'>


:ref:`2979_recursive-dns-resolution_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/slb_template_dns_recursive_dns_resolution_GET.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Modify Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/slb/template/dns/{name}/recursive-dns-resolution



.. raw:: html

   </td><td valign = 'top'>


:ref:`2979_recursive-dns-resolution_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace Object



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/slb/template/dns/{name}/recursive-dns-resolution



.. raw:: html

   </td><td valign = 'top'>


:ref:`2979_recursive-dns-resolution_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/slb_template_dns_recursive_dns_resolution_PUT.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

   </td><td valign = 'top'>


DELETE



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/slb/template/dns/{name}/recursive-dns-resolution



.. raw:: html

   </td><td valign = 'top'>


:ref:`2979_recursive-dns-resolution_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _2979_recursive-dns-resolution_attributes:

recursive-dns-resolution attributes
-----------------------------------

    **csubnet-retry**

        **Description** retry when server REFUSED AX inserted EDNS(0) subnet, works only when insert-client-subnet is configured

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **default-recursive**

        **Description** Default recursive mode, forward query to bound service-group if hostnames matched

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **dnssec-validation**

        **Description** 'enabled': Enable DNSSEC validation; 'disabled': Disable DNSSEC validation; 

        **Type:** string

        **Supported Values:** enabled, disabled

        **Default:** disabled

    **fast-ns-selection**

        **Description** 'enabled': Enable fast NS selection; 'disabled': Disable fast NS selection; 

        **Type:** string

        **Supported Values:** enabled, disabled

        **Default:** enabled

    **force-cname-resolution**

        **Description** 'enabled': Force CNAME resolution always; 'disabled': Use answer record in CNAME response if it exists, else resolve; 

        **Type:** string

        **Supported Values:** enabled, disabled

        **Default:** enabled

    **full-response**

        **Description** Serve all records (authority and additional) when applicable

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **gateway-health-check**

        **Description:** gateway-health-check is a **JSON Block**.  Please see below for :ref:`2979_gateway-health-check` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/recursive-dns-resolution/gateway-health-check <slb_template_dns>`

    **host-list-cfg**

        **Type:** List

    **ipv4-nat-pool**

        **Description** IPv4 Source NAT pool or pool group

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/ip/nat/pool <ip_nat_pool>`

    **ipv6-nat-pool**

        **Description** IPv6 Source NAT pool or pool group

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/ipv6/nat/pool <ipv6_nat_pool>`

    **lookup-order**

        **Description:** lookup-order is a **JSON Block**.  Please see below for :ref:`2979_lookup-order` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/recursive-dns-resolution/lookup-order <slb_template_dns>`

    **max-trials**

        **Description** Total number of times to try DNS query to server before closing client connection, default 255

        **Type:** number

        **Range:** 1-255

        **Default:** 255

    **ns-cache-lookup**

        **Description** 'disabled': Disable NS Cache Lookup; 'enabled': Enable NS Cache Lookup; 

        **Type:** string

        **Supported Values:** disabled, enabled

        **Default:** enabled

    **request-for-pending-resolution**

        **Description** 'drop': Drop of the request during ongoing; 'respond-with-servfail': Respond with SERVFAIL of the request during ongoing; 'start-new-resolution': Start new resolution of the request during ongoing; 

        **Type:** string

        **Supported Values:** drop, respond-with-servfail, start-new-resolution

        **Default:** respond-with-servfail

    **retries-per-level**

        **Description** Number of DNS query retries at each server level before closing client connection, default 6

        **Type:** number

        **Range:** 1-6

        **Default:** 6

    **udp-initial-interval**

        **Description** UDP DNS Retry Interval value 1-6, default is 5 sec (1-6, default is 5sec)

        **Type:** number

        **Range:** 1-6

        **Default:** 5

    **udp-retry-interval**

        **Description** UDP DNS Retry Interval value 1-6, default is 1 sec (1-6 , default is 1 sec)

        **Type:** number

        **Range:** 1-6

        **Default:** 1

    **use-client-qid**

        **Description** Use client side query id for recursive query

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **use-service-group-response**

        **Description** 'disabled': Start Recursive Resolver if Server response doesnt have final answer; 'enabled': Forward Backend Server response to client and dont start recursive resolver; 

        **Type:** string

        **Supported Values:** disabled, enabled

        **Default:** enabled

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2979_lookup-order:

lookup-order
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **query-type**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2979_lookup-order_query-type:

lookup-order_query-type
^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **num-query-type**

        **Description** Other query type value

        **Type:** number

        **Range:** 1-65535

    **order**

        **Description** 'ipv4-precede-ipv6': Recursive lookup via IPv4 then IPv6; 'ipv6-precede-ipv4': Recursive lookup via IPv6 then IPv4; 

        **Type:** string

        **Supported Values:** ipv4-precede-ipv6, ipv6-precede-ipv4

    **str-query-type**

        **Description** 'A': Address record; 'AAAA': IPv6 Address record; 'CNAME': Canonical name record; 'MX': Mail exchange record; 'NS': Name server record; 'SRV': Service locator; 'PTR': PTR resource record; 'SOA': Start of authority record; 'TXT': Text record; 'ANY': All cached record; 

        **Type:** string

        **Supported Values:** A, AAAA, CNAME, MX, NS, SRV, PTR, SOA, TXT, ANY

.. _2979_gateway-health-check:

gateway-health-check
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **gwhc-ns-cache-lookup**

        **Description** 'disabled': Disable NS Cache Lookup; 'enabled': Enable NS Cache Lookup; 

        **Type:** string

        **Supported Values:** disabled, enabled

        **Default:** disabled

    **interval**

        **Description** Specify the health check interval, default is 10 sec (Interval value, in seconds (default 10))

        **Type:** number

        **Range:** 1-300

        **Default:** 10

    **num-query-type**

        **Description** Other record type value

        **Type:** number

        **Range:** 1-65535

        **Mutual Exclusion:** num-query-type and str-query-type are mutually exclusive

    **query-name**

        **Description** Specify the query name used in probe queries, default "a10networks.com"

        **Type:** string

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

        **Default:** a10networks.com

    **retry**

        **Description** Maximum number of DNS query retries at each server level before health check fails, default 6 (Retry count (default 6))

        **Type:** number

        **Range:** 1-6

        **Default:** 6

    **retry-multi**

        **Description** Specify number of times that health check consecutively fails before declaring gateway DOWN, default 1 (retry-multi count (default 1))

        **Type:** number

        **Range:** 1-10

        **Default:** 1

    **str-query-type**

        **Description** 'A': Address record; 'AAAA': IPv6 Address record; 'CNAME': Canonical name record; 'MX': Mail exchange record; 'NS': Name server record; 'SRV': Service locator; 'PTR': PTR resource record; 'SOA': Start of authority record; 'TXT': Text record; 

        **Type:** string

        **Supported Values:** A, AAAA, CNAME, MX, NS, SRV, PTR, SOA, TXT

        **Default:** A

        **Mutual Exclusion:** str-query-type and num-query-type are mutually exclusive

    **timeout**

        **Description** Specify the health check timeout before retrying or finish, default is 5 sec (Timeout value, in seconds (default 5))

        **Type:** number

        **Range:** 1-6

        **Default:** 5

    **up-retry**

        **Description** Specify number of times that health check consecutively passes before declaring gateway UP, default 1 (up-retry count (default 1))

        **Type:** number

        **Range:** 1-10

        **Default:** 1

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2979_host-list-cfg:

host-list-cfg
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **hostnames**

        **Description** Hostnames class-list name (dns type), perform resolution while query name matched

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/class-list <class_list>`