.. _slb_template_dns_logging:

slb template dns-logging
========================

DNS Logging template


dns-logging Specification
-------------------------

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

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

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

	 **Collection Name**                   :ref:`2972_dns-logging_list`

	 **Collection URI**                    /axapi/v3/slb/template/dns-logging

	                                       

	 **Element Name**                      dns-logging

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

	 **Element Attributes**                dns-logging_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2972_dns-logging_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_logging_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/slb/template/dns-logging



.. raw:: html

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


:ref:`2972_dns-logging_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/slb/template/dns-logging/{name}



.. raw:: html

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


:ref:`2972_dns-logging_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_logging_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/slb/template/dns-logging



.. raw:: html

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


:ref:`2972_dns-logging_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/slb/template/dns-logging/{name}



.. raw:: html

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


:ref:`2972_dns-logging_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-logging/{name}



.. raw:: html

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


:ref:`2972_dns-logging_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_logging_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/slb/template/dns-logging



.. raw:: html

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


:ref:`2972_dns-logging_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/slb/template/dns-logging/{name}



.. raw:: html

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


:ref:`2972_dns-logging_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/slb_template_dns_logging_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2972_dns-logging_list:

dns-logging-list
----------------


    dns-logging-list is **JSON List** of :ref:`2972_dns-logging_attributes` 

        dns-logging-list : [

             { :ref:`2972_dns-logging_attributes` },

             { :ref:`2972_dns-logging_attributes` },

             ...

         ]

.. _2972_dns-logging_attributes:

dns-logging attributes
----------------------

    **disable**

        **Description** Disable DNS Logging template

        **Type:** boolean

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

        **Default:** 0

    **dns-logging-protocol**

        **Description** 'both': Log DNS over tcp and udp; 'tcp': Log DNS over tcp; 'udp': Log DNS over udp; 

        **Type:** string

        **Supported Values:** both, tcp, udp

    **dns-logging-request-section**

        **Description** 'all': Log DNS header and question section; 'header': Log DNS header information; 'question': Log DNS question section; 

        **Type:** string

        **Supported Values:** all, header, question

    **dns-logging-response-section**

        **Description** 'all': Log DNS header information, answer, authority, additional section content; 'header': Log DNS header information; 'answer': Log DNS header information and answer section content; 

        **Type:** string

        **Supported Values:** all, header, answer

    **dns-logging-type**

        **Description** 'query': DNS Query Logging; 'response': DNS Response Logging; 'both': DNS Query and Response Logging; 

        **Type:** string

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

    **name**

        **Description** DNS Logging Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **response-type**

        **Description:** response-type is a **JSON Block**.  Please see below for :ref:`2972_response-type` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/slb/template/dns-logging/{name}/response-type <slb_template_dns_logging>`

    **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

.. _2972_response-type:

response-type
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **config**

        **Description** start config the response type detail

        **Type:** boolean

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

        **Default:** 0

    **type-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/slb/template/dns-logging/{name}/response-type/type/{response-type-name} <slb_template_dns_logging>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2972_response-type_type-list:

response-type_type-list
^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **caa-type-limit-num**

        **Description** Limit the field length

        **Type:** number

        **Range:** 0-256

        **Default:** 0

        **Mutual Exclusion:** caa-type-limit-num and caa-type-no-limit are mutually exclusive

    **caa-type-no-limit**

        **Description** Print the field as much as possible

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** caa-type-no-limit and caa-type-limit-num are mutually exclusive

    **digest**

        **Description** 

        **Type:** boolean

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

        **Default:** 0

    **dnskey-type-limit-num**

        **Description** Limit the field length

        **Type:** number

        **Range:** 0-256

        **Default:** 0

        **Mutual Exclusion:** dnskey-type-limit-num and dnskey-type-no-limit are mutually exclusive

    **dnskey-type-no-limit**

        **Description** Print the field as much as possible

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** dnskey-type-no-limit and dnskey-type-limit-num are mutually exclusive

    **ds-type-limit-num**

        **Description** Limit the field length

        **Type:** number

        **Range:** 0-256

        **Default:** 0

        **Mutual Exclusion:** ds-type-limit-num and ds-type-no-limit are mutually exclusive

    **ds-type-no-limit**

        **Description** Print the field as much as possible

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** ds-type-no-limit and ds-type-limit-num are mutually exclusive

    **length-limit-flag**

        **Description** 

        **Type:** boolean

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

        **Default:** 0

    **naptr-type-limit-num**

        **Description** Limit the field length

        **Type:** number

        **Range:** 0-256

        **Default:** 0

        **Mutual Exclusion:** naptr-type-limit-num and naptr-type-no-limit are mutually exclusive

    **naptr-type-no-limit**

        **Description** Print the field as much as possible

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** naptr-type-no-limit and naptr-type-limit-num are mutually exclusive

    **opt-type-limit-num**

        **Description** Limit the field length

        **Type:** number

        **Range:** 0-256

        **Default:** 0

        **Mutual Exclusion:** opt-type-limit-num and opt-type-no-limit are mutually exclusive

    **opt-type-no-limit**

        **Description** Print the field as much as possible

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** opt-type-no-limit and opt-type-limit-num are mutually exclusive

    **other-data**

        **Description** 

        **Type:** boolean

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

        **Default:** 0

    **public-key**

        **Description** 

        **Type:** boolean

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

        **Default:** 0

    **rdata-field**

        **Description** 

        **Type:** boolean

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

        **Default:** 0

    **response-type-name**

        **Description** 'TXT': TXT; 'RRSIG': RRSIG; 'TSIG': TSIG; 'DNSKEY': DNSKEY; 'DS': DS; 'CAA': CAA; 'NAPTR': NAPTR; 'OPT': OPT; 

        **Type:** string

        **Supported Values:** TXT, RRSIG, TSIG, DNSKEY, DS, CAA, NAPTR, OPT

    **rrsig-type-limit-num**

        **Description** Limit the field length

        **Type:** number

        **Range:** 0-256

        **Default:** 0

        **Mutual Exclusion:** rrsig-type-limit-num and rrsig-type-no-limit are mutually exclusive

    **rrsig-type-no-limit**

        **Description** Print the field as much as possible

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** rrsig-type-no-limit and rrsig-type-limit-num are mutually exclusive

    **service-field**

        **Description** 

        **Type:** boolean

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

        **Default:** 0

    **signature**

        **Description** 

        **Type:** boolean

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

        **Default:** 0

    **tsig-type-limit-num**

        **Description** Limit the field length

        **Type:** number

        **Range:** 0-256

        **Default:** 0

        **Mutual Exclusion:** tsig-type-limit-num and tsig-type-no-limit are mutually exclusive

    **tsig-type-no-limit**

        **Description** Print the field as much as possible

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** tsig-type-no-limit and tsig-type-limit-num are mutually exclusive

    **txt-data**

        **Description** 

        **Type:** boolean

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

        **Default:** 0

    **txt-type-limit-num**

        **Description** Limit the field length

        **Type:** number

        **Range:** 0-256

        **Default:** 0

        **Mutual Exclusion:** txt-type-limit-num and txt-type-no-limit are mutually exclusive

    **txt-type-no-limit**

        **Description** Print the field as much as possible

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** txt-type-no-limit and txt-type-limit-num are mutually exclusive

    **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

    **value-field**

        **Description** 

        **Type:** boolean

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

        **Default:** 0