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

現場で使える！Pythonによるネットワーク機器とのファイル転送自動化（SCP/SFTP）

はじめに

ネットワーク機器の運用において、設定ファイルの配布、ログファイルの収集、あるいはスクリプトやファームウェアの転送といったファイル操作は日常的に発生します。これらの作業をCLI（Command Line Interface）を手動で行うことは、時間がかかるだけでなく、オペレーションミスを引き起こすリスクも伴います。特に、多数の機器に対して定型的なファイル操作を行う場合、その非効率性は顕著になります。

Pythonを活用したネットワーク自動化は、こうした課題を解決する強力な手段です。Pythonの豊富なライブラリを利用することで、ネットワーク機器とのインタラクションをプログラムから制御し、ファイル転送を含む様々なタスクを効率化できます。

この記事では、Pythonを用いてネットワーク機器との間でファイルを安全に転送する方法に焦点を当てます。具体的には、SSH上で動作する安全なファイル転送プロトコルであるSCP（Secure Copy）とSFTP（SSH File Transfer Protocol）を利用した自動化スクリプトの作成方法を解説します。現場での利用を想定し、基本的な転送方法から、エラーハンドリング、認証情報の安全な管理方法、そして他の自動化ツールとの連携についても触れていきます。

なぜSCP/SFTPか？

ネットワーク機器とのファイル転送プロトコルには、TFTP（Trivial File Transfer Protocol）のような古くから利用されているものも存在します。しかし、TFTPは認証や暗号化の機能を持たないため、セキュリティ上のリスクが高いという欠点があります。

一方、SCPとSFTPはどちらもSSHプロトコル上で動作します。SSHは、通信経路を暗号化し、ユーザー認証を行うため、ファイルの機密性や完全性を保護できます。多くの現代的なネットワーク機器がSSHをサポートしており、それに付随してSCPやSFTPも利用可能です。これらのプロトコルを利用することで、安全性の高いファイル転送自動化を実現できます。

SCPはシンプルで高速なファイル転送に適しており、SFTPはより高機能でディレクトリ操作なども可能です。Pythonからこれらのプロトコルを扱うためのライブラリが提供されています。

Pythonライブラリの選択

PythonでSCP/SFTPを扱うための主要なライブラリとしては、paramikoが挙げられます。paramikoはPythonでSSHv2プロトコルを実装しており、SSH接続だけでなく、SCPやSFTPのクライアント機能も提供しています。低レベルな操作が可能で柔軟性が高いのが特徴です。

ネットワーク機器の自動化に特化したライブラリであるNetmikoも、内部でparamikoを使用しており、簡易的なSCP転送機能を提供しています。ネットワーク機器へのコマンド実行と組み合わせてファイル転送を行いたい場合には、Netmikoが便利です。

本記事では、より汎用的なparamikoを使ったファイル転送を中心に解説し、Netmikoでの利用方法にも触れます。

paramikoを使ったSCPファイル転送

まずはparamikoを使ったSCPによるファイル転送方法を見ていきましょう。

ライブラリのインストール

paramikoはpipでインストールできます。

pip install paramiko

SCPClientを利用したファイルのアップロード

paramikoでSCP転送を行うには、SSH接続を確立した後、そのSSHClientオブジェクトからparamiko.SCPClientを生成して利用します。

import paramiko
import paramiko.ssh_exception
import scp
import os

# 接続情報
hostname = 'your_network_device_ip'
port = 22
username = 'your_username'
password = 'your_password' # 実際のコードでは安全な方法で管理することを推奨
local_file_path = 'local_config.txt'
remote_file_path = '/flash/upload_config.txt' # 機器側の保存先パス

# ローカルにアップロードするファイルを作成（例）
with open(local_file_path, 'w') as f:
    f.write("hostname MyDevice\n")
    f.write("interface GigabitEthernet0/1\n")
    f.write("  no shutdown\n")

ssh_client = None
scp_client = None

try:
    # SSHクライアントの作成と接続
    ssh_client = paramiko.SSHClient()
    ssh_client.set_missing_host_key_policy(paramiko.AutoAddPolicy()) # 非本番環境向け、本番ではKnownHostsを推奨

    print(f"Connecting to {hostname}...")
    ssh_client.connect(hostname, port=port, username=username, password=password, timeout=10)
    print("Connected successfully.")

    # SCPClientの作成
    scp_client = scp.SCPClient(ssh_client.get_transport())

    # ファイルのアップロード
    print(f"Uploading {local_file_path} to {remote_file_path}...")
    scp_client.put(local_file_path, remote_path=remote_file_path)
    print("Upload successful.")

except paramiko.ssh_exception.AuthenticationException:
    print("Authentication failed. Please check your username and password.")
except paramiko.ssh_exception.NoAuthenticationMethodsAvailable:
     print("No authentication methods available for the given username.")
except paramiko.ssh_exception.SSHException as e:
    print(f"SSH error occurred: {e}")
except scp.SCPException as e:
    print(f"SCP error occurred: {e}")
except FileNotFoundError:
    print(f"Local file not found: {local_file_path}")
except Exception as e:
    print(f"An unexpected error occurred: {e}")

finally:
    # クライアントのクローズ
    if scp_client:
        scp_client.close()
    if ssh_client:
        ssh_client.close()
    print("Connection closed.")

# 例として作成したローカルファイルを削除
if os.path.exists(local_file_path):
    os.remove(local_file_path)

このコードは、指定されたホストにSSH接続し、local_config.txtというローカルファイルを機器の/flash/upload_config.txtというパスにアップロードする例です。scp.SCPClientを利用するには、別途scpライブラリのインストールが必要な場合があります（pip install scp）。

paramiko.AutoAddPolicy()は、初めて接続するホストのキーを自動的にknown_hostsファイルに追加する設定です。これは開発や検証には便利ですが、本番環境ではセキュリティリスクを伴うため、事前にホストキーを取得してknown_hostsファイルに登録しておくか、別のポリシーを使用することを強く推奨します。

エラーハンドリングとして、認証エラー、SSHエラー、SCPエラー、ファイルが見つからない場合などを捕捉しています。接続や転送処理中には様々な問題が発生しうるため、適切なエラー処理は自動化スクリプトにおいて非常に重要です。

SCPClientを利用したファイルのダウンロード

次に、機器からローカルにファイルをダウンロードする例です。

import paramiko
import paramiko.ssh_exception
import scp
import os

# 接続情報
hostname = 'your_network_device_ip'
port = 22
username = 'your_username'
password = 'your_password' # 実際のコードでは安全な方法で管理することを推奨
remote_file_path = 'running-config' # 機器側のダウンロード元パス（例: IOS-XEのrunning-config）
local_file_path = 'downloaded_config.txt' # ローカルの保存先パス

ssh_client = None
scp_client = None

try:
    # SSHクライアントの作成と接続
    ssh_client = paramiko.SSHClient()
    ssh_client.set_missing_host_key_policy(paramiko.AutoAddPolicy())

    print(f"Connecting to {hostname}...")
    ssh_client.connect(hostname, port=port, username=username, password=password, timeout=10)
    print("Connected successfully.")

    # SCPClientの作成
    scp_client = scp.SCPClient(ssh_client.get_transport())

    # ファイルのダウンロード
    print(f"Downloading {remote_file_path} to {local_file_path}...")
    # recursive=Trueとするとディレクトリを再帰的にダウンロードできます
    scp_client.get(remote_file_path, local_path=local_file_path)
    print("Download successful.")

except paramiko.ssh_exception.AuthenticationException:
    print("Authentication failed. Please check your username and password.")
except paramiko.ssh_exception.NoAuthenticationMethodsAvailable:
     print("No authentication methods available for the given username.")
