.. _cgnv6_lsn_health_check_gateway:

cgnv6 lsn health-check-gateway
==============================

Configure LSN health-check gateway


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

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

	===================================== ===============================================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *ipv4-addr, ipv6-addr*

	 **Collection Name**                   :ref:`364_health-check-gateway_list`

	 **Collection URI**                    /axapi/v3/cgnv6/lsn/health-check-gateway

	                                       

	 **Element Name**                      health-check-gateway

	 **Element URI**                       /axapi/v3/cgnv6/lsn/health-check-gateway/{ipv4-addr}+{ipv6-addr}

	 **Element Attributes**                health-check-gateway_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`health-check-gateway schema <cgnv6-lsn-health-check-gateway/cgnv6-lsn-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/lsn/health-check-gateway



.. raw:: html

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


:ref:`364_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_lsn_health_check_gateway_POST.txt
   :literal:




.. raw:: html

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


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/cgnv6/lsn/health-check-gateway



.. raw:: html

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


:ref:`364_health-check-gateway_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/cgnv6/lsn/health-check-gateway/{ipv4-addr}+{ipv6-addr}



.. raw:: html

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


:ref:`364_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_lsn_health_check_gateway_GET.txt
   :literal:




.. raw:: html

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


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/cgnv6/lsn/health-check-gateway



.. raw:: html

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


:ref:`364_health-check-gateway_list`



.. 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/cgnv6/lsn/health-check-gateway/{ipv4-addr}+{ipv6-addr}



.. raw:: html

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


:ref:`364_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/lsn/health-check-gateway/{ipv4-addr}+{ipv6-addr}



.. raw:: html

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


:ref:`364_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_lsn_health_check_gateway_PUT.txt
   :literal:




.. raw:: html

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


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/cgnv6/lsn/health-check-gateway



.. raw:: html

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


:ref:`364_health-check-gateway_list`



.. 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/cgnv6/lsn/health-check-gateway/{ipv4-addr}+{ipv6-addr}



.. raw:: html

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


:ref:`364_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_lsn_health_check_gateway_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _364_health-check-gateway_list:

health-check-gateway-list
-------------------------


    health-check-gateway-list is **JSON List** of :ref:`364_health-check-gateway_attributes` 

        health-check-gateway-list : [

             { :ref:`364_health-check-gateway_attributes` },

             { :ref:`364_health-check-gateway_attributes` },

             ...

         ]

.. _364_health-check-gateway_attributes:

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

    **ipv4-addr**

        **Description** Specify IPv4 Gateway

        **Type:** string

        **Format:** ipv4-address

        **Mutual Exclusion:** ipv4-addr and ipv6-addr are mutually exclusive

    **ipv6-addr**

        **Description** Specify IPv6 Gateway

        **Type:** string

        **Format:** ipv6-address

        **Mutual Exclusion:** ipv6-addr and ipv4-addr are mutually exclusive

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters