1lldptool(8) System Manager's Manual lldptool(8)
2
6 lldptool - manage the LLDP settings and status of lldpad
7
9 lldptool <command> [options] [argument]
10
14 lldptool is used to query and configure lldpad. It connects to the
15 client interface of lldpad to perform these operations. lldptool will
16 operate in interactive mode if it is executed without a command. In
17 interactive mode, lldptool also functions as an event listener and will
18 print out events as they are received asynchronously from lldpad.
19
22 -i [ifname]
23 specifies the network interface to which the command applies
24 -V [tlvid]
26 specifies the TLV identifier
27 The tlvid is an integer value used to identify specific LLDP
28 TLVs. The tlvid value is the Type value for types not equal to
29 127 (the organizationally specific type). For organizationally
30 specific TLVs, the tlvid is the value represented by the 3 byte
31 OUI and 1 byte subtype - where the subtype is the lowest order
32 byte of the tlvid.
33 The tlvid can be entered as a numerical value (e.g. 10 or 0xa),
34 or for supported TLVs, as a keyword. Review the lldptool help
35 output to see the list of supported TLV keywords.
36 -n "neighbor" option for commands which can use it (e.g. get-tlv)
38 -a "add" option for commands which can use it
40 (not implemented yet)
41 -d "remove" option for commands which can use it
43 (not implemented yet)
44 -r show raw client interface messages
46 -R show only raw Client interface messages
48
50 license
51 show license information
52 -h, help
54 show usage information
55 -v, version
57 show version information
58 -S, stats
60 get LLDP statistics
61 -t, get-tlv
63 get TLV information
64 -T, set-tlv
66 set TLV information
67 -l, get-lldp
69 get LLDP parameters
70 -L, set-lldp
72 set LLDP parameters
73 -q, quit
75 exit from interactive mode
76
78 adminStatus
79 Argument for the get-lldp/set-lldp commands. May be applied per
80 port or globbally. Valid values are: disabled, rx, tx, rxtx
81 enableTx
84 Argument for the get-tlv/set-tlv commands. May be applied per
85 port for a specified TLV. Valid values are: yes, no. If the
86 DCBX TLV enableTx is set to no, then all of the DCB feature TLVs
87 DCBX advertise settings will be turned off as well. Setting
88 enableTx to yes for a DCBX TLV will not affect the DCBX adver‐
89 tise settings.
90 ipv4 Argument for the get-tlv/set-tlv commands with respect to the
93 Management Address TLV. May be applied per port or globally.
94 The get command will retrieve the configured value. Set values
95 take the form of an IPv4 address: A.B.C.D
96 ipv6 Argument for the get-tlv/set-tlv commands with respect to the
99 Management Address TLV. May be applied per port or globally.
100 The get command will retrieve the configured value. Set values
101 take the form of an IPv6 address:
102 1111:2222:3333:4444:5555:6666:7777:8888 and various shorthand
103 variations.
104
107 Configure LLDP adminStatus to Receive and Transmit for interface eth2
108 lldptool -L -i eth2 adminStatus=rxtx
109 lldptool set-lldp -i eth2 adminStatus=rxtx
110 Disable the LLDP adminStatus for all interfaces
113 lldptool set-lldp adminStatus=disabled
114 Query the LLDP adminStatus for interface eth3
117 lldptool -l -i eth3 adminStatus=disabled
118 lldptool get-lldp -i eth3 adminStatus=disabled
119 Query the LLDP statistics for interface eth3
122 lldptool -S -i eth3 adminStatus
123 lldptool stats -i eth3 adminStatus
124 Query the local TLVs which are being transmitted for a given interface:
127 lldptool -t -i eth3
128 lldptool get-tlv -i eth3
129 Query the received neighbor TLVs received on a given interface:
132 lldptool -t -n -i eth3
133 lldptool get-tlv -n -i eth3
134 Query the value of the System Description TLV as received from the
137 neighbor on a given interface:
138 lldptool -t -n -i eth3 -V sysDesc
139 lldptool get-tlv -n -i eth3 -V 6
140 Disable transmit of the IEEE 802.3 MAC/PHY Configuration Status TLV for
143 a given interface:
144 lldptool -T -i eth3 -V macPhyCfg enableTx=no
145 lldptool set-tlv -i eth3 -V 0x120f01 enableTx=no
146 Enable transmit of the Port Description TLV for all interfaces:
149 lldptool -T -V portDesc enableTx=yes
150 lldptool set-tlv -V 4 enableTx=yes
151 Query value of the transmit setting for the Port Description TLV for a
154 given interface:
155 lldptool -t -V portDesc enableTx
156 lldptool get-tlv -V 4 enableTx
157 Set a Management Address TLV on eth3 to carry IPv4 address
160 192.168.10.10
161 lldptool -T -eth3 -V mngAddr ipv4=192.168.10.10
162 Set a Management Address TLV on eth3 to carry IPv6 address
165 ::192.168.10.10
166 lldptool -T -eth3 -V mngAddr ipv6=::192.168.10.10
167 Get the configured IPv4 address for the Management Address TLV on eth3
170 lldptool -t -eth3 -V mngAddr ipv4
171 Enable transmit of the Edge Virtual Bridging TLV for interface eth4
174 lldptool -i eth4 -T -V evbCfg enableTx=yes
175 Configure EVB TLV to set reflective relay and RTE,ECP and VDP capabili‐
178 ties
179 lldptool -T -i eth4 -V evbCfg fmode=reflectiverelay
180 lldptool -T -i eth4 -V evbCfg capabilities=rte,ecp,vdp
181 Enable transmit of the VDP for interface eth4
184 lldptool -i eth4 -T -V vdp enableTx=yes
185 Configurations per port have higher precedence than global configura‐
188 tions.
189
192 lldptool - LLDP agent configuration utility
193 Copyright(c) 2007-2010 Intel Corporation. Portions of lldptool are
194 based on:
195 hostapd-0.5.7
197 Copyright
199 (c) 2004-2008, Jouni Malinen <j@w1.fi>
200
203 This program is free software; you can redistribute it and/or modify it
204 under the terms and conditions of the GNU General Public License, ver‐
205 sion 2, as published by the Free Software Foundation.
206 This program is distributed in the hope it will be useful, but WITHOUT
208 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
209 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
210 for more details.
211 You should have received a copy of the GNU General Public License along
213 with this program; if not, write to the Free Software Foundation, Inc.,
214 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
215 The full GNU General Public License is included in this distribution in
217 the file called "COPYING".
218
220 Contact Information: e1000-eedc Mailing List <e1000-eedc@lists.source‐
221 forge.net> Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro,
222 OR 97124-6497
223 February 23, 2010 lldptool(8)