.. _network_virtual_wire:

network virtual-wire
====================

Configure Virtual Wire


virtual-wire Specification
--------------------------

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

	 **Object Key(s)**                     *virtual-wire-id*

	 **Collection Name**                   :ref:`364_virtual-wire_list`

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

	                                       

	 **Element Name**                      virtual-wire

	 **Element URI**                       /axapi/v3/network/virtual-wire/{virtual-wire-id}

	 **Element Attributes**                virtual-wire_attributes

	 **Operational Data URI**              /axapi/v3/network/virtual-wire/{virtual-wire-id}/oper

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



.. raw:: html

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


:ref:`364_virtual-wire_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



.. raw:: html

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


:ref:`364_virtual-wire_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/{virtual-wire-id}



.. raw:: html

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


:ref:`364_virtual-wire_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



.. raw:: html

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


:ref:`364_virtual-wire_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/{virtual-wire-id}



.. raw:: html

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


:ref:`364_virtual-wire_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/{virtual-wire-id}



.. raw:: html

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


:ref:`364_virtual-wire_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



.. raw:: html

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


:ref:`364_virtual-wire_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/{virtual-wire-id}



.. raw:: html

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


:ref:`364_virtual-wire_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _364_virtual-wire_list:

virtual-wire-list
-----------------


    virtual-wire-list is **JSON List** of :ref:`364_virtual-wire_attributes` 

        virtual-wire-list : [

             { :ref:`364_virtual-wire_attributes` },

             { :ref:`364_virtual-wire_attributes` },

             ...

         ]

.. _364_virtual-wire_attributes:

virtual-wire attributes
-----------------------

    **eth1**

        **Description** 

        **Type:** number

        **Format:** interface

        **Refernce Object:** :doc:`/axapi/v3/interface/ethernet <interface_ethernet>`

    **eth2**

        **Description** 

        **Type:** number

        **Format:** interface

        **Refernce Object:** :doc:`/axapi/v3/interface/ethernet <interface_ethernet>`

    **group1**

        **Description** 

        **Type:** number

        **Range:** 1-16

        **Refernce Object:** :doc:`/axapi/v3/network/virtual-wire-ethernet-group <network_virtual_wire_ethernet_group>`

    **group2**

        **Description** 

        **Type:** number

        **Range:** 1-16

        **Refernce Object:** :doc:`/axapi/v3/network/virtual-wire-ethernet-group <network_virtual_wire_ethernet_group>`

    **trunk1**

        **Description** 

        **Type:** number

        **Range:** 1-4096

        **Refernce Object:** :doc:`/axapi/v3/interface/trunk <interface_trunk>`

    **trunk2**

        **Description** 

        **Type:** number

        **Range:** 1-4096

        **Refernce Object:** :doc:`/axapi/v3/interface/trunk <interface_trunk>`

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

    **virtual-wire-id**

        **Description** virtual wire id

        **Type:** number

        **Range:** 1-32

.. _364_oper_data:

operational data
----------------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - endpoints
      - 
      - endpoints

   *  - 
      - virtual_wire_status
      - enum
      -  Output contains one of the following values: - Up, Down