.. _gslb_dns:

gslb dns
========

DNS Global Options


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

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

	 **Element Name**                      dns

	 **Element URI**                       /axapi/v3/gslb/dns

	 **Element Attributes**                dns_attributes

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

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



.. raw:: html

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


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



.. raw:: html

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


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



.. raw:: html

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


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



.. raw:: html

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


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



.. raw:: html

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


:ref:`469_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_dns_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _469_dns_attributes:

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

    **action**

        **Description** 'none': No action (default); 'drop': Drop query; 'reject': Send refuse response; 'ignore': Send empty response; 

        **Type:** string

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

        **Default:** none

    **logging**

        **Description** 'none': No logging (default); 'query': DNS Query; 'response': DNS Response; 'both': Both DNS Query and Response; 

        **Type:** string

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

        **Default:** none

    **sampling-enable**

        **Type:** List

    **template**

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

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _469_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'total-query': Total number of DNS queries received; 'total-response': Total number of DNS replies sent to clients; 'bad-packet-query': Number of queries with incorrect data length; 'bad-packet-response': Number of replies with incorrect data length; 'bad-header-query': Number of queries with incorrect header; 'bad-header-response': Number of replies with incorrect header; 'bad-format-query': Number of queries with incorrect format; 'bad-format-response': Number of replies with incorrect format; 'bad-service-query': Number of queries with unknown service; 'bad-service-response': Number of replies with unknown service; 'bad-class-query': Number of queries with incorrect class; 'bad-class-response': Number of replies with incorrect class; 'bad-type-query': Number of queries with incorrect type; 'bad-type-response': Number of replies with incorrect type; 'no_answer': Number of replies with unknown server IP; 

        **Type:** string

        **Supported Values:** all, total-query, total-response, bad-packet-query, bad-packet-response, bad-header-query, bad-header-response, bad-format-query, bad-format-response, bad-service-query, bad-service-response, bad-class-query, bad-class-response, bad-type-query, bad-type-response, no_answer, metric_health_check, metric_weighted_ip, metric_weighted_site, metric_capacity, metric_active_server, metric_easy_rdt, metric_active_rdt, metric_geographic, metric_connection_load, metric_number_of_sessions, metric_active_weight, metric_admin_preference, metric_bandwidth_quality, metric_bandwidth_cost, metric_user, metric_least_reponse, metric_admin_ip, metric_round_robin

.. _469_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - metric_capacity
      - 8
      - Metric Capacity Hit

   *  - 
      - metric_admin_ip
      - 8
      - Metric Admin IP Hit

   *  - 
      - no_answer
      - 8
      - Number of replies with unknown server IP

   *  - 
      - bad-format-query
      - 8
      - Number of queries with incorrect format

   *  - 
      - metric_active_server
      - 8
      - Metric Active Server Hit

   *  - 
      - metric_active_rdt
      - 8
      - Metric Active RDT Hit

   *  - 
      - metric_connection_load
      - 8
      - Metric Connection Load Hit

   *  - 
      - bad-service-response
      - 8
      - Number of replies with unknown service

   *  - 
      - metric_user
      - 8
      - Metric User Hit

   *  - 
      - bad-packet-query
      - 8
      - Number of queries with incorrect data length

   *  - 
      - total-query
      - 8
      - Total number of DNS queries received

   *  - 
      - metric_bandwidth_cost
      - 8
      - Metric Bandwidth Cost Hit

   *  - 
      - bad-class-query
      - 8
      - Number of queries with incorrect class

   *  - 
      - metric_bandwidth_quality
      - 8
      - Metric Bandwidth Quality Hit

   *  - 
      - bad-service-query
      - 8
      - Number of queries with unknown service

   *  - 
      - bad-header-response
      - 8
      - Number of replies with incorrect header

   *  - 
      - metric_least_reponse
      - 8
      - Metric Least Reponse Hit

   *  - 
      - metric_weighted_site
      - 8
      - Metric Weighted Site Hit

   *  - 
      - total-response
      - 8
      - Total number of DNS replies sent to clients

   *  - 
      - metric_health_check
      - 8
      - Metric Health Check Hit

   *  - 
      - metric_round_robin
      - 8
      - Metric Round Robin Hit

   *  - 
      - metric_easy_rdt
      - 8
      - Metric Easy RDT Hit

   *  - 
      - bad-type-query
      - 8
      - Number of queries with incorrect type

   *  - 
      - bad-packet-response
      - 8
      - Number of replies with incorrect data length

   *  - 
      - metric_weighted_ip
      - 8
      - Metric Weighted IP Hit

   *  - 
      - bad-class-response
      - 8
      - Number of replies with incorrect class

   *  - 
      - bad-format-response
      - 8
      - Number of replies with incorrect format

   *  - 
      - metric_geographic
      - 8
      - Metric Geographic Hit

   *  - 
      - bad-header-query
      - 8
      - Number of queries with incorrect header

   *  - 
      - metric_active_weight
      - 8
      - Metric Active Weight Hit

   *  - 
      - metric_admin_preference
      - 8
      - Metric Admin Preference Hit

   *  - 
      - metric_number_of_sessions
      - 8
      - Metric Number of Sessions Hit

   *  - 
      - bad-type-response
      - 8
      - Number of replies with incorrect type