.. _slb_template_dns_recursive_dns_resolution_gateway_health_check:

slb template dns recursive-dns-resolution gateway-health-check
==============================================================

Enable health check to recursive gateway based on current configuration


gateway-health-check Specification
----------------------------------

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

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

	 **Element Name**                      gateway-health-check

	 **Element URI**                       /axapi/v3/slb/template/dns/{name}/recursive-dns-resolution/gateway-health-check

	 **Element Attributes**                gateway-health-check_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`gateway-health-check schema <slb-template-dns-recursive-dns-resolution-gateway-health-check/slb-template-dns-recursive-dns-resolution-gateway-health-check.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/{name}/recursive-dns-resolution/gateway-health-check



.. raw:: html

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


:ref:`2976_gateway-health-check_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_recursive_dns_resolution_gateway_health_check_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/slb/template/dns/{name}/recursive-dns-resolution/gateway-health-check



.. raw:: html

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


:ref:`2976_gateway-health-check_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_recursive_dns_resolution_gateway_health_check_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/slb/template/dns/{name}/recursive-dns-resolution/gateway-health-check



.. raw:: html

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


:ref:`2976_gateway-health-check_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/{name}/recursive-dns-resolution/gateway-health-check



.. raw:: html

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


:ref:`2976_gateway-health-check_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_recursive_dns_resolution_gateway_health_check_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/slb/template/dns/{name}/recursive-dns-resolution/gateway-health-check



.. raw:: html

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


:ref:`2976_gateway-health-check_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_recursive_dns_resolution_gateway_health_check_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2976_gateway-health-check_attributes:

gateway-health-check attributes
-------------------------------

    **gwhc-ns-cache-lookup**

        **Description** 'disabled': Disable NS Cache Lookup; 'enabled': Enable NS Cache Lookup; 

        **Type:** string

        **Supported Values:** disabled, enabled

        **Default:** disabled

    **interval**

        **Description** Specify the health check interval, default is 10 sec (Interval value, in seconds (default 10))

        **Type:** number

        **Range:** 1-300

        **Default:** 10

    **num-query-type**

        **Description** Other record type value

        **Type:** number

        **Range:** 1-65535

        **Mutual Exclusion:** num-query-type and str-query-type are mutually exclusive

    **query-name**

        **Description** Specify the query name used in probe queries, default "a10networks.com"

        **Type:** string

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

        **Default:** a10networks.com

    **retry**

        **Description** Maximum number of DNS query retries at each server level before health check fails, default 6 (Retry count (default 6))

        **Type:** number

        **Range:** 1-6

        **Default:** 6

    **retry-multi**

        **Description** Specify number of times that health check consecutively fails before declaring gateway DOWN, default 1 (retry-multi count (default 1))

        **Type:** number

        **Range:** 1-10

        **Default:** 1

    **str-query-type**

        **Description** 'A': Address record; 'AAAA': IPv6 Address record; 'CNAME': Canonical name record; 'MX': Mail exchange record; 'NS': Name server record; 'SRV': Service locator; 'PTR': PTR resource record; 'SOA': Start of authority record; 'TXT': Text record; 

        **Type:** string

        **Supported Values:** A, AAAA, CNAME, MX, NS, SRV, PTR, SOA, TXT

        **Default:** A

        **Mutual Exclusion:** str-query-type and num-query-type are mutually exclusive

    **timeout**

        **Description** Specify the health check timeout before retrying or finish, default is 5 sec (Timeout value, in seconds (default 5))

        **Type:** number

        **Range:** 1-6

        **Default:** 5

    **up-retry**

        **Description** Specify number of times that health check consecutively passes before declaring gateway UP, default 1 (up-retry count (default 1))

        **Type:** number

        **Range:** 1-10

        **Default:** 1

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters