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