1lldptool(8) Linux 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 will also function as an event listener to
18 print out events as they are received asynchronously from lldpad. It
19 will use libreadline for interactive input when available.
20
23 -i [ifname]
24 specifies the network interface to which the command applies.
25 Most lldptool commands require specifying a network interface.
26 -V [tlvid]
28 specifies the TLV identifier
29 The tlvid is an integer value used to identify specific LLDP
30 TLVs. The tlvid value is the Type value for types not equal to
31 127 (the organizationally specific type). For organizationally
32 specific TLVs, the tlvid is the value represented by the 3 byte
33 OUI and 1 byte subtype - where the subtype is the lowest order
34 byte of the tlvid.
35 The tlvid can be entered as a numerical value (e.g. 10 or 0xa),
36 or for supported TLVs, as a keyword. Review the lldptool help
37 output to see the list of supported TLV keywords.
38 -n "neighbor" option for commands which can use it (e.g. get-tlv)
40 -g [bridge scope]
42 specify the bridge scope this command operates on. Allows to set
43 and query all LLDP TLV modules for "nearest_bridge" (short:
44 "nb"), "nearest_customer_bridge" ("ncb") and "near‐
45 est_nontpmr_bridge" ("nntpmrb") group mac addresses. Configura‐
46 tions are saved into independent sections in lldpad.conf. If no
47 bridge scope is supplied this defaults to "nearest bridge" to
48 preserve the previous behaviour.
49 -c <argument list>
51 "config" option for TLV queries. Indicates that the query is for
52 the configuration elements for the specified TLV. The argument
53 list specifies the specific elements to query. If no arguments
54 are listed, then all configuration elements for the TLV are re‐
55 turned.
56 -r show raw client interface messages
58 -R show only raw Client interface messages
60
62 license
63 show license information
64 -h, help
66 show usage information
67 -v, version
69 show version information
70 -S, stats
72 get LLDP statistics for the specified interface
73 -t, get-tlv
75 get TLV information for the specified interface
76 -T, set-tlv
78 set TLV information for the specified interface
79 -l, get-lldp
81 get LLDP parameters for the specified interface
82 -L, set-lldp
84 set LLDP parameters for the specified interface
85 -p, ping
87 display the process identifier of the running lldpad process
88 -q, quit
90 exit from interactive mode
91
93 This section lists arguments which are available for administration of
94 LLDP parameters. Arguments for basic TLV's (non-organizationally spe‐
95 cific TLVs) are also described. See the SEE ALSO section for refer‐
96 ences to other lldptool man pages which contain usage details and argu‐
97 ments for various organizationally specific TLVs.
98 adminStatus
101 Argument for the get-lldp/set-lldp commands. Configures the
102 LLDP adminStatus parameter for the specified interface. Valid
103 values are: disabled, rx, tx, rxtx
104 enableTx
107 Argument for the get-tlv/set-tlv commands. May be applied per
108 interface for a specified TLV. Valid values are: yes, no. If
109 the DCBX TLV enableTx is set to no, then all of the DCB feature
110 TLVs DCBX advertise settings will be turned off as well. Set‐
111 ting enableTx to yes will enable the DCBX advertise settings.
112 ipv4 Argument for the get-tlv/set-tlv commands with respect to the
115 Management Address TLV. The get command will retrieve the con‐
116 figured value. Set values take the form of an IPv4 address:
117 A.B.C.D
118 ipv6 Argument for the get-tlv/set-tlv commands with respect to the
121 Management Address TLV. The get command will retrieve the con‐
122 figured value. Set values take the form of an IPv6 address:
123 1111:2222:3333:4444:5555:6666:7777:8888 and various shorthand
124 variations.
125
128 Configure LLDP adminStatus to Receive and Transmit for interface eth2
129 lldptool -L -i eth2 adminStatus=rxtx
130 lldptool set-lldp -i eth2 adminStatus=rxtx
131 Query the LLDP adminStatus for interface eth3
134 lldptool -l -i eth3 adminStatus
135 lldptool get-lldp -i eth3 adminStatus
136 Query the LLDP statistics for interface eth3
139 lldptool -S -i eth3
140 lldptool stats -i eth3
141 Query the local TLVs which are being transmitted for a given interface:
144 lldptool -t -i eth3
145 lldptool get-tlv -i eth3
146 Query the received neighbor TLVs received on a given interface:
149 lldptool -t -n -i eth3
150 lldptool get-tlv -n -i eth3
151 Query the value of the System Description TLV as received from the
154 neighbor on a given interface:
155 lldptool -t -n -i eth3 -V sysDesc
156 lldptool get-tlv -n -i eth3 -V 6
157 Disable transmit of the IEEE 802.3 MAC/PHY Configuration Status TLV for
160 a given interface:
161 lldptool -T -i eth3 -V macPhyCfg enableTx=no
162 lldptool set-tlv -i eth3 -V 0x120f01 enableTx=no
163 Query value of the transmit setting for the Port Description TLV for a
166 given interface:
167 lldptool -t -i eth3 -V portDesc -c enableTx
168 lldptool get-tlv -i eth3 -V 4 -c enableTx
169 Set a Management Address TLV on eth3 to carry IPv4 address
172 192.168.10.10
173 lldptool -T -i eth3 -V mngAddr ipv4=192.168.10.10
174 Set a Management Address TLV on eth3 to carry IPv6 address
177 ::192.168.10.10
178 lldptool -T -i eth3 -V mngAddr ipv6=::192.168.10.10
179 Get the configured IPv4 address for the Management Address TLV on eth3
182 lldptool -t -i eth3 -V mngAddr -c ipv4
183 Get all configured attributes for the Management Address TLV on eth3
186 lldptool -t -i eth3 -V mngAddr -c
187 Enable transmit of the Edge Virtual Bridging TLV for interface eth4
190 lldptool -i eth4 -T -g ncb -V evbCfg enableTx=yes
191 Enable transmit of VDP for interface eth4
194 lldptool -i eth4 -T -V vdp enableTx=yes
195 Display process identifier of lldpad
198 lldptool -p
199
202 lldptool-dcbx(8), lldptool-ets(8), lldptool-pfc(8), lldptool-app(8),
203 lldptool-med(8), lldptool-vdp(8), lldptool-evb(8), lldptool-evb22(8),
204 dcbtool(8), lldpad(8)
205
208 lldptool - LLDP agent configuration utility
209 Copyright(c) 2007-2012 Intel Corporation. Portions of lldptool are
210 based on:
211 hostapd-0.5.7
213 Copyright
215 (c) 2004-2008, Jouni Malinen <j@w1.fi>
216
219 This program is free software; you can redistribute it and/or modify it
220 under the terms and conditions of the GNU General Public License, ver‐
221 sion 2, as published by the Free Software Foundation.
222 This program is distributed in the hope it will be useful, but WITHOUT
224 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
225 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
226 for more details.
227 You should have received a copy of the GNU General Public License along
229 with this program; if not, write to the Free Software Foundation, Inc.,
230 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
231 The full GNU General Public License is included in this distribution in
233 the file called "COPYING".
234
236 Contact Information: open-lldp Mailing List <lldp-devel@open-lldp.org>
237open-lldp August 2012 lldptool(8)