前回の「ネットワーク機器の管理の自動化1」で紹介したPythonスクリプトの詳細について書いていきます。

スクリプトの中身

ネットワーク機器の情報を取得する方法としてAPIを使わずテキスト検索をしています。具体的には以下の方法で情報を取得します。

①ログファイルのテキストをリストに変換します。

②リスト内で空欄の値をすべて削除します。

③enumerate関数を使って取得したい値に関連するキーワードのインデックスのリストを作成します。

④同じキーワードが複数のshowコマンドの出力結果で使用されている可能性があります。キーワードのインデックスのリストの値をfor文で1つずつ検索し、その値の前後の値も確認して本当に該当するキーワードかどうか確認します。

⑤該当していれば、関連するキーワードの前後にある取得したい値を取得します。

具体的な例としてIPアドレス情報を取得したい場合、以下のような「show run」のインターフェース設定から取得します。

interface Loopback0
 ip address 3.3.3.3 255.255.255.255

!
interface FastEthernet4/0
 description to_CORE01_Fa3_0
 ip address 192.168.1.2 255.255.255.0
 ip ospf network point-to-point
 duplex full

 speed auto

手順①によって"interface", "Loopback0", "ip", "address", "3.3.3.3","255.255.255.255","!","interface","FastEthernet4/0","description"...のような階層のないリストに変換します。

手順③のenumerate関数では例えば「interface」をキーワードにインデックスのリストを作成します。「interface」というキーワードはログ内で別のshowコマンドの出力でも使用されているかもしれません。そのため本当に「show run」のインターフェースの箇所のものかどうか確認するため、「interface」のインデックスに+1した値が「Loopback◯」や「FastEthernet◯/◯」になっていることをチェックします。なっていたらfor文で1個ずつインデックスを足していき「ip」とそれに続く「address」が出てきたら、「address」の次の値はIPアドレス、その次の値はサブネットマスクというように値を取得できます。

この方法でその他の情報も取得できます。よく問題になるのは機器側の設定のデスクリプションに「to CORE01 FastEthernet0/0」のように設定していると、手順①でファイルをリスト化した際にスペースをデリミタとして「to」、「CORE01」、「FastEthernet0/0」という値に分けられ「FastEthernet0/0」がshowコマンドの結果と判別できず、正しくデスクリプションの値を取得できないことがあります。機器側の設定を「to_CORE01_FastEthernet0/0」のようにアンダースコアでつなげて1つの値となるようにしておけば問題になりません。

APIを使わない理由

なぜAPIを使わなかったかと思うかもしれません。もともとこのスクリプトはAPIアクセスが許可されていない環境で作成したものでした。APIを使用しないので、作りこめば同じ方法で異なるメーカーや型番の機器でも対応できます。APIをサポートしていない機器や導入時点でコンソールアクセスしかできない場合などでもログさえ取得できれば利用できます。問題としてはメーカーや型番の違いによってshowコマンドの値の表示が異なるものはスクリプト側で作りこむ必要があることでしょう。

その他

エクセルへの書き込みにはopenpyxlライブラリを使用しました。xlsxライブラリと比較するとopenpyxlの方がずっといいです。

xlsxは「.xls」ファイルに対応していますが「.xlsx」ファイルには対応しません。またxlsxではエクセルのフィルタを設定できません。

ネットワーク機器の管理のために機器情報や設定項目をエクセルなどに一覧にしてまとめることが多々あります。例えば各機器のシリアル番号やIPアドレスを一覧にしたりします。これを手動で行う場合、一台ずつ機器にログインして必要な情報をコピペして作成することになります。数十台〜数百台の機器があると一日で終わらないかもしれません。また、機器や構成の変更がある度にこの一覧を更新する必要があります。情報が間違っていることも多々あります。

このような手動タスクを自動化する例としてPythonで作成したスクリプトを紹介します。

スクリプトの動作

※WindowsにインストールしたGNS3で動作するCiscoルーターを使用しています。

①ターミナルソフトで各Ciscoルーターにアクセスしてshowコマンドを実行。出力結果をログに保存します。

例えば以下のようなshowコマンドを実行します。

term len 0
show version
show run
show ip int brief
show cdp nei
show ip ospf nei
show ip bgp summary
show ip route
show ntp associations

ログのファイル名は「ホスト名.txt」として複数機器のログを同じディレクトリに保存します。

②今回紹介するPythonスクリプトを実行し、①で取得したログを保存したディレクトリを指定します。

「cisco_audit.pyw」をダブルクリックします。

※このスクリプトではtkinterによるGUIのウィンドウが表示されます。Pythonのファイルの拡張子を「pyw」とすることで「py」の場合と違って、Pythonのコンソール画面（CLI画面）は表示させずGUIの画面のみを表示させています。

以下のGUIウィンドウが表示されます。

ステップ1の「コマンド一覧表示」ボタンをクリックすると「tmp.txt」というテキストファイルが開きます。①で取得するshowコマンドをコピペできます。

ステップ2の「ディレクトリ選択」ボタンをクリックすると「フォルダーの選択」ウィンドウがポップアップします。

①で取得したログのディレクトリを選択します。

③結果が記載されたエクセルファイルが生成されます。

スクリプトファイルと同じディレクトリにエクセルファイル「result.xlsx」が生成され、自動で開きます。

生成されたエクセルファイルの中身

「result.txt」は2つのシート「IP」、「Status」があります。

それぞれ以下の情報が含まれます。

「IP」シート： IPアドレス関連の情報
       インターフェース名
       IPアドレス
       サブネットマスク
       プレフィックス
       ネットワークアドレス
       ホスト範囲
       ステータス(UP/DOWN)
       デスクリプション
 

 「Status」シート：機器のステータス情報
       HWモデル
       ソフトウエアバージョン
       アップタイム
       インターフェースの状態
       CDP
       OSPFネイバー
       BGPネイバー
       デフォルトルート
       NTP同期の状態

①「IP」シートの詳細

このシートではIPアドレスに特化した情報を表示します。機器からIPアドレス情報を取得するだけでなく、サブネットマスクをプレフィックス表示に変換したものを表示したり、ホストアドレスの範囲も表示します。

A列：ホスト名

B列：インターフェース名

C列：IPアドレス

D列：サブネットマスク

E列：プレフィックス

F列：ネットワークアドレス

G列：ホストアドレスの範囲

H列：インターフェースのステータス

I列：デスクリプション

特定の機器や特定のインターフェース（例：「Loopback」）などでフィルタできます。

「IP address」の列の値をコピーしてpingツール（ExPingなど）に張り付けることもできます。

②「Status」シートの詳細

このシートでは機器情報や機器状態を表示します。インベントリ管理、正常性の確認などに活用できます。

A列：ホスト名

B列：カテゴリ1   : 「1.system」、「2.interface」、「3.routing」、「4.ntp」

C列：カテゴリ2   :  カテゴリ1の詳細

D列：フラグ 　　:  エラーの有無

E列：コマンド    ： showコマンド 

F列以降　　　　：値

【機器情報】

B列を「1.system」、C列を「1.hardware model」でフィルタするとHWモデル情報を一覧表示できます。

B列を「1.system」、C列を「2.software version」でフィルタするとSWバージョン情報を一覧表示できます。

【インターフェース情報】

B列を「2.interface」でフィルタするとインターフェースの情報を一覧表示できます。「IP」シートの情報ではIPアドレスが設定されているインターフェースのみ対象としていますが、ここではIPアドレスがないインターフェースも表示します。CDPで取得した対向の機器の情報も表示します。

【ルーティング情報】

B列を「3.routing」、C列を「1.ospf」でフィルタすればOSPFネイバーの状態を一覧表示できます。

B列を「3.routing」、C列を「2.bgp」でフィルタすればBGPピアの状態を一覧表示できます。

B列を「3.routing」、C列を「3.default route」でフィルタすればデフォルトルートを一覧表示できます。

【NTP情報】

B列を「4.ntp」でフィルタすればNTPの同期状態を一覧表示できます。

【エラー判定】

D列を「check!!」または「error!!」でフィルタすると状態の項目（OSPF、BGP、デフォルトルート、NTP)での注意すべきまたは異常な項目を一覧表示できます。

次回はこのスクリプトの中身について書いていきたいと思います。