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

PythonとネットワークAPI（RESTConf/NETConf）で情報取得を自動化：構造化データ活用の実践

Tags: Python, ネットワーク自動化, RESTConf, NETConf, API, requests, 構造化データ

はじめに

近年、ネットワーク機器の運用・管理において自動化の重要性がますます高まっています。特に、既存のインフラ自動化や開発ワークフローにネットワーク操作を組み込みたいと考えるエンジニアにとって、Pythonは非常に強力なツールです。

従来のネットワーク機器操作はCLI（コマンドラインインターフェース）が中心でしたが、CLIは人間が操作することを前提としているため、スクリプトによる自動化では出力のパース（解析）が課題となりがちです。機器やOSバージョンによって出力形式が微妙に異なる場合があり、堅牢なスクリプトを作成するには多くの労力が必要でした。

そこで注目されているのが、ネットワーク機器が提供するAPIを利用した自動化です。特にRESTConfやNETConfといった標準的なAPIは、XMLやJSONといった構造化されたデータ形式で情報を提供するため、Pythonでのデータ処理が容易になります。

本記事では、Pythonを使ってネットワーク機器のRESTConf/NETConf APIから情報を取得し、それを構造化データとして活用する基本的な手法について、具体的なコード例を交えて解説します。CLIからの脱却を図り、より効率的でメンテナンス性の高いネットワーク自動化を目指しましょう。

ネットワークAPI（RESTConf/NETConf）とは

RESTConfとNETConfは、ネットワーク機器の設定や状態の取得、変更などをプログラムから行うための標準化されたプロトコルです。

これらのAPIを利用することで、CLIの出力パースといった煩雑な作業から解放され、直接的に構造化データとして機器の状態や設定を取得できるようになります。

PythonによるネットワークAPI連携の基本

PythonからRESTConfやNETConfを利用するためのライブラリがいくつか存在します。

本記事では、Web APIに馴染みやすいRESTConfを例に、Pythonでの情報取得方法を解説します。

Python requestsライブラリを使ったRESTConf連携

ここでは、requestsライブラリを使って、ネットワーク機器のRESTConf APIからインターフェース情報を取得する例を考えます。多くのネットワーク機器ベンダーは、標準化されたYANGモデルに基づいたAPIを提供しています。YANGモデルは、ネットワーク機器の設定や状態を記述するためのデータモデリング言語です。

前提条件:

コード例：インターフェース情報の取得

import requests
import json
import os

# 認証情報の取得（環境変数から取得することを推奨）
# 本番環境では認証情報をコード内に直書きしないようにしてください。
DEVICE_HOST = "your_device_ip" # 機器のIPアドレスまたはホスト名
RESTCONF_PORT = 443 # RESTConfのポート番号 (HTTPSの場合は443が一般的)
API_USERNAME = os.environ.get("NETWORK_API_USERNAME") # 環境変数から取得
API_PASSWORD = os.environ.get("NETWORK_API_PASSWORD") # 環境変数から取得

# RESTConf APIのエンドポイントURLの構築
# 対象機器や取得したい情報によってURLは異なります。
# ここではietf-interfaces YANGモデルのconfigデータを取得する例とします。
# 実際のパスは機器のドキュメントをご確認ください。
API_URL = f"https://{DEVICE_HOST}:{RESTCONF_PORT}/restconf/data/ietf-interfaces:interfaces"

# リクエストヘッダーの設定
headers = {
    "Accept": "application/yang-data+json", # 応答形式をJSONで要求
    "Content-Type": "application/yang-data+json" # リクエストボディがある場合
}

# SSL証明書の検証設定
# 本番環境では、信頼できるCAが発行した証明書を使用し、検証を有効にすることを強く推奨します。
# 自己署名証明書などで検証を無効にする場合は、セキュリティリスクを理解した上で行ってください。
verify_ssl = False # 例として検証を無効にしていますが、非推奨です

