.. _system_dns_cache:

system dns-cache
================

DNS Cache Statistics


dns-cache Specification
-----------------------

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

	 **Element Name**                      dns-cache

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

	 **Element Attributes**                dns-cache_attributes

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

	 **Operational Data URI**              /axapi/v3/system/dns-cache/oper

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



.. raw:: html

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


:ref:`2013_dns-cache_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-cache



.. raw:: html

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


:ref:`2013_dns-cache_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-cache



.. raw:: html

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


:ref:`2013_dns-cache_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-cache



.. raw:: html

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


:ref:`2013_dns-cache_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-cache



.. raw:: html

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


:ref:`2013_dns-cache_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2013_dns-cache_attributes:

dns-cache attributes
--------------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2013_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'total_q': Total query; 'total_r': Total server response; 'hit': Total cache hit; 'bad_q': Query not passed; 'encode_q': Query encoded; 'multiple_q': Query with multiple questions; 'oversize_q': Query exceed cache size; 'bad_r': Response not passed; 'oversize_r': Response exceed cache size; 'encode_r': Response encoded; 'multiple_r': Response with multiple questions; 'answer_r': Response with multiple answers; 'ttl_r': Response with short TTL; 'ageout': Total aged out; 'bad_answer': Bad Answer; 'ageout_weight': Total aged for lower weight; 'total_log': Total stats log sent; 'total_alloc': Total allocated; 'total_freed': Total freed; 'current_allocate': Current allocate; 'current_data_allocate': Current data allocate; 'resolver_queue_full': Resolver task queue full; 'truncated_r': Response with Truncation bit set; 

        **Type:** string

        **Supported Values:** all, total_q, total_r, hit, bad_q, encode_q, multiple_q, oversize_q, bad_r, oversize_r, encode_r, multiple_r, answer_r, ttl_r, ageout, bad_answer, ageout_weight, total_log, total_alloc, total_freed, current_allocate, current_data_allocate, resolver_queue_full, truncated_r

.. _2013_stats_data:

stats data
----------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - multiple_r
      - 2
      - Response with multiple questions

   *  - 
      - multiple_q
      - 2
      - Query with multiple questions

   *  - 
      - bad_q
      - 2
      - Query not passed

   *  - 
      - bad_r
      - 2
      - Response not passed

   *  - 
      - answer_r
      - 2
      - Response with multiple answers

   *  - 
      - encode_q
      - 2
      - Query encoded

   *  - 
      - current_data_allocate
      - 8
      - Current data allocate

   *  - 
      - ttl_r
      - 2
      - Response with short TTL

   *  - 
      - resolver_queue_full
      - 8
      - Resolver task queue full

   *  - 
      - total_q
      - 2
      - Total query

   *  - 
      - total_r
      - 2
      - Total server response

   *  - 
      - total_log
      - 2
      - Total stats log sent

   *  - 
      - hit
      - 2
      - Total cache hit

   *  - 
      - current_allocate
      - 8
      - Current allocate

   *  - 
      - oversize_r
      - 2
      - Response exceed cache size

   *  - 
      - oversize_q
      - 2
      - Query exceed cache size

   *  - 
      - truncated_r
      - 8
      - Response with Truncation bit set

   *  - 
      - ageout_weight
      - 2
      - Total aged for lower weight

   *  - 
      - bad_answer
      - 2
      - Bad Answer

   *  - 
      - ageout
      - 2
      - Total aged out

   *  - 
      - total_freed
      - 2
      - Total freed

   *  - 
      - total_alloc
      - 2
      - Total allocated

   *  - 
      - encode_r
      - 2
      - Response encoded

.. _2013_oper_data:

operational data
----------------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - fqdn_domain
      - string-rlx
      - domain name

   *  - 
      - type_value
      - number
      - type_value

   *  - 
      - port-num
      - number
      - port-num

   *  - 
      - cache-client
      - 
      - cache-client

   *  - 
      - class_value
      - number
      - type value

   *  - 
      - type_string
      - enum
      -  Output contains one of the following values: - A, AAAA, CNAE, MX, NS, SRV

   *  - 
      - global
      - flag
      - global

   *  - 
      - vs-name
      - string
      - vs-name

   *  - 
      - domain_name
      - string-rlx
      - domain name

   *  - 
      - class_string
      - enum
      -  Output contains one of the following values: - IN, CH, HS, NONE, ANY

   *  - 
      - client
      - flag
      - client

   *  - 
      - entry
      - flag
      - entry

   *  - 
      - cache-entry
      - 
      - cache-entry

   *  - 
      - total
      - number
      - total

   *  - 
      - vport
      - flag
      - vport

   *  - 
      - port-type
      - string
      - port-type