Topology-Scanner 技术文档

Topology-Scanner 技术文档

topology-scanner 网络拓扑自动扫描工具 项目地址: https://gitcode.com/gh_mirrors/to/topology-scanner

Topology-Scanner是由WeOps团队开源的一款用于自动扫描网络拓扑的工具。该工具能够自动识别网络设备的种类以及它们之间的互联关系，极大地方便了网络管理员对网络架构的理解与管理。以下是详细的使用和技术说明：

安装指南

1. 下载: 访问项目页面或直接在命令行使用Git克隆仓库到本地。

   git clone [项目GitHub链接]
   

2. 环境需求: 确保您的环境中已安装Java环境（建议JDK 1.8及以上版本）。

3. 运行: 进入项目根目录，执行以下命令启动Toplogy-Scanner。

   java -jar ./topology-scanner.jar --config_path=./config/
   

   注意替换./config/为您实际存放配置文件的路径。

项目使用说明

Topology-Scanner提供了几种不同的拓扑发现算法，用户可根据网络环境选择最适合的模式。

• 全网发现：通过指定核心设备的IP地址和搜索深度(hop)进行全网扫描。
• 子网发现：提供子网IP及其掩码来进行针对性的子网拓扑扫描。

配置信息应放置于JSON文件中（如request.json），详细设置见下文配置说明部分。

项目API使用文档

本项目的主要交互通过命令行参数进行，没有直接的外部API接口。不过，通过修改配置文件（如request.json, discovery.properties等）间接影响其行为，可以视为一种间接API使用方式。

配置详情

• request.json

  • ips/range: 根据需要选择配置全网或子网发现的IP地址和范围。
  • hop: 搜索的层级深度。
  • group: SNMP V2的团体名配置。
  • way: 发现方式选择（全网或子网）。
  • algory: 拓扑发现算法类型（常规、CDP、LLDP、桥接）。
  • version: SNMP协议版本。
  • v3: 如果使用SNMP V3，则需要详细配置安全相关参数。

• discovery.properties 提供线程池配置、Ping策略、超时设定等运行时参数调整。

• systemoid.xml/getterConfig.xml 设备特定的SNMP OID配置，确保正确采集不同类型设备的数据。

输出结果解析

扫描完成后，结果将以结构化的数据形式给出，包含设备信息(device)和链路信息(link)，便于进一步处理或可视化展示。

注意事项

• 在大规模网络环境中，请务必细致测试配置以避免不必要的网络干扰。
• 根据不同的网络设备类型和拓扑复杂度，适当调整发现算法和配置参数。
• 确保SNMP访问权限已经正确配置在网络设备上，以便Topology-Scanner能够成功查询信息。

---

此文档旨在帮助用户快速了解并有效地使用Topology-Scanner，对于高级应用或特殊配置情况，请参考项目源代码和官方文档获取更多信息。

topology-scanner 网络拓扑自动扫描工具 项目地址: https://gitcode.com/gh_mirrors/to/topology-scanner