protocol/lldp

Resource URIs

URI Description
<base_URI>/config/running/protocol Protocol configuration.
<base_URI>/config/running/protocol/lldp Link Layer Discovery Protocol (LLDP).
GET URIs Description
<base_URI>/config/running/protocol/lldp Protocol configuration.
<base_URI>/config/running/protocol/lldp/description Retrieves the user description.
<base_URI>/config/running/protocol/lldp/hello Retrieves hello interval.
<base_URI>/config/running/protocol/lldp/mode Retrieves LLDP Transmit Only Mode information.
<base_URI>/config/running/protocol/lldp/multiplier Retrieves multiplier details.
<base_URI>/config/running/protocol/lldp//advertise/dot1-tlv Retrieves advertise IEEE 802.1 Organizationally Specific TLV configuration details.
<base_URI>/config/running/protocol/lldp/advertise/dot3-tlv Retrieves advertise IEEE 802.3 Organizationally Specific TLV configuration details.
<base_URI>/config/running/protocol/lldp/advertise/optional-tlv/management-address Retrieves management address TLV details.
<base_URI>/config/running/protocol/lldp/advertise/optional-tlv/port-description Retrieves port description TLV details.
<base_URI>/config/running/protocol/lldp/advertise/optional-tlv/system-capabilities Retrieves system capabilities TLV details.
<base_URI>/config/running/protocol/lldp/advertise/optional-tlv/system-description Retrieves system description TLV details.
<base_URI>/config/running/protocol/lldp/advertise/optional-tlv/system-name Retrieves system name TLV details.
<base_URI>/config/running/protocol/lldp/system-name Retrieves system name.
<base_URI>/config/running/protocol/lldp/system-description Retrieves system description.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/description Retrieves port profile description.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/hello Retrieves port profile hello interval configuration details.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/mode Retrieves port profile mode.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/multiplier Retrieves port profile multiplier.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/dot1-tlv Retrieves port profile advertisement TLV details.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/dot3-tlv Retrieves port profile advertisement TLV details.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/optional-tlv/management-address Retrieves advertise IEEE 802.1 Organizationally Specific TLV configuration details.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/optional-tlv/port-description Retrieves advertise IEEE 802.3 Organizationally Specific TLV configuration details.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/optional-tlv/system-capabilities Retrieves system capabilities TLV details.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/optional-tlv/system-description Retrieves system description TLV details.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/optional-tlv/system-name Retrieves system name TLV details.
POST URIs Payload Description
<base_URI>/config/running/protocol/lldp <profile><profile-name>(profile-name-string)</profile-name></profile> Configures LLDP profile.
PATCH URIs Payload Description
<base_URI>/config/running/protocol/lldp <lldp><description>(string)</description></lldp> Configures LLDP description.
<base_URI>/config/running/protocol/lldp <lldp><hello>(unit32)</hello></lldp> Configures LLD hello interval.
<base_URI>/config/running/protocol/lldp <lldp><mode>(string)</mode></lldp> Configures LLDP mode.
<base_URI>/config/running/protocol/lldp <lldp><multiplier>(unit32)</multiplier></lldp> Configures LLDP multiplier.
<base_URI>/config/running/protocol/lldp/advertise <advertise><dot1-tlv>(string)</dot1-tlv></advertise> Configures LLDP advertisement.
<base_URI>/config/running/protocol/lldp/advertise <advertise><dot3-tlv>(string)</dot3-tlv></advertise> Configures LLDP advertisement.
<base_URI>/config/running/protocol/lldp/advertise/optional-tlv <optional-tlv><management-address>(string)</management-address></optional-tlv> Configures LLDP optional TLV parameters.
<base_URI>/config/running/protocol/lldp/advertise/optional-tlv <optional-tlv><port-description>(string)</port-description></optional-tlv> Configures LLDP optional TLV parameters.
<base_URI>/config/running/protocol/lldp/advertise/optional-tlv <optional-tlv><system-capabilities>(string)</system-capabilities></optional-tlv> Configures LLDP optional TLV parameters.
<base_URI>/config/running/protocol/lldp/advertise/optional-tlv <optional-tlv><system-description>(string)</system-description></optional-tlv> Configures LLDP optional TLV parameters.
<base_URI>/config/running/protocol/lldp/advertise/optional-tlv <optional-tlv><system-name>(string)</system-name></optional-tlv> Configures LLDP optional TLV parameters.
<base_URI>/config/running/protocol/lldp <lldp><system-name>(string)</system-name></lldp> Configure LLDP system name.
<base_URI>/config/running/protocol/lldp <lldp><system-description>(string)</system-description></lldp> Configures LLDP system description.
<base_URI>/config/running/protocol/lldp <lldp><disable>(string)</disable></lldp> Disables LLDP.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string) <profile><description>(string)</description></profile> Configures LLDP profile description.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string) <profile><hello>(unit32)</hello></profile> Configures LLDP profile hello interval.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string) <profile><multiplier>(nit32)</multiplier></profile> Configures LLDP profile multiplier.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise <advertise><dot1-tlv>(string)</dot1-tlv></advertise> Configures LLDP profile advertisement.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise <advertise><dot3-tlv>(string)</dot3-tlv></advertise> Configures LLDP profile advertisement.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/optional-tlv <optional-tlv><management-address>(string)</management-address></optional-tlv> Configures LLDP optional TLV parameters.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/optional-tlv <optional-tlv><port-description>(string)</port-description></optional-tlv> Configures LLDP optional TLV parameters.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/optional-tlv <optional-tlv><system-capabilities>(string)</system-capabilities></optional-tlv> Configures LLDP optional TLV parameters.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/optional-tlv <optional-tlv><system-description>(string)</system-description></optional-tlv> Configures LLDP optional TLV parameters.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/optional-tlv <optional-tlv><system-name>(string)</system-name></optional-tlv> Configures LLDP optional TLV parameters.
PUT URIs Payload Description
<base_URI>/config/running/protocol/lldp/description <description>(string)</description> Configures LLDP description.
<base_URI>/config/running/protocol/lldp/hello <hello>(unit32)</hello> Configures LLD hello interval.
<base_URI>/config/running/protocol/lldp/mode <mode>(unit32)</mode> Configures LLDP mode.
<base_URI>/config/running/protocol/lldp/multiplier <multiplier>(unit32)</multiplier> Configures LLDP multiplier.
<base_URI>/config/running/protocol/lldp/advertise/dot1-tlv <dot1-tlv>(string)</dot1-tlv> Configures LLDP advertisement.
<base_URI>/config/running/protocol/lldp/advertise/dot3-tlv <dot3-tlv>(string)</dot3-tlv> Configures LLDP advertisement.
<base_URI>/config/running/protocol/lldp/advertise/optional-tlv/management-address <management-address>(string)</management-address> Configures LLDP optional TLV parameters.
<base_URI>/config/running/protocol/lldp/advertise/optional-tlv/port-description <port-description>(string)</port-description> Configures LLDP optional TLV parameters.
<base_URI>/config/running/protocol/lldp/advertise/optional-tlv/system-capabilities <system-capabilities>(string)</system-capabilities> Configures LLDP optional TLV parameters.
<base_URI>/config/running/protocol/lldp/advertise/optional-tlv/system-description <system-description>(string)</system-description> Configures LLDP optional TLV parameters.
<base_URI>/config/running/protocol/lldp/advertise/optional-tlv/system-name <system-name>(string)</system-name> Configures LLDP optional TLV parameters.
<base_URI>/config/running/protocol/lldp/system-name <system-name>(string)</system-name> Configure LLDP system name.
<base_URI>/config/running/protocol/lldp/system-description <system-description>(string)</system-description> Configures LLDP system description.
<base_URI>/config/running/protocol/lldp/disable <disable>(string)</disable> Disables LLDP.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/description <description>(string)</description> Configures LLDP profile description.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/hello <hello>(unit32)</hello> Configures LLDP profile hello interval.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/mode <mode>(unit32)</mode> Configures LLDP profile mode.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/multiplier <multiplier>(unit32)</multiplier> Configures LLDP profile multiplier.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/dot1-tlv <dot1-tlv>(string)</dot1-tlv> Configures LLDP profile advertisement.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/dot3-tlv <dot3-tlv>(string)</dot3-tlv> Configures LLDP profile advertisement.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/optional-tlv/management-address <management-address>(string)</management-address> Configures LLDP optional TLV parameters.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/optional-tlv/port-description <port-description>(string)</port-description> Configures LLDP optional TLV parameters.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/optional-tlv/system-capabilities <system-capabilities>(string)</system-capabilities> Configures LLDP optional TLV parameters.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/optional-tlv/system-description <system-description>(string)</system-description> Configures LLDP optional TLV parameters.
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/optional-tlv/system-name <system-name>(string)</system-name> Configures LLDP optional TLV parameters.
DELETE URIs
<base_URI>/config/running/protocol/lldp/description
<base_URI>/config/running/protocol/lldp/hello
<base_URI>/config/running/protocol/lldp/mode
<base_URI>/config/running/protocol/lldp/multiplier
<base_URI>/config/running/protocol/lldp//advertise/dot1-tlv
<base_URI>/config/running/protocol/lldp/advertise/dot3-tlv
<base_URI>/config/running/protocol/lldp/advertise/optional-tlv/management-address
<base_URI>/config/running/protocol/lldp/advertise/optional-tlv/port-description
<base_URI>/config/running/protocol/lldp/advertise/optional-tlv/system-capabilities
<base_URI>/config/running/protocol/lldp/advertise/optional-tlv/system-description
<base_URI>/config/running/protocol/lldp/advertise/optional-tlv/system-name
<base_URI>/config/running/protocol/lldp/system-name
<base_URI>/config/running/protocol/lldp/system-description
<base_URI>/config/running/protocol/lldp/disable
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/description
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/hello
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/mode
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/multiplier
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/dot1-tlv
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/dot3-tlv
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/optional-tlv/management-address
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/optional-tlv/port-description
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/optional-tlv/system-capabilities
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/optional-tlv/system-description
<base_URI>/config/running/protocol/lldp/profile/(profile-name-string)/advertise/optional-tlv/system-name

