.. _interface_ethernet_trunk_group:

interface ethernet trunk-group
==============================

Trunk Group Settings


trunk-group Specification
-------------------------

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

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

	 **Object Key(s)**                     *trunk-number*

	 **Collection Name**                   :ref:`1932_trunk-group_list`

	 **Collection URI**                    /axapi/v3/interface/ethernet/{ifnum}/trunk-group

	                                       

	 **Element Name**                      trunk-group

	 **Element URI**                       /axapi/v3/interface/ethernet/{ifnum}/trunk-group/{trunk-number}

	 **Element Attributes**                trunk-group_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`trunk-group schema <interface-ethernet-trunk-group/interface-ethernet-trunk-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/interface/ethernet/{ifnum}/trunk-group



.. raw:: html

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


:ref:`1932_trunk-group_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/interface/ethernet/{ifnum}/trunk-group



.. raw:: html

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


:ref:`1932_trunk-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/interface/ethernet/{ifnum}/trunk-group/{trunk-number}



.. raw:: html

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


:ref:`1932_trunk-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/interface/ethernet/{ifnum}/trunk-group



.. raw:: html

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


:ref:`1932_trunk-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/interface/ethernet/{ifnum}/trunk-group/{trunk-number}



.. raw:: html

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


:ref:`1932_trunk-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/interface/ethernet/{ifnum}/trunk-group/{trunk-number}



.. raw:: html

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


:ref:`1932_trunk-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/interface/ethernet/{ifnum}/trunk-group



.. raw:: html

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


:ref:`1932_trunk-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/interface/ethernet/{ifnum}/trunk-group/{trunk-number}



.. raw:: html

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


:ref:`1932_trunk-group_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1932_trunk-group_list:

trunk-group-list
----------------


    trunk-group-list is **JSON List** of :ref:`1932_trunk-group_attributes` 

        trunk-group-list : [

             { :ref:`1932_trunk-group_attributes` },

             { :ref:`1932_trunk-group_attributes` },

             ...

         ]

.. _1932_trunk-group_attributes:

trunk-group attributes
----------------------

    **admin-key**

        **Description** LACP admin key (Admin key value)

        **Type:** number

        **Range:** 10000-65535

    **mode**

        **Description** 'active': enable initiation of LACP negotiation on a port(default); 'passive': disable initiation of LACP negotiation on a port; 

        **Type:** string

        **Supported Values:** active, passive

        **Default:** active

    **port-priority**

        **Description** Set LACP priority for a port (LACP port priority)

        **Type:** number

        **Range:** 1-65535

    **timeout**

        **Description** 'long': Set LACP long timeout (default); 'short': Set LACP short timeout; 

        **Type:** string

        **Supported Values:** long, short

        **Default:** long

    **trunk-number**

        **Description** Trunk Number

        **Type:** number

        **Range:** 1-4096

    **type**

        **Description** 'static': Static (default); 'lacp': lacp; 'lacp-udld': lacp-udld; 

        **Type:** string

        **Supported Values:** static, lacp, lacp-udld

        **Default:** static

    **udld-timeout-cfg**

        **Description:** udld-timeout-cfg is a **JSON Block**.  Please see below for :ref:`1932_udld-timeout-cfg` 

        **Type:** Object

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

.. _1932_udld-timeout-cfg:

udld-timeout-cfg
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **fast**

        **Description** fast timeout in unit of milli-seconds(default 1000)

        **Type:** number

        **Range:** 100-1000

        **Default:** 1000

        **Mutual Exclusion:** fast and slow are mutually exclusive

    **slow**

        **Description** slow timeout in unit of seconds

        **Type:** number

        **Range:** 1-60

        **Mutual Exclusion:** slow and fast are mutually exclusive