lldpd 项目技术文档

1. 安装指南

1.1 从源码安装

1. 下载源码包或从 Git 仓库克隆项目：

   git clone https://github.com/lldpd/lldpd.git
   cd lldpd
   

2. 执行以下命令进行编译和安装：

   ./autogen.sh
   ./configure
   make
   sudo make install
   

3. 创建用户和组 _lldpd，并设置相关目录权限：

   sudo groupadd _lldpd
   sudo useradd -g _lldpd -s /bin/false _lldpd
   sudo mkdir -p /usr/local/var/run/lldpd
   sudo chown root:root /usr/local/var/run/lldpd
   

1.2 使用 Docker 安装

1. 运行以下命令启动 lldpd 容器：

   docker run --rm --net=host --uts=host \
              -v /etc/os-release:/etc/os-release \
              --cap-add=NET_RAW --cap-add=NET_ADMIN \
              --name lldpd \
              ghcr.io/lldpd/lldpd:latest
   

2. 使用 lldpcli 命令查询邻居信息：

   docker exec lldpd lldpcli show neighbors
   

1.3 在 macOS 上安装

1. 使用 Homebrew 安装：

   brew install lldpd
   

2. 或者从源码编译 macOS 安装包：

   mkdir build && cd build
   ../configure --prefix=/usr/local --localstatedir=/var --sysconfdir=/private/etc --with-embedded-libevent \
      --without-snmp
   make -C osx pkg
   

1.4 在 Android 上安装

1. 下载官方发布包并解压。
2. 下载并解压 Android NDK。
3. 安装 automake、libtool 和 pkg-config。
4. 创建 compile.sh 脚本并运行：

   export TOOLCHAIN=$PWD/android-ndk/toolchains/llvm/prebuilt/linux-x86_64
   export TARGET=armv7a-linux-androideabi
   export API=30
   ./autogen.sh
   mkdir -p build && cd build
   ../configure \
       --host=$TARGET \
       --with-sysroot=$TOOLCHAIN/sysroot \
       --prefix=/system \
       --sbindir=/system/bin \
       --runstatedir=/data/data/lldpd \
       --with-privsep-user=root \
       --with-privsep-group=root \
       PKG_CONFIG=/bin/false
   make
   make install DESTDIR=$PWD/install
   

2. 项目使用说明

2.1 启动 lldpd

在安装完成后，可以通过以下命令启动 lldpd：

sudo lldpd -d

2.2 使用 lldpcli 查询信息

1. 查询邻居信息：

   lldpcli show neighbors
   

2. 进入交互式命令行：

   lldpcli
   

2.3 支持的协议

lldpd 支持以下协议：

• LLDP (Link Layer Discovery Protocol)
• CDP (Cisco Discovery Protocol)
• FDP (Foundry Discovery Protocol)
• SONMP (Nortel Discovery Protocol)
• EDP (Extreme Discovery Protocol)

3. 项目 API 使用文档

3.1 通过 lldpcli 查询 API

lldpcli 提供了丰富的命令行接口，用于查询和管理 lldpd 的运行状态。以下是一些常用的命令：

• 显示所有邻居信息：

  lldpcli show neighbors
  

• 显示接口信息：

  lldpcli show interfaces
  

• 显示系统信息：

  lldpcli show system
  

3.2 SNMP 子代理

lldpd 实现了 SNMP 子代理，可以通过 SNMP 查询本地和远程的 LLDP 信息。

4. 项目安装方式

4.1 从源码安装

通过源码编译安装，适用于大多数操作系统，包括 FreeBSD、GNU/Linux、macOS、NetBSD、OpenBSD 和 Solaris。

4.2 使用 Docker 安装

通过 Docker 容器运行 lldpd，适用于需要快速部署的场景。

4.3 在 macOS 上安装

通过 Homebrew 或从源码编译 macOS 安装包，适用于 macOS 系统。

4.4 在 Android 上安装

通过 Android NDK 编译安装，适用于 Android 系统。

---

通过以上文档，您可以顺利安装、配置和使用 lldpd 项目，实现网络设备的链路层发现和管理。