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