ncclient 技术文档

本文档将详细介绍如何安装、使用以及 API 调用 ncclient，这是一个用于简化 NETCONF 客户端脚本和应用程序开发的 Python 库。

1. 安装指南

在开始使用 ncclient 之前，您需要确保满足以下依赖条件：

• Python 2.7 或 Python 3.5+
• setuptools 0.6+
• Paramiko 1.7+
• lxml 3.3.0+
• libxml2
• libxslt

如果您使用的是 Debian/Ubuntu 系统，需要安装以下库：

sudo apt-get install libxml2-dev libxslt1-dev

安装 ncclient 的方法有两种：

通过 setup.py 安装

sudo python setup.py install

通过 pip 安装

pip install ncclient

如果您需要在本地克隆的项目中安装，可以使用以下命令：

pip install -U .

2. 项目使用说明

以下是一个使用 ncclient 从设备获取运行配置的示例：

from ncclient import manager

with manager.connect(host='设备IP', port=830, username='用户名', hostkey_verify=False) as m:
    c = m.get_config(source='running').data_xml
    with open("设备IP.xml", 'w') as f:
        f.write(c)

对于特定类型的 NETCONF 服务器，您可以指定设备处理器参数，例如，对于 Juniper 设备：

from ncclient import manager

with manager.connect(host='设备IP', port=830, username='用户名', hostkey_verify=False,
                     device_params={'name': 'junos'}) as m:
    c = m.get_config(source='running').data_xml
    with open("设备IP.xml", 'w') as f:
        f.write(c)

3. 项目 API 使用文档

ncclient 提供了丰富的 API 用于与 NETCONF 服务器进行交互。以下是一些常用的 API：

连接到 NETCONF 服务器

from ncclient import manager

with manager.connect(host='设备IP', port=830, username='用户名', hostkey_verify=False) as m:
    # 执行操作...

获取设备运行配置

c = m.get_config(source='running').data_xml

发送 RPC 操作

rpc回复 = m.dispatch(rpc请求)

关闭会话

m.close_session()

更多 API 和示例，请参考官方文档。

4. 项目安装方式

ncclient 支持多种安装方式，如上所述，您可以通过 setup.py 或 pip 进行安装。以下是简要的安装步骤：

通过 pip 安装

pip install ncclient

通过 setup.py 安装

sudo python setup.py install

从本地克隆的项目安装

pip install -U .

确保遵循上述安装指南中的依赖项要求，以确保正确安装 ncclient。