pythonのtelnetlibでL3スイッチを操作できない

Question

前提・実現したいこと

Allied Telesis製のL3スイッチに対してpythonのtelnetlibで操作を試みています。

telnetlibのサンプルを参考に、単純なコマンドを実行して結果を出力してみたところ、read_all()にコマンドの結果が出力されませんでした。
途中経過をread_eager()を使用して出力してみましたが何も表示されないため、正常にコマンドを送信できていないのだと思われます。

何が原因かが全くつかめない状況です。
調査方法など、問題を解消できるヒントをいただけないでしょうか。

発生している問題・エラーメッセージ

スクリプトを実行した結果は以下の通りです。
修正後

$ python3 telnet.py
Login:
Login Success
b''
b''
exit

該当のソースコード

# -*- coding:utf-8 -*-
import getpass
import sys
import telnetlib

HOST = "xxx.xxx.xxx.xxx"
#user = input("Enter your remote account: ")
#password = getpass.getpass()
user = b"adminuser"
password = b"dummypassword"

tn = telnetlib.Telnet(HOST)

tn.read_until(b"login: ")
print("Login:")

tn.write(user + b"\n")
if password:
    tn.read_until(b"Password: ")
    tn.write(password + b"\n")
    print("Login Success")

tn.read_until(b'>')

#ページ送り無効
tn.write(b"terminal length 0\n")
print(tn.read_eager())

tn.read_until(b">")


#特権モードへ
tn.write(b"enable\n")

tn.read_until(b"#")

#tn.write(b"show wireless ap status\n")
tn.write(b"show virsion\n")
print(tn.read_eager())

tn.read_until(b"#")
tn.write(b"exit\n")

print(tn.read_all().decode("ascii"))

tn.close()

ご指摘を受けてソースを修正しました。
・tn.read_eager()　が出力されるように修正した
・デバッグ用のメッセージ部分を削除した

ご指摘修正前の出力結果

~/python$ python3 -V
Python 3.6.9

~/python$ python3 telnet.py
Login:
Login Success
プロンプト------------------  >
コマンド実行---------------- terminal length 0
特権モード------------------ enable
プロンプト------------------ #
コマンド実行---------------- show version
コマンド実行 ----------------------- exit
reslut-----------------------------------------------
exit

ご指摘修正前のソース

# -*- coding:utf-8 -*-
import getpass
import sys
import telnetlib

HOST = "xxx.xxx.xxx.xxx"
#user = input("Enter your remote account: ")
#password = getpass.getpass()
user = b"adminuser"
password = b"dummypassword"

tn = telnetlib.Telnet(HOST)

tn.read_until(b"login: ")
print("Login:")

tn.write(user + b"\n")
if password:
    tn.read_until(b"Password: ")
    tn.write(password + b"\n")
    print("Login Success")

tn.read_until(b'>') # コマンドを実行する直前まで読み飛ばす
print("プロンプト------------------  >")

#ページ送り無効
tn.write(b"terminal length 0\n")
tn.read_eager()

tn.read_until(b'>')
print("コマンド実行---------------- terminal length 0")


#特権モードへ
tn.write(b"enable\n")
print("特権モード------------------ enable")

tn.read_until(b"#")
print("プロンプト------------------ #")

#tn.write(b"show wireless ap status\n")
tn.write(b"show virsion\n")
tn.read_eager()
print("コマンド実行---------------- show version")

tn.read_until(b'#')
tn.write(b"exit\n")
print("コマンド実行 ----------------------- exit")

#result = tn.read_all().decode("ascii")
print("reslut-----------------------------------------------")
print(tn.read_all().decode('ascii'))

tn.close()

試したこと

Windows からTeraTearm や 今回操作しているクライアントPCからTelnetクライアントで接続し、該当のコマンドを操作してみましたが、問題なく操作できました。
操作しているスイッチ固有の問題ではないかと考えていますが、検索して近い事象は見当たりませんでした。

補足情報（FW/ツールのバージョンなど）

Ubuntu 18.04.5 LTS
Python 3.6.9

Answer 1

アドバイスをいただいた結果、pexpectに挑戦してみたところうまくいきました。

import pexpect
import sys

child  = pexpect.spawn("telnet xxx.xxx.xxx.xxx")
child .logfile_read = sys.stdout.buffer

print("-------------")
#ログイン
child .expect("login: ")
child .send("adminuser\n")
child .expect("Password: ")
child .send("dummypassword\n")
child .expect(">")

#ページ送り無効
child .send("terminal length 0\n")
child .expect(">")

#管理者モードへ
child .send("enable\n")
child .expect("#")

child .send("show version\n")
child .expect("#")

child .send("disable\n")
child .expect(">")

#終了
child .send("exit\n")
child .expect(pexpect.EOF)
print("-------------")
print("終了")

以下実行結果です。

