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 and
  65 .Em keyvalue
  66 formats are available. The default is
  67 .Em plain .
  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.
  74 .El
  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.
  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.
  91 .Bd -ragged -offset XX
  92 .Cd exit
  93 .Bd -ragged -offset XXXXXX
  94 Quit
  95 .Nm .
  96 .Ed
  97
  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
 110 .Cd show neighbors
 111 .Op ports Ar ethX Op ,...
 112 .Op Cd details | summary
 113 .Op Cd hidden
 114 .Bd -ragged -offset XXXXXX
 115 Display information about each neighbor known by
 116 .Xr lldpd 8
 117 daemon. With
 118 .Cd summary ,
 119 only a the name and the port description of each remote host will be
 120 displayed. On the other hand, with
 121 .Cd details ,
 122 all available information will be displayed, giving a verbose
 123 view. When using
 124 .Cd hidden ,
 125 also display remote ports hidden by the smart filter. When specifying
 126 one or several ports, the information displayed is limited to the
 127 given list of ports.
 128 .Ed
 129
 130 .Cd 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
 141 .Cd watch
 142 .Op ports Ar ethX Op ,...
 143 .Op Cd details | summary
 144 .Op Cd hidden
 145 .Op Cd limit Ar X
 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
 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.
 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
 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
 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
 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
 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
 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
 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
 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
 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
 227 .Cd configure
 228 .Cd system interface pattern Ar pattern
 229 .Bd -ragged -offset XXXXXX
 230 Specify which interface to listen and send LLDPDU to. Without this
 231 option,
 232 .Nm lldpd
 233 will use all available physical interfaces. This option can use
 234 wildcards. Several interfaces can be specified separated by commas.
 235 It is also possible to blacklist an interface by suffixing it with an
 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
 240 .Em eth*,!eth1,!eth2
 241 .Nm lldpd
 242 will only use interfaces starting by
 243 .Em eth
 244 with the exception of
 245 .Em eth1
 246 and
 247 .Em eth2 .
 248 While with
 249 .Em *,!eth*,!!eth1
 250 .Nm
 251 will use all interfaces, except interfaces starting by
 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.
 258 .Ed
 259
 260 .Cd unconfigure
 261 .Cd system interface pattern
 262 .Bd -ragged -offset XXXXXX
 263 Remove any previously configured interface pattern and use all
 264 physical interafces. This option undoes the previous one.
 265 .Ed
 266
 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
 277 .Cd unconfigure
 278 .Cd system interface description
 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
 284 .Cd configure
 285 .Cd system interface promiscuous
 286 .Bd -ragged -offset XXXXXX
 287 Enable promiscuous mode on managed interfaces.
 288 .Pp
 289 When the interface is not managed any more (or when quitting
 290 .Nm lldpd ) ,
 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
 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.
 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
 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.
 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
 325 .Em !*:* .
 326 .Ed
 327
 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
 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
 368 .Cd configure
 369 .Cd lldp agent-type
 370 .Cd nearest-bridge | nearest-non-tpmr-bridge | nearest-customer-bridge
 371 .Bd -ragged -offset XXXXXX
 372 The destination MAC address used to send LLDPDU allows an agent to
 373 control the propagation of LLDPDUs. By default, the
 374 .Li 01:80:c2:00:00:0e
 375 MAC address is used and limit the propagation of the LLDPDU to the
 376 nearest bridge
 377 .Cd ( nearest-bridge ) .
 378 To instruct
 379 .Nm lldpd
 380 to use the
 381 .Li 01:80:c2:00:00:03
 382 MAC address instead, use
 383 .Cd nearest-nontpmr-bridge
 384 instead.
 385 To use the
 386 .Li 01:80:c2:00:00:00
 387 MAC address instead, use
 388 .Cd nearest-customer-bridge
 389 instead.
 390 .Ed
 391
 392 .Cd configure
 393 .Cd lldp portidsubtype
 394 .Cd ifname | macaddress
 395 .Pp
 396 .Cd configure
 397 .Op ports Ar ethX Op ,...
 398 .Cd lldp portidsubtype
 399 .Cd local Ar value Op Cd description Ar description
 400 .Bd -ragged -offset XXXXXX
 401 Force port ID subtype. By default,
 402 .Nm lldpd
 403 will use the MAC address as port identifier and the interface name as
 404 port description, unless the interface has an alias. In this case, the
 405 interface name will be used as port identifier and the description
 406 will be the interface alias. With this command, you can force the port
 407 identifier to be the interface name (with
 408 .Cd ifname ) ,
 409 the MAC address (with
 410 .Cd macaddress )
 411 or a local value (with
 412 .Cd value ) .
 413 In the latest case, the local value should be provided.
 414 Optionally, a port description can also be provided after the local
 415 value.
 416 .Ed
 417
 418 .Cd configure
 419 .Cd lldp tx-interval Ar interval
 420 .Bd -ragged -offset XXXXXX
 421 Change transmit delay to the specified value in seconds. The transmit
 422 delay is the delay between two transmissions of LLDP PDU. The default
 423 value is 30 seconds.
 424 .Ed
 425
 426 .Cd configure
 427 .Cd lldp tx-hold Ar hold
 428 .Bd -ragged -offset XXXXXX
 429 Change transmit hold value to the specified value. This value is used
 430 to compute the TTL of transmitted packets which is the product of this
 431 value and of the transmit delay. The default value is 4 and therefore
 432 the default TTL is 120 seconds.
 433 .Ed
 434
 435 .Cd configure
 436 .Op ports Ar ethX Op ,...
 437 .Cd lldp
 438 .Cd status Ar rx-and-tx | rx-only | tx-only | disabled
 439 .Bd -ragged -offset XXXXXX
 440 Configure the administrative status of the given port. By default, all
 441 ports are configured to be in
 442 .Ar rx-and-tx
 443 mode. This means they can receive and transmit LLDP frames (as well as
 444 other protocols if needed). In
 445 .Ar rx-only
 446 mode, they won't emit any frames and in
 447 .Ar tx-only
 448 mode, they won't receive any frames. In
 449 .Ar disabled
 450 mode, no frame will be sent and any incoming frame will be
 451 discarded. This settings do not override the operational mode of the
 452 main daemon. If it is configured in receive-only mode (with the
 453 .Fl r
 454 flag), setting any transmit mode won't have any effect.
 455 .Ed
 456
 457 .Cd configure
 458 .Cd lldp custom-tlv
 459 .Op Cd add | replace
 460 .Cd oui Ar oui
 461 .Cd subtype Ar subtype
 462 .Op Cd oui-info Ar content
 463 .Bd -ragged -offset XXXXXX
 464 Emit a custom TLV for OUI
 465 .Ar oui ,
 466 with subtype
 467 .Ar subtype
 468 and optionally with the bytes specified in
 469 .Ar content .
 470 Both
 471 .Ar oui
 472 and
 473 .Ar content
 474 should be a comma-separated list of bytes in hex format.
 475 .Ar oui
 476 must be exactly 3-byte long.
 477 If
 478 .Ar add
 479 is specified then the TLV will be added. This is the default action.
 480 If
 481 .Ar replace
 482 is specified then all TLVs with the same
 483 .Ar oui
 484 and
 485 .Ar subtype
 486 will be replaced.
 487
 488 .Ed
 489
 490 .Cd unconfigure
 491 .Cd lldp custom-tlv
 492 .Op Cd oui Ar oui
 493 .Op Cd subtype Ar subtype
 494 .Bd -ragged -offset XXXXXX
 495 When no oui is specified, remove all previously configured custom TLV.
 496 When OUI
 497 .Ar oui
 498 and subtype
 499 .Ar subtype
 500 is specified, remove specific instances of custom TLV.
 501 .Ed
 502
 503 .Cd configure med fast-start
 504 .Cd enable | tx-interval Ar interval
 505 .Bd -ragged -offset XXXXXX
 506 Configure LLDP-MED fast start mechanism. When a new LLDP-MED-enabled
 507 neighbor is detected, fast start allows
 508 .Nm lldpd
 509 to shorten the interval between two LLDPDU.
 510 .Cd enable
 511 should enable LLDP-MED fast start while
 512 .Cd tx-interval
 513 specifies the interval between two LLDPDU in seconds. The default
 514 interval is 1 second. Once 4 LLDPDU have been sent, the fast start
 515 mechanism is disabled until a new neighbor is detected.
 516 .Ed
 517
 518 .Cd unconfigure med fast-start
 519 .Bd -ragged -offset XXXXXX
 520 Disable LLDP-MED fast start mechanism.
 521 .Ed
 522
 523 .Cd configure
 524 .Op ports Ar ethX Op ,...
 525 .Cd med location coordinate
 526 .Cd latitude Ar latitude
 527 .Cd longitude Ar longitude
 528 .Cd altitude Ar altitude Ar unit
 529 .Cd datum Ar datum
 530 .Bd -ragged -offset XXXXXX
 531 Advertise a coordinate based location on the given ports (or on all
 532 ports if no port is specified). The format of
 533 .Ar latitude
 534 is a decimal floating point number followed either by
 535 .Em N
 536 or
 537 .Em S .
 538 The format of
 539 .Ar longitude
 540 is a decimal floating point number followed either by
 541 .Em E
 542 or
 543 .Em W .
 544 .Ar altitude
 545 is a decimal floating point number followed either by
 546 .Em m
 547 when expressed in meters or
 548 .Em f
 549 when expressed in floors. A space is expected between the floating
 550 point number and the unit.
 551 .Ar datum
 552 is one of those values:
 553 .Bl -bullet -compact -offset XXXXXXXX
 554 .It
 555 WGS84
 556 .It
 557 NAD83
 558 .It
 559 NAD83/MLLW
 560 .El
 561 .Pp
 562 A valid use of this command is:
 563 .D1 configure ports eth0 med location coordinate latitude 48.85667N longitude 2.2014E altitude 117.47 m datum WGS84
 564 .Ed
 565
 566 .Cd configure
 567 .Op ports Ar ethX Op ,...
 568 .Cd med location address
 569 .Cd country Ar country
 570 .Cd Op Ar type value Op ...
 571 .Bd -ragged -offset XXXXXX
 572 Advertise a civic address on the given ports (or on all ports if no
 573 port is specified).
 574 .Ar country
 575 is the two-letter code representing the country. The remaining
 576 arguments should be paired to form the address. The first member of
 577 each pair indicates the type of the second member which is a free-form
 578 text. Here is the list of valid types:
 579 .Bl -bullet -compact -offset XXXXXXXX
 580 .It
 581 language
 582 .It
 583 country-subdivision
 584 .It
 585 county
 586 .It
 587 city
 588 .It
 589 city-division
 590 .It
 591 block
 592 .It
 593 street
 594 .It
 595 direction
 596 .It
 597 trailing-street-suffix
 598 .It
 599 street-suffix
 600 .It
 601 number
 602 .It
 603 number-suffix
 604 .It
 605 landmark
 606 .It
 607 additional
 608 .It
 609 name
 610 .It
 611 zip
 612 .It
 613 building
 614 .It
 615 unit
 616 .It
 617 floor
 618 .It
 619 room
 620 .It
 621 place-type
 622 .It
 623 script
 624 .El
 625 .Pp
 626 A valid use of this command is:
 627 .D1 configure ports eth1 med location address country US street Qo Commercial Road Qc city Qo Roseville Qc
 628 .Ed
 629
 630 .Cd configure
 631 .Op ports Ar ethX Op ,...
 632 .Cd med location elin
 633 .Ar number
 634 .Bd -ragged -offset XXXXXX
 635 Advertise the availability of an ELIN number. This is used for setting
 636 up emergency call. If the provided number is too small, it will be
 637 padded with 0. Here is an example of use:
 638 .D1 configure ports eth2 med location elin 911
 639 .Ed
 640
 641 .Cd configure
 642 .Op ports Ar ethX Op ,...
 643 .Cd med policy
 644 .Cd application Ar application
 645 .Op Cd unknown
 646 .Op Cd tagged
 647 .Op Cd vlan Ar vlan
 648 .Op Cd priority Ar priority
 649 .Op Cd dscp Ar dscp
 650 .Bd -ragged -offset XXXXXX
 651 Advertise a specific network policy for the given ports (or for all
 652 ports if no port was provided). Only the application type is
 653 mandatory.
 654 .Ar application
 655 should be one of the following values:
 656 .Bl -bullet -compact -offset XXXXXXXX
 657 .It
 658 voice
 659 .It
 660 voice-signaling
 661 .It
 662 guest-voice
 663 .It
 664 guest-voice-signaling
 665 .It
 666 softphone-voice
 667 .It
 668 video-conferencing
 669 .It
 670 streaming-video
 671 .It
 672 video-signaling
 673 .El
 674 .Pp
 675 The
 676 .Cd unknown
 677 flag tells that the network policy for the specified application type
 678 is required by the device but is currently unknown. This is used by
 679 Endpoint Devices, not by Network Connectivity Devices. If not
 680 specified, the network policy for the given application type is
 681 defined.
 682 .Pp
 683 When a VLAN is specified with
 684 .Ar vlan
 685 tells which 802.1q VLAN ID has to be advertised for the network
 686 policy. A valid value is between 1 and 4094.
 687 .Cd tagged
 688 tells the VLAN should be tagged for the specified application type.
 689 .Pp
 690 .Ar priority
 691 allows one to specify IEEE 802.1d / IEEE 802.1p Layer 2 Priority, also
 692 known as Class of Service (CoS), to be used for the specified
 693 application type. This field is usually ignored if no VLAN is
 694 specified. The names match 802.1D-2004 standard (table G-2). Some more
 695 recent standards may use different labels. Only the numeric values
 696 should be relied upon. The accepted labels are:
 697 .Bl -tag -width "X." -compact -offset XXXX
 698 .It Sy 1
 699 background
 700 .It Sy 0
 701 best-effort
 702 .It Sy 2
 703 excellent-effort
 704 .It Sy 3
 705 critical-applications
 706 .It Sy 4
 707 video
 708 .It Sy 5
 709 voice
 710 .It Sy 6
 711 internetwork-control
 712 .It Sy 7
 713 network-control
 714 .El
 715 .Pp
 716 .Ar dscp
 717 represents the DSCP value to be advertised for the given network
 718 policy.  DiffServ/Differentiated Services Code Point (DSCP) value as
 719 defined in IETF RFC 2474 for the specified application type. Value: 0
 720 (default per RFC 2475) through 63. Note: The class selector DSCP
 721 values are backwards compatible for devices that only support the old
 722 IP precedence Type of Service (ToS) format. (See the RFCs for what
 723 these values mean)
 724 .Pp
 725 A valid use of this command is:
 726 .D1 configure med policy application voice vlan 500 priority voice dscp 46
 727 .Ed
 728
 729 .Cd configure
 730 .Op ports Ar ethX Op ,...
 731 .Cd med power pse | pd
 732 .Cd source Ar source
 733 .Cd priority Ar priority
 734 .Cd value Ar value
 735 .Bd -ragged -offset XXXXXX
 736 Advertise the LLDP-MED POE-MDI TLV for the given ports or for all
 737 interfaces if no port is provided.  One can act as a PD (power
 738 consumer) or a PSE (power provider). No check is done on the validity
 739 of the parameters while LLDP-MED requires some restrictions:
 740 .Bl -bullet
 741 .It
 742 PD shall never request more power than physical 802.3af class.
 743 .It
 744 PD shall never draw more than the maximum power advertised by PSE.
 745 .It
 746 PSE shall not reduce power allocated to PD when this power is in use.
 747 .It
 748 PSE may request reduced power using conservation mode
 749 .It
 750 Being PSE or PD is a global parameter, not a per-port parameter.
 751 .Nm
 752 does not enforce this: a port can be set as PD or PSE. LLDP-MED also
 753 requires for a PSE to only have one power source (primary or
 754 backup). Again,
 755 .Nm
 756 does not enforce this. Each port can have its own power source. The
 757 same applies for PD and power priority. LLDP-MED MIB does not allow
 758 this kind of representation.
 759 .El
 760 .Pp
 761 Valid types are:
 762 .Bl -tag -width "XXX." -compact -offset XX
 763 .It Sy pse
 764 Power Sourcing Entity (power provider)
 765 .It Sy pd
 766 Power Device (power consumer)
 767 .El
 768 .Pp
 769 Valid sources are:
 770 .Bl -tag -width "XXXXXXX" -compact -offset XX
 771 .It Sy unknown
 772 Unknown
 773 .It Sy primary
 774 For PSE, the power source is the primary power source.
 775 .It Sy backup
 776 For PSE, the power source is the backup power source or a power
 777 conservation mode is asked (the PSE may be running on UPS for
 778 example).
 779 .It Sy pse
 780 For PD, the power source is the PSE.
 781 .It Sy local
 782 For PD, the power source is a local source.
 783 .It Sy both
 784 For PD, the power source is both the PSE and a local source.
 785 .El
 786 .Pp
 787 Valid priorities are:
 788 .Bl -tag -width "XXXXXXXXX" -compact -offset XX
 789 .It Sy unknown
 790 Unknown priority
 791 .It Sy critical
 792 Critical
 793 .It Sy high
 794 High
 795 .It Sy low
 796 Low
 797 .El
 798 .Pp
 799 .Ar value
 800 should be the total power in milliwatts required by the PD device or
 801 available by the PSE device.
 802 .Pp
 803 Here is an example of use:
 804 .D1 configure med power pd source pse priority high value 5000
 805 .Ed
 806
 807 .Cd configure
 808 .Op ports Ar ethX Op ,...
 809 .Cd dot3 power pse | pd
 810 .Op Cd supported
 811 .Op Cd enabled
 812 .Op Cd paircontrol
 813 .Cd powerpairs Ar powerpairs
 814 .Op Cd class Ar class
 815 .Op Cd type Ar type Cd source Ar source Cd priority Ar priority Cd requested Ar requested Cd allocated Ar allocated
 816 .Bd -ragged -offset XXXXXX
 817 Advertise Dot3 POE-MDI TLV for the given port or for all ports if none
 818 was provided. One can act as a PD (power consumer) or a PSE (power
 819 provider). This configuration is distinct of the configuration of the
 820 transmission of the LLDP-MED POE-MDI TLV but the user should ensure
 821 the coherency of those two configurations if they are used together.
 822 .Pp
 823 .Ar supported
 824 means that MDI power is supported on the given port while
 825 .Ar enabled
 826 means that MDI power is enabled.
 827 .Ar paircontrol
 828 is used to indicate if pair selection can be controlled. Valid values
 829 forr
 830 .Ar powerpairs
 831 are:
 832 .Bl -tag -width "XXXXXX" -compact -offset XX
 833 .It Sy signal
 834 The signal pairs only are in use.
 835 .It Sy spare
 836 The spare pairs only are in use.
 837 .El
 838 .Pp
 839 When specified,
 840 .Ar class
 841 is a number between 0 and 4.
 842 .Pp
 843 The remaining parameters are in conformance with 802.3at and are optional.
 844 .Ar type
 845 should be either 1 or 2, indicating which if the device conforms to
 846 802.3at type 1 or 802.3at type 2. Values of
 847 .Ar source
 848 and
 849 .Ar priority
 850 are the same as for LLDP-MED POE-MDI TLV.
 851 .Ar requested
 852 and
 853 .Ar allocated
 854 are expressed in milliwats.
 855 .Pp
 856 Here are two valid uses of this command:
 857 .D1 configure ports eth3 dot3 power pse supported enabled paircontrol powerpairs spare class class-3
 858 .D1 configure dot3 power pd supported enabled powerpairs spare class class-3 type 1 source pse priority low requested 10000 allocated 15000
 859 .Ed
 860
 861 .Cd pause
 862 .Bd -ragged -offset XXXXXX
 863 Pause
 864 .Nm lldpd
 865 operations.
 866 .Nm lldpd
 867 will not send any more frames or receive ones. This can be undone with
 868 .Cd resume
 869 command.
 870 .Ed
 871
 872 .Cd resume
 873 .Bd -ragged -offset XXXXXX
 874 Resume
 875 .Nm lldpd
 876 operations.
 877 .Nm lldpd
 878 will start to send and receive frames. This command is issued
 879 internally after processing configuration but can be used at any time
 880 if a manual
 881 .Cd pause
 882 command is issued.
 883 .Ed
 884
 885 .Ed
 886 .Sh FILES
 887 .Bl -tag -width "@LLDPD_CTL_SOCKET@XX" -compact
 888 .It @LLDPD_CTL_SOCKET@
 889 Unix-domain socket used for communication with
 890 .Xr lldpd 8 .
 891 .El
 892 .Sh SEE ALSO
 893 .Xr lldpd 8
 894 .Sh AUTHORS
 895 .An -nosplit
 896 The
 897 .Nm
 898 program was written by
 899 .An Vincent Bernat Aq bernat@luffy.cx .