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

Pythonでネットワーク設定をコード化：状態駆動型自動化の基本と実装

Tags: Python, ネットワーク自動化, 状態駆動型, IaC, Netmiko, NAPALM, Jinja2

はじめに

システム開発やインフラ構築の現場において、Infrastructure as Code (IaC) はもはや標準的なアプローチとなっています。サーバー、ミドルウェア、クラウドインフラなどはコードとして管理され、自動化されたワークフローを通じてデプロイや変更が行われます。一方、ネットワーク機器の設定変更や運用管理は、いまだに手動でのCLI操作に依存しているケースが少なくありません。これは、設定の属人化やヒューマンエラーのリスクを高めるだけでなく、IaCを中心とした全体の自動化ワークフローとの連携を困難にします。

特に、Pythonによる開発やクラウドインフラ自動化の経験が豊富なエンジニアの皆様にとって、ネットワーク領域の自動化は、Pythonスキルを活かせる新たなフロンティアであり、システム全体の効率化に不可欠な要素です。本記事では、ネットワーク機器の設定を「コード」として扱い、常に「あるべき状態（Desired State）」を保つための「状態駆動型自動化」の考え方と、Pythonを用いたその基本的な実装方法について解説します。

状態駆動型自動化とは

従来のネットワーク自動化スクリプトは、特定のコマンドシーケンスを実行することを主目的とする「手続き型（Procedural）」のアプローチが一般的でした。例えば、「VLAN 10を作成する」「インターフェース Gi1/1にIPアドレスを設定する」といった、具体的な操作手順を記述します。

これに対し、状態駆動型自動化は、操作手順ではなく、「最終的にネットワーク機器がどのような状態であるべきか（Desired State）」を定義することに焦点を当てます。自動化ツールは、この定義されたDesired Stateと、機器の現在の状態（Current State）を比較し、Desired Stateを実現するために必要な最小限の操作を判断・実行します。

このアプローチの利点は以下の通りです。

IaCツール（Ansible, Chef, Puppet, Terraformなど）の多くは、この状態駆動型の考え方に基づいています。ネットワーク自動化においても、この考え方を取り入れることで、IaCワークフローとの連携を強化し、より堅牢な自動化システムを構築することが可能になります。

ネットワーク設定をコード化するアプローチ

ネットワーク機器のDesired Stateを定義するために、設定をコードとして表現します。具体的な方法としては、以下のようなアプローチがあります。

  1. 構造化データの利用: YAMLやJSONなどの構造化データ形式で、VLAN ID、IPアドレス、インターフェース名、ルーティング情報などのネットワーク設定要素を記述します。これは、サーバーの構成をYAMLで記述するAnsibleのPlaybookや、クラウド資源をJSON/HCLで記述するTerraformの設定ファイルに似ています。
  2. 設定テンプレートの利用: 機器に投入する実際の設定コマンドやコンフィグレーションは、Jinja2などのテンプレートエンジンを使用して生成します。これにより、構造化データからベンダー固有のCLIコマンドや設定ファイルを効率的に生成できます。

Pythonを用いた実装では、これらのアプローチを組み合わせます。

Pythonによる状態駆動型自動化の基本的な実装例

ここでは、簡単なVLAN設定を例に、Pythonと主要ライブラリを用いた状態駆動型自動化の基本的な流れを示します。

1. Desired Stateの定義 (YAML)

Desired Stateとして、作成したいVLANとその名前を定義します。

# desired_state.yaml
vlans:
  - id: 10
    name: Sales
  - id: 20
    name: Marketing
  - id: 30
    name: Engineering

2. 設定テンプレートの作成 (Jinja2)

定義したDesired Stateから、Cisco IOSライクな機器に投入する設定コマンドを生成するテンプレートを作成します。

# vlan_config.j2
{% for vlan in vlans %}
vlan {{ vlan.id }}
  name {{ vlan.name }}
exit
{% endfor %}

3. Pythonスクリプトによる自動化ワークフロー

YAMLデータの読み込み、Jinja2テンプレートのレンダリング、Netmikoを用いた機器への設定投入、NAPALMを用いた状態検証を行います。

