/netdev

基于fastapi实现简单网络自动化后端服务

Primary LanguagePython

基于fastapi实现简单网络自动化后端服务

  • 为了方便安装部署，尽量减少外部中间件的引入，如数据库、缓存等，如果需要持久化存储对接内部平台，则自行引入
  • config.toml作为项目配置文件，包括设备的相关所需信息(管理地址、账号、密码、设备类型、备份路径...)

安装（虚拟环境或docker）

  • 虚拟环境
pip install virtualenv 
virtualenv venv --python=python3.8
source venv/bin/activate
git clone git@github.com:xxddpac/netdev.git
cd netdev
pip install -r requirements.txt -i https://pypi.douban.com/simple/
python main.py
  • Docker(确保已安装docker)
git clone git@github.com:xxddpac/netdev.git
cd netdev
docker build -t netdev .
docker images
docker run -d -p 5000:5000 -v /data/network:/data/network -v /var/log:/var/log --name 'networkAutomationServiceWithFastapi' netdev
docker ps -a

验证

curl http://X.X.X.X:5000/api/v1/ping

# 返回 {'msg': 'success', 'code': 200, 'data': 'pong'} 说明服务已正常启动

支持功能

  • 实现全网多种类型设备配置备份(思科、华为、华三、飞塔、山石、Juniper...)
  • 备份任务通知(企业微信、邮件)，展示任务执行详情(设备总数、执行失败数、执行失败列表)
  • 安全基线扫描(针对不同类型设备定义安全扫描项，快速输出基线扫描结果应对合规检查要求)
  • 配置历史对比(根据不同日期备份配置展示差异)
  • 配置下载、配置查询等其他API服务
  • 设备类型统计
  • 同步网络设备相关CVE漏洞,通过邮件发送漏洞预警便于及时跟进修复
  • 设备资产信息(主机名、IP地址、设备类型、设备型号、序列号、系统镜像、系统版本、运行时间)支持API查询
  • mac --> interface --> vlan --> switch 映射关系查询(方便运维快速定位终端mac地址接入在全网哪台交换机接口下) todo

功能展示

  • (手动)触发异步备份任务
curl http://X.X.X.X:5000/api/v1/network/config/backup
  • (计划任务)触发异步备份任务
40 0 * * * curl http://X.X.X.X:5000/api/v1/network/config/backup
  • 触发异步基线扫描任务(扫描结果.xlsx存放baseline文件夹下)
curl http://X.X.X.X:5000/api/v1/network/baseline/check
  • (计划任务)触发CVE漏洞同步任务
0 * * * * curl http://X.X.X.X:5000/api/v1/network/cve
  • 查询备份成功设备详情

img

  • 查询指定设备最新配置

img

  • 指定日期获取配置差异

img

  • 备份任务通知

img

  • 安全基线扫描

img

详情参考API接口文档

http://X.X.X.X:5000/docs

img