.. _system_dns:

system dns
==========

DNS Packet Statistics


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

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

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

	 **Element Name**                      dns

	 **Element URI**                       /axapi/v3/system/dns

	 **Element Attributes**                dns_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/system/dns/stats

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



.. raw:: html

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


:ref:`2405_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/system/dns



.. raw:: html

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


:ref:`2405_dns_attributes`



.. 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/system/dns



.. raw:: html

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


:ref:`2405_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/system/dns



.. raw:: html

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


:ref:`2405_dns_attributes`



.. 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/system/dns



.. raw:: html

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


:ref:`2405_dns_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2405_dns_attributes:

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

    **recursive-nameserver**

        **Description:** recursive-nameserver is a **JSON Block**.  Please see below for :ref:`2405_recursive-nameserver` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/system/dns/recursive-nameserver <system_dns_recursive_nameserver>`

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2405_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'slb_req': No. of requests; 'slb_resp': No. of responses; 'slb_no_resp': No. of requests with no response; 'slb_req_rexmit': No. of requests retransmit; 'slb_resp_no_match': No. of requests and responses with no match; 'slb_no_resource': No. of resource failures; 'nat_req': (NAT) No. of requests; 'nat_resp': (NAT) No. of responses; 'nat_no_resp': (NAT) No. of resource failures; 'nat_req_rexmit': (NAT) No. of request retransmits; 'nat_resp_no_match': (NAT) No. of requests with no response; 'nat_no_resource': (NAT) No. of resource failures; 'nat_xid_reused': (NAT) No. of requests reusing a transaction id; 'filter_type_drop': Total Query Type Drop; 'filter_class_drop': Total Query Class Drop; 'filter_type_any_drop': Total Query ANY Type Drop; 'slb_dns_client_ssl_succ': No. of client ssl success; 'slb_dns_server_ssl_succ': No. of server ssl success; 'slb_dns_udp_conn': No. of backend udp connections; 'slb_dns_udp_conn_succ': No. of backend udp conn established; 'slb_dns_padding_to_server_removed': some help string; 'slb_dns_padding_to_client_added': some help string; 'slb_dns_edns_subnet_to_server_removed': some help string; 'slb_dns_udp_retransmit': some help string; 'slb_dns_udp_retransmit_fail': some help string; 'rpz_action_drop': RPZ Action Drop; 'rpz_action_pass_thru': RPZ Action Pass Through; 'rpz_action_tcp_only': RPZ Action TCP Only; 'rpz_action_nxdomain': RPZ Action NXDOMAIN; 'rpz_action_nodata': RPZ Action NODATA; 'rpz_action_local_data': RPZ Action Local Data; 'slb_drop': DNS requests drop; 'nat_slb_drop': (NAT)DNS requests drop; 'invalid_q_len_to_udp': invalid query length to conver to UDP; 

        **Type:** string

        **Supported Values:** all, slb_req, slb_resp, slb_no_resp, slb_req_rexmit, slb_resp_no_match, slb_no_resource, nat_req, nat_resp, nat_no_resp, nat_req_rexmit, nat_resp_no_match, nat_no_resource, nat_xid_reused, filter_type_drop, filter_class_drop, filter_type_any_drop, slb_dns_client_ssl_succ, slb_dns_server_ssl_succ, slb_dns_udp_conn, slb_dns_udp_conn_succ, slb_dns_padding_to_server_removed, slb_dns_padding_to_client_added, slb_dns_edns_subnet_to_server_removed, slb_dns_udp_retransmit, slb_dns_udp_retransmit_fail, rpz_action_drop, rpz_action_pass_thru, rpz_action_tcp_only, rpz_action_nxdomain, rpz_action_nodata, rpz_action_local_data, slb_drop, nat_slb_drop, invalid_q_len_to_udp

.. _2405_recursive-nameserver:

recursive-nameserver
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **follow-shared**

        **Description** Use the configured name servers of shared partition

        **Type:** boolean

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

        **Default:** 0

    **server-list**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2405_recursive-nameserver_server-list:

recursive-nameserver_server-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ipv4-addr**

        **Description** Specify IPv4 server address

        **Type:** string

        **Format:** ipv4-address

    **ipv6-addr**

        **Description** Specify IPv6 server address

        **Type:** string

        **Format:** ipv6-address

    **v4-desc**

        **Description** Description for this ipv4 address

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **v6-desc**

        **Description** Description for this ipv6 address

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters