网络工程师的Python之路 -- pyntc

弈心：从事计算机网络工作11年（新加坡7年，沙特4年），2013年考取CCIE，在新加坡先后任职于AT&T，新加坡交通部，苹果，Equinix，苏格兰皇家银行等大型企业、银行和政府部门。 目前供职于“世界第一土豪大学“沙特阿卜杜拉国王科技大学（KAUST），担任Senior Network Engineer，为KAUST校史上第一位也是唯一一位华人IT部门高级职员。2019年6月在知乎发布了华语圈第一本专门为编程零基础的网络工程师量身打造的Python教程《网络工程师的Python之路》。

前面几篇专栏文章已经介绍了TextFSM, ntc-template以及NAPALM，除了这些好用的第三方模块和模板集外，pyntc也是一个非常优秀的用来帮助我们管理网络设备配置、升级网络设备OS、重启网络设备的第三方开源Python模块。也许你从名字上已经猜出来了，是的，同ntc-templates一样，pyntc也是由Network to Code团队开发制作的，其源码存放在Github上：https://github.com/networktocode/pyntc。

pyntc和NAPALM的比较

同NAPALM一样，pyntc也依赖于netmiko（如果对象设备使用的是思科IOS操作系统的话），但又可以在脚本里独立使用（只需要保证运行脚本的主机安装了netmiko即可），这个特性使得pyntc拥有同NAPALM一样的一大优点：让网络运维的脚本代码简洁、易懂、便于维护。

和为不同厂商设备提供统一API的NAPALM不一样，pyntc是一种多厂商、多API的模块，截至2020年5月，Pyntc支持包括思科、Arista、Juniper在内的三家主流设备厂商的四种操作系统：

• Cisco IOS platforms - uses SSH (netmiko)
• Cisco NX-OS - uses pynxos (NX-API)
• Arista EOS - uses pyeapi (eAPI)
• Juniper Junos - uses PyEz (NETCONF)

可以看到，针对不同的操作系统，Pyntc提供的API是不一样的。针对使用思科IOS的传统设备，因为它们不支持API，因此pyntc借助的是netmiko提供的SSH功能来对这些设备进行访问和管理，而针对使用NX-OS操作系统的思科Nexus系列设备，pyntc使用的是NX-OS自带的NX-API，而针对另外两个厂商：Arista和Juniper，pyntc则分别依赖于它们自带的eAPI和NETCONF来对设备进行访问和管理。

pyntc的安装

作为Python的第三方模块，pyntc有两种安装方法。

第一种方法是使用pip直接安装：

Pip安装完毕后进入Python并import pyntc，如果Python没有报错则说明安装成功。

除了pip外，我们也可以使用下面的git clone命令从GitHub下载textfsm的源代码并安装，如果你的CentOS 8主机没有安装git，系统会提醒你一并安装。

 git clone https://github.com/networktocode/pyntc.git
 cd pyntc
 python setup.py install

pyntc的应用

本节以实验的形式来分别演示如何使用pyntc来对使用思科IOS操作系统的目标设备完成以下几项操作：

• 获取目标设备的基本信息
• 对目标设备进行配置
• 获取目标设备的running config
• 对目标设备的running config进行备份
• 重启目标设备

获取目标设备的基本信息

首先创建一个名为pyntc1.py的脚本，将下列代码放入该脚本中：

 import json
 from pyntc import ntc_device as NTC
  
 SW1 = NTC(host='192.168.2.11', username='python', password='123', device_type='cisco_ios_ssh')
 SW1.open()
  
 print (json.dumps(SW1.facts, indent=4))
 SW1.close()

代码讲解如下：

• ntc_device是pyntc最重要的子模块，pyntc通过它来SSH访问目标IOS设备，因为它的名字有点偏长，这里我们使用“from pyntc import ntc_device as NTC”将其命名为NTC并调用它。
• 前面讲到了，同NAPALM一样，pyntc也是依赖于netmiko的，因此访问设备的基本配置和方法大体是一样的，这里需要注意的是因为我们要访问的目标设备是一台思科IOS设备，因此NTC()里的device_type这个参数我们使用“cisco_ios_ssh”。
• 同NAPALM一样，访问目标设备的基本参数配置好后，我们再调用open()函数即完成了SSH远程登录交换机的操作。
• Pyntc中的facts方法用来帮我们读取目标设备的厂商、设备型号、OS版本、序列号、主机名、uptime、端口列表、VLAN等基本信息和配置，为了使输出的内容更具可读性，这里我们调用json.dumps()来将输出内容转换成JSON的格式。
• 脚本最后使用close()方法退出交换机，关闭SSH进程。

