.. _sys_ut_template_l2:

sys-ut template l2
==================

L2 packet paramters


l2 Specification
----------------

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

	===================================== ==================================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      l2

	 **Element URI**                       /axapi/v3/sys-ut/template/{name}/l2

	 **Element Attributes**                l2_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`l2 schema <sys-ut-template-l2/sys-ut-template-l2.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/sys-ut/template/{name}/l2



.. raw:: html

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


:ref:`3167_l2_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/sys_ut_template_l2_POST.txt
   :literal:




.. raw:: html

   </div></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/sys-ut/template/{name}/l2



.. raw:: html

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


:ref:`3167_l2_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/sys_ut_template_l2_GET.txt
   :literal:




.. raw:: html

   </div></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/sys-ut/template/{name}/l2



.. raw:: html

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


:ref:`3167_l2_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/sys-ut/template/{name}/l2



.. raw:: html

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


:ref:`3167_l2_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/sys_ut_template_l2_PUT.txt
   :literal:




.. raw:: html

   </div></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/sys-ut/template/{name}/l2



.. raw:: html

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


:ref:`3167_l2_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/sys_ut_template_l2_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3167_l2_attributes:

l2 attributes
-------------

    **ethertype**

        **Description** L2 frame type

        **Type:** boolean

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

        **Default:** 0

    **mac-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/sys-ut/template/{name}/l2/mac/{src-dst} <sys_ut_template>`

    **protocol**

        **Description** 'arp': arp; 'ipv4': ipv4; 'ipv6': ipv6; 

        **Type:** string

        **Supported Values:** arp, ipv4, ipv6

        **Default:** ipv4

        **Mutual Exclusion:** protocol and value are mutually exclusive

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **value**

        **Description** ethertype number

        **Type:** number

        **Range:** 0-2147483647

        **Mutual Exclusion:** value and protocol are mutually exclusive

    **vlan**

        **Description** Vlan ID on the packet. 0 is untagged

        **Type:** number

        **Range:** 0-4095

        **Default:** 0

.. _3167_mac-list:

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

	 **Block object keys**             

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

    **address-type**

        **Description** 'broadcast': broadcast; 'multicast': multicast; 

        **Type:** string

        **Supported Values:** broadcast, multicast

    **ethernet**

        **Description** Ethernet interface

        **Type:** number

        **Format:** interface

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

    **nat-pool**

        **Description** Nat pool

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **src-dst**

        **Description** 'dest': dest; 'src': src; 

        **Type:** string

        **Supported Values:** dest, src

    **trunk**

        **Description** Trunk number

        **Type:** number

        **Format:** interface

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **value**

        **Description** Mac Address

        **Type:** string

        **Format:** mac-address

    **ve**

        **Description** Virtual Ethernet interface

        **Type:** number

        **Format:** interface

        **Reference Object:** :doc:`/axapi/v3/interface/ve <interface_ve>`

    **virtual-server**

        **Description** vip

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/slb/virtual-server <slb_virtual_server>`