.. _cgnv6_map_translation_domain_health_check_gateway:

cgnv6 map translation domain health-check-gateway
=================================================

Health-check gateway for route withdrawn


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

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

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

	 **Element Name**                      health-check-gateway

	 **Element URI**                       /axapi/v3/cgnv6/map/translation/domain/{name}/health-check-gateway

	 **Element Attributes**                health-check-gateway_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`health-check-gateway schema <cgnv6-map-translation-domain-health-check-gateway/cgnv6-map-translation-domain-health-check-gateway.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/cgnv6/map/translation/domain/{name}/health-check-gateway



.. raw:: html

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


:ref:`450_health-check-gateway_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/cgnv6_map_translation_domain_health_check_gateway_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/cgnv6/map/translation/domain/{name}/health-check-gateway



.. raw:: html

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


:ref:`450_health-check-gateway_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/cgnv6_map_translation_domain_health_check_gateway_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/cgnv6/map/translation/domain/{name}/health-check-gateway



.. raw:: html

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


:ref:`450_health-check-gateway_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/cgnv6/map/translation/domain/{name}/health-check-gateway



.. raw:: html

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


:ref:`450_health-check-gateway_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/cgnv6_map_translation_domain_health_check_gateway_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/cgnv6/map/translation/domain/{name}/health-check-gateway



.. raw:: html

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


:ref:`450_health-check-gateway_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/cgnv6_map_translation_domain_health_check_gateway_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _450_health-check-gateway_attributes:

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

    **address-list**

        **Type:** List

    **ipv6-address-list**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **withdraw-route**

        **Description** 'all-link-failure': Withdraw routes on health-check failure of all IPv4 gateways or all IPv6 gateways; 'any-link-failure': Withdraw routes on health-check failure of any gateway (default); 

        **Type:** string

        **Supported Values:** all-link-failure, any-link-failure

        **Default:** any-link-failure

.. _450_ipv6-address-list:

ipv6-address-list
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ipv6-gateway**

        **Description** IPv6 Gateway

        **Type:** string

        **Format:** ipv6-address

.. _450_address-list:

address-list
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ipv4-gateway**

        **Description** IPv4 Gateway

        **Type:** string

        **Format:** ipv4-address