src/client/lldpcli.8.in

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