.. _network_virtual_wire_health_check:

network virtual-wire-health-check
=================================

Virtual Wire Health Check Configuration


virtual-wire-health-check Specification
---------------------------------------

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

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

	 **Object Key(s)**                     *vlan*

	 **Collection Name**                   :ref:`1618_virtual-wire-health-check_list`

	 **Collection URI**                    /axapi/v3/network/virtual-wire-health-check

	                                       

	 **Element Name**                      virtual-wire-health-check

	 **Element URI**                       /axapi/v3/network/virtual-wire-health-check/{vlan}

	 **Element Attributes**                virtual-wire-health-check_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/network/virtual-wire-health-check/{vlan}/stats

	 **Operational Data URI**              /axapi/v3/network/virtual-wire-health-check/{vlan}/oper

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



.. raw:: html

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


:ref:`1618_virtual-wire-health-check_attributes`



.. raw:: html

   </td><td></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/network/virtual-wire-health-check



.. raw:: html

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


:ref:`1618_virtual-wire-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/network/virtual-wire-health-check/{vlan}



.. raw:: html

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


:ref:`1618_virtual-wire-health-check_attributes`



.. raw:: html

   </td><td></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/network/virtual-wire-health-check



.. raw:: html

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


:ref:`1618_virtual-wire-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/network/virtual-wire-health-check/{vlan}



.. raw:: html

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


:ref:`1618_virtual-wire-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/network/virtual-wire-health-check/{vlan}



.. raw:: html

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


:ref:`1618_virtual-wire-health-check_attributes`



.. raw:: html

   </td><td></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/network/virtual-wire-health-check



.. raw:: html

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


:ref:`1618_virtual-wire-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/network/virtual-wire-health-check/{vlan}



.. raw:: html

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


:ref:`1618_virtual-wire-health-check_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1618_virtual-wire-health-check_list:

virtual-wire-health-check-list
------------------------------


    virtual-wire-health-check-list is **JSON List** of :ref:`1618_virtual-wire-health-check_attributes` 

        virtual-wire-health-check-list : [

             { :ref:`1618_virtual-wire-health-check_attributes` },

             { :ref:`1618_virtual-wire-health-check_attributes` },

             ...

         ]

.. _1618_virtual-wire-health-check_attributes:

virtual-wire-health-check attributes
------------------------------------

    **active-threshold**

        **Description** Threshold(Packet Per Second) for entering active mode

        **Type:** number

        **Range:** 1-1048575

    **enable**

        **Description** Enable the health check

        **Type:** boolean

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

        **Default:** 0

    **ethernet**

        **Description** Ethernet interface

        **Type:** number

        **Format:** interface

    **garp-interval**

        **Description** Interval (Seconds), default is 3, 0 for interface event only

        **Type:** number

        **Range:** 0-180

    **interval**

        **Description** Interval (Seconds), default is 3

        **Type:** number

        **Range:** 1-180

    **ipv4-addr**

        **Description** IP address

        **Type:** string

        **Format:** ipv4-address

    **l3-packet**

        **Description** Only count L3 packets

        **Type:** boolean

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

        **Default:** 0

    **method**

        **Description** 'ping': Ping; 'garp': GARP; 'packet-count': Packet Count; 

        **Type:** string

        **Supported Values:** ping, garp, packet-count

    **partition-health-check**

        **Description** Health check state stands for the partition

        **Type:** boolean

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

        **Default:** 0

    **sampling-enable**

        **Type:** List

    **sby-ethernet**

        **Description** Ethernet interface

        **Type:** number

        **Format:** interface

    **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

    **vlan**

        **Description** VLAN id, specify 1 for untagged traffic

        **Type:** number

        **Range:** 1-4094

.. _1618_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'act-event': Active Event Count; 'sby-event': Standby Event Count; 'packet-count': Packet Count; 

        **Type:** string

        **Supported Values:** all, act-event, sby-event, packet-count