.. _network_lldp:

network lldp
============

Configure LLDP


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

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

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

	 **Element Name**                      lldp

	 **Element URI**                       /axapi/v3/network/lldp

	 **Element Attributes**                lldp_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2332_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/network_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/network/lldp



.. raw:: html

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


:ref:`2332_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/network_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/network/lldp



.. raw:: html

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


:ref:`2332_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/network/lldp



.. raw:: html

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


:ref:`2332_lldp_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/network_lldp_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/network/lldp



.. raw:: html

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


:ref:`2332_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/network_lldp_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2332_lldp_attributes:

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

    **enable-cfg**

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

        **Type:** Object

    **management-address**

        **Description:** management-address is a **JSON Block**.  Please see below for :ref:`2332_management-address` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/network/lldp/management-address <network_lldp_management_address>`

    **notification-cfg**

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

        **Type:** Object

    **system-description**

        **Description** Configure lldp system description

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **system-name**

        **Description** Configure lldp system name

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **tx-set**

        **Description:** tx-set is a **JSON Block**.  Please see below for :ref:`2332_tx-set` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2332_management-address:

management-address
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **dns-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/network/lldp/management-address/dns/{dns} <network_lldp_management_address_dns>`

    **ipv4-addr-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/network/lldp/management-address/ipv4-addr/{ipv4} <network_lldp_management_address_ipv4_addr>`

    **ipv6-addr-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/network/lldp/management-address/ipv6-addr/{ipv6} <network_lldp_management_address_ipv6_addr>`

.. _2332_management-address_ipv6-addr-list:

management-address_ipv6-addr-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **interface-ipv6**

        **Description:** interface-ipv6 is a **JSON Block**.  Please see below for :ref:`2332_management-address_ipv6-addr-list_interface-ipv6` 

        **Type:** Object

    **ipv6**

        **Description** Configure lldp management-address, subtype is ipv6 (lldp management-address ipv6 address)

        **Type:** string

        **Format:** ipv6-address

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2332_management-address_ipv6-addr-list_interface-ipv6:

management-address_ipv6-addr-list_interface-ipv6
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ipv6-eth**

        **Description** configure lldp management-address interface ethernet (lldp management-address interface port number)

        **Type:** number

        **Format:** interface

    **ipv6-mgmt**

        **Description** configure lldp management-address interface management

        **Type:** boolean

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

        **Default:** 0

    **ipv6-ve**

        **Description** configure lldp management-address interface ve (lldp management-address interface port number)

        **Type:** number

        **Range:** 2-4094

.. _2332_management-address_ipv4-addr-list:

management-address_ipv4-addr-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **interface-ipv4**

        **Description:** interface-ipv4 is a **JSON Block**.  Please see below for :ref:`2332_management-address_ipv4-addr-list_interface-ipv4` 

        **Type:** Object

    **ipv4**

        **Description** Configure lldp management-address, subtype is ipv4 (lldp management-address ipv4 address)

        **Type:** string

        **Format:** ipv4-address

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2332_management-address_ipv4-addr-list_interface-ipv4:

management-address_ipv4-addr-list_interface-ipv4
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ipv4-eth**

        **Description** configure lldp management-address interface ethernet (lldp management-address interface port number)

        **Type:** number

        **Format:** interface

    **ipv4-mgmt**

        **Description** configure lldp management-address interface management

        **Type:** boolean

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

        **Default:** 0

    **ipv4-ve**

        **Description** configure lldp management-address interface ve (lldp management-address interface port number)

        **Type:** number

        **Range:** 2-4094

.. _2332_management-address_dns-list:

management-address_dns-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **dns**

        **Description** Configure lldp management-address, subtype is dns (lldp management-address dns address)

        **Type:** string

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **interface**

        **Description:** interface is a **JSON Block**.  Please see below for :ref:`2332_management-address_dns-list_interface` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2332_management-address_dns-list_interface:

management-address_dns-list_interface
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ethernet**

        **Description** configure lldp management-address interface ethernet (lldp management-address interface port number)

        **Type:** number

        **Format:** interface

        **Mutual Exclusion:** ethernet, ve, and management are mutually exclusive

    **management**

        **Description** configure lldp management-address interface management

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** management, ethernet, and ve are mutually exclusive

    **ve**

        **Description** configure lldp management-address interface management (lldp management-address interface port number)

        **Type:** number

        **Range:** 2-4094

        **Mutual Exclusion:** ve, ethernet, and management are mutually exclusive

.. _2332_notification-cfg:

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

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

    **interval**

        **Description** Configure lldp notification interval, default is 30 (The lldp notification interval value, default is 30)

        **Type:** number

        **Range:** 5-3600

        **Default:** 30

    **notification**

        **Description** Enable lldp notification

        **Type:** boolean

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

        **Default:** 0

.. _2332_tx-set:

tx-set
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **fast-count**

        **Description** Configure lldp tx fast count value (The lldp tx fast count value, default is 4)

        **Type:** number

        **Range:** 1-8

        **Default:** 4

    **fast-interval**

        **Description** Configure lldp tx fast interval value (The lldp tx fast interval value, default is 1)

        **Type:** number

        **Range:** 1-3600

        **Default:** 1

    **hold**

        **Description** Configure lldp tx hold multiplier (The lldp tx hold value, default is 4)

        **Type:** number

        **Range:** 1-10

        **Default:** 4

    **reinit-delay**

        **Description** Configure lldp tx reinit delay (The lldp tx reinit_delay value, default is 2)

        **Type:** number

        **Range:** 1-10

        **Default:** 2

    **tx-interval**

        **Description** Configure lldp tx interval (The lldp tx interval value, default is 30)

        **Type:** number

        **Range:** 1-3600

        **Default:** 30

.. _2332_enable-cfg:

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

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

    **enable**

        **Description** Enable lldp

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