.. _interface_ethernet_lldp:

interface ethernet lldp
=======================

Interface lldp configuration


lldp Specification
------------------

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

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

	 **Element Name**                      lldp

	 **Element URI**                       /axapi/v3/interface/ethernet/{ifnum}/lldp

	 **Element Attributes**                lldp_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`lldp schema <interface-ethernet-lldp/interface-ethernet-lldp.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}/lldp



.. raw:: html

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


:ref:`1924_lldp_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/interface_ethernet_lldp_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/interface/ethernet/{ifnum}/lldp



.. raw:: html

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


:ref:`1924_lldp_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/interface_ethernet_lldp_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/interface/ethernet/{ifnum}/lldp



.. raw:: html

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


:ref:`1924_lldp_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}/lldp



.. raw:: html

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


:ref:`1924_lldp_attributes`



.. 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}/lldp



.. raw:: html

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


:ref:`1924_lldp_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/interface_ethernet_lldp_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1924_lldp_attributes:

lldp attributes
---------------

    **enable-cfg**

        **Description:** enable-cfg is a **JSON Block**.  Please see below for :ref:`1924_enable-cfg` 

        **Type:** Object

    **notification-cfg**

        **Description:** notification-cfg is a **JSON Block**.  Please see below for :ref:`1924_notification-cfg` 

        **Type:** Object

    **tx-dot1-cfg**

        **Description:** tx-dot1-cfg is a **JSON Block**.  Please see below for :ref:`1924_tx-dot1-cfg` 

        **Type:** Object

    **tx-tlvs-cfg**

        **Description:** tx-tlvs-cfg is a **JSON Block**.  Please see below for :ref:`1924_tx-tlvs-cfg` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1924_tx-dot1-cfg:

tx-dot1-cfg
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **link-aggregation**

        **Description** Interface link aggregation information

        **Type:** boolean

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

        **Default:** 0

    **tx-dot1-tlvs**

        **Description** Interface lldp tx IEEE 802.1 Organizationally specific TLVs configuration

        **Type:** boolean

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

        **Default:** 0

    **vlan**

        **Description** Interface vlan information

        **Type:** boolean

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

        **Default:** 0

.. _1924_notification-cfg:

notification-cfg
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **notif-enable**

        **Description** Interface lldp notification enable

        **Type:** boolean

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

        **Default:** 0

    **notification**

        **Description** Interface lldp notification configuration

        **Type:** boolean

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

        **Default:** 0

.. _1924_tx-tlvs-cfg:

tx-tlvs-cfg
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **exclude**

        **Description** Configure which TLVs excluded. All basic TLVs will be included by default

        **Type:** boolean

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

        **Default:** 0

    **management-address**

        **Description** Interface lldp management address

        **Type:** boolean

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

        **Default:** 0

    **port-description**

        **Description** Interface lldp port description

        **Type:** boolean

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

        **Default:** 0

    **system-capabilities**

        **Description** Interface lldp system capabilities

        **Type:** boolean

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

        **Default:** 0

    **system-description**

        **Description** Interface lldp system description

        **Type:** boolean

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

        **Default:** 0

    **system-name**

        **Description** Interface lldp system name

        **Type:** boolean

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

        **Default:** 0

    **tx-tlvs**

        **Description** Interface lldp tx TLVs configuration

        **Type:** boolean

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

        **Default:** 0

.. _1924_enable-cfg:

enable-cfg
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **rt-enable**

        **Description** Interface lldp enable/disable

        **Type:** boolean

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

        **Default:** 0

    **rx**

        **Description** Enable lldp rx

        **Type:** boolean

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

        **Default:** 0

    **tx**

        **Description** Enable lldp tx

        **Type:** boolean

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

        **Default:** 0