$ python3 telnet.py
-------------
Trying xxx.xxx.xxx.xxx...
Connected to xxx.xxx.xxx.xxx.
Escape character is '^]'.
NAGOYA-x8106 login: adminuser
Password:
Last login: Wed Mar 17 19:54:05 JST 2021 from 10.10.50.181

AlliedWare Plus (TM) 5.4.5 12/17/15 03:26:06


中略


SWITCH-NAME#disable
SWITCH-NAME>exit
Connection closed by foreign host.
<class 'pexpect.exceptions.EOF'>
Done!
-------------

Answer 2

tn.read_eager()de出力を読込んでますが、結果をどこでも出力していないからじゃないかと思います。

試してみてないですが、

res = tn.read_eager().decode('ascii')
print(res)

のような感じです。 read_eager でなく他の、read_xxx で試してみる必要があるかもしれません。

Comments

[sumou_sumou]

ご指摘ありがとうございます。うっかりしていました。
ただ、一番の問題はread_allした結果がコマンドの実行結果が表示されず、『exit』としか表示されていないことなのです。

ご指摘いただいた部分を修正し、余計なメッセージを全部消した結果は次の通りです。
途中経過も b''が出力されているところから、必要なコマンドを正しく送信できていないという事でしょうか。

・tn.read_eager()　が出力されるように修正した
・デバッグ用のメッセージ部分を削除した

↓↓↓出力結果↓↓↓
~/python$ python3 telnet.py
Login:
Login Success
b''
b''
exit

[TakaiY]

read_eager() はその時点までに出力されているものを取得して表示するものです。その時点で何も出力されていなければ、待たずに空を返します。
なので、コマンド実行直後にはまだ結果が出ていないのかもしれません。
スリープを入れるとか、タイムアウト付きのread_xxx を使うなどしてみるとどうでしょうか。

[sumou_sumou]

スリープを入れたところ、read_eager()で値が表示されました。

コマンド入力後のプロンプトが 『switch_name>』もしくは『switch_name#』になるため、read_until()を入れていたのですが、正しく拾えていないようでした。

read_until()が正しく動作しないのは困りものですが、とりあえず目的は果たせたので、解決済みといたします。

ありがとうございました。

[TakaiY]

read_until() を使った場合のコードを提示いただければ、何かアドバイスできるかもしれません。

[sumou_sumou]

ありがとうございます。実際に試してみたコードは次の通りです。
sleepを入れることで、ログインまでは正常動作しているようなのでsleepは入れたままになっています。

『terminal length 0』を送った後のread_untile()で停止しました。
Ubuntuのターミナルでスクリプトを実行しているのですが、ターミナルのカーソルが点滅から点灯に変わったので、異常動作しているのではないかと思います。

↓↓↓該当のソース↓↓↓
import telnetlib
import time
import re
import csv

HOST = "XX.XX.XX.XX"
user = b"adminuser"
password = b"dummypassword"

#スリープ
def wait(waittime: int):
time.sleep(waittime)

#ホストに接続
tn = telnetlib.Telnet(HOST)
tn.read_until(b"login: ")
print("Login:")
wait(5)

tn.write(user + b"\n")
if password:
tn.read_until(b"Password: ")
tn.write(password + b"\n")
print("Login Success")
wait(5)

#ページ送り無効
tn.write(b"terminal length 0\n")
tn.read_until(b">")

#以下いずれの場合もダメでした
#tn.read_until(b"SWITCH-name001>")
#tn.read_until(b".+>")
#tn.read_until(b"[A-Za-z0-9-]+>")

#管理者モードへ
tn.write(b"enable\n")
tn.read_until(b"[A-Za-z0-9-]+>")

tn.write(b"show wireless ap status\n")
result = tn.read_until(b"[A-Za-z0-9-]+#").decode(encoding='utf-8')

tn.write(b"exit\n")
tn.close()
print(result)

[TakaiY]

止っているということですが、そこまでの動作が想定どおりなのを確認するのがいいのではないかと思います。

パスワードを投入してログインに成功しているでしょうか？
そのタイミングでread_eager()をして取得できた文字列を確認してみるのはどうでしょう。

リモートとの対話的通信では、想定している応答がちゃんと来ているか確認しながら進めるのが大切だと思います。

また、いまさらですが、こういう対話形式の処理をするのであれば、pexpectというモジュールがもう少し高機能なので使いやすいと思います。
また、pythonにこだわらないのであれば、本家のexpect(https://core.tcl-lang.org/expect/index)がより使いやすいです。tclがベースなので慣れないと使いにくいかもしれませんが。

[sumou_sumou]

返信が遅くなり申し訳ございません。
色々と試行錯誤しておりました。
read_eager()で出力する限りは、terminal length 0 を投げ終わるところまではうまくいっているように見受けられました。

質問には直接関係がないと思い記載しなかったのですが、最終的に社内使用するWEBアプリのバックエンドとして考えていました。
expectですとそのあたりのやり取りが面倒だったので、Pythonで作りたかったという理由があります。

pexpectで書き直してみたところ、うまく動作しました。
ありがとうございました。