import yaml
from jinja2 import Environment, FileSystemLoader
from netmiko import ConnectHandler
from napalm import get_network_driver
import json # NAPALMが出力する構造化データを扱うため

# --- 設定 ---
# Desired State定義ファイル
DESIRED_STATE_FILE = 'desired_state.yaml'
# 設定テンプレートファイル
CONFIG_TEMPLATE_FILE = 'vlan_config.j2'
# Jinja2テンプレートのディレクトリ
TEMPLATE_DIR = '.' # 同じディレクトリにある場合

# ネットワーク機器接続情報 (例: Cisco IOS)
DEVICE_PARAMS = {
    'device_type': 'cisco_ios',
    'host': 'your_device_ip', # 適切なIPアドレス/ホスト名に変更
    'username': 'your_username', # 適切なユーザー名に変更
    'password': 'your_password', # 適切なパスワードに変更
    'secret': 'your_enable_password', # 適切なenableパスワードに変更 (必要に応じて)
    'port': 22, # SSHポート
}

# --- 処理 ---

def load_desired_state(filepath):
    """Desired State定義ファイルを読み込む"""
    with open(filepath, 'r') as f:
        return yaml.safe_load(f)

def render_config(template_dir, template_file, data):
    """Jinja2テンプレートをレンダリングして設定テキストを生成する"""
    env = Environment(loader=FileSystemLoader(template_dir))
    template = env.get_template(template_file)
    return template.render(data)

def apply_config(device_params, config_text):
    """ネットワーク機器に設定を投入する"""
    print(f"Connecting to {device_params['host']}...")
    try:
        with ConnectHandler(**device_params) as net_connect:
            # 設定投入モードに移行 (Cisco IOSの場合)
            # net_connect.enable() # enableパスワードが必要な場合

            # 設定投入
            # cfg_changes = config_text.splitlines() # 行ごとに分割する場合
            print("Applying configuration...")
            output = net_connect.send_config_set(config_text)
            print("Configuration applied.")
            print("Output:\n", output)

    except Exception as e:
        print(f"Error applying configuration: {e}")
        raise # エラーを上位に通知

def verify_state(device_params, desired_vlans):
    """機器の現在の状態を取得し、Desired Stateと比較検証する (NAPALMを使用)"""
    print(f"Verifying state on {device_params['host']}...")
    try:
        # device_typeはNAPALMドライバー名に対応させる
        napalm_driver_name = device_params['device_type'].replace('_', '-') # 例: cisco_ios -> cisco-ios
        driver = get_network_driver(napalm_driver_name)

        # NAPALMデバイスオブジェクトを作成、open()で接続
        with driver(
            hostname=device_params['host'],
            username=device_params['username'],
            password=device_params['password'],
            optional_args={'secret': device_params.get('secret')} # enableパスワード
        ) as device:
            # get_vlans()でVLAN情報を構造化データで取得
            current_vlans_data = device.get_vlans()
            print("Current VLANs data retrieved.")
            # print(json.dumps(current_vlans_data, indent=2)) # デバッグ表示

            # Current StateとDesired Stateを比較
            # NAPALMの出力形式に合わせてDesired Stateと比較しやすい形に変換する
            # NAPALMのget_vlans()は {vlan_id: {'name': 'vlan_name', ...}, ...} の形式
            desired_vlans_dict = {str(v['id']): {'name': v['name']} for v in desired_vlans}

            # Desired Stateに存在するVLANがCurrent Stateに存在し、名前が一致するか確認
            all_match = True
            print("Comparing Desired and Current states...")
            for vlan_id, desired_vlan_info in desired_vlans_dict.items():
                if vlan_id not in current_vlans_data:
                    print(f"  [Mismatch] VLAN {vlan_id} ({desired_vlan_info['name']}) is missing on the device.")
                    all_match = False
                elif current_vlans_data[vlan_id]['name'] != desired_vlan_info['name']:
                     print(f"  [Mismatch] VLAN {vlan_id} name mismatch: Desired '{desired_vlan_info['name']}', Current '{current_vlans_data[vlan_id]['name']}'.")
                     all_match = False
                else:
                    print(f"  [Match] VLAN {vlan_id} ({desired_vlan_info['name']}) matches Desired State.")

            # Current Stateには存在するがDesired Stateには存在しないVLANは、
            # このシンプルな例では確認しないが、本来は考慮が必要な場合がある
            # (例: 削除すべきVLANなど)

            if all_match:
                print("Verification successful: Current state matches Desired State for specified VLANs.")
            else:
                print("Verification failed: Current state does not fully match Desired State.")

            return all_match # 検証結果を返す

    except Exception as e:
        print(f"Error verifying state: {e}")
        # ここでエラーを捕捉しても処理を止めない、あるいは通知する等の考慮が必要
        return False # 検証失敗とする

# --- メイン処理 ---
if __name__ == "__main__":
    try:
        # 1. Desired Stateを読み込む
        print(f"Loading desired state from {DESIRED_STATE_FILE}...")
        desired_state = load_desired_state(DESIRED_STATE_FILE)
        print("Desired state loaded.")
        # print(yaml.dump(desired_state, indent=2)) # デバッグ表示

        # 2. 設定テキストを生成する
        print(f"Rendering configuration from {CONFIG_TEMPLATE_FILE}...")
        config_to_apply = render_config(TEMPLATE_DIR, CONFIG_TEMPLATE_FILE, desired_state)
        print("Configuration text generated:\n")
        print(config_to_apply)

        # 3. ネットワーク機器に設定を投入する (冪等性を考慮した応用例としてDiffを確認してから投入することも可能)
        # 例: Netmikoのcompare_config()/commit_config()を使用する、あるいは
        # 機器のCurrent Configを取得して手動でDiffを作成し、差分コマンドだけ投入する等
        # ここではシンプルに生成した設定全体を投入する (多くの場合、機器側で差分適用される)

        # apply_config(DEVICE_PARAMS, config_to_apply) # 実際の機器への投入処理

        # 4. 機器の現在の状態を取得し、Desired Stateと比較検証する
        # apply_configの後に実行するのが一般的
        # verify_state(DEVICE_PARAMS, desired_state['vlans']) # 実際の検証処理

        print("\n--- End of Script (Skipped actual device interaction for safety) ---")
        print("To run against a real device, uncomment the apply_config and verify_state calls")

    except FileNotFoundError as e:
        print(f"Error: File not found - {e}")
    except yaml.YAMLError as e:
        print(f"Error parsing YAML: {e}")
    except Exception as e:
        print(f"An unexpected error occurred: {e}")

コードの解説:

この例では、VLAN設定のみを扱いましたが、インターフェース設定、ルーティング設定、ACLなど、他の設定要素についても同様にYAMLでDesired Stateを定義し、テンプレートで機器設定を生成し、適切なNAPALMメソッドで状態を検証することで、状態駆動型自動化を実現できます。

実践的な考慮事項

現場でこのアプローチを導入する際には、以下の点を考慮する必要があります。

まとめ

本記事では、Pythonを用いたネットワーク自動化において、設定をコード化し「状態駆動型」のアプローチを取り入れる基本的な考え方と実装例をご紹介しました。Desired StateをYAMLなどの構造化データで定義し、Jinja2テンプレートで機器設定を生成し、NetmikoやNAPALMといったライブラリを用いて機器への投入と状態検証を行うことで、冪等性が高く保守性の良い自動化スクリプトを構築することが可能です。

このアプローチは、ネットワーク自動化を単なるタスク実行から、システム全体の状態管理の一部へと昇華させます。インフラ自動化や開発の経験を持つ皆様にとって、ネットワーク機器の設定管理をIaCの枠組みに組み込むことは、全体の効率と信頼性を向上させる上で非常に価値のあるスキルとなるでしょう。

今後は、より複雑な設定のコード化、大規模環境におけるインベントリ管理や並列実行、さらにはイベント駆動型の自動応答システムなど、さらに発展的なトピックにも触れていければと考えております。まずは、手元の環境で簡単な設定のコード化と状態検証から試してみてはいかがでしょうか。