.. _gslb_policy_dns:

gslb policy dns
===============

DNS related policy


dns Specification
-----------------

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

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

	 **Element Name**                      dns

	 **Element URI**                       /axapi/v3/gslb/policy/{name}/dns

	 **Element Attributes**                dns_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`dns schema <gslb-policy-dns/gslb-policy-dns.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/gslb/policy/{name}/dns



.. raw:: html

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


:ref:`1722_dns_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/gslb_policy_dns_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/gslb/policy/{name}/dns



.. raw:: html

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


:ref:`1722_dns_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/gslb_policy_dns_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/gslb/policy/{name}/dns



.. raw:: html

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


:ref:`1722_dns_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/gslb/policy/{name}/dns



.. raw:: html

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


:ref:`1722_dns_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/gslb_policy_dns_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/gslb/policy/{name}/dns



.. raw:: html

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


:ref:`1722_dns_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

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


.. include:: ../artifacts/gslb_policy_dns_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1722_dns_attributes:

dns attributes
--------------

    **action**

        **Description** Apply DNS action for service

        **Type:** boolean

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

        **Default:** 0

    **action-type**

        **Description** 'drop': Drop query; 'reject': Send refuse response; 'ignore': Send empty response; 

        **Type:** string

        **Supported Values:** drop, reject, ignore

    **active-only**

        **Description** Only keep active servers

        **Type:** boolean

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

        **Default:** 0

    **active-only-fail-safe**

        **Description** Continue if no candidate

        **Type:** boolean

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

        **Default:** 0

    **aging-time**

        **Description** Specify aging-time, default is TTL in DNS record, unit: second (Aging time, default 0 means using TTL in DNS record as aging time)

        **Type:** number

        **Range:** 0-1000000000

        **Default:** 0

    **backup-alias**

        **Description** Return alias name when fail

        **Type:** boolean

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

        **Default:** 0

    **backup-server**

        **Description** Return fallback server when fail

        **Type:** boolean

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

        **Default:** 0

    **block-action**

        **Description** Specify Action

        **Type:** boolean

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

        **Default:** 0

    **block-type**

        **Description** 

        **Type:** string

        **Format:** enum-list

    **block-value**

        **Type:** List

    **cache**

        **Description** Cache DNS Server response

        **Type:** boolean

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

        **Default:** 0

    **cname-detect**

        **Description** Apply GSLB for DNS Server response when service is Canonical Name (CNAME)

        **Type:** boolean

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

        **Default:** 1

    **delegation**

        **Description** Zone Delegation

        **Type:** boolean

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

        **Default:** 0

    **dns-addition-mx**

        **Description** Append MX Records in Addition Section

        **Type:** boolean

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

        **Default:** 0

    **dns-auto-map**

        **Description** Automatically build DNS Infrastructure

        **Type:** boolean

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

        **Default:** 0

    **dynamic-preference**

        **Description** Make dynamically change the preference

        **Type:** boolean

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

        **Default:** 0

    **dynamic-weight**

        **Description** dynamically change the weight

        **Type:** boolean

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

        **Default:** 0

    **external-ip**

        **Description** Return DNS response with external IP address

        **Type:** boolean

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

        **Default:** 1

    **external-soa**

        **Description** Return DNS response with external SOA Record

        **Type:** boolean

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

        **Default:** 0

    **geoloc-action**

        **Description** Apply DNS action by geo-location

        **Type:** boolean

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

        **Default:** 0

    **geoloc-alias**

        **Description** Return alias name by geo-location

        **Type:** boolean

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

        **Default:** 0

    **geoloc-policy**

        **Description** Apply different policy by geo-location

        **Type:** boolean

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

        **Default:** 0

    **hint**

        **Description** 'none': None; 'answer': Append Hint Records in DNS Answer Section; 'addition': Append Hint Records in DNS Addition Section; 

        **Type:** string

        **Supported Values:** none, answer, addition

        **Default:** addition

    **ip-replace**

        **Description** Replace DNS Server Response with GSLB Service-IPs

        **Type:** boolean

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

        **Default:** 0

    **ipv6**

        **Type:** List

    **logging**

        **Description** 'none': None; 'query': DNS Query; 'response': DNS Response; 'both': Both DNS Query and Response; 

        **Type:** string

        **Supported Values:** none, query, response, both

    **proxy-block-port-range-list**

        **Type:** List

    **selected-only**

        **Description** Only keep selected servers

        **Type:** boolean

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

        **Default:** 0

    **selected-only-value**

        **Description** Answer Number

        **Type:** number

        **Range:** 1-128

    **server**

        **Description** Run GSLB as DNS server mode

        **Type:** boolean

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

        **Default:** 0

    **server-addition-mx**

        **Description** Append MX Records in Addition Section

        **Type:** boolean

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

        **Default:** 0

    **server-any**

        **Description** Provide All Records

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** server-any and server-any-with-metric are mutually exclusive

    **server-any-with-metric**

        **Description** Provide All Records with GSLB Metrics applied to A/AAAA Records

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** server-any-with-metric and server-any are mutually exclusive

    **server-authoritative**

        **Description** As authoritative server

        **Type:** boolean

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

        **Default:** 0

    **server-auto-ns**

        **Description** Provide A-Records for NS-Records automatically

        **Type:** boolean

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

        **Default:** 0

    **server-auto-ptr**

        **Description** Provide PTR Records automatically

        **Type:** boolean

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

        **Default:** 0

    **server-caa**

        **Description** Provide CAA Records

        **Type:** boolean

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

        **Default:** 0

    **server-cname**

        **Description** Provide CNAME Records

        **Type:** boolean

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

        **Default:** 0

    **server-custom**

        **Description** Provide Custom Records

        **Type:** boolean

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

        **Default:** 0

    **server-full-list**

        **Description** Append All A Records in Authoritative Section

        **Type:** boolean

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

        **Default:** 0

    **server-mode-only**

        **Description** Only run GSLB as DNS server mode

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** server-mode-only and zone-owner-mode are mutually exclusive

    **server-mx**

        **Description** Provide MX Records

        **Type:** boolean

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

        **Default:** 0

    **server-naptr**

        **Description** Provide NAPTR Records

        **Type:** boolean

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

        **Default:** 0

    **server-ns**

        **Description** Provide NS Records

        **Type:** boolean

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

        **Default:** 0

    **server-ns-list**

        **Description** Append All NS Records in Authoritative Section

        **Type:** boolean

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

        **Default:** 0

    **server-ptr**

        **Description** Provide PTR Records

        **Type:** boolean

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

        **Default:** 0

    **server-sec**

        **Description** Provide DNSSEC support

        **Type:** boolean

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

        **Default:** 0

    **server-srv**

        **Description** Provide SRV Records

        **Type:** boolean

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

        **Default:** 0

    **server-txt**

        **Description** Provide TXT Records

        **Type:** boolean

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

        **Default:** 0

    **sticky**

        **Description** Make DNS Record sticky for certain time

        **Type:** boolean

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

        **Default:** 0

    **sticky-aging-time**

        **Description** Specify aging-time, unit: min, default is 5 (Aging time)

        **Type:** number

        **Range:** 1-65535

        **Default:** 5

    **sticky-ipv6-mask**

        **Description** Specify IPv6 mask length, default is 128

        **Type:** number

        **Range:** 1-128

        **Default:** 128

    **sticky-mask**

        **Description** Specify IP mask, default is /32

        **Type:** string

        **Format:** ipv4-netmask-brief

        **Default:** /32

    **template**

        **Description** Logging template (Logging Template Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/slb/template/logging <slb_template_logging>`

    **ttl**

        **Description** Specify the TTL value contained in DNS record (TTL value, unit: second, default is 10)

        **Type:** number

        **Range:** 0-1000000000

        **Default:** 10

        **Mutual Exclusion:** ttl and use-server-ttl are mutually exclusive

    **use-server-ttl**

        **Description** Use DNS Server Response TTL value in GSLB Proxy mode

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** use-server-ttl and ttl are mutually exclusive

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **zone-owner-mode**

        **Description** Only run GSLB as DNS server mode with zone ownership

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** zone-owner-mode and server-mode-only are mutually exclusive

.. _1722_block-value:

block-value
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **block-value**

        **Description** Specify Type Number

        **Type:** number

        **Range:** 1-255

.. _1722_ipv6:

ipv6
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **dns-ipv6-mapping-type**

        **Description** 'addition': Append Mapped Record in DNS Addition Section; 'answer': Append Mapped Record in DNS Answer Section; 'exclusive': Only return AAAA Record; 'replace': Replace Record with Mapped Record; 

        **Type:** string

        **Supported Values:** addition, answer, exclusive, replace

    **dns-ipv6-option**

        **Description** 'mix': Return both AAAA Record and A Record; 'smart': Return AAAA Record by DNS Query Type; 'mapping': Map A Record to AAAA Record; 

        **Type:** string

        **Supported Values:** mix, smart, mapping

.. _1722_proxy-block-port-range-list:

proxy-block-port-range-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **proxy-block-range-from**

        **Description** Specify Type Range (From)

        **Type:** number

    **proxy-block-range-to**

        **Description** To

        **Type:** number