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