lldptool(8)lldptool(8)NAMElldptool - manage the LLDP settings and status of lldpad
SYNOPSISlldptool <command> [options] [argument]
DESCRIPTIONlldptool is used to query and configure lldpad. It connects to the
client interface of lldpad to perform these operations. lldptool will
operate in interactive mode if it is executed without a command. In
interactive mode, lldptool will also function as an event listener to
print out events as they are received asynchronously from lldpad. It
will use libreadline for interactive input when available.
OPTIONS-i [ifname]
specifies the network interface to which the command applies
-V [tlvid]
specifies the TLV identifier
The tlvid is an integer value used to identify specific LLDP
TLVs. The tlvid value is the Type value for types not equal to
127 (the organizationally specific type). For organizationally
specific TLVs, the tlvid is the value represented by the 3 byte
OUI and 1 byte subtype - where the subtype is the lowest order
byte of the tlvid.
The tlvid can be entered as a numerical value (e.g. 10 or 0xa),
or for supported TLVs, as a keyword. Review the lldptool help
output to see the list of supported TLV keywords.
-n "neighbor" option for commands which can use it (e.g. get-tlv)
-g [bridge scope]
specify the bridge scope this command operates on. Allows to set
and query all LLDP TLV modules for "nearest_bridge" (short:
"nb"), "nearest_customer_bridge" ("ncb") and "near‐
est_nontpmr_bridge" ("nntpmrb") group mac addresses. Configura‐
tions are saved into independent sections in lldpad.conf. If no
bridge scope is supplied this default to "nearest bridge" to
preserve the previous behaviour.
-c <argument list>
"config" option for TLV queries. Indicates that the query is for
the configuration elements for the specified TLV. The argument
list specifies the specific elements to query. If no arguments
are listed, then all configuration elements for the TLV are
returned.
-r show raw client interface messages
-R show only raw Client interface messages
COMMANDS
license
show license information
-h, help
show usage information
-v, version
show version information
-S, stats
get LLDP statistics
-t, get-tlv
get TLV information
-T, set-tlv
set TLV information
-l, get-lldp
get LLDP parameters
-L, set-lldp
set LLDP parameters
-q, quit
exit from interactive mode
ARGUMENTS
adminStatus
Argument for the get-lldp/set-lldp commands. May be applied per
port or globbally. Valid values are: disabled, rx, tx, rxtx
enableTx
Argument for the get-tlv/set-tlv commands. May be applied per
port for a specified TLV. Valid values are: yes, no. If the
DCBX TLV enableTx is set to no, then all of the DCB feature TLVs
DCBX advertise settings will be turned off as well. Setting
enableTx to yes for a DCBX TLV will not affect the DCBX adver‐
tise settings.
ipv4 Argument for the get-tlv/set-tlv commands with respect to the
Management Address TLV. May be applied per port or globally.
The get command will retrieve the configured value. Set values
take the form of an IPv4 address: A.B.C.D
ipv6 Argument for the get-tlv/set-tlv commands with respect to the
Management Address TLV. May be applied per port or globally.
The get command will retrieve the configured value. Set values
take the form of an IPv6 address:
1111:2222:3333:4444:5555:6666:7777:8888 and various shorthand
variations.
EXAMPLES
Configure LLDP adminStatus to Receive and Transmit for interface eth2
lldptool-L -i eth2 adminStatus=rxtx
lldptool set-lldp -i eth2 adminStatus=rxtx
Disable the LLDP adminStatus for all interfaces
lldptool set-lldp adminStatus=disabled
Query the LLDP adminStatus for interface eth3
lldptool-l -i eth3 adminStatus
lldptool get-lldp -i eth3 adminStatus
Query the LLDP statistics for interface eth3
lldptool-S -i eth3 adminStatus
lldptool stats -i eth3 adminStatus
Query the local TLVs which are being transmitted for a given interface:
lldptool-t -i eth3
lldptool get-tlv -i eth3
Query the received neighbor TLVs received on a given interface:
lldptool-t -n -i eth3
lldptool get-tlv -n -i eth3
Query the value of the System Description TLV as received from the
neighbor on a given interface:
lldptool-t -n -i eth3 -V sysDesc
lldptool get-tlv -n -i eth3 -V 6
Disable transmit of the IEEE 802.3 MAC/PHY Configuration Status TLV for
a given interface:
lldptool-T -i eth3 -V macPhyCfg enableTx=no
lldptool set-tlv -i eth3 -V 0x120f01 enableTx=no
Enable transmit of the Port Description TLV for all interfaces:
lldptool-T -V portDesc enableTx=yes
lldptool set-tlv -V 4 enableTx=yes
Query value of the transmit setting for the Port Description TLV for a
given interface:
lldptool-t -V portDesc -c enableTx
lldptool get-tlv -V 4 -c enableTx
Set a Management Address TLV on eth3 to carry IPv4 address
192.168.10.10
lldptool-T -i eth3 -V mngAddr ipv4=192.168.10.10
Set a Management Address TLV on eth3 to carry IPv6 address
::192.168.10.10
lldptool-T -i eth3 -V mngAddr ipv6=::192.168.10.10
Get the configured IPv4 address for the Management Address TLV on eth3
lldptool-t -i eth3 -V mngAddr -c ipv4
Get all configured attributes for the Management Address TLV on eth3
lldptool-t -i eth3 -V mngAddr -c
Query the current DCBX mode that will be used if lldpad is restarted.
(this is not a persistent setting)
lldptool-t -i eth3 -V IEEE-DCBX -c mode
Reset the DCBX mode to be 'auto' (start in IEEE DCBX mode) after the
next lldpad restart
lldptool-T -i eth3 -V IEEE-DCBX mode=reset
Enable transmit of the Edge Virtual Bridging TLV for interface eth4
lldptool-i eth4 -T -V evbCfg enableTx=yes
Configure EVB TLV to set reflective relay and RTE,ECP and VDP capabili‐
ties
lldptool-T -i eth4 -V evbCfg fmode=reflectiverelay
lldptool-T -i eth4 -V evbCfg capabilities=rte,ecp,vdp
Enable transmit of the VDP for interface eth4
lldptool-i eth4 -T -V vdp enableTx=yes
Configurations per port have higher precedence than global configura‐
tions.
SEE ALSOlldptool-ets(8), lldptool-pfc(8), lldptool-app(8), lldptool-med(8),
dcbtool(8), lldpad(8)COPYRIGHTlldptool - LLDP agent configuration utility
Copyright(c) 2007-2010 Intel Corporation. Portions of lldptool are
based on:
hostapd-0.5.7
Copyright
(c) 2004-2008, Jouni Malinen <j@w1.fi>
LICENSE
This program is free software; you can redistribute it and/or modify it
under the terms and conditions of the GNU General Public License, ver‐
sion 2, as published by the Free Software Foundation.
This program is distributed in the hope it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
The full GNU General Public License is included in this distribution in
the file called "COPYING".
SUPPORT
Contact Information: open-lldp Mailing List <lldp-devel@open-lldp.org>
November 2, 2011 lldptool(8)
