実践ネット自動化スクリプト集

Pythonで実現するネットワークインベントリ活用自動化：収集データから設定生成まで

Tags: Python, ネットワーク自動化, インベントリ管理, データ活用, 設定自動化

はじめに

ネットワーク自動化を進める上で、「どの機器に」「どのような状態を」実現したいかを定義することは非常に重要です。特に、インフラ全体の自動化に慣れている方々にとって、ネットワーク機器に関する最新の構成情報（インベントリ）を一元的に把握し、それを自動化処理の入力データとして活用したいというニーズは多いでしょう。

本記事では、Pythonを用いてネットワーク機器からインベントリ情報を自動収集し、さらにその収集したデータを活用して、ネットワーク設定や監視設定を自動的に生成する具体的な手法について解説します。Pythonスキルを活かしてネットワーク領域の自動化を効率化したいとお考えのシステムエンジニア、インフラエンジニアの方々にとって、実践的なヒントとなれば幸いです。

ネットワークインベントリの重要性と課題

ネットワークインベントリとは、ネットワーク機器の種類、ホスト名、IPアドレス、OSバージョン、インターフェース情報、接続先、物理的な場所など、機器に関するあらゆる構成情報の集まりを指します。このインベントリ情報は、ネットワークの現状把握、トラブルシューティング、変更管理、セキュリティ脆弱性管理など、多岐にわたる運用業務の基盤となります。

しかし、インベントリ情報を手動で収集・管理することは、多くの時間と労力を要する上に、ヒューマンエラーによる情報の陳腐化や不整合が発生しやすいという課題があります。特に、機器台数が多い環境や、頻繁に構成変更が行われる環境では、常に正確な最新情報を維持することが困難になります。

この課題を解決するために、Pythonによるネットワークインベントリの自動収集と、収集したデータの効率的な活用が有効です。

Pythonによるインベントリ収集手法

Pythonを使ってネットワーク機器からインベントリ情報を収集するには、いくつかの方法があります。主な手法としては、以下のものが挙げられます。

  1. CLI（コマンドラインインターフェース）スクレイピング:

    • SSHやTelnet経由で機器に接続し、show version や show interface status といったコマンドを実行して、その出力をパース（解析）して必要な情報を抽出する方法です。
    • 使用ライブラリ例: netmiko, paramiko (NetmikoはParamikoを内部的に使用し、様々なベンダー機器のCLI操作を抽象化してくれます。)
    • メリット: 多くの機器がCLIを提供しているため汎用性が高いです。
    • デメリット: ベンダーやOSバージョンによってコマンド出力形式が異なるため、パース処理が複雑になりがちです。正規表現などを駆使する必要があります。

  2. SNMP（Simple Network Management Protocol）:

    • ネットワーク機器から管理情報を取得するための標準プロトコルです。MIB（Management Information Base）というツリー構造のデータベースから情報を取得します。
    • 使用ライブラリ例: pysnmp
    • メリット: 構造化されたデータを取得しやすいです。監視ツールなどでも広く利用されています。
    • デメリット: SNMPエージェントが機器上で有効になっている必要があります。コミュニティ名やユーザー名といった認証設定が必要です。

  3. ネットワークAPI（RESTConf / NETConfなど）:

    • 比較的新しい機器やSDN（Software-Defined Networking）環境では、RESTConfやNETConfといったAPIを通じてプログラムから直接、構造化されたデータを取得できます。
    • 使用ライブラリ例: requests (RESTConf), ncclient (NETConf)
    • メリット: 構造化されたデータ（XMLやJSON）を直接取得できるため、パースが容易です。
    • デメリット: 対応している機器が限られる場合があります。

対象読者のPythonスキルが高いことを考慮すると、netmikoやrequests/ncclientといったライブラリを使ったデータ収集は比較的容易でしょう。特にnetmikoはCLIパースの複雑さをある程度吸収してくれるため、ネットワーク機器のコマンドに不慣れな場合でも取り組みやすい選択肢となります。

収集したデータの構造化と管理

どのような方法で収集したとしても、取得したインベントリ情報は自動化しやすいように構造化して管理することが重要です。一般的には、以下のような形式でデータを保持することが推奨されます。

例えば、各機器の情報を以下のようなYAML形式で表現することができます。

- hostname: switch01.example.com
  ip_address: 192.168.1.10
  vendor: Cisco
  os_version: 16.9.5
  interfaces:
    - name: GigabitEthernet1/0/1
      status: up
      speed: 1000
      description: To Server-A
    - name: GigabitEthernet1/0/2
      status: down
      speed: 100
      description: Not Used