except paramiko.ssh_exception.SSHException as e:
    print(f"SSH error occurred: {e}")
except scp.SCPException as e:
    print(f"SCP error occurred: {e}")
except Exception as e:
    print(f"An unexpected error occurred: {e}")

finally:
    # クライアントのクローズ
    if scp_client:
        scp_client.close()
    if ssh_client:
        ssh_client.close()
    print("Connection closed.")

この例では、機器からrunning-config（多くの機器で現在の設定が保存されている仮想ファイル）をダウンロードし、downloaded_config.txtとしてローカルに保存しています。getメソッドのlocal_path引数には、ローカルの保存先ディレクトリまたはファイルパスを指定します。

SCPはファイル転送に特化しているため、SFTPのようにディレクトリの作成や一覧表示といった操作は直接は行えません。これらの操作が必要な場合は、SFTPを利用するか、SSH接続でコマンドを実行して行う必要があります。

Netmikoを使ったSCPファイル転送

Netmikoはネットワーク機器とのSSH接続やコマンド実行に特化したライブラリですが、簡易的なSCP転送機能も内蔵しています。特に、ネットワーク機器固有のプロンプト処理などを考慮してくれるため、機器の種類が多い環境ではNetmikoを使う利点があります。

NetmikoのSCP機能を利用するには、ConnectHandlerで接続オブジェクトを作成し、scp_transfer_fileメソッドなどを利用します。

from netmiko import ConnectHandler
from netmiko.ssh_exception import NetmikoTimeoutException, NetmikoAuthenticationException
import os

# 接続情報
device = {
    'device_type': 'cisco_ios', # 機器の種類に合わせて変更
    'host':   'your_network_device_ip',
    'username': 'your_username',
    'password': 'your_password', # 実際のコードでは安全な方法で管理することを推奨
    'port' : 22,
}

local_file_path = 'local_script.py'
remote_file_path = '/flash/run_script.py' # 機器側の保存先パス

# ローカルにアップロードするファイルを作成（例）
with open(local_file_path, 'w') as f:
    f.write("#!/usr/bin/env python\n")
    f.write("print('Hello from device!')\n")

net_connect = None

try:
    print(f"Connecting to {device['host']}...")
    net_connect = ConnectHandler(**device)
    print("Connected successfully.")

    # ファイルのアップロード
    # enable=True は、必要に応じてenableモードに移行するかどうかを制御します
    print(f"Uploading {local_file_path} to {remote_file_path}...")
    transfer_success = net_connect.scp_transfer_file(
        local_file=local_file_path,
        dest_file=remote_file_path,
        file_system="flash:", # 機器のファイルシステムに合わせて変更
        direction="put",
        enable=True
    )

    if transfer_success:
        print("Upload successful.")
    else:
        print("Upload failed.")
        # エラー詳細はNetmikoのログを確認するか、詳細なエラー処理を追加してください

    # 必要に応じて、転送したスクリプトを機器上で実行するコマンドなどを追加
    # output = net_connect.send_command("python /flash/run_script.py")
    # print(f"Script output:\n{output}")


except NetmikoAuthenticationException:
    print("Authentication failed. Please check your username and password.")
except NetmikoTimeoutException:
    print("Connection timed out.")
except Exception as e:
    print(f"An unexpected error occurred: {e}")

finally:
    # クライアントのクローズ
    if net_connect:
        net_connect.disconnect()
    print("Connection closed.")

# 例として作成したローカルファイルを削除
if os.path.exists(local_file_path):
    os.remove(local_file_path)

Netmikoのscp_transfer_fileメソッドは、direction引数でput（アップロード）またはget（ダウンロード）を指定します。また、機器固有のファイルシステム（flash:, bootflash:, disk0:など）を指定できる点が、ネットワーク機器自動化ライブラリらしい便利な機能です。

Netmikoは内部でparamikoを使用しているため、より詳細なSFTP操作を行いたい場合や、特定の高度なSSH/SCP/SFTPオプションが必要な場合は、直接paramikoを利用することを検討してください。

実践的な考慮事項

ファイル転送自動化スクリプトを現場で利用する際には、いくつかの実践的な考慮事項があります。

認証情報の安全な管理

スクリプトの中にユーザー名やパスワードを直接記述することは、セキュリティ上極めて危険です。これらの認証情報は、以下のような安全な方法で管理することを強く推奨します。

• 環境変数: 最もシンプルな方法です。スクリプト実行時に環境変数から認証情報を取得します。
• 外部ファイル: 設定ファイル（YAML, JSONなど）に記述し、適切な権限を設定します。ただし、ファイル自体の保護が必要です。
• シークレット管理ツール: HashiCorp Vault、AWS Secrets Manager、CyberArkなどの専門ツールを利用します。
• SSH Keyベース認証: パスワード認証よりも安全とされており、多くの機器やライブラリがサポートしています。公開鍵を機器に登録し、秘密鍵で認証を行います。

以前の記事「現場で役立つPythonネットワーク自動化：機器認証情報の安全な管理方法」でも解説していますので、ぜひ参考にしてください。

転送後のファイル検証

ファイルを転送した後に、正しく転送されたかを確認することも重要です。

• ファイルサイズ: 機器側のファイルサイズとローカルのファイルサイズを比較する。
• ハッシュ値: ファイルのハッシュ値（MD5, SHA256など）を計算し、両者で一致するかを確認する。
• ファイル内容の確認: テキストファイルであれば、先頭や末尾の数行を読み込んで期待する内容が含まれているか確認する。

複数機器への一括転送

多くの機器に対して同じファイルを配布する場合、単一機器への転送スクリプトをそのままループさせるのは効率的ではありません。このようなケースでは、Nornirのような並列処理をサポートする自動化フレームワークを活用することが有効です。

Nornirは、インベントリ管理とタスクの並列実行機能を持ち、各タスク内でNetmikoやparamikoを使ってファイル転送を実行することで、大規模なファイル配布を効率的に自動化できます。

インフラ自動化ワークフローへの組み込み

ネットワーク機器へのファイル転送は、より大きなインフラ自動化ワークフローの一部として組み込むことが可能です。例えば：

• CI/CDパイプライン: 設定変更を含むアプリケーションのデプロイの一部として、関連するネットワーク機器設定ファイルを配布する。
• IaCツールとの連携: AnsibleなどのIaCツールでネットワーク機器の設定を行う際に、設定ファイルのアップロード処理をPythonスクリプトとして呼び出す。
• 自動バックアップシステム: スケジュールされたタスクとして、定期的に機器から設定ファイルやログファイルをダウンロードし、外部ストレージに保存する。

これらのワークフローにファイル転送を組み込むことで、運用プロセス全体の自動化レベルを高めることができます。

まとめ

この記事では、Pythonのparamikoライブラリを中心に、ネットワーク機器との間でファイルを安全に転送するためのSCP/SFTP活用スクリプトの作成方法を解説しました。また、ネットワーク自動化ライブラリであるNetmikoを使った簡単なファイル転送方法にも触れました。

Pythonを使うことで、SSH上で動作するSCP/SFTPを利用し、設定ファイルの配布やログの収集といったファイル操作を自動化し、手動操作に伴うリスクや非効率性を大幅に削減できます。

ファイル転送自動化スクリプトを現場で利用する際には、認証情報の安全な管理、転送後のファイル検証、そして複数機器への対応といった実践的な考慮が不可欠です。これらの要素を適切に実装することで、より堅牢で信頼性の高い自動化システムを構築できます。

今回紹介したファイル転送スクリプトを基盤として、自動バックアップ、設定ファイル配布、ログ収集・解析といった、様々なネットワーク運用タスクの自動化に応用していくことが可能です。ぜひ、ご自身の環境に合わせてカスタマイズし、日々の業務効率化に役立ててください。