.. _cgnv6_template_dns:

cgnv6 template dns
==================

DNS template


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

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

	===================================== ==================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`607_dns_list`

	 **Collection URI**                    /axapi/v3/cgnv6/template/dns

	                                       

	 **Element Name**                      dns

	 **Element URI**                       /axapi/v3/cgnv6/template/dns/{name}

	 **Element Attributes**                dns_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`dns schema <cgnv6-template-dns/cgnv6-template-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/cgnv6/template/dns



.. raw:: html

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


:ref:`607_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/cgnv6_template_dns_POST.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/cgnv6/template/dns



.. raw:: html

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


:ref:`607_dns_attributes`



.. raw:: html

   </td><td></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/cgnv6/template/dns/{name}



.. raw:: html

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


:ref:`607_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/cgnv6_template_dns_GET.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/cgnv6/template/dns



.. raw:: html

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


:ref:`607_dns_list`



.. raw:: html

   </td><td></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/cgnv6/template/dns/{name}



.. raw:: html

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


:ref:`607_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/cgnv6/template/dns/{name}



.. raw:: html

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


:ref:`607_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/cgnv6_template_dns_PUT.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/cgnv6/template/dns



.. raw:: html

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


:ref:`607_dns_list`



.. raw:: html

   </td><td></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/cgnv6/template/dns/{name}



.. raw:: html

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


:ref:`607_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/cgnv6_template_dns_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _607_dns_list:

dns-list
--------


    dns-list is **JSON List** of :ref:`607_dns_attributes` 

        dns-list : [

             { :ref:`607_dns_attributes` },

             { :ref:`607_dns_attributes` },

             ...

         ]

.. _607_dns_attributes:

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

    **class-list**

        **Description:** class-list is a **JSON Block**.  Please see below for :ref:`607_class-list` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/template/dns/{name}/class-list <cgnv6_template_dns>`

    **default-policy**

        **Description** 'nocache': Cache disable; 'cache': Cache enable; 

        **Type:** string

        **Supported Values:** nocache, cache

        **Default:** nocache

    **disable-dns-template**

        **Description** Disable DNS template

        **Type:** boolean

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

        **Default:** 0

    **dns64**

        **Description:** dns64 is a **JSON Block**.  Please see below for :ref:`607_dns64` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/template/dns/{name}/dns64 <cgnv6_template_dns>`

    **drop**

        **Description** Drop the malformed query

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** drop and forward are mutually exclusive

    **forward**

        **Description** Forward to service group (Service group name)

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** forward and drop are mutually exclusive

    **max-cache-size**

        **Description** Define maximum cache size (Maximum cache entry per VIP)

        **Type:** number

    **name**

        **Description** DNS Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **period**

        **Description** Period in minutes

        **Type:** number

        **Range:** 1-10000

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _607_class-list:

class-list
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **lid-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/cgnv6/template/dns/{name}/class-list/lid/{lidnum} <cgnv6_template_dns>`

    **name**

        **Description** Specify a class list name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _607_class-list_lid-list:

class-list_lid-list
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **action-value**

        **Description** 'dns-cache-disable': Disable DNS cache when it exceeds limit; 'dns-cache-enable': Enable DNS cache when it exceeds limit; 'forward': Forward the traffic even it exceeds limit; 

        **Type:** string

        **Supported Values:** dns-cache-disable, dns-cache-enable, forward

    **conn-rate-limit**

        **Description** Connection rate limit

        **Type:** number

        **Range:** 1-2147483647

    **dns**

        **Description:** dns is a **JSON Block**.  Please see below for :ref:`607_class-list_lid-list_dns` 

        **Type:** Object

    **lidnum**

        **Description** Specify a limit ID

        **Type:** number

        **Range:** 1-31

    **lockout**

        **Description** Don't accept any new connection for certain time (Lockout duration in minutes)

        **Type:** number

        **Range:** 1-1023

    **log**

        **Description** Log a message

        **Type:** boolean

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

        **Default:** 0

    **log-interval**

        **Description** Log interval (minute, by default system will log every over limit instance)

        **Type:** number

        **Range:** 1-255

    **over-limit-action**

        **Description** Action when exceeds limit

        **Type:** boolean

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

        **Default:** 0

    **per**

        **Description** Per (Number of 100ms)

        **Type:** number

        **Range:** 1-65535

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _607_class-list_lid-list_dns:

class-list_lid-list_dns
^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **cache-action**

        **Description** 'cache-disable': Disable dns cache; 'cache-enable': Enable dns cache; 

        **Type:** string

        **Supported Values:** cache-disable, cache-enable

        **Default:** cache-disable

    **ttl**

        **Description** TTL for cache entry (TTL in seconds)

        **Type:** number

        **Range:** 1-65535

    **weight**

        **Description** Weight for cache entry

        **Type:** number

        **Range:** 1-7

.. _607_dns64:

dns64
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **answer-only-disable**

        **Description** Disable Only translate the Answer Section

        **Type:** boolean

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

        **Default:** 0

    **auth-data**

        **Description** Set AA flag in DNS Response

        **Type:** boolean

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

        **Default:** 0

    **cache**

        **Description** Use a cached A-query response to provide AAAA query responses for the same hostname

        **Type:** boolean

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

        **Default:** 0

    **change-query**

        **Description** Always change incoming AAAA DNS Query to A

        **Type:** boolean

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

        **Default:** 0

    **compress-disable**

        **Description** Disable Always try DNS Compression

        **Type:** boolean

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

        **Default:** 0

    **deep-check-qr**

        **Description** Check DNS Question Record

        **Type:** boolean

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

        **Default:** 0

    **deep-check-rr-disable**

        **Description** Disable Check DNS Response Records

        **Type:** boolean

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

        **Default:** 0

    **drop-cname-disable**

        **Description** Disable Drop DNS CNAME Response

        **Type:** boolean

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

        **Default:** 0

    **edns-append**

        **Description** Append EDNS Record when send A Query to server

        **Type:** boolean

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

        **Default:** 0

    **enable**

        **Description** Enable DNS64 (Need to config this option before config any other dns64 options)

        **Type:** boolean

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

        **Default:** 0

    **fast-append**

        **Description** Append translated Records when original Response only has Answer Section

        **Type:** boolean

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

        **Default:** 0

    **ignore-rcode3-disable**

        **Description** Disable Ignore DNS error Response with rcode 3

        **Type:** boolean

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

        **Default:** 0

    **max-qr-length**

        **Description** Max Question Record Length, default is 128

        **Type:** number

        **Range:** 1-1023

        **Default:** 128

    **parallel-query**

        **Description** Forward AAAA Query & generate A Query in parallel

        **Type:** boolean

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

        **Default:** 0

    **passive-query-disable**

        **Description** Disable Generate A query upon empty or error Response

        **Type:** boolean

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

        **Default:** 0

    **retry**

        **Description** Retry count, default is 3 (Retry Number)

        **Type:** number

        **Range:** 0-15

        **Default:** 3

    **single-response-disable**

        **Description** Disable Single Response which is used to avoid ambiguity

        **Type:** boolean

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

        **Default:** 0

    **timeout**

        **Description** Timeout to send additional Queries, unit: second, default is 1

        **Type:** number

        **Range:** 0-15

        **Default:** 1

    **trans-ptr**

        **Description** Translate DNS PTR Records

        **Type:** boolean

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

        **Default:** 0

    **trans-ptr-query**

        **Description** Translate DNS PTR Query

        **Type:** boolean

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

        **Default:** 0

    **ttl**

        **Description** Specify Max TTL in DNS Response, unit: second

        **Type:** number

        **Range:** 1-1000000000

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters