.. _network_vlan_group:

network vlan-group
==================

Configure group of VLANs


vlan-group Specification
------------------------

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

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

	 **Object Key(s)**                     *vlan-num-start, vlan-num-end*

	 **Collection Name**                   :ref:`2369_vlan-group_list`

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

	                                       

	 **Element Name**                      vlan-group

	 **Element URI**                       /axapi/v3/network/vlan-group/{vlan-num-start}+{vlan-num-end}

	 **Element Attributes**                vlan-group_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2369_vlan-group_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_group_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-group



.. raw:: html

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


:ref:`2369_vlan-group_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-group/{vlan-num-start}+{vlan-num-end}



.. raw:: html

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


:ref:`2369_vlan-group_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/vlan-group



.. raw:: html

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


:ref:`2369_vlan-group_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-group/{vlan-num-start}+{vlan-num-end}



.. raw:: html

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


:ref:`2369_vlan-group_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-group/{vlan-num-start}+{vlan-num-end}



.. raw:: html

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


:ref:`2369_vlan-group_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/vlan-group



.. raw:: html

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


:ref:`2369_vlan-group_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-group/{vlan-num-start}+{vlan-num-end}



.. raw:: html

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


:ref:`2369_vlan-group_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2369_vlan-group_list:

vlan-group-list
---------------


    vlan-group-list is **JSON List** of :ref:`2369_vlan-group_attributes` 

        vlan-group-list : [

             { :ref:`2369_vlan-group_attributes` },

             { :ref:`2369_vlan-group_attributes` },

             ...

         ]

.. _2369_vlan-group_attributes:

vlan-group attributes
---------------------

    **eth-list**

        **Type:** List

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

    **vlan-num-end**

        **Description** End of VLAN range

        **Type:** number

        **Range:** 2-4094

    **vlan-num-start**

        **Description** Start of VLAN range

        **Type:** number

        **Range:** 2-4094

.. _2369_eth-list:

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

	 **Block object keys**             

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

    **ethernet-end**

        **Description** Ethernet port (Interface number)

        **Type:** number

        **Format:** interface

    **ethernet-start**

        **Description** Ethernet port (Interface number)

        **Type:** number

        **Format:** interface

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

.. _2369_trunk-list:

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

	 **Block object keys**             

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

    **trunk-end**

        **Description** 

        **Type:** number

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

    **trunk-start**

        **Description** 

        **Type:** number

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