pythonでparamikoを利用してネットワーク機器の設定変更を実施したいが、なぜこのコードで動作しないのか教えてほしい

Question

実現したいこと

pythonで、paramikoでネットワーク機器にSSH接続後に設定変更を行いたい

前提

・ネットワーク機器（fortigate）にアクセスして設定変更を行いたい
・対話型インタプリタだと問題なく実行されるが、コードを記述したファイルから実行すると設定変更が反映されない
・設定変更のコマンド自体が正しい事は確認している

該当のソースコード

IP_ADDRESS = '192.168.1.1'
USER_NAME = 'AAA'
PASSWORD = 'BBB'

# paramikoのインポート
import paramiko

# sshクライアントの作成
client = paramiko.SSHClient()
client.set_missing_host_key_policy(paramiko.WarningPolicy())

# 上記で設定したIPアドレス、ユーザー名、キーファイルを渡す
client.connect(IP_ADDRESS,
                          username=USER_NAME,
                          password=PASSWORD,
                          timeout=5.0)

# コマンド設定
object_name = "test1"
object = "192.168.1.1/24" 

command = f"config firewall address \nedit {object_name} \nset subnet {object} \nend"

# コマンドの実行
stdin, stdout, stderr = client.exec_command(command)

試したこと

・上記を対話型インタプリタで実行すると、問題なく設定変更が反映される
・上記をファイルから実行すると、設定変更が反映されない
・コードの最後にprint(stdout.read())を追加するとファイルから実行してもなぜか設定変更が反映される

Answer 1

exec_command()メソッドは、コマンドの実行を開始した直後に=終了を待たずに返ります。
もし、プログラムがそこで終了してしまっていると、即座にセッションが切れてしまうので、開始されたコマンドが強制的に終了してしまうのです。

対話型で実行している場合、メソッド実行後にもインタープリタは生きているので、セッションは切れません。

また、出力を得るために、stdout.read()を実行すると、コマンドの出力結果を待つことでコマンドが実行されるようになるということです。

---

ちなみに、paramikoはかなり低レベルのAPIでできているので、手動の作業の自動化が目的であれば、もう少し高レベルの pexpectを使ったり、ルータなどのみが対象であればnetmikoあたりを検討するのもいいと思います。
また、pythonプログラムでの制御が目的ということでなければ、ansibleを使うというのもありでしょう。

Answer 2

ChatGPTの回答

質問文は省略

設定変更が反映されない原因は、コマンドの実行後に接続が切断されてしまうためです。これは、exec_command() メソッドがコマンドの実行を非同期で行うためであり、コマンドの完了を待たずに接続を閉じてしまうためです。そのため、コマンドの完了を待つためには、stdout.read() を使用する必要があります。stdout.read() はコマンドの実行を同期的に行うため、コマンドが完了するまで待機し、その後接続を閉じるため、設定変更が反映されるようになります。

以下は、設定変更が反映されるように修正したコード例です。

IP_ADDRESS = '192.168.1.1'
USER_NAME = 'AAA'
PASSWORD = 'BBB'

# paramikoのインポート
import paramiko

# sshクライアントの作成
client = paramiko.SSHClient()
client.set_missing_host_key_policy(paramiko.WarningPolicy())

# 上記で設定したIPアドレス、ユーザー名、キーファイルを渡す
client.connect(IP_ADDRESS,
                          username=USER_NAME,
                          password=PASSWORD,
                          timeout=5.0)

# コマンド設定
object_name = "test1"
object = "192.168.1.1/24" 

command = f"config firewall address \nedit {object_name} \nset subnet {object} \nend"

# コマンドの実行
stdin, stdout, stderr = client.exec_command(command)
output = stdout.read()
print(output)

# 接続の終了
client.close()

上記のコードでは、exec_command() メソッドの出力を stdout.read() で同期的に読み込むことで、コマンドの完了を待ち、設定変更が反映されるようにしています。また、接続を閉じるためには、client.close() を呼び出すことで正しく接続を終了できます。

Comments

[TakaiY]

すごいなChatGPT

[8524ba23]

たまに「息をするように嘘を吐く」こともあるので注意は必要です。