网络工程师利器-textFSM语法

textFSM是一个对命令回显进行格式化的一个库，是在学习netmiko的学习过程中有个字段是调用 textFSM对回显进行格式化的，但是调用完发现没有作用，查了一通资料之后发现，自己的命令在templates的index里根本没有，然后就开始查textFSM是怎么工作的，进而发现这真是个好东西。今天有时间写个下跟大家分享下学习的过程。这个库在windows不支持，不过可以在windows的子系统ubuntu中使用也很方便，文末有wsl的说明。

小案例

通过下面这个小案例看下通过textFSM处理之后会有是一个什么效果。下面是一段trace一个地址的回显处理，我们对回显只想看到每一跳的ID和每一跳的地址。

#parse_traceroute.py
import textfsm
import os

os.chdir('/mnt/d/project/Netmiko_learn/textFSM_learn')

traceroute = '''
r2#traceroute 90.0.0.9 source 33.0.0.2
traceroute 90.0.0.9 source 33.0.0.2
Type escape sequence to abort.
Tracing the route to 90.0.0.9
VRF info: (vrf in name/id, vrf out name/id)
  1 10.0.12.1 1 msec 0 msec 0 msec
  2 15.0.0.5  0 msec 5 msec 4 msec
  3 57.0.0.7  4 msec 1 msec 4 msec
  4 79.0.0.9  4 msec *  1 msec
'''

with open('../templates/traceroute.template') as template:
    fsm = textfsm.TextFSM(template)
    result = fsm.ParseText(traceroute)

print(fsm.header)
print(result)

#traceroute.template
Value Hop (\d+)
Value Ip (\S+)

Start
 ^  ${Hop} ${Ip} -> Record

#输出:
['Hop', 'Ip']
[['1', '10.0.12.1'], ['2', '15.0.0.5'], ['3', '57.0.0.7'], ['4', '79.0.0.9']]

感受下是不是很香，没有任何多余的显示，显示的就是自己想要的，这个在批量化处理设备的时候是非常有用。下面跟大家分享这个库的官方文档，还有一些比较高级的用法，官方文档全是英文，英语学习太重要了，关于这个库的中文资料真的是少之又少。

textFSM语法

Value definitions

textFSM通过Value关键字来定义列名，特殊用法通过option这个字段来声明，关于option字段会在会面的一些简单案例中进行说明，干说也不大好理解，格式如下：
Value [option[,option...]] name regex

变量定义.png

State definitions

声明的首行是声明的名称，由字母和数字组成，之后是定义的一系列规则。规则的每行由一个或两个空格以及一个^符号组成，英文叫carat。
默认情况下FSM从Start这个state开始，除非由state转换转至其他的声明。

State Rules

每个State可以包含多个rule，FSM从读取的文本中取一行数据来进行匹配，如果匹配到了则开始执行后面的action，并从文本中读取下一行数据来重复进行。格则的格式如下：
^regex [-> action]

Rule Actions

这里是重点，看到小伙伴要多理解下。正则表达式之后一般会跟随着actions，通过'->'符号进行分割，格式是：A.B C。Actions中的ABC分别表示三个部分，A是Line Actions，是针对输入的字符串进行。B是Record Actions 是针对匹配到的结果进行的。C是State transition 转向新的State。

Line Actions

LineActions.png

前面说的A是针对输入的文本进行的，Next就是匹配到之后就换下一行，就是不再匹配下一行的正则表达式，这是一个默认的规则。Continue就是匹配到本后之后保留匹配结果，继续匹配之后的正则表达式。

Record Actions

RecordActions.png

这里就是前面说的B, 在line action之后会跟着会有标点符号.然后跟着record action。我们一般只会用到Record，默认的是NoRecord。Next, Next.NoRecord and NoRecord这三个是一样的，

New State Transition

在正则表达式之后可以跟着一个空格和一个新的State，就是前面说的C，如果输入的文本匹配到这个本行则转向新的State进行匹配。如下图中的Start中的跟随的Routes表示匹配到了"-----"之后才开始进行下面Routes中的规则匹配。

StateTransition.png

需要注意的是Continue action不是跟转至新的transition，放环机制。这篇文章就到这里，下篇会写下一些特殊字段的用法。

参考文档：

textFSM github文档
https://github.com/google/textfsm/wiki/TextFSM
windows中通过wsl执行python脚本
https://code.visualstudio.com/docs/remote/wsl-tutorial