.. _system_health_check:

system health-check
===================

Layer-2 path health monitor


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

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

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

	 **Object Key(s)**                     *l2hm-hc-name*

	 **Collection Name**                   :ref:`3274_health-check_list`

	 **Collection URI**                    /axapi/v3/system/health-check

	                                       

	 **Element Name**                      health-check

	 **Element URI**                       /axapi/v3/system/health-check/{l2hm-hc-name}

	 **Element Attributes**                health-check_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3274_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/system_health_check_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/system/health-check



.. raw:: html

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


:ref:`3274_health-check_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/health-check/{l2hm-hc-name}



.. raw:: html

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


:ref:`3274_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/system_health_check_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/system/health-check



.. raw:: html

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


:ref:`3274_health-check_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/system/health-check/{l2hm-hc-name}



.. raw:: html

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


:ref:`3274_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/system/health-check/{l2hm-hc-name}



.. raw:: html

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


:ref:`3274_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/system_health_check_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/system/health-check



.. raw:: html

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


:ref:`3274_health-check_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/system/health-check/{l2hm-hc-name}



.. raw:: html

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


:ref:`3274_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/system_health_check_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3274_health-check_list:

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


    health-check-list is **JSON List** of :ref:`3274_health-check_attributes` 

        health-check-list : [

             { :ref:`3274_health-check_attributes` },

             { :ref:`3274_health-check_attributes` },

             ...

         ]

.. _3274_health-check_attributes:

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

    **l2bfd-multiplier**

        **Description** Multiplier value used to compute holddown (value used to multiply the interval (default: 4))

        **Type:** number

        **Range:** 3-50

    **l2bfd-rx-interval**

        **Description** Minimum receive interval capability (Milliseconds (default: 800))

        **Type:** number

        **Range:** 48-1000

    **l2bfd-tx-interval**

        **Description** Transmit interval between BFD packets

        **Type:** number

        **Range:** 48-1000

    **l2hm-hc-name**

        **Description** Monitor Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **method-l2bfd**

        **Description** Method is l2bfd

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters