基于Python TextFSM模塊的網絡設備自動化運維方法

本文將給大家介紹一種主流的基于CLI命令行登錄的自動化運維實踐案例，希望能夠給大家帶來幫助。

#互聯網

發布時間：2021-03-04
點擊量：
點贊：

分享至

我想評論

本文作者：kevinwoo

銳捷網絡技術服務部互聯網服務中心

隨著云計算和SDN技術的發展，數據中心規模越來越大，而網絡架構逐漸向“去堆疊”、“去框”式發展，這就意味著需要維護的交換機數量在成倍的增長。隨著網絡維護規模越來越大，運維人員壓力也成倍增加，依靠傳統的人工維護已不太現實，工具化、自動化運維勢在必行。這就需要運維人員具備一定編程能力，從而通過軟件代替傳統的人工維護。網絡自動化運維理念結合軟件開發領域DevOps理念而產生的NetDevOps概念已逐漸被網絡運維界所接受。

網絡自動化運維，首先要實現網絡設備與自動化運維平臺對接，即通過代碼實現登錄網絡設備并獲取信息。目前常見連接設備的方法有模擬傳統的Telnet/SSH命令登錄、NETCONF、gRPC、OpenFlow協議對接等等。

為了跟上SDN的發展趨勢，各個傳統網絡設備廠商已逐漸開放API接口，比較有代表性的是NETCONF和YANG模型對網絡設備的配置和信息輸出的數據結構化定義。目前銳捷數據中心交換機產品已全面支持NETCONF協議，可適用于和SDN控制器或運維平臺的南向接口對接。而面對網絡工程師在操作網絡設備時習慣于使用CLI命令行的現狀，又有什么樣的案例實踐呢？

本文將給大家介紹一種主流的基于CLI命令行登錄的自動化運維實踐案例，希望能夠給大家帶來幫助。

基于CLI的自動化運維帶來的問題

CLI(Command-Line Interface)是傳統網絡工程師最熟悉的與網絡設備“溝通”的方式，工程師最初學習網絡課程就是要熟悉各類協議的命令行配置、調試。工程師在日常工作中需要結合命令行輸出結果進行排錯，甚至在網絡割接和變更的場景中，需要將變更的操作步驟細化到每一條命令。相比NETCONF等API接口，CLI命令行通常支持的內容更加豐富、靈活。所以在實現網絡自動化運維的過程中，基于CLI的自動化是容易被傳統網絡工程師所接受和執行的。

隨著Python語言在近些年的快速發展，涌現了一批基于Python的優秀開源模塊，比如Ansible、Paramiko、Netmiko、Pexpect等。網絡工程師現在可以編寫簡短的Python腳本就能調用這些模塊實現批量登錄設備執行腳本，但是隨之而來的另一個頭痛的問題是傳統的命令行輸出結果通常是按照適合人類閱讀的方式來呈現的。比如“show”命令的輸出結果包含了大量的空格、縮進、換行等，而且很多命令還存在上下文關聯性。這些命令行輸出結果通常無法被計算機很好地識別，計算機更擅長識別XML、JSON、YAML等結構化數據類型，所以網工在編寫Python腳本時不得不寫一堆正則表達式去“摳”關鍵參數，然而使用復雜的正則表達式又進一步導致代碼可維護性較差。

下面以交換機最基礎的查看VLAN命令為例進行說明。如下圖所示是通過“show vlan”命令的輸出結果，對于同一個VLAN可能會存在多個端口同時放行的情況。關聯的接口數量超過一定數量時，輸出的結果將會拆分成多行顯示，此時，VLAN信息只在第一行顯示，后續幾行內容需要與第一行進行關聯匹配才能得到正確的輸出信息。此時如果需要讀取某個VLAN關聯的所有端口號列表，使用傳統的正則表達式就需要多次調用正則表達式并配合循環邏輯判斷才能實現，整個過程非常繁瑣。

Python常規的數據類型主要是列表或字典格式，如果有工具能夠將設備的上面的輸出結果直接轉化為Python適配的數據類型（如下圖），那么就可以直接使用Python進行處理。

下面就要隆重介紹一下本文標題中提到的TextFSM模塊，它就是用于結構化輸出文本的一個神奇工具。

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輸出結果。

詳細可參考該模塊的GitHub主頁：

https://github.com/networktocode/ntc-templates

ntc-templates模塊內置了index文件，將各類廠商平臺和show命令映射到相應的TextFSM模板文件，每個廠商的不同命令都對應著一個獨立的模板。我們在ntc-templates模塊的基礎上，開發了基于銳捷數據中心交換機產品的模板庫：ruijie-templates。ruijie-templates模板庫是基于TextFSM規則開發，用于適配ntc-templates模塊，可以無縫銜接Netmiko模塊使用。ruijie-templates模塊可以將銳捷數據中心交換機CLI內容進行結構化輸出，輸出結果可以直接用于Python腳本使用。該模塊經過多個銳捷主流數據中心交換機版本測試，覆蓋RG-S6510、RG-S6520、RG-S6910、RG-S6920、RG-N18000-X系列[權5] 產品，目前已支持近50條常用命令解析，后續會逐步更新完善，敬請關注。目前ruijie-templates代碼已托管至GitHub：https://github.com/kevinkrabi/ruijie-templates

下面介紹一下ruijie-templates模塊使用方法。