parse.
.It Fl c Ar file
Read the given configuration file. This option may be repeated several
-times. If a directory is provided, each file contained in it will be
-read if ending by
+times. If a directory is provided, each file therein suffixed with
.Li .conf .
-Order is alphabetical.
+will be read. Order is alphabetical.
.El
.Pp
When invoked as
.Nm lldpctl ,
.Nm
-will display detailed information about each neighbors on the
+will display detailed information about each neighbor on the
specified interfaces or on all interfaces if none are specified. This
command is mostly kept for backward compatibility with older versions.
.Pp
Display general help or help about a command. Also, you can get help
using the completion or by pressing the
.Ic ?
-key. However, completion and inline help may be unavailable if
+key. Completion and inline help may be unavailable, however, if
.Nm
was compiled without readline support but
.Cd help
.Cd hidden , summary
and
.Cd details
-have the same meaning than previously described. If
+have the same meaning as previously described. If
.Cd limit
is specified,
.Nm
received, discarded or unrecognized. When specifying ports, only the
statistics from the given port are reported. With
.Cd summary
-the statistics of each port is summed.
+the statistics of each port are summed.
.Ed
.Cd update
.Cd unconfigure
.Cd system chassisid
.Bd -ragged -offset XXXXXX
-Do not override chassis ID and use a value computed from one of the interface
-MAC address (or host name if none is found).
+Do not override chassis ID, but instead use a value computed from one of the interface
+MAC addresses (or host name if none is found).
.Ed
.Cd configure
.Cd system capabilities enabled Ar capabilities
.Bd -ragged -offset XXXXXX
Override system capabilities with the provided value instead of using
-kernel information. Several capabilities can be specified separated by
+kernel information. Several capabilities can be specified, separated by
commas. Only available capabilities can be enabled. Valid capabilities are:
.Bl -tag -width "XXX." -compact -offset XX
.It Sy other
.Cd unconfigure
.Cd system capabilities enabled
.Bd -ragged -offset XXXXXX
-Do not override capabilities and use the kernel information. This option
+Do not override capabilities, but instead use the kernel information. This option
undoes the previous one.
.Ed
.Cd configure
.Cd system interface pattern Ar pattern
.Bd -ragged -offset XXXXXX
-Specify which interface to listen and send LLDPDU to. Without this
-option,
+Specify which interface to listen upon and send LLDPDU from. Without this option,
.Nm lldpd
will use all available physical interfaces. This option can use
wildcards. Several interfaces can be specified separated by commas.
It is also possible to remove an interface by prefixing it with an
exclamation mark. It is possible to allow an interface by
prefixing it with two exclamation marks. An allowed interface beats
-a forbidden interfaces which beats a simple matched interface. For
+a forbidden interface which beats a simple matched interface. For
example, with
.Em eth*,!eth1,!eth2
.Nm lldpd
-will only use interfaces starting by
+will only use interfaces starting with
.Em eth
with the exception of
.Em eth1
While with
.Em *,!eth*,!!eth1
.Nm
-will use all interfaces, except interfaces starting by
+will use all interfaces, except interfaces starting with
.Em eth
with the exception of
.Em eth1 .
.Nm lldpd .
By default,
.Nm lldpd
-disregard any data about interfaces when they are removed from the
+disregards any data about interfaces when they are removed from the
system (statistics, custom configuration). This option allows one to
specify a pattern similar to the interface pattern. If an interface
-disappear but matches the pattern, its data is kept in memory and
-reused if the interface reappear at some point. For example, on Linux,
+disappears but matches the pattern, its data is kept in memory and
+reused if the interface reappears at some point. For example, on Linux,
one could use the pattern
.Em eth*,eno*,enp* ,
which should match fixed interfaces on most systems.
.Cd configure
.Cd system interface description
.Bd -ragged -offset XXXXXX
-Some OS allows the user to set a description for an interface. Setting
+Some OSes allow the user to set a description for an interface. Setting
this option will enable
.Nm lldpd
to override this description with the name of the peer neighbor if one
.Pp
This option is known to be useful when the remote switch is a Cisco
2960 and the local network card features VLAN hardware
-acceleration. In this case, you may not receive LLDP frames from the
-remote switch. The most plausible explanation for this is the frame is
-tagged with some VLAN (usually VLAN 1) and your network card is
-filtering VLAN. This is not the only available solution to work-around
+acceleration. In this case, you might not receive LLDP frames from the
+remote switch. The most plausible explanation for this is that the frame is
+tagged with some VLAN (usually VLAN 1) and your network card filters
+VLANs. This is not the only available solution to work around
this problem. If you are concerned about performance issues, you can
-also tag the VLAN 1 on each interface instead.
+also tag VLAN 1 on each interface instead.
.Pp
-Currently, this option has no effect on anything else than Linux. On
-other OS, either disable VLAN acceleration, tag VLAN 1 or enable
+Currently, this option has no effect on anything other than Linux. On
+other OSes, either disable VLAN acceleration, tag VLAN 1 or enable
promiscuous mode manually on the interface.
.Ed
Without this option, the first IPv4 and the first IPv6 are used. If an
exact IP address is provided, it is used as a management address
without any check. If only negative patterns are provided, only one
-IPv4 and one IPv6 addresses are chosen. Otherwise, many of them can be
-selected. If you want to remove IPv6 addresses, you can use
+IPv4 and one IPv6 address are chosen. Otherwise, many of them can be
+selected. To remove IPv6 addresses, use
.Em !*:* .
If an interface name is matched, the first IPv4 address and the first
-IPv6 address associated to this interface will be chosen.
+IPv6 address associated with this interface will be chosen.
.Ed
.Cd unconfigure
.Li ( 00:60:08:69:97:ef )
.It Sy local
Real mac with locally administered bit set. If the real mac already
-has the locally administered bit set, fallback to the fixed value.
+has the locally administered bit set, fall back to the fixed value.
.El
.Pp
Default value for
The destination MAC address used to send LLDPDU allows an agent to
control the propagation of LLDPDUs. By default, the
.Li 01:80:c2:00:00:0e
-MAC address is used and limit the propagation of the LLDPDU to the
+MAC address is used and limits the propagation of the LLDPDU to the
nearest bridge
.Cd ( nearest-bridge ) .
To instruct
.Ar content
should be a comma-separated list of bytes in hex format.
.Ar oui
-must be exactly 3-byte long.
+must be exactly 3 bytes long.
If
.Ar add
is specified then the TLV will be added. This is the default action.
.Ar number
.Bd -ragged -offset XXXXXX
Advertise the availability of an ELIN number. This is used for setting
-up emergency call. If the provided number is too small, it will be
+up emergency calls. If the provided number is too small, it will be
padded with 0. Here is an example of use:
.D1 configure ports eth2 med location elin 911
.Ed
specified, the network policy for the given application type is
defined.
.Pp
-When a VLAN is specified with
+A VLAN specified with
.Ar vlan
tells which 802.1q VLAN ID has to be advertised for the network
policy. A valid value is between 1 and 4094.
.Cd tagged
-tells the VLAN should be tagged for the specified application type.
+tells that the VLAN should be tagged for the specified application type.
.Pp
.Ar priority
allows one to specify IEEE 802.1d / IEEE 802.1p Layer 2 Priority, also
Being PSE or PD is a global parameter, not a per-port parameter.
.Nm
does not enforce this: a port can be set as PD or PSE. LLDP-MED also
-requires for a PSE to only have one power source (primary or
+requires a PSE to have only one power source (primary or
backup). Again,
.Nm
does not enforce this. Each port can have its own power source. The
.It Sy primary
For PSE, the power source is the primary power source.
.It Sy backup
-For PSE, the power source is the backup power source or a power
-conservation mode is asked (the PSE may be running on UPS for
+For PSE, the power source is the backup power source, or a power
+conservation mode is requested (the PSE may be running on UPS for
example).
.It Sy pse
For PD, the power source is the PSE.
.Bd -ragged -offset XXXXXX
Advertise Dot3 POE-MDI TLV for the given port or for all ports if none
was provided. One can act as a PD (power consumer) or a PSE (power
-provider). This configuration is distinct of the configuration of the
+provider). This configuration is distinct from the configuration of the
transmission of the LLDP-MED POE-MDI TLV but the user should ensure
the coherency of those two configurations if they are used together.
.Pp
.Ar enabled
means that MDI power is enabled.
.Ar paircontrol
-is used to indicate if pair selection can be controlled. Valid values
+is used to indicate whether pair selection can be controlled. Valid values
for
.Ar powerpairs
are:
.Pp
The remaining parameters are in conformance with 802.3at and are optional.
.Ar type
-should be either 1 or 2, indicating which if the device conforms to
+should be either 1 or 2, indicating whether the device conforms to
802.3at type 1 or 802.3at type 2. Values of
.Ar source
and
.Nm lldpd
operations.
.Nm lldpd
-will not send any more frames or receive ones. This can be undone with
+will not send or receive any more frames. This can be undone with
.Cd resume
command. This only works interactively as lldpd asks lldpcli to
unpause after reading the configuration file.
operations.
.Nm lldpd
will start to send and receive frames. This command is issued
-internally after processing configuration but can be used at any time
+internally after processing the configuration but can be used at any time
if a manual
.Cd pause
command is issued.
With this option,
.Nm
will enable an SNMP subagent using AgentX protocol. This allows you to
-get information about local system and remote systems through SNMP.
+get information about the local system and remote systems through SNMP.
.It Fl X Ar socket
Enable SNMP subagent using the specified socket.
.Nm
Specify the Unix-domain socket used for communication with
.Xr lldpctl 8 .
.It Fl I Ar interfaces
-Specify which interface to listen and send LLDPDU to. Without this
+Specify which interface to listen upon and send LLDPDU from. Without this
option,
.Nm
will use all available physical interfaces. This option can use
example, with
.Em eth*,!eth1,!eth2
.Nm
-will only use interfaces starting by
+will only use interfaces starting with
.Em eth
with the exception of
.Em eth1
While with
.Em *,!eth*,!!eth1
.Nm
-will use all interfaces, except interfaces starting by
+will use all interfaces, except interfaces starting with
.Em eth
with the exception of
.Em eth1 .
.Em !* ) ,
the system name is used as a chassis ID instead.
.It Fl M Ar class
-Enable emission of LLDP-MED frame. Depending on the selected class,
+Enable emission of LLDP-MED frames. Depending on the selected class,
the standard defines which set of TLV should be transmitted. See
-section 10.2.1. Some devices may be strict about this aspect. The
-class should be one of the following value:
+section 10.2.1. Some devices may be strict in this aspect. The
+class should be one of the following values:
.Bl -tag -width "0:XX" -compact
.It Sy 1
Generic Endpoint (Class I)
.It Sy 2
Media Endpoint (Class II). In this case, the standard requires to
-define at least one network policy through
+define at least one network policy via
.Nm lldpcli .
.It Sy 3
Communication Device Endpoints (Class III). In this case, the standard
-requires to define at least one network policy through
+requires to define at least one network policy via
.Nm lldpcli .
.It Sy 4
Network Connectivity Device
.Nm
will still receive (and publish using SNMP if enabled) those LLDP-MED
TLV but will not send them. Use this option if you don't want to
-transmit sensible information like serial numbers.
+transmit sensitive information like serial numbers.
.It Fl H Ar hide
Filter neighbors. See section
.Sx FILTERING NEIGHBORS
.It Fl O Ar configfile
Override default configuration locations processed by
.Nm lldpcli
-at start. If a directory is provided, each file contained in it will be read if ending by
+at start. If a directory is provided, each file therein suffixed with
.Sy .conf.
-Order is alphabetical.
+will be read. Order is alphabetical.
.It Fl v
Show
.Nm
frames are forwarded by the Cisco switch. This may not be what you
want. The
.Fl H Ar hide
-parameter will allow you to tell
+parameter allows you to tell
.Nm
-to discard some frames that it receives and to avoid to send some
+to discard some frames that it receives and to avoid sending some
other frames.
.Pp
Incoming filtering and outgoing filtering are
-unrelated. Incoming filtering will hide some remote ports to get you a
+unrelated. Incoming filtering will hide some remote ports to give you a
chance to know exactly what equipment is on the other side of the
-network cable. Outgoing filtering will avoid to use some protocols to
+link. Outgoing filtering will avoid using some protocols to
avoid flooding your network with a protocol that is not handled by the
nearest equipment. Keep in mind that even without filtering,
.Nm
.Pp
When enabling incoming filtering,
.Nm
-will try to select one protocol and filter out neighbors using other
+will try to select one protocol, and filter out neighbors using other
protocols. To select this protocol, the rule is to take the less used
protocol. If on one port, you get 12 CDP neighbors and 1 LLDP
-neighbor, this mean that the remote switch speaks LLDP and does not
+neighbor, this means that the remote switch speaks LLDP and does not
filter CDP. Therefore, we select LLDP. When enabling outgoing
filtering,
.Nm
-will also try to select one protocol and only speaks this
+will also try to select one protocol and only speak this
protocol. The filtering is done per port. Each port may select a
different protocol.
.Pp
There are two additional criteria when enabling filtering: allowing
one or several protocols to be selected (in case of a tie) and
allowing one or several neighbors to be selected. Even when allowing
-several protocols, the rule of selecting the protocols with the less
-neighbors still apply. If
+several protocols, the rule of selecting the protocols with the fewest
+neighbors still applies. If
.Nm
selects LLDP and CDP, this means they have the same number of
neighbors. The selection of the neighbor is random. Incoming filtering
protocols because some tools use the CDP table and some other the LLDP
table.
.Pp
-The table below summarize all accepted values for the
+The table below summarizes all accepted values for the
.Fl H Ar hide
parameter. The default value is
.Em 15
projects / thirdparty / lldpd.git / commitdiff