Parameters

mode
Specifies the LLDP mode. Supported modes are rx amd tx. Configuring rx enables LLDP receive only mode. Configuring tx enables LLDP transmit only mode.
description
Specifies user description for LLDP.
advertise
Sets the Advertise TLV configuration.
system-name
Specifies system name.
system-description
Specifies system description.
profile-name
Specifies the profile name.
dot1-tlv
Enables IEEE 802.1 organizationally specific TLV.
dot3-tlv
Enables IEEE 802.3 organizationally specific TLV.
optional-tlv
Advertises the optional Type, Length, and Values (TLV) values.
description
Configures the user description.
profile
Configures the LLDP profile name.

Usage Guidelines

GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD operations are supported.

Examples

URI

The following example uses the GET option to retrieve the configuration details.

http://host:80/rest/config/running/protocol/lldp

None

<lldp xmlns="urn:Extreme.com:mgmt:Extreme-lldp" xmlns:y="http://Extreme.com/ns/rest" y:self="/rest/config/running/protocol/lldp">
  <description>rest testing</description>
  <hello>4</hello>
  <mode>tx</mode>
  <multiplier>10</multiplier>
  <advertise y:self="/rest/config/running/protocol/lldp/advertise">
    <dot1-tlv>true</dot1-tlv>
    <dot3-tlv>true</dot3-tlv>
    <optional-tlv y:self="/rest/config/running/protocol/lldp/advertise/optional-tlv">
      <management-address>true</management-address>
      <system-capabilities>true</system-capabilities>
      <system-description>true</system-description>
    </optional-tlv>
  </advertise>
  <system-description>Extreme BR-SLX9850-4 Router</system-description>
</lldp>

URI

The following example uses the POST option to configure LLDP profile.

http://host:80/rest/config/running/protocol/lldp

<profile>
 <profile-name>profile1</profile-name>
</profile>

None

URI

The following example uses the DELETE option to remove LLDP description.

http://host:80/rest/config/running/protocol/lldp/description

None

None