]> git.ipfire.org Git - thirdparty/lldpd.git/blame - src/client/lldpcli.8.in
client: remove previous way to set port description from documentation
[thirdparty/lldpd.git] / src / client / lldpcli.8.in
CommitLineData
fe80711e
VB
1.\" Copyright (c) 2006 Pierre-Yves Ritschard <pyr@openbsd.org>
2.\" Copyright (c) 2008 Vincent Bernat <bernat@luffy.cx>
3.\"
4.\" Permission to use, copy, modify, and/or distribute this software for any
5.\" purpose with or without fee is hereby granted, provided that the above
6.\" copyright notice and this permission notice appear in all copies.
7.\"
8.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15.\"
16.Dd $Mdocdate: July 16 2008 $
17.Dt LLDPCLI 8
18.Os
19.Sh NAME
20.Nm lldpcli ,
21.Nm lldpctl
22.Nd control LLDP daemon
23.Sh SYNOPSIS
24.Nm
25.Op Fl dv
baaa96d1 26.Op Fl u Ar socket
fe80711e 27.Op Fl f Ar format
6402fd2c 28.Op Fl c Ar file
fe80711e
VB
29.Op Ar command ...
30.Nm lldpctl
31.Op Fl dv
baaa96d1 32.Op Fl u Ar socket
fe80711e
VB
33.Op Fl f Ar format
34.Op Ar interfaces ...
35.Sh DESCRIPTION
36The
37.Nm
38program controls
39.Xr lldpd 8
40daemon.
41.Pp
42When no command is specified,
43.Nm
44will start an interactive shell which can be used to input arbitrary
45commands as if they were specified on the command line. This
46interactive shell should provide completion and history support.
47.Pp
48The options are as follows:
49.Bl -tag -width Ds
50.It Fl d
9856f279 51Enable more debugging information. This flag can be repeated.
baaa96d1 52.It Fl u Ar socket
0262adbb
ZM
53Specify the Unix-domain socket used for communication with
54.Xr lldpd 8 .
fe80711e
VB
55.It Fl v
56Show
57.Nm
efa6a7a3 58version. When repeated, show more build information.
fe80711e
VB
59.It Fl f Ar format
60Choose the output format. Currently
61.Em plain ,
62.Em xml ,
479d4985
VB
63.Em json ,
64.Em json0
fe80711e
VB
65and
66.Em keyvalue
67formats are available. The default is
68.Em plain .
479d4985
VB
69.Em json0
70is more verbose than
71.Em json
72but the structure of the JSON object is not affected by the number of
73interfaces or the number of neighbors. It is therefore easier to
74parse.
6402fd2c
VB
75.It Fl c Ar file
76Read the given configuration file. This option may be repeated several
77times. If a directory is provided, each file contained in it will be
78read if ending by
79.Li .conf .
80Order is alphabetical.
fe80711e 81.El
fe80711e
VB
82.Pp
83When invoked as
84.Nm lldpctl ,
85.Nm
86will display detailed information about each neighbors on the
87specified interfaces or on all interfaces if none are specified. This
88command is mostly kept for backward compatibility with older versions.
fe80711e
VB
89.Pp
90The following commands are supported by
91.Nm .
92When there is no ambiguity, the keywords can be abbreviated. For
93example,
94.Cd show neighbors ports eth0 summary
95and
96.Cd sh neigh p eth0 sum
97are the same command.
fe80711e
VB
98.Bd -ragged -offset XX
99.Cd exit
100.Bd -ragged -offset XXXXXX
101Quit
102.Nm .
103.Ed
104
72706acd
VB
105.Cd help Op ...
106.Bd -ragged -offset XXXXXX
107Display general help or help about a command. Also, you can get help
108using the completion or by pressing the
109.Ic ?
110key. However, completion and inline help may be unavailable if
111.Nm
112was compiled without readline support but
113.Cd help
114command is always available.
115.Ed
116
fe80711e 117.Cd show neighbors
97772619 118.Op ports Ar ethX Op ,...
fe80711e
VB
119.Op Cd details | summary
120.Op Cd hidden
121.Bd -ragged -offset XXXXXX
122Display information about each neighbor known by
123.Xr lldpd 8
124daemon. With
125.Cd summary ,
a6d1d023 126only the name and the port description of each remote host will be
fe80711e
VB
127displayed. On the other hand, with
128.Cd details ,
129all available information will be displayed, giving a verbose
130view. When using
131.Cd hidden ,
132also display remote ports hidden by the smart filter. When specifying
133one or several ports, the information displayed is limited to the
134given list of ports.
135.Ed
136
a54f6012
SW
137.Cd show interfaces
138.Op ports Ar ethX Op ,...
139.Op Cd details | summary
140.Op Cd hidden
141.Bd -ragged -offset XXXXXX
142Display information about each local interface known by
143.Xr lldpd 8
144daemon. With
145.Cd summary ,
146only the name and the port description of each local interface will be
147displayed. On the other hand, with
148.Cd details ,
149all available information will be displayed, giving a verbose
150view. When using
151.Cd hidden ,
152also display local ports hidden by the smart filter. When specifying
153one or several ports, the information displayed is limited to the
154given list of ports.
155.Ed
156
3407e638
VB
157.Cd show chassis
158.Op Cd details | summary
159.Bd -ragged -offset XXXXXX
160Display information about local chassis. With
161.Cd summary ,
162most details are skipped. On the other hand, with
163.Cd details ,
164all available information will be displayed, giving a verbose
165view.
166.Ed
167
fe80711e 168.Cd watch
97772619 169.Op ports Ar ethX Op ,...
fe80711e
VB
170.Op Cd details | summary
171.Op Cd hidden
a7c54949 172.Op Cd limit Ar X
fe80711e
VB
173.Bd -ragged -offset XXXXXX
174Watch for any neighbor changes and report them as soon as they
175happen. When specifying ports, the changes are only reported when
176happening on the given ports.
177.Cd hidden , summary
178and
179.Cd details
a7c54949
VB
180have the same meaning than previously described. If
181.Cd limit
a6d1d023 182is specified,
a7c54949
VB
183.Nm
184will exit after receiving the specified number of events.
fe80711e
VB
185.Ed
186
187.Cd show configuration
188.Bd -ragged -offset XXXXXX
189Display global configuration of
190.Xr lldpd 8
191daemon.
192.Ed
193
885aa4f4
VB
194.Cd show statistics
195.Op ports Ar ethX Op ,...
196.Op Cd summary
197.Bd -ragged -offset XXXXXX
198Report LLDP-related statistics, like the number of LLDPDU transmitted,
199received, discarded or unrecognized. When specifying ports, only the
200statistics from the given port are reported. With
201.Cd summary
202the statistics of each port is summed.
203.Ed
204
fe80711e
VB
205.Cd update
206.Bd -ragged -offset XXXXXX
207Make
208.Xr lldpd 8
209update its information and send new LLDP PDU on all interfaces.
210.Ed
211
17a90fc0
VB
212.Cd configure
213.Cd system hostname Ar name
214.Bd -ragged -offset XXXXXX
215Override system hostname with the provided value. By default, the
a9d00cbd 216system name is the FQDN found from the resolved value of
17a90fc0 217.Ic uname -n .
a9d00cbd
VB
218As a special value, use "." (dot) to use the short hostname instead of
219a FQDN.
17a90fc0
VB
220.Ed
221
6dd83015
VB
222.Cd unconfigure
223.Cd system hostname
224.Bd -ragged -offset XXXXXX
225Do not override system hostname and restore the use of the node name.
226.Ed
227
decaec0d
VB
228.Cd configure
229.Cd system description Ar description
230.Bd -ragged -offset XXXXXX
231Override chassis description with the provided value instead of using
232kernel name, node name, kernel version, build date and architecture.
233.Ed
234
6dd83015
VB
235.Cd unconfigure
236.Cd system description
237.Bd -ragged -offset XXXXXX
238Do not override chassis description and use a value computed from node
239name, kernel name, kernel version, build date and architecture instead.
240.Ed
241
8481f490
VB
242.Cd configure
243.Cd system chassisid Ar description
244.Bd -ragged -offset XXXXXX
245Override chassis ID with the provided value instead of using MAC address
246from one interface or host name.
247.Ed
248
249.Cd unconfigure
250.Cd system chassisid
251.Bd -ragged -offset XXXXXX
252Do not override chassis ID and use a value computed from one of the interface
253MAC address (or host name if none is found).
254.Ed
255
3f70e118
VB
256.Cd configure
257.Cd system platform Ar description
258.Bd -ragged -offset XXXXXX
259Override platform description with the provided value instead of using
260kernel name. This value is currently only used for CDP.
261.Ed
262
6dd83015
VB
263.Cd unconfigure
264.Cd system platform
265.Bd -ragged -offset XXXXXX
266Do not override platform description and use the kernel name. This
267option undoes the previous one.
268.Ed
269
f88442ac 270.Cd configure
48d0a4b0 271.Cd system interface pattern Ar pattern
0093777b 272.Bd -ragged -offset XXXXXX
5a1f4586
VB
273Specify which interface to listen and send LLDPDU to. Without this
274option,
0093777b 275.Nm lldpd
5a1f4586 276will use all available physical interfaces. This option can use
0093777b
VB
277wildcards. Several interfaces can be specified separated by commas.
278It is also possible to blacklist an interface by suffixing it with an
3b0273ee
VB
279exclamation mark. It is possible to whitelist an interface by
280suffixing it with two exclamation marks. A whitelisted interface beats
281a blacklisted interfaces which beats a simple matched interface. For
282example, with
0093777b
VB
283.Em eth*,!eth1,!eth2
284.Nm lldpd
5a1f4586 285will only use interfaces starting by
0093777b
VB
286.Em eth
287with the exception of
288.Em eth1
289and
290.Em eth2 .
3b0273ee
VB
291While with
292.Em *,!eth*,!!eth1
293.Nm
5a1f4586 294will use all interfaces, except interfaces starting by
3b0273ee
VB
295.Em eth
296with the exception of
297.Em eth1 .
298When an exact match is found, it will circumvent some tests. For example, if
299.Em eth0.12
300is specified, it will be accepted even if this is a VLAN interface.
0093777b
VB
301.Ed
302
6dd83015
VB
303.Cd unconfigure
304.Cd system interface pattern
305.Bd -ragged -offset XXXXXX
5a1f4586 306Remove any previously configured interface pattern and use all
a6d1d023 307physical interfaces. This option undoes the previous one.
6dd83015
VB
308.Ed
309
bb37268d
VB
310.Cd configure
311.Cd system interface description
312.Bd -ragged -offset XXXXXX
313Some OS allows the user to set a description for an interface. Setting
314this option will enable
315.Nm lldpd
316to override this description with the name of the peer neighbor if one
317is found or with the number of neighbors found.
318.Ed
319
6dd83015 320.Cd unconfigure
b1118c26 321.Cd system interface description
6dd83015
VB
322.Bd -ragged -offset XXXXXX
323Do not update interface description with the name of the peer
324neighbor. This option undoes the previous one.
325.Ed
326
f84199dd
VB
327.Cd configure
328.Cd system interface promiscuous
329.Bd -ragged -offset XXXXXX
0a6f3866 330Enable promiscuous mode on managed interfaces.
f84199dd
VB
331.Pp
332When the interface is not managed any more (or when quitting
1eadc9a1 333.Nm lldpd ) ,
f84199dd
VB
334the interface is left in promiscuous mode as it is difficult to know
335if someone else also put the interface in promiscuous mode.
336.Pp
337This option is known to be useful when the remote switch is a Cisco
0a6f3866
VB
3382960 and the local network card features VLAN hardware
339acceleration. In this case, you may not receive LLDP frames from the
340remote switch. The most plausible explanation for this is the frame is
341tagged with some VLAN (usually VLAN 1) and your network card is
342filtering VLAN. This is not the only available solution to work-around
343this problem. If you are concerned about performance issues, you can
344also tag the VLAN 1 on each interface instead.
345.Pp
346Currently, this option has no effect on anything else than Linux. On
347other OS, either disable VLAN acceleration, tag VLAN 1 or enable
348promiscuous mode manually on the interface.
f84199dd
VB
349.Ed
350
351.Cd unconfigure
352.Cd system interface promiscuous
353.Bd -ragged -offset XXXXXX
354Do not set promiscuous mode on managed interfaces. This option does
355not disable promiscuous mode on interfaces already using this mode.
356.Ed
357
622d14bb
VB
358.Cd configure
359.Cd system ip management pattern Ar pattern
360.Bd -ragged -offset XXXXXX
361Specify the management addresses of this system. As for interfaces
362(described above), this option can use wildcards and inversions.
abfea7d0
VB
363Without this option, the first IPv4 and the first IPv6 are used. If an
364exact IP address is provided, it is used as a management address
365without any check. If only negative patterns are provided, only one
366IPv4 and one IPv6 addresses are chosen. Otherwise, many of them can be
367selected. If you want to blacklist IPv6 addresses, you can use
622d14bb
VB
368.Em !*:* .
369.Ed
370
6dd83015
VB
371.Cd unconfigure
372.Cd system ip management pattern
373.Bd -ragged -offset XXXXXX
374Unset any specific pattern for matching management addresses. This
375option undoes the previous one.
376.Ed
377
3106c706
VB
378.Cd configure
379.Cd system bond-slave-src-mac-type Ar value
380.Bd -ragged -offset XXXXXX
381Set the type of src mac in lldp frames sent on bond slaves
382
383Valid types are:
384.Bl -tag -width "XXX." -compact -offset XX
385.It Sy real
386Slave real mac
387.It Sy zero
388All zero mac
389.It Sy fixed
390An arbitrary fixed value
391.Li ( 00:60:08:69:97:ef )
392.It Sy local
393Real mac with locally administered bit set. If the real mac already
394has the locally administered bit set, fallback to the fixed value.
395.El
396.Pp
397Default value for
398.Nm bond-slave-src-mac-type
399is
400.Nm local .
401Some switches may complain when using one of the two other possible
402values (either because
403.Li 00:00:00:00:00:00
404is not a valid MAC or because the MAC address is flapping from one
405port to another). Using
406.Sy local
407might lead to a duplicate MAC address on the network (but this is
408quite unlikely).
409.Ed
410
1eadc9a1
VB
411.Cd configure
412.Cd lldp agent-type
413.Cd nearest-bridge | nearest-non-tpmr-bridge | nearest-customer-bridge
414.Bd -ragged -offset XXXXXX
415The destination MAC address used to send LLDPDU allows an agent to
416control the propagation of LLDPDUs. By default, the
417.Li 01:80:c2:00:00:0e
418MAC address is used and limit the propagation of the LLDPDU to the
419nearest bridge
420.Cd ( nearest-bridge ) .
421To instruct
422.Nm lldpd
423to use the
424.Li 01:80:c2:00:00:03
425MAC address instead, use
426.Cd nearest-nontpmr-bridge
427instead.
428To use the
429.Li 01:80:c2:00:00:00
430MAC address instead, use
431.Cd nearest-customer-bridge
432instead.
433.Ed
434
bef085b8 435.Cd configure
4edc4960 436.Cd lldp portidsubtype
b3dd61af
VB
437.Cd ifname | macaddress
438.Pp
439.Cd configure
440.Op ports Ar ethX Op ,...
441.Cd lldp portidsubtype
dc9869ef 442.Cd local Ar value
bef085b8
VB
443.Bd -ragged -offset XXXXXX
444Force port ID subtype. By default,
1eadc9a1 445.Nm lldpd
bef085b8
VB
446will use the MAC address as port identifier and the interface name as
447port description, unless the interface has an alias. In this case, the
448interface name will be used as port identifier and the description
449will be the interface alias. With this command, you can force the port
450identifier to be the interface name (with
50a978dc
VB
451.Cd ifname ) ,
452the MAC address (with
453.Cd macaddress )
454or a local value (with
455.Cd value ) .
456In the latest case, the local value should be provided.
bef085b8
VB
457.Ed
458
3d96ef66
JJ
459.Cd configure
460.Op ports Ar ethX Op ,...
461.Cd lldp portdescription
462.Cd Ar description
463.Bd -ragged -offset XXXXXX
464Force port description to the provided string.
465.Ed
466
48d0a4b0
VB
467.Cd configure
468.Cd lldp tx-interval Ar interval
469.Bd -ragged -offset XXXXXX
470Change transmit delay to the specified value in seconds. The transmit
471delay is the delay between two transmissions of LLDP PDU. The default
472value is 30 seconds.
473.Ed
474
475.Cd configure
476.Cd lldp tx-hold Ar hold
477.Bd -ragged -offset XXXXXX
478Change transmit hold value to the specified value. This value is used
479to compute the TTL of transmitted packets which is the product of this
480value and of the transmit delay. The default value is 4 and therefore
481the default TTL is 120 seconds.
482.Ed
483
e7331ce9
VB
484.Cd configure
485.Op ports Ar ethX Op ,...
486.Cd lldp
487.Cd status Ar rx-and-tx | rx-only | tx-only | disabled
488.Bd -ragged -offset XXXXXX
489Configure the administrative status of the given port. By default, all
490ports are configured to be in
6934b73d 491.Ar rx-and-tx
e7331ce9
VB
492mode. This means they can receive and transmit LLDP frames (as well as
493other protocols if needed). In
6934b73d 494.Ar rx-only
e7331ce9 495mode, they won't emit any frames and in
6934b73d 496.Ar tx-only
e7331ce9
VB
497mode, they won't receive any frames. In
498.Ar disabled
499mode, no frame will be sent and any incoming frame will be
a6d1d023 500discarded. This setting does not override the operational mode of the
e7331ce9
VB
501main daemon. If it is configured in receive-only mode (with the
502.Fl r
503flag), setting any transmit mode won't have any effect.
504.Ed
505
24133f55 506.Cd configure
7c26c8b4 507.Cd lldp custom-tlv
508.Op Cd add | replace
509.Cd oui Ar oui
24133f55
VB
510.Cd subtype Ar subtype
511.Op Cd oui-info Ar content
512.Bd -ragged -offset XXXXXX
513Emit a custom TLV for OUI
514.Ar oui ,
515with subtype
516.Ar subtype
7c26c8b4 517and optionally with the bytes specified in
24133f55
VB
518.Ar content .
519Both
520.Ar oui
521and
522.Ar content
e9400049 523should be a comma-separated list of bytes in hex format.
24133f55
VB
524.Ar oui
525must be exactly 3-byte long.
7c26c8b4 526If
527.Ar add
528is specified then the TLV will be added. This is the default action.
529If
92a6d7f9 530.Ar replace
7c26c8b4 531is specified then all TLVs with the same
532.Ar oui
533and
534.Ar subtype
535will be replaced.
536
24133f55
VB
537.Ed
538
539.Cd unconfigure
540.Cd lldp custom-tlv
7c26c8b4 541.Op Cd oui Ar oui
542.Op Cd subtype Ar subtype
24133f55 543.Bd -ragged -offset XXXXXX
7c26c8b4 544When no oui is specified, remove all previously configured custom TLV.
545When OUI
546.Ar oui
547and subtype
548.Ar subtype
549is specified, remove specific instances of custom TLV.
24133f55
VB
550.Ed
551
486a6133
VB
552.Cd configure med fast-start
553.Cd enable | tx-interval Ar interval
554.Bd -ragged -offset XXXXXX
555Configure LLDP-MED fast start mechanism. When a new LLDP-MED-enabled
556neighbor is detected, fast start allows
557.Nm lldpd
558to shorten the interval between two LLDPDU.
559.Cd enable
560should enable LLDP-MED fast start while
561.Cd tx-interval
562specifies the interval between two LLDPDU in seconds. The default
563interval is 1 second. Once 4 LLDPDU have been sent, the fast start
564mechanism is disabled until a new neighbor is detected.
565.Ed
566
567.Cd unconfigure med fast-start
568.Bd -ragged -offset XXXXXX
569Disable LLDP-MED fast start mechanism.
570.Ed
571
fe80711e 572.Cd configure
97772619 573.Op ports Ar ethX Op ,...
fe80711e
VB
574.Cd med location coordinate
575.Cd latitude Ar latitude
576.Cd longitude Ar longitude
577.Cd altitude Ar altitude Ar unit
578.Cd datum Ar datum
579.Bd -ragged -offset XXXXXX
580Advertise a coordinate based location on the given ports (or on all
581ports if no port is specified). The format of
582.Ar latitude
583is a decimal floating point number followed either by
584.Em N
585or
586.Em S .
587The format of
588.Ar longitude
589is a decimal floating point number followed either by
590.Em E
591or
592.Em W .
593.Ar altitude
594is a decimal floating point number followed either by
595.Em m
596when expressed in meters or
597.Em f
3fc1a10a
VB
598when expressed in floors. A space is expected between the floating
599point number and the unit.
fe80711e
VB
600.Ar datum
601is one of those values:
602.Bl -bullet -compact -offset XXXXXXXX
603.It
604WGS84
605.It
606NAD83
607.It
608NAD83/MLLW
609.El
610.Pp
611A valid use of this command is:
3fc1a10a 612.D1 configure ports eth0 med location coordinate latitude 48.85667N longitude 2.2014E altitude 117.47 m datum WGS84
fe80711e
VB
613.Ed
614
615.Cd configure
97772619 616.Op ports Ar ethX Op ,...
fe80711e
VB
617.Cd med location address
618.Cd country Ar country
619.Cd Op Ar type value Op ...
620.Bd -ragged -offset XXXXXX
621Advertise a civic address on the given ports (or on all ports if no
622port is specified).
623.Ar country
624is the two-letter code representing the country. The remaining
625arguments should be paired to form the address. The first member of
626each pair indicates the type of the second member which is a free-form
627text. Here is the list of valid types:
628.Bl -bullet -compact -offset XXXXXXXX
629.It
630language
631.It
632country-subdivision
633.It
634county
635.It
636city
637.It
638city-division
639.It
640block
641.It
642street
643.It
644direction
645.It
646trailing-street-suffix
647.It
648street-suffix
649.It
650number
651.It
652number-suffix
653.It
654landmark
655.It
656additional
657.It
658name
659.It
660zip
661.It
662building
663.It
664unit
665.It
666floor
667.It
668room
669.It
670place-type
671.It
672script
673.El
674.Pp
675A valid use of this command is:
120c071a 676.D1 configure ports eth1 med location address country US street Qo Commercial Road Qc city Qo Roseville Qc
fe80711e
VB
677.Ed
678
679.Cd configure
97772619 680.Op ports Ar ethX Op ,...
fe80711e
VB
681.Cd med location elin
682.Ar number
683.Bd -ragged -offset XXXXXX
684Advertise the availability of an ELIN number. This is used for setting
685up emergency call. If the provided number is too small, it will be
686padded with 0. Here is an example of use:
687.D1 configure ports eth2 med location elin 911
688.Ed
689
690.Cd configure
97772619 691.Op ports Ar ethX Op ,...
fe80711e
VB
692.Cd med policy
693.Cd application Ar application
694.Op Cd unknown
17e55ef9 695.Op Cd tagged
fe80711e
VB
696.Op Cd vlan Ar vlan
697.Op Cd priority Ar priority
698.Op Cd dscp Ar dscp
699.Bd -ragged -offset XXXXXX
700Advertise a specific network policy for the given ports (or for all
701ports if no port was provided). Only the application type is
702mandatory.
703.Ar application
704should be one of the following values:
fe80711e
VB
705.Bl -bullet -compact -offset XXXXXXXX
706.It
707voice
708.It
709voice-signaling
710.It
711guest-voice
712.It
713guest-voice-signaling
714.It
715softphone-voice
716.It
717video-conferencing
718.It
719streaming-video
720.It
721video-signaling
722.El
723.Pp
724The
725.Cd unknown
726flag tells that the network policy for the specified application type
727is required by the device but is currently unknown. This is used by
728Endpoint Devices, not by Network Connectivity Devices. If not
729specified, the network policy for the given application type is
730defined.
731.Pp
732When a VLAN is specified with
e7f83dc0 733.Ar vlan
fe80711e
VB
734tells which 802.1q VLAN ID has to be advertised for the network
735policy. A valid value is between 1 and 4094.
17e55ef9
VB
736.Cd tagged
737tells the VLAN should be tagged for the specified application type.
e7f83dc0
VB
738.Pp
739.Ar priority
fe80711e
VB
740allows one to specify IEEE 802.1d / IEEE 802.1p Layer 2 Priority, also
741known as Class of Service (CoS), to be used for the specified
17e55ef9 742application type. This field is usually ignored if no VLAN is
e7f83dc0
VB
743specified. The names match 802.1D-2004 standard (table G-2). Some more
744recent standards may use different labels. Only the numeric values
745should be relied upon. The accepted labels are:
746.Bl -tag -width "X." -compact -offset XXXX
747.It Sy 1
fe80711e 748background
e7f83dc0 749.It Sy 0
fe80711e 750best-effort
c56e4067 751.It Sy 2
fe80711e 752excellent-effort
c56e4067
VB
753.It Sy 3
754critical-applications
e7f83dc0 755.It Sy 4
fe80711e 756video
c56e4067 757.It Sy 5
fe80711e 758voice
c56e4067
VB
759.It Sy 6
760internetwork-control
e7f83dc0 761.It Sy 7
fe80711e
VB
762network-control
763.El
764.Pp
765.Ar dscp
766represents the DSCP value to be advertised for the given network
767policy. DiffServ/Differentiated Services Code Point (DSCP) value as
768defined in IETF RFC 2474 for the specified application type. Value: 0
769(default per RFC 2475) through 63. Note: The class selector DSCP
770values are backwards compatible for devices that only support the old
771IP precedence Type of Service (ToS) format. (See the RFCs for what
772these values mean)
773.Pp
774A valid use of this command is:
775.D1 configure med policy application voice vlan 500 priority voice dscp 46
776.Ed
777
778.Cd configure
97772619 779.Op ports Ar ethX Op ,...
fe80711e
VB
780.Cd med power pse | pd
781.Cd source Ar source
782.Cd priority Ar priority
783.Cd value Ar value
784.Bd -ragged -offset XXXXXX
785Advertise the LLDP-MED POE-MDI TLV for the given ports or for all
786interfaces if no port is provided. One can act as a PD (power
787consumer) or a PSE (power provider). No check is done on the validity
788of the parameters while LLDP-MED requires some restrictions:
789.Bl -bullet
790.It
791PD shall never request more power than physical 802.3af class.
792.It
793PD shall never draw more than the maximum power advertised by PSE.
794.It
795PSE shall not reduce power allocated to PD when this power is in use.
796.It
797PSE may request reduced power using conservation mode
798.It
b1118c26 799Being PSE or PD is a global parameter, not a per-port parameter.
fe80711e
VB
800.Nm
801does not enforce this: a port can be set as PD or PSE. LLDP-MED also
802requires for a PSE to only have one power source (primary or
803backup). Again,
804.Nm
805does not enforce this. Each port can have its own power source. The
806same applies for PD and power priority. LLDP-MED MIB does not allow
807this kind of representation.
808.El
809.Pp
810Valid types are:
811.Bl -tag -width "XXX." -compact -offset XX
812.It Sy pse
813Power Sourcing Entity (power provider)
814.It Sy pd
815Power Device (power consumer)
816.El
817.Pp
818Valid sources are:
819.Bl -tag -width "XXXXXXX" -compact -offset XX
820.It Sy unknown
821Unknown
822.It Sy primary
823For PSE, the power source is the primary power source.
824.It Sy backup
825For PSE, the power source is the backup power source or a power
826conservation mode is asked (the PSE may be running on UPS for
827example).
828.It Sy pse
829For PD, the power source is the PSE.
830.It Sy local
831For PD, the power source is a local source.
832.It Sy both
833For PD, the power source is both the PSE and a local source.
834.El
835.Pp
836Valid priorities are:
837.Bl -tag -width "XXXXXXXXX" -compact -offset XX
838.It Sy unknown
839Unknown priority
840.It Sy critical
841Critical
842.It Sy high
843High
844.It Sy low
845Low
846.El
847.Pp
848.Ar value
849should be the total power in milliwatts required by the PD device or
850available by the PSE device.
851.Pp
852Here is an example of use:
853.D1 configure med power pd source pse priority high value 5000
854.Ed
855
856.Cd configure
97772619 857.Op ports Ar ethX Op ,...
fe80711e
VB
858.Cd dot3 power pse | pd
859.Op Cd supported
860.Op Cd enabled
861.Op Cd paircontrol
862.Cd powerpairs Ar powerpairs
863.Op Cd class Ar class
864.Op Cd type Ar type Cd source Ar source Cd priority Ar priority Cd requested Ar requested Cd allocated Ar allocated
865.Bd -ragged -offset XXXXXX
866Advertise Dot3 POE-MDI TLV for the given port or for all ports if none
867was provided. One can act as a PD (power consumer) or a PSE (power
868provider). This configuration is distinct of the configuration of the
869transmission of the LLDP-MED POE-MDI TLV but the user should ensure
870the coherency of those two configurations if they are used together.
871.Pp
872.Ar supported
873means that MDI power is supported on the given port while
874.Ar enabled
875means that MDI power is enabled.
876.Ar paircontrol
877is used to indicate if pair selection can be controlled. Valid values
a6d1d023 878for
fe80711e
VB
879.Ar powerpairs
880are:
881.Bl -tag -width "XXXXXX" -compact -offset XX
882.It Sy signal
883The signal pairs only are in use.
884.It Sy spare
885The spare pairs only are in use.
886.El
887.Pp
888When specified,
889.Ar class
890is a number between 0 and 4.
891.Pp
892The remaining parameters are in conformance with 802.3at and are optional.
893.Ar type
894should be either 1 or 2, indicating which if the device conforms to
5d0938c0 895802.3at type 1 or 802.3at type 2. Values of
fe80711e
VB
896.Ar source
897and
898.Ar priority
899are the same as for LLDP-MED POE-MDI TLV.
900.Ar requested
901and
902.Ar allocated
903are expressed in milliwats.
904.Pp
905Here are two valid uses of this command:
26498cf4
VB
906.D1 configure ports eth3 dot3 power pse supported enabled paircontrol powerpairs spare class class-3
907.D1 configure dot3 power pd supported enabled powerpairs spare class class-3 type 1 source pse priority low requested 10000 allocated 15000
fe80711e
VB
908.Ed
909
e4ff3ed5
VB
910.Cd pause
911.Bd -ragged -offset XXXXXX
912Pause
913.Nm lldpd
914operations.
915.Nm lldpd
916will not send any more frames or receive ones. This can be undone with
917.Cd resume
918command.
919.Ed
920
921.Cd resume
922.Bd -ragged -offset XXXXXX
923Resume
924.Nm lldpd
925operations.
926.Nm lldpd
927will start to send and receive frames. This command is issued
928internally after processing configuration but can be used at any time
929if a manual
930.Cd pause
931command is issued.
932.Ed
933
fe80711e
VB
934.Ed
935.Sh FILES
2cbc9cc5
VB
936.Bl -tag -width "@LLDPD_CTL_SOCKET@XX" -compact
937.It @LLDPD_CTL_SOCKET@
fe80711e
VB
938Unix-domain socket used for communication with
939.Xr lldpd 8 .
940.El
941.Sh SEE ALSO
942.Xr lldpd 8
943.Sh AUTHORS
944.An -nosplit
945The
946.Nm
947program was written by
948.An Vincent Bernat Aq bernat@luffy.cx .