? ? textFSM是一個(gè)對(duì)命令回顯進(jìn)行格式化的一個(gè)庫(kù)，是在學(xué)習(xí)netmiko的學(xué)習(xí)過(guò)程中有個(gè)字段是調(diào)用 textFSM對(duì)回顯進(jìn)行格式化的，但是調(diào)用完發(fā)現(xiàn)沒有作用，查了一通資料之后發(fā)現(xiàn)，自己的命令在templates的index里根本沒有，然后就開始查textFSM是怎么工作的，進(jìn)而發(fā)現(xiàn)這真是個(gè)好東西。今天有時(shí)間寫個(gè)下跟大家分享下學(xué)習(xí)的過(guò)程。這個(gè)庫(kù)在windows不支持，不過(guò)可以在windows的子系統(tǒng)ubuntu中使用也很方便，文末有wsl的說(shuō)明。
小案例
? ? 通過(guò)下面這個(gè)小案例看下通過(guò)textFSM處理之后會(huì)有是一個(gè)什么效果。下面是一段trace一個(gè)地址的回顯處理，我們對(duì)回顯只想看到每一跳的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']]
? ? 感受下是不是很香，沒有任何多余的顯示，顯示的就是自己想要的，這個(gè)在批量化處理設(shè)備的時(shí)候是非常有用。下面跟大家分享這個(gè)庫(kù)的官方文檔，還有一些比較高級(jí)的用法，官方文檔全是英文，英語(yǔ)學(xué)習(xí)太重要了，關(guān)于這個(gè)庫(kù)的中文資料真的是少之又少。
textFSM語(yǔ)法
Value definitions
? ? textFSM通過(guò)Value關(guān)鍵字來(lái)定義列名，特殊用法通過(guò)option這個(gè)字段來(lái)聲明，關(guān)于option字段會(huì)在會(huì)面的一些簡(jiǎn)單案例中進(jìn)行說(shuō)明，干說(shuō)也不大好理解，格式如下：
Value [option[,option...]] name regex
State definitions
? ? 聲明的首行是聲明的名稱，由字母和數(shù)字組成，之后是定義的一系列規(guī)則。規(guī)則的每行由一個(gè)或兩個(gè)空格以及一個(gè)^符號(hào)組成，英文叫carat。
? ? 默認(rèn)情況下FSM從Start這個(gè)state開始，除非由state轉(zhuǎn)換轉(zhuǎn)至其他的聲明。
State Rules
? ? 每個(gè)State可以包含多個(gè)rule，F(xiàn)SM從讀取的文本中取一行數(shù)據(jù)來(lái)進(jìn)行匹配，如果匹配到了則開始執(zhí)行后面的action，并從文本中讀取下一行數(shù)據(jù)來(lái)重復(fù)進(jìn)行。格則的格式如下：
^regex [-> action]
Rule Actions
? ? 這里是重點(diǎn)，看到小伙伴要多理解下。正則表達(dá)式之后一般會(huì)跟隨著actions，通過(guò)'->'符號(hào)進(jìn)行分割，格式是：A.B C。Actions中的ABC分別表示三個(gè)部分，A是Line Actions，是針對(duì)輸入的字符串進(jìn)行。B是Record Actions 是針對(duì)匹配到的結(jié)果進(jìn)行的。C是State transition 轉(zhuǎn)向新的State。
Line Actions
? ? 前面說(shuō)的A是針對(duì)輸入的文本進(jìn)行的，Next就是匹配到之后就換下一行，就是不再匹配下一行的正則表達(dá)式，這是一個(gè)默認(rèn)的規(guī)則。Continue就是匹配到本后之后保留匹配結(jié)果，繼續(xù)匹配之后的正則表達(dá)式。
Record Actions
? ? 這里就是前面說(shuō)的B, 在line action之后會(huì)跟著會(huì)有標(biāo)點(diǎn)符號(hào).然后跟著record action。我們一般只會(huì)用到Record，默認(rèn)的是NoRecord。Next, Next.NoRecord and NoRecord這三個(gè)是一樣的，
New State Transition
? ? 在正則表達(dá)式之后可以跟著一個(gè)空格和一個(gè)新的State，就是前面說(shuō)的C，如果輸入的文本匹配到這個(gè)本行則轉(zhuǎn)向新的State進(jìn)行匹配。如下圖中的Start中的跟隨的Routes表示匹配到了"-----"之后才開始進(jìn)行下面Routes中的規(guī)則匹配。
? ? 需要注意的是Continue action不是跟轉(zhuǎn)至新的transition，放環(huán)機(jī)制。這篇文章就到這里，下篇會(huì)寫下一些特殊字段的用法。
參考文檔：
textFSM github文檔
https://github.com/google/textfsm/wiki/TextFSM
windows中通過(guò)wsl執(zhí)行python腳本
https://code.visualstudio.com/docs/remote/wsl-tutorial