- hostname: router01.example.com
  ip_address: 10.0.0.1
  vendor: Juniper
  os_version: 18.4R2
  interfaces:
    - name: ge-0/0/0
      status: up
      speed: 1000
      description: To Internet
# ... 他の機器情報

このように構造化することで、後続の自動化処理（特定ベンダーの機器だけを対象とする、特定OSバージョンの機器を抽出する、特定のインターフェースを持つ機器をリストアップするなど）が容易になります。

インベントリデータの活用例：設定生成

収集・構造化したインベントリデータを最も効果的に活用できる例の一つが、ネットワーク設定の自動生成です。テンプレートエンジンと組み合わせることで、機器の種類や役割、さらには個別のインターフェース情報などに基づいて、動的に設定ファイルを生成できます。

ここでは、Pythonで広く使われているテンプレートエンジンである Jinja2 を使用した例を紹介します。

準備

Jinja2 ライブラリをインストールします。

pip install Jinja2

テンプレートファイルの作成

例えば、上記で収集したインベントリデータを用いて、各インターフェースのdescriptionを設定するCisco IOS XEの設定テンプレートを作成します。

interface_description.j2 というファイル名で以下の内容を保存します。

{% for interface in interfaces %}
interface {{ interface.name }}
 description {{ interface.description }}
{% endfor %}

Pythonスクリプトの実装

収集したインベントリデータ（YAML形式）を読み込み、Jinja2 を使って設定ファイルを生成するスクリプトです。

import yaml
from jinja2 import Environment, FileSystemLoader

# 収集したインベントリデータファイル
inventory_file = 'inventory.yaml'

# Jinja2テンプレートファイルが置かれているディレクトリ
template_dir = '.'
# 使用するテンプレートファイル名
template_file = 'interface_description.j2'

def generate_config(inventory_data, template_name):
    """
    インベントリデータとテンプレートを使用して設定を生成する
    """
    # Jinja2環境をセットアップ
    # FileSystemLoaderでテンプレートファイルの場所を指定
    env = Environment(loader=FileSystemLoader(template_dir))
    template = env.get_template(template_name)

    generated_configs = {}
    # インベントリデータから各機器の設定を生成
    for device in inventory_data:
        hostname = device.get('hostname')
        interfaces = device.get('interfaces', [])

        # テンプレートに変数を渡してレンダリング
        config = template.render(interfaces=interfaces)
        generated_configs[hostname] = config

    return generated_configs

# メイン処理
if __name__ == "__main__":
    try:
        # インベントリデータを読み込み
        with open(inventory_file, 'r') as f:
            inventory_data = yaml.safe_load(f)

        # 設定を生成
        configs = generate_config(inventory_data, template_file)

        # 生成された設定を表示またはファイルに保存
        for hostname, config in configs.items():
            print(f"--- Configuration for {hostname} ---")
            print(config)
            print("-" * (len(hostname) + 20))

            # ファイルに保存する場合
            # with open(f"{hostname}_config.txt", "w") as f:
            #     f.write(config)

    except FileNotFoundError:
        print(f"エラー: インベントリファイル '{inventory_file}' が見つかりません。")
    except Exception as e:
        print(f"エラーが発生しました: {e}")

このスクリプトは、inventory.yaml というファイルからインベントリデータを読み込み、各機器の interfaces 情報を interface_description.j2 テンプレートに渡して設定を生成します。生成された設定は標準出力に表示されますが、ファイルに保存する処理を追加することも容易です。

この例ではインターフェースのdescriptionだけですが、テンプレートを工夫することで、VLAN設定、ルーティング設定、ACLなど、より複雑な設定ファイルも生成できます。

インベントリデータの活用例：監視設定生成やIaC連携

インベントリデータは設定生成だけでなく、様々な自動化に活用できます。

実践的な考慮点

現場でインベントリ自動収集・活用スクリプトを運用する際には、いくつかの実践的な考慮点があります。

まとめ

本記事では、Pythonを用いたネットワークインベントリの自動収集と、収集したデータの構造化、そして設定生成を中心としたデータ活用の手法について解説しました。

Pythonの強力なライブラリとテンプレートエンジンを組み合わせることで、ネットワーク機器に関する最新のインベントリ情報を自動的に収集し、そのデータを基にした設定の自動生成や、監視設定、IaCツールとの連携など、様々な自動化のワークフローを構築できます。

ネットワーク機器の直接的な操作に慣れていない場合でも、Pythonによるデータ収集とデータ活用のアプローチは、インフラ自動化全体の文脈でネットワーク領域の効率化を進める上で非常に有効です。是非、本記事を参考に、皆様の現場でのネットワーク自動化に取り組んでみてください。