.. _system_path:

system path
===========

Layer-2 path


path Specification
------------------

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

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

	 **Object Key(s)**                     *l2hm-path-name*

	 **Collection Name**                   :ref:`3343_path_list`

	 **Collection URI**                    /axapi/v3/system/path

	                                       

	 **Element Name**                      path

	 **Element URI**                       /axapi/v3/system/path/{l2hm-path-name}

	 **Element Attributes**                path_attributes

	 **Partition Visibility**              shared

	 **Operational Data URI**              /axapi/v3/system/path/{l2hm-path-name}/oper

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



.. raw:: html

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


:ref:`3343_path_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/system_path_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/system/path



.. raw:: html

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


:ref:`3343_path_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/system/path/{l2hm-path-name}



.. raw:: html

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


:ref:`3343_path_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/system_path_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/system/path



.. raw:: html

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


:ref:`3343_path_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/system/path/{l2hm-path-name}



.. raw:: html

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


:ref:`3343_path_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/system/path/{l2hm-path-name}



.. raw:: html

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


:ref:`3343_path_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/system_path_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/system/path



.. raw:: html

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


:ref:`3343_path_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/system/path/{l2hm-path-name}



.. raw:: html

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


:ref:`3343_path_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/system_path_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3343_path_list:

path-list
---------


    path-list is **JSON List** of :ref:`3343_path_attributes` 

        path-list : [

             { :ref:`3343_path_attributes` },

             { :ref:`3343_path_attributes` },

             ...

         ]

.. _3343_path_attributes:

path attributes
---------------

    **ifpair-eth-end**

        **Description** Ethernet port

        **Type:** number

        **Format:** interface

    **ifpair-eth-start**

        **Description** Ethernet port (Interface number)

        **Type:** number

        **Format:** interface

    **ifpair-trunk-end**

        **Description** Trunk Group

        **Type:** number

        **Range:** 1-4096

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

    **ifpair-trunk-start**

        **Description** Trunk groups

        **Type:** number

        **Range:** 1-4096

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

    **l2hm-attach**

        **Description** Monitor Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **l2hm-path-name**

        **Description** Monitor Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Default:** hc-obj

    **l2hm-setup-test-api**

        **Description** Test-API Interface (Ethernet Interface)

        **Type:** number

        **Format:** interface

    **l2hm-vlan**

        **Description** VLAN id

        **Type:** number

        **Range:** 2-4094

        **Reference Object:** :doc:`/axapi/v3/network/vlan <network_vlan>`

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