运行脚本看效果：

注：因为这里我使用的是GNS3模拟器上的虚拟交换机（vios_l2-adventerprisek9-m），因此pyntc读取不到“model”、“os_version”、“serial_number”几项信息，这个影响不大，如果目标设备为真机则不会有这个问题。

对目标设备进行配置

在pyntc中，我们可以使用config()以及config_list()来对目标设备进行配置，两者的区别是前者一次只能对设备执行一条命令，而后者顾名思义是将多条命令作为元素放入一个列表中，pyntc依次调用列表里的命令对设备进行配置。

接下来我们创建一个名为pyntc2.py的脚本，将下列代码放入该脚本中：

 from pyntc import ntc_device as NTC
  
 SW1 = NTC(host='192.168.2.11', username='python', password='123', device_type='cisco_ios_ssh')
 SW1.open()
  
 SW1.config('hostname pyntc_SW1')
 SW1.config_list(['router ospf 1', 'network 0.0.0.0 255.255.255.255 area 0'])
 SW1.close()

代码讲解如下：

• 这里我们使用config(‘howname pyntc_SW1’)将交换机的主机名由SW1改为pyntc_SW1，用config_list([‘router ospf 1’, ‘network 0.0.0.0 255.255.255.255 area0’])在交换机上开启OSPF。
• 运行脚本前，先手动登录交换机，确定它目前的主机名为SW1，并且还没有配置OSPF：

运行脚本后，因为我们没有使用print语句，因此不会有任何回显内容：

回到交换机，这时可以发现其主机名已经被pyntc配置为pyntc_SW1，并且OSPF也被开启了。

获取目标设备的running config

通过pyntc的running_config方法我们也可以很方便的获取设备的running config，该方法返回值的数据类型为字符串，我们可以用print语句将它打印出来。这里我们创建一个名为pyntc3.py的脚本，将下列代码放入脚本：

 from pyntc import ntc_device as NTC
  
 SW1 = NTC(host='192.168.2.11', username='python', password='123', device_type='cisco_ios_ssh')
 SW1.open()
  
 run = SW1.running_config
 print (run)
 SW1.close()

代码讲解部分略过，我们直接来看脚本运行后的效果（由于回显内容的长度，这里只截取其中一部分）：

对目标设备的running config进行备份

除了获取设备的running config外，我们也可以通过pyntc对设备running config做备份。这里我将演示如果通过pyntc的backup_running_conig()方法，仅仅使用5行代码就将一台交换机的配置备份在本地主机上。

首先将下列代码写入名为pyntc4.py的脚本中：

 from pyntc import ntc_device as NTC
  
 SW1 = NTC(host='192.168.2.11', username='python', password='123', device_type='cisco_ios_ssh')
 SW1.open()
  
 SW1.backup_running_config('SW1_config.cfg')
 SW1.close()

代码讲解如下：

• 这里我们调用pyntc的backup_running_config()对交换机的running config做备份，将它保存在一个名为“SW1_config.cfg”的配置文件里，该配置文件将自动生成在运行脚本的CentOS主机的当前目录下。

运行脚本前，我们首先在主机上通过命令“ls SW_config.cfg”确认当前目录下没有SW1_config.cfg这个文件：

执行脚本看效果：

执行脚本后，可以看到当前目录现在多出了SW1_config.cfg这个配置文件，查看该文件内容，确认的确是交换机SW1的running config，一台思科设备配置的备份仅仅通过5行代码就完成了。

重启目标设备

最后我们来看下如何使用pyntc来重启目标设备。首先将下列代码写入名为pyntc5.py的脚本中：

 from pyntc import ntc_device as NTC
  
 SW1 = NTC(host='192.168.2.11', username='python', password='123', device_type='cisco_ios_ssh')
 SW1.open()
  
 SW1.save()
 SW1.reboot(confirm=True)

代码讲解如下：

• 在重启设备前，首先要保证当前的配置已被保存，这里我们使用pyntc的save()方法，它的功能等同于思科的“copy run start”命令，随后我们调用pyntc的reboot()方法，并将参数confirm设为True，表示确认要对设备重启。

执行脚本看效果：

执行脚本后，可以看到交换机上面跳出了日志提示（这里我们通过console访问交换机），证明脚本对交换机执行了“copy run start”命令，保存了当前的配置，随后对交换机执行了reload命令，重启了设备。

最后当交换机重新回到命令行后，可以发现之前配置的交换机hostname以及OSPF都保存了下来。