锐捷:基于Python TextFSM模块的网络设备自动化运维方法

网络设备自动化运维，首先要实现网络设备与自动化运维平台对接，即通过代码实现登录网络设备并获取信息。邮政业科技创新战略联盟单位锐捷自主研发的数据中心交换机产品已全面支持NETCONF协议，可适用于和SDN控制器或运维平台的南向接口对接。而针对网络工程师在操作网络设备时习惯于使用CLI命令行的现状，本文将介绍一种主流的基于CLI命令行登录的自动化运维案例。

基于CLI的自动化运维带来的问题

CLI（Command-Line Interface）是传统网络工程师最熟悉的与网络设备“沟通”的方式，工程师最初学习网络课程就是要熟悉各类协议的命令行配置、调试。工程师在日常工作中需要结合命令行输出结果进行排错，甚至在网络割接和变更的场景中，需要将变更的操作步骤细化到每一条命令。相比NETCONF等API接口，CLI命令行通常支持的内容更加丰富、灵活。所以在实现网络自动化运维的过程中，基于CLI的自动化是最能够被传统网络工程师所接受和执行的。

下面以交换机最基础的查看VLAN命令为例进行说明。如下图所示是通过“show vlan”命令的输出结果，对于同一个VLAN可能会存在多个端口同时放行的情况。关联的接口数量超过一定数量时，输出的结果将会拆分成多行显示，此时，VLAN信息只在第一行显示，后续几行内容需要与第一行进行关联匹配才能得到正确的输出信息。此时如果需要读取某个VLAN关联的所有端口号列表，使用传统的正则表达式就需要多次调用正则表达式并配合循环逻辑判断才能实现，整个过程非常繁琐。

Python常规的数据类型主要是列表或字典格式，如果有工具能够将设备的上面的输出结果直接转化为Python适配的数据类型（如下图），那么就可以直接使用Python进行处理。

TextFSM模块介绍

TextFSM是Google开发的一种开源Python模块，可以基于模板的状态机来解析半格式化文本，从而实现对网络设备CLI输出信息进行结构化数据处理，最终将文本内容输出为Python的字典或列表格式（或者是两者组合）。

详细内容可以访问该模块的GitHub：
https://github.com/google/textfsm

例如，上文中需要将“show vlan”命令的输出结果进行解析，可以通过调用下面的TextFSM模板将命令输出进行格式化：

ruijie-templates模块介绍

虽然有了TextFSM模块能够做到结构化解析文本信息，但是每个厂家的CLI输出内容差异较大，需要每条命令都有相应的模板来适配，导致运维人员还需要投入大量时间去编写相应的模板。ntc-templates模块就是为了解决这个痛点诞生的。ntc-templates模块是由networktocode团队开发的Python模块，该模块基于TextFSM开发，它内置了将近400个TextFSM模板，可以适配主流厂商的CLI输出结果。