try:
    # Basic認証情報を持つリクエストの送信
    response = requests.get(
        API_URL,
        headers=headers,
        auth=(API_USERNAME, API_PASSWORD),
        verify=verify_ssl # SSL証明書の検証設定
    )

    # レスポンスのステータスコードを確認
    response.raise_for_status() # 200以外のステータスコードの場合は例外発生

    # JSON形式のレスポンスボディを取得
    interface_data = response.json()

    print("--- 取得したインターフェース情報 (JSON形式) ---")
    print(json.dumps(interface_data, indent=4)) # 見やすく整形して出力

    # 構造化データの活用例：特定のインターフェース情報を抽出
    if "ietf-interfaces:interfaces" in interface_data and "interface" in interface_data["ietf-interfaces:interfaces"]:
        print("\n--- 各インターフェースの名前と状態 ---")
        for interface in interface_data["ietf-interfaces:interfaces"]["interface"]:
            name = interface.get("name", "N/A")
            enabled = interface.get("enabled", "N/A")
            oper_status = interface.get("oper-status", "N/A")
            print(f"  Name: {name}, Enabled: {enabled}, Oper Status: {oper_status}")

except requests.exceptions.RequestException as e:
    print(f"APIリクエスト中にエラーが発生しました: {e}")
except json.JSONDecodeError:
    print("API応答がJSON形式ではありませんでした。")
except Exception as e:
    print(f"予期しないエラーが発生しました: {e}")

コードの解説:

  1. requestsライブラリをインポートします。jsonは取得したJSONデータを見やすく整形するために、osは環境変数から認証情報を取得するために使用します。
  2. 接続対象機器のホスト名、ポート番号、API認証情報を設定します。認証情報は環境変数など安全な方法で管理することが非常に重要です。
  3. RESTConf APIのエンドポイントURLを構築します。このURLは、対象機器のベンダーや取得したい情報（YANGモデルのパス）によって異なりますので、必ず機器のAPIドキュメントを参照してください。
  4. リクエストヘッダーでは、Acceptヘッダーで応答データの形式をJSON (application/yang-data+json) で要求します。
  5. requests.get()メソッドを使ってGETリクエストを送信します。auth引数にタプル形式でユーザー名とパスワードを渡すと、Basic認証が行われます。SSL証明書の検証は、セキュリティ上、本番環境では必ず有効にすべきですが、検証方法や自己署名証明書の扱いは環境によって異なるため注意が必要です。
  6. response.raise_for_status()を呼び出すことで、HTTPステータスコードが200番台以外（エラー）だった場合に例外を発生させ、エラーハンドリングを容易にします。
  7. response.json()メソッドで、JSON形式のレスポンスボディをPythonの辞書やリストに変換します。これが構造化データとして取得できる大きなメリットです。
  8. 取得したinterface_data辞書から、必要な情報をキーを指定して簡単に抽出できます。CLI出力のように文字列パースを行う必要がありません。
  9. try...exceptブロックを使って、APIリクエスト中のネットワークエラーや、無効な認証情報によるエラー、API応答がJSON形式でない場合などの例外を適切に処理します。

実践的な考慮事項

構造化データ活用のさらなる可能性

APIから取得した構造化データは、単に表示するだけでなく、様々な用途に活用できます。

これらの活用は、Pythonの強力なデータ処理能力や、pandasなどのライブラリと組み合わせることでさらに発展させることが可能です。

まとめ

本記事では、Pythonとネットワーク機器のAPI（特にRESTConf）を利用して情報を取得し、構造化データとして扱う基本的な手法をご紹介しました。CLIの出力パースに依存しないAPI自動化は、スクリプトのメンテナンス性を向上させ、より効率的なネットワーク運用を実現するための強力な手段となります。

APIが提供する構造化データを活用することで、ネットワークの状態把握、インベントリ管理、監視、設定検証など、様々な自動化タスクをより堅牢かつ柔軟に実現できるようになります。

まずは対象機器のAPIドキュメントを確認し、簡単な情報取得から始めてみてください。Pythonスキルを活かして、ネットワーク自動化の次のステップに進みましょう。今後、APIを使った設定変更や、NETConfを利用した自動化についても記事を公開していく予定です。