Skip to main content

Python Scripts to get schema YANG files from network device

Project description

NETCONF scripts for LNU Campus Network

BRAS 设备 IPoE 认证用户 IPv6 地址溯源程序

一、工作原理

本程序通过 NETCONF 协议获得 BRAS 设备 IPoE 认证用户 MAC、IPv4、IPv6 地址信息,并发送到 syslog 进行记录。可以通过 cron 每二十分钟定时执行本程序,记录用户地址信息,以供事后溯源。

本程序在 H3C SR8808-X 以及华为 ME60 上进行了测试。H3C SR8808-X IPoE 认证功能存在问题,需要关闭 IPv6 认证,目前本程序是按照关闭 IPv6 认证的情况编写的。华为 ME60 的 V800R013C00SPC100 版本软件 NETCONF 接口存在问题,无法正常获得 IPv6 地址。

二、开发环境

本项目使用了 PDM 设置开发环境,src/netconf_lnu/mytest.py 中的函数可以作为测试使用,具体命令类似如下:

pdm run netconf-lnu -c config/config.ini -t dispatch_test

其中 config/config.ini 是配置文件,可以参考 config/config.ini.example 来编写。

src/netconf_lnu/mytest.py 程序中的 download_schema 函数,能够下载网络设备的 YANG 文件,用户可以参考该测试函数编写自己的下载程序。

对于下载后的 YANG 文件,可以利用已经安装的 pyang 程序来浏览,命令如下:

pdm run pyang -f tree schema/huawei-bras-user-manage.yang

虽然可以从设备上获得 YANG 文件,但还是建议在 Netconf Central 查找并浏览。

对于程序基本功能可以通过下面命令进行测试:

pdm run netconf-lnu -c config/config.ini

三、打包部署

本项目可以通过 pdm build 命令可以打包,方便修改后部署。

项目已经在 PyPI 上发布,可以直接通过 pipx 安装,以 Debian 类系统为例,可以以 root 用户执行如下命令安装 pipx:

apt install pipx
cat >> ~/.bashrc << EOF

# For pipx
export PIPX_HOME=/opt/pipx
export PIPX_BIN_DIR=/usr/local/bin
EOF

然后重新登陆系统并安装 netconf-lnu

pipx install netconf-lnu

安装后需要建立配置文件 /etc/netconf-lnu/config.ini 并运行 netconf-lnu 命令测试。

测试无误后,可以建立 cron 配置文件 /etc/cron.d/netconf-lnu,每20分钟运行程序一次,其内容如下:

*/20 * * * * root /usr/local/bin/netconf-lnu

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netconf_lnu-2023.12.2.3.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

netconf_lnu-2023.12.2.3-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file netconf_lnu-2023.12.2.3.tar.gz.

File metadata

  • Download URL: netconf_lnu-2023.12.2.3.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.2.1 CPython/3.11.6

File hashes

Hashes for netconf_lnu-2023.12.2.3.tar.gz
Algorithm Hash digest
SHA256 c9c118ac57b9bd0887367f7e11bb441bf67a67d2d810de52bf9ddef62f6e56bd
MD5 9eb31de638f510e96b79920b90b1f017
BLAKE2b-256 f6c249dc05a304f7a7f2619fd04169c7a3876b74997c4cdbdcf2690bfdf2aa0d

See more details on using hashes here.

File details

Details for the file netconf_lnu-2023.12.2.3-py3-none-any.whl.

File metadata

File hashes

Hashes for netconf_lnu-2023.12.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c25302e8052b65208158511bdab3f09932d169f20b54acb76df2606524b60b77
MD5 a8679fa9516302d54047595c89deeaac
BLAKE2b-256 a9c5254ea5d863fa1ba1ea478c985834586f1f59bfbd4042176579570f536552

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page