.. _network_vlan:

network vlan
============

Configure VLAN


vlan Specification
------------------

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

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

	 **Object Key(s)**                     *vlan-num*

	 **Collection Name**                   :ref:`2334_vlan_list`

	 **Collection URI**                    /axapi/v3/network/vlan

	                                       

	 **Element Name**                      vlan

	 **Element URI**                       /axapi/v3/network/vlan/{vlan-num}

	 **Element Attributes**                vlan_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/network/vlan/{vlan-num}/stats

	 **Operational Data URI**              /axapi/v3/network/vlan/{vlan-num}/oper

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



.. raw:: html

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


:ref:`2334_vlan_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/network_vlan_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/network/vlan



.. raw:: html

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


:ref:`2334_vlan_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/vlan/{vlan-num}



.. raw:: html

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


:ref:`2334_vlan_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/network_vlan_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/network/vlan



.. raw:: html

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


:ref:`2334_vlan_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/vlan/{vlan-num}



.. raw:: html

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


:ref:`2334_vlan_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/vlan/{vlan-num}



.. raw:: html

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


:ref:`2334_vlan_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/network_vlan_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/network/vlan



.. raw:: html

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


:ref:`2334_vlan_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/vlan/{vlan-num}



.. raw:: html

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


:ref:`2334_vlan_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/network_vlan_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2334_vlan_list:

vlan-list
---------


    vlan-list is **JSON List** of :ref:`2334_vlan_attributes` 

        vlan-list : [

             { :ref:`2334_vlan_attributes` },

             { :ref:`2334_vlan_attributes` },

             ...

         ]

.. _2334_vlan_attributes:

vlan attributes
---------------

    **name**

        **Description** VLAN name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **sampling-enable**

        **Type:** List

    **shared-vlan**

        **Description** Configure VLAN as a shared VLAN

        **Type:** boolean

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

        **Default:** 0

    **tagged-eth-list**

        **Type:** List

    **tagged-trunk-list**

        **Type:** List

    **traffic-distribution-mode**

        **Description** 'sip': sip; 'dip': dip; 'primary': primary; 'blade': blade; 'l4-src-port': l4-src-port; 'l4-dst-port': l4-dst-port; 

        **Type:** string

        **Supported Values:** sip, dip, primary, blade, l4-src-port, l4-dst-port

    **untagged-eth-list**

        **Type:** List

    **untagged-lif**

        **Description** Logical tunnel interface (Logical tunnel interface name)

        **Type:** string

        **Maximum Length:** 15 characters

        **Maximum Length:** 1 characters

    **untagged-trunk-list**

        **Type:** List

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

    **ve**

        **Description** ve number

        **Type:** number

        **Range:** 2-4094

    **vlan-num**

        **Description** VLAN number

        **Type:** number

        **Range:** 2-4094

.. _2334_untagged-trunk-list:

untagged-trunk-list
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **untagged-trunk-end**

        **Description** Trunk Group

        **Type:** number

    **untagged-trunk-start**

        **Description** Trunk groups

        **Type:** number

.. _2334_untagged-eth-list:

untagged-eth-list
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **untagged-ethernet-end**

        **Description** Ethernet port

        **Type:** number

        **Format:** interface

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

    **untagged-ethernet-start**

        **Description** Ethernet port (Interface number)

        **Type:** number

        **Format:** interface

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

.. _2334_tagged-eth-list:

tagged-eth-list
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **tagged-ethernet-end**

        **Description** Ethernet port

        **Type:** number

        **Format:** interface

    **tagged-ethernet-start**

        **Description** Ethernet port (Interface number)

        **Type:** number

        **Format:** interface

.. _2334_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'broadcast_count': Broadcast counter; 'multicast_count': Multicast counter; 'ip_multicast_count': IP Multicast counter; 'unknown_unicast_count': Unknown Unicast counter; 'mac_movement_count': Mac Movement counter; 'shared_vlan_partition_switched_counter': SVLAN Partition switched counter; 

        **Type:** string

        **Supported Values:** all, broadcast_count, multicast_count, ip_multicast_count, unknown_unicast_count, mac_movement_count, shared_vlan_partition_switched_counter

.. _2334_tagged-trunk-list:

tagged-trunk-list
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **tagged-trunk-end**

        **Description** Trunk Group

        **Type:** number

    **tagged-trunk-start**

        **Description** Trunk groups

        **Type:** number