man/lldpd.8

   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 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: August 21 2008 $
  17 .Dt LLDPD 8
  18 .Os
  19 .Sh NAME
  20 .Nm lldpd
  21 .Nd LLDP daemon
  22 .Sh SYNOPSIS
  23 .Nm
  24 .Op Fl dxcseikl
  25 .Op Fl S Ar description
  26 .Op Fl X Ar socket
  27 .Op Fl m Ar management
  28 .Op Fl M Ar class
  29 .Sh DESCRIPTION
  30 .Nm
  31 is a daemon able to receive and send
  32 .Em LLDP
  33 frames. The Link Layer Discovery Protocol is a vendor-neutral Layer 2
  34 protocol that allows a network device to advertise its identity and
  35 capabilities on the local network.
  36 .Pp
  37 .Nm
  38 also implements an SNMP subagent using AgentX protocol to interface to
  39 a regular SNMP agent like Net-SNMP. To enable this subagent, you need
  40 something like that in your
  41 .Xr snmpd.conf 5 :
  42 .Bd -literal -offset indent
  43 master agentx
  44 .Ed
  45 .Pp
  46 This daemon implements both reception and sending. It will collect
  47 various information to send LLDP frames to all Ethernet interfaces,
  48 including management address, speed and VLAN names.
  49 .Pp
  50 The options are as follows:
  51 .Bl -tag -width Ds
  52 .It Fl d
  53 Do not daemonize.
  54 If this option is specified,
  55 .Nm
  56 will run in the foreground and log to
  57 .Em stderr .
  58 This option can be specified many times to increase verbosity.
  59 .It Fl k
  60 Disable advertising of kernel release, version and machine. Kernel name
  61 (ie: Linux) will still be shared, and Inventory software version will be set
  62 to 'Unknown'.
  63 .It Fl S Ar description
  64 Override system description with the provided description. The default
  65 description is the kernel name, the node name, the kernel version, the
  66 build date and the architecture (except if you use the
  67 .Fl k
  68 flag described above).
  69 .It Fl x
  70 Enable SNMP subagent.
  71 With this option,
  72 .Nm
  73 will enable an SNMP subagent using AgentX protocol. This allows to get
  74 information about local system and remote systems through SNMP.
  75 .It Fl X Ar socket
  76 Enable SNMP subagent using the specified socket.
  77 .Nm
  78 will enable an SNMP subagent using AgentX protocol for the given
  79 socket. This option implies the previous one. The default socket is
  80 usally
  81 .Em /var/agentx/master .
  82 You can specify a socket like
  83 .Em tcp:127.0.0.1:705
  84 for example. Since the process that will open this socket is enclosed
  85 in a chroot, you need to specify an IP address (not a hostname) when
  86 using a TCP or UDP socket.
  87 .It Fl c
  88 Enable the support of CDP protocol to deal with Cisco routers that do
  89 not speak LLDP. If repeated, CDPv1 packets will be sent even when
  90 there is no CDP peer detected.
  91 .It Fl f
  92 Enable the support of FDP protocol to deal with Foundry routers that do
  93 not speak LLDP. If repeated, FDP packets will be sent even when there
  94 is no FDP peer detected.
  95 .It Fl s
  96 Enable the support of SONMP protocol to deal with Nortel routers and
  97 switches that do not speak LLDP. If repeated, SONMP packets will be
  98 sent even when there is no SONMP peer detected.
  99 .It Fl e
 100 Enable the support of EDP protocol to deal with Extreme routers and
 101 switches that do not speak LLDP. If repeated, EDP packets will be sent
 102 even when there is no EDP peer detected.
 103 .It Fl l
 104 Force to send LLDP packets even when there is no LLDP peer detected
 105 but there is a peer speaking another protocol detected. By default,
 106 LLDP packets are sent when there is a peer speaking LLDP detected or
 107 when there is no peer at all.
 108 .It Fl m Ar management
 109 Specify the management address of this system.
 110 .Nm
 111 only sends one management address. It will use the first one that it
 112 finds or the one that you specify with this option. This option can
 113 use wildcards.
 114 .It Fl M Ar class
 115 Enable emission of LLDP-MED frame. The class should be one of the
 116 following value:
 117 .Bl -tag -width "0:XX" -compact
 118 .It Sy 1
 119 Generic Endpoint (Class I)
 120 .It Sy 2
 121 Media Endpoint (Class II)
 122 .It Sy 3
 123 Communication Device Endpoints (Class III)
 124 .It Sy 4
 125 Network Connectivity Device
 126 .El
 127 .It Fl i
 128 Disable LLDP-MED inventory TLV transmission.
 129 .Nm
 130 will still receive (and publish using SNMP if enabled) those LLDP-MED
 131 TLV but will not send them. Use this option if you don't want to
 132 transmit sensible information like serial numbers.
 133 .El
 134 .Sh FILES
 135 .Bl -tag -width "/var/run/lldpd.socketXX" -compact
 136 .It /var/run/lldpd.socket
 137 Unix-domain socket used for communication with
 138 .Xr lldpctl 8 .
 139 .El
 140 .Sh SEE ALSO
 141 .Xr lldpctl 8 ,
 142 .Xr snmpd 8
 143 .Sh HISTORY
 144 The
 145 .Nm
 146 program is inspired from a preliminary work of Reyk Floeter.
 147 .Sh AUTHORS
 148 .An -nosplit
 149 The
 150 .Nm
 151 program was written by
 152 .An Pierre-Yves Ritschard Aq pyr@openbsd.org ,
 153 and
 154 .An Vincent Bernat Aq bernat@luffy.cx .