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