「シリアルコンソール」の版間の差分

提供: ArchWiki
ナビゲーションに移動 検索に移動
 
(2人の利用者による、間の12版が非表示)
9行目: 9行目:
 
以下の設定では GRUB のメニュー選択とブートメッセージを有効にしてシリアルコンソールに端末を転送します。
 
以下の設定では GRUB のメニュー選択とブートメッセージを有効にしてシリアルコンソールに端末を転送します。
   
  +
==接続先のマシンのコンソールを設定==
==設定==
 
   
  +
=== ブートローダー ===
===接続先のマシンのコンソールを設定===
 
   
====GRUB2 systemd====
+
==== GRUB ====
   
  +
生成された {{ic|grub.cfg}} で [[GRUB]] を使用する場合、{{ic|/etc/default/grub}} を編集し、シリアル入出力サポートを有効にします。
GRUB2 でシリアルコンソールを設定する場合、systemd によってデフォルトで getty リスナーが同一のシリアルデバイスに作成されます。grub からシリアルコンソールが使えるようにするには {{ic|/etc/default/grub}} をエディタで開いてください。{{ic|GRUB_CMDLINE_DEFAULT}} 行を変更して {{ic|/dev/ttyS0}} でコンソールを起動してください。tty0 とシリアルポートでコンソールを立ち上げる例:
 
GRUB_CMDLINE_LINUX_DEFAULT="console=tty0 console=ttyS0,38400n8"
 
   
  +
{{hc|/etc/default/grub|2=
シリアルコンソールを有効にするにはコンソールのコマンドを指定する必要があります (Linux カーネルと同じように、grub ではターミナルの入出力を複数記述できます。例: {{ic|<nowiki>GRUB_TERMINAL="console serial"</nowiki>}}:
 
  +
...
  +
GRUB_TERMINAL_INPUT="console serial"
  +
...
  +
GRUB_TERMINAL_OUTPUT="gfxterm serial"
  +
...
  +
}}
   
  +
次に {{ic|GRUB_SERIAL_COMMAND}} 変数を追加し、シリアル接続のオプションを設定します。 COM1 ({{ic|/dev/ttyS0}}) のボーレートが 115200 ビット/秒の場合:
## Serial console
 
GRUB_TERMINAL=serial
 
GRUB_SERIAL_COMMAND="serial --speed=38400 --unit=0 --word=8 --parity=no --stop=1"
 
   
  +
{{hc|/etc/default/grub|2=
以下のコマンドで {{ic|grub.cfg}} ファイルを再生成してください:
 
  +
...
# grub-mkconfig -o /boot/grub/grub.cfg
 
  +
GRUB_SERIAL_COMMAND="serial --unit=0 --speed=115200"
  +
}}
   
  +
利用可能なオプションの詳細な説明については、[https://www.gnu.org/software/grub/manual/grub/grub.html#Serial-terminal Using GRUB via a serial line] および [https://www.gnu.org/software/grub/manual/grub/grub.html#serial serial command] を参照してください。
再起動後、getty は {{ic|/dev/ttyS0}} を listen するようになります。38400 ボーで、パリティビットを使わずストップビットを1個使用する、8 データビットで接続します。Arch が起動すると systemd が自動的に getty セッションを同一設定の同一デバイスで起動します。
 
   
=====GRUB2 を使わず systemd だけを使用=====
+
==== GRUB Legacy ====
GRUB2 を設定してシリアルコンソールを使う場合にはこのセクションは無視してください。起動後に getty だけ listen させたい場合に以下の手順に従ってください。
 
   
  +
[[GRUB Legacy]] 設定ファイル {{ic|/boot/grub/menu.lst}} を編集し、次の行を設定の一般領域に追加します。
systemctl を使って getty を {{ic|/dev/ttyS0}} で起動:
 
   
  +
serial --unit=0 --speed=9600
# systemctl start getty@ttyS0.service
 
  +
terminal --timeout=5 serial console
   
  +
{{Note|{{ic|1=terminal --timeout=5 Serial console}} 行が {{ic|menu.lst}} に追加されると、ブートシーケンスに一連の {{ic|Press any key to continue}} メッセージが表示されるようになります。キーが押されていない場合、ブートメニューは、{{ic|terminal}} 設定行の最初に表示される方 (シリアルまたはコンソール) に表示されます。}}
systemctl を使って getty の速度を確認できます (38400 8N1 になるはずです):
 
   
  +
==== rEFInd ====
# systemctl status serial-getty@ttyS0.service
 
   
  +
[[rEFInd]] はテキストモードでのみシリアルコンソールをサポートします。{{ic|refind.conf}} を編集し、{{ic|textonly}} のコメントを解除します。
起動時に毎回 getty で {{ic|/dev/ttyS0}} を listen するには、サービスを有効化します:
 
   
  +
==== Syslinux ====
# systemctl enable serial-getty@ttyS0.service
 
   
  +
[[Syslinux]] でシリアルコンソールを有効にするには、{{ic|syslinux.cfg}} を編集し、構成ファイルの最初のディレクティブとして {{ic|SERIAL}} を追加します。
====GRUB v1 だけを使って systemd を使用しない====
 
GRUB の設定ファイル {{ic|/boot/grub/menu.lst}} を編集して以下の行を追加してください:
 
   
  +
ボーレート 115200 bit/s の COM1 ({{ic|/dev/ttyS0}}) の場合:
serial --unit=0 --speed=9600
 
terminal --timeout=5 serial console
 
   
  +
SERIAL 0 115200
kernel 行の末尾に適切なコンソールパラメータを追加 (必要であればシリアルデバイスの名前やボーレートを変更してください):
 
   
  +
シリアルパラメータは 8 ビット、パリティなし、1 ストップビットにハードコーディングされています。[https://wiki.syslinux.org/wiki/index.php/SYSLINUX#SERIAL_port_.5Bbaudrate_.5Bflowcontrol.5D.5D] ディレクティブのオプションについては、[https://wiki.syslinux.org/wiki/index.php?title=Config#SERIAL Syslinux Wiki:Config#SERIAL] を参照してください。
console=tty0 console=ttyS0,9600
 
   
  +
=== カーネル ===
編集すると kernel 行は以下のようになります:
 
   
  +
カーネルの出力は、{{ic|1=console=}} [[カーネルパラメータ]] を設定することでシリアルコンソールに送信できます。最後に指定された {{ic|1=console=}} は、{{ic|/dev/console}} として設定されます。
kernel /vmlinuz-linux root=/dev/md0 ro md=0,/dev/sda3,/dev/sdb3 vga=773 console=tty0 console=ttyS0,9600
 
   
  +
console=tty0 console=ttyS0,115200
{{ic|<nowiki>terminal --timeout=5 serial console</nowiki>}} 行を {{ic|menu.lst}} に追加すると、起動画面で "Press any key to continue" メッセージが表示されるようになります。何もキーを押さないと、ブートメニューは 'terminal' 行に先に設定したほう (serial または console) に表示されます。以下のようにメッセージが表示されます:
 
   
  +
https://docs.kernel.org/admin-guide/serial-console.html を参照してください。
Press any key to continue.
 
Press any key to continue.
 
Press any key to continue.
 
Press any key to continue.
 
Press any key to continue.
 
Press any key to continue.
 
Press any key to continue.
 
   
  +
=== getty ===
そして {{ic|/etc/inittab}} を編集して末尾に新しく agetty の行を追加します:
 
   
  +
起動時に、{{man|8|systemd-getty-generator}} は、カーネルコマンドラインで指定された各コンソールの [[getty]] インスタンスを起動します。
c0:2345:respawn:/sbin/agetty 9600 ttyS0 linux
 
   
  +
カーネルコマンドラインで {{ic|1=console=}} を設定していない場合は、{{ic|serial-getty@''device''.service}} を [[起動]] します。{{ic|/dev/ttyS0}} (COM1) の場合、{{ic|serial-getty@ttyS0.service}} になります。
{{ic|/etc/securetty}} を編集して既存のエントリの下にシリアルコンソールのエントリを追加してください:
 
  +
サービスを [[有効化]] して起動時に開始します。
   
  +
カーネルコマンドラインで特に指定がない限り、getty はボーレート 38400ビット/秒、データビット8、パリティなし、ストップビット1回を想定します。
ttyS0
 
 
設定できたら再起動してください。
 
 
{{note|シリアルポートが複数ある場合、上記の設定の代わりに ttyS1 を使うこともできます。}}
 
   
 
==接続==
 
==接続==
135行目: 129行目:
 
==== tinyserial ====
 
==== tinyserial ====
   
  +
{{pkg|tinyserial}} は、FreeBSD 'tip' からインスピレーションを得た、Linux 上のシリアルポートにアクセスするための {{pkg|minicom}} の代替品です。
{{pkg|tinyserial}} is a {{pkg|minicom}} replacement for accessing serial ports on Linux inspired by FreeBSD 'tip'.
 
   
 
$ com /dev/ttyS0 9600
 
$ com /dev/ttyS0 9600
  +
  +
==== tio ====
  +
  +
{{AUR|tio}} は、簡単なコマンドラインと設定ファイルインターフェイスを備えたシンプルなシリアルデバイスツールです、基本的な I/O 操作のためにシリアル TTY デバイスに簡単に接続できます。従来の端末/モデム機能にはあまり重点を置かず、組み込み開発者やハッカーのニーズに重点を置いています。tio は元々、tmux と組み合わせて使用​​した場合に、シリアルデバイスに接続するための画面を置き換えるために作成されました。
  +
  +
$ tio /dev/ttyUSB0
   
 
=== グラフィカルフロントエンド ===
 
=== グラフィカルフロントエンド ===
164行目: 164行目:
 
* このガイドでは例としてポート速度を 9600 としていますが、もっと高い値を使うことが推奨されます (Minicom で 'Ctrl-A' を押してから 'P' を押すことで利用可能な速度を確認できます)。}}
 
* このガイドでは例としてポート速度を 9600 としていますが、もっと高い値を使うことが推奨されます (Minicom で 'Ctrl-A' を押してから 'P' を押すことで利用可能な速度を確認できます)。}}
   
  +
== シリアルコンソールを使用した応答しないマシンのデバッグ ==
== Debugging an unresponsive machine using a serial console ==
 
   
  +
[https://lists.archlinux.org/archives/list/arch-general@lists.archlinux.org/message/R3B32YF5EBKZCYF3TGKG6WTDONQ6RFS4/] には簡潔な説明しかありませんが、シーン全体が示されています。ここで、テスト対象のマシンが再現可能な方法で応答しなくなったことに注意することが重要です。そしてそれは通常の運用中に起こったということです。そのため、デバッグが必要になる前に通常どおりにアクセスできました。ただし、一般に、シリアルコンソールはブートの問題のデバッグにも役立ちます。おそらく、マシンの起動時に手動でブートローダーのによります。このセクションの外部リンクの PS 段落内で言及されている [[netconsole]] にも注意してください。
Even though [https://lists.archlinux.org/archives/list/arch-general@lists.archlinux.org/message/R3B32YF5EBKZCYF3TGKG6WTDONQ6RFS4/] has only raw and terse instructions, it presents the full scene. It is important to note that here, the machine under test got unresponsive in a reproducible manner. And that it happened during normal operation. So it could be accessed normally before it needed debugging. However, in general, the serial console is also useful for debugging boot issues. Perhaps by configuring the boot loader by hand at machine startup time. Also note the mentioned [[netconsole]] within the P.S paragraph of the external link from this section.
 
   
 
==トラブルシューティング==
 
==トラブルシューティング==
201行目: 201行目:
 
}</nowiki>}}
 
}</nowiki>}}
   
  +
=== マルチポート拡張カードにポートがありません ===
=== Missing ports on multi-port expansion cards ===
 
 
{{Expansion|Can the kernel module option be set in {{man|5|modprobe.d}}?}}
 
   
  +
デフォルトのカーネル構成で汎用 8250 ドライバーを使用するシリアルポートの数は、実行時に 4 に設定され、最大は 32 になります。これにより、{{ic|/dev/ttyS4}} 以上の作成が防止されます。マザーボード上の一般的な内蔵シリアルポートを数えると、4 ポート拡張カードの 4 番目のシリアルポートは使用できなくなります。
The number of serial ports using the generic 8250 driver on the default kernel configuration is set to 4 at runtime with a maximum of 32. This will prevent the creation of {{ic|/dev/ttyS4}} and above. Counting the typical built in serial port on the motherboard this prevents the use of the 4th serial port on a 4 port expansion card.
 
   
This can be overridden with the [[kernel parameter]] {{ic|8250.nr_uarts}}. E.g.:
+
これは [[カーネルパラメータ]] {{ic|8250.nr_uarts}} でオーバーライドできます。例えば:
   
 
8250.nr_uarts=5
 
8250.nr_uarts=5

2024年1月24日 (水) 23:30時点における最新版

Arch Linux マシンを設定してシリアルコンソールポート (com ポート) でマシンを接続することができます。キーボードやマウス、モニター、ネットワークが接続されていなくても (ヘッドレスサーバー)、マシンを管理することが可能です。

Arch Linux をシリアルコンソールでインストールすることもできます。

シリアルケーブル (9ピンの接続ケーブル) を使ってマシンを接続されていることが基本条件とします。管理用のマシンはターミナルエミュレータプログラム (PuTTY や Minicom など) が動作するのであれば Unix/Linux あるいは Windows のどちらでもかまいません。

以下の設定では GRUB のメニュー選択とブートメッセージを有効にしてシリアルコンソールに端末を転送します。

接続先のマシンのコンソールを設定

ブートローダー

GRUB

生成された grub.cfgGRUB を使用する場合、/etc/default/grub を編集し、シリアル入出力サポートを有効にします。

/etc/default/grub
...
GRUB_TERMINAL_INPUT="console serial"
...
GRUB_TERMINAL_OUTPUT="gfxterm serial"
...

次に GRUB_SERIAL_COMMAND 変数を追加し、シリアル接続のオプションを設定します。 COM1 (/dev/ttyS0) のボーレートが 115200 ビット/秒の場合:

/etc/default/grub
...
GRUB_SERIAL_COMMAND="serial --unit=0 --speed=115200"

利用可能なオプションの詳細な説明については、Using GRUB via a serial line および serial command を参照してください。

GRUB Legacy

GRUB Legacy 設定ファイル /boot/grub/menu.lst を編集し、次の行を設定の一般領域に追加します。

serial --unit=0 --speed=9600
terminal --timeout=5 serial console
ノート: terminal --timeout=5 Serial console 行が menu.lst に追加されると、ブートシーケンスに一連の Press any key to continue メッセージが表示されるようになります。キーが押されていない場合、ブートメニューは、terminal 設定行の最初に表示される方 (シリアルまたはコンソール) に表示されます。

rEFInd

rEFInd はテキストモードでのみシリアルコンソールをサポートします。refind.conf を編集し、textonly のコメントを解除します。

Syslinux

Syslinux でシリアルコンソールを有効にするには、syslinux.cfg を編集し、構成ファイルの最初のディレクティブとして SERIAL を追加します。

ボーレート 115200 bit/s の COM1 (/dev/ttyS0) の場合:

SERIAL 0 115200

シリアルパラメータは 8 ビット、パリティなし、1 ストップビットにハードコーディングされています。[1] ディレクティブのオプションについては、Syslinux Wiki:Config#SERIAL を参照してください。

カーネル

カーネルの出力は、console= カーネルパラメータ を設定することでシリアルコンソールに送信できます。最後に指定された console= は、/dev/console として設定されます。

console=tty0 console=ttyS0,115200

https://docs.kernel.org/admin-guide/serial-console.html を参照してください。

getty

起動時に、systemd-getty-generator(8) は、カーネルコマンドラインで指定された各コンソールの getty インスタンスを起動します。

カーネルコマンドラインで console= を設定していない場合は、serial-getty@device.service起動 します。/dev/ttyS0 (COM1) の場合、serial-getty@ttyS0.service になります。 サービスを 有効化 して起動時に開始します。

カーネルコマンドラインで特に指定がない限り、getty はボーレート 38400ビット/秒、データビット8、パリティなし、ストップビット1回を想定します。

接続

ターミナルエミュレータプログラムを使って接続

ノート: 接続を行う前に、ユーザーを uucp グループに追加することを推奨します。グループに追加されていない場合、接続するのに root 権限が必要になります。詳しくはユーザーとグループ#ユーザーグループを参照。

dterm

dtermAUR は小さなシリアル接続プログラムです。パラメータを付けずに起動した場合、デフォルトでは /dev/ttyS0 に 9600 ボーで接続します。以下の例は /dev/ttyS0 に 115200 ボーで、パリティビットを使わずストップビットを1個使用する、8 データビットで接続します:

$ dterm 115200 8 n 1

詳しくは ホームページ を見てください。

Minicom

minicom は公式リポジトリからインストールできます。セットアップモードで Minicom を起動:

$ minicom -s

テキストのナビゲーションメニューを使って、以下のようにシリアルポートの設定を変更:

Serial Device: /dev/ttyS0
Bps/Par/Bits: 9600 8N1

Enter を押してメニューを終了してください (Esc を押した場合、変更が保存されません)。モデムには接続しないため、モデムの Init と Reset の文字列は削除します。Modem and Dialing メニューで Init と Reset 文字列を削除してください。メインメニューから save setup as dfl を選択することで設定が保存されます。マシンにシリアルケーブルを接続したまま minicom を再起動してください。セッションを終了するには Ctrl+A を押してから Ctrl+X を押します。

picocom

picocom は minicom とよく似ている小さなダム端末エミュレーションプログラムです。以下の例は ttyS0 に 9600 bps で接続します:

$ picocom -b 9600 /dev/ttyS0
ノート: バックスペースキーが上手く動作しない場合、次のオプションを試してみてください: '--omap delbs'。

詳しい使い方はマニュアルを見てください。

Screen

screen はシリアルポートに接続することができます。デフォルトでは 9600 ボーで接続します:

$ screen /dev/ttyS0

コマンドラインからボーレート (例: 115200) を指定できます:

$ screen /dev/ttyS0 115200

Serialclient

Serialclient は Ruby で書かれたシリアル接続 CLI クライアントです [2]Gem を使ってインストールしてください。

以下のようにして使うことが可能です:

$ serialclient -p /dev/ttyS0

tinyserial

tinyserial は、FreeBSD 'tip' からインスピレーションを得た、Linux 上のシリアルポートにアクセスするための minicom の代替品です。

$ com /dev/ttyS0 9600

tio

tioAUR は、簡単なコマンドラインと設定ファイルインターフェイスを備えたシンプルなシリアルデバイスツールです、基本的な I/O 操作のためにシリアル TTY デバイスに簡単に接続できます。従来の端末/モデム機能にはあまり重点を置かず、組み込み開発者やハッカーのニーズに重点を置いています。tio は元々、tmux と組み合わせて使用​​した場合に、シリアルデバイスに接続するための画面を置き換えるために作成されました。

$ tio /dev/ttyUSB0

グラフィカルフロントエンド

  • cutecomAUR は gui で使えるシリアルモニターです。
  • putty は Linux からでも使うことができます。
  • moserial は gtk ベースのシリアルターミナルです。組み込み環境や試験装置、シリアルコンソールを使う必要がある技術者やハードウェアハッカー用に作られています。

Windows

Windows マシンでは PuTTYTerminalbpp などのプログラムを使ってシリアルポートに接続してください。

シリアルコンソールを使って Arch Linux をインストール

ノート: Arch Linux の月次リリースのインストール CD のブートローダーは 0 ポート (ttyS0/COM1) を 38400 bps、パリティビットを使わずストップビットを1個使用する、8 データビットで listen するように設定されています [3]
  1. 上に書かれている方法でインストールを行うマシンに接続。
  2. Arch Linux インストール CD を使ってマシンを起動。
  3. ブートローダーが表示されたら Boot Arch Linux (<arch>) を選択して Tab を押してエントリを編集。
  4. console=ttyS0,38400 を追加して Enter を押す。
  5. systemd によって ttyS0 が認識されシリアル getty が起動します。root でログインして通常通りにインストールを行ってください。
ノート:
  • セットアップが完了しても、マシンのコンソール設定は保存されません。キーボードとモニターを毎回接続しなくても良いように、再起動する前にマシンの中でコンソールアクセスの設定を行ってください。
  • このガイドでは例としてポート速度を 9600 としていますが、もっと高い値を使うことが推奨されます (Minicom で 'Ctrl-A' を押してから 'P' を押すことで利用可能な速度を確認できます)。

シリアルコンソールを使用した応答しないマシンのデバッグ

[4] には簡潔な説明しかありませんが、シーン全体が示されています。ここで、テスト対象のマシンが再現可能な方法で応答しなくなったことに注意することが重要です。そしてそれは通常の運用中に起こったということです。そのため、デバッグが必要になる前に通常どおりにアクセスできました。ただし、一般に、シリアルコンソールはブートの問題のデバッグにも役立ちます。おそらく、マシンの起動時に手動でブートローダーのによります。このセクションの外部リンクの PS 段落内で言及されている netconsole にも注意してください。

トラブルシューティング

Ctrl-C と Minicom

minicom で Control-C コマンドを送ったときに問題が起こる場合、デバイス設定 (minicom -s) でハードウェアフロー制御をオフにしてください。ブレークが有効になります。

ターミナルのサイズ変更

ssh と異なり、シリアル接続にはターミナルのサイズを変更したときに SIGWINCH を転送する機能がありません。そのため、ターミナルウィンドウのサイズを変更したときにフルスクリーンプログラム (例: less) で表示が崩れてしまいます。

解決方法として stty でターミナルのサイズを変えることができます:

$ stty rows lines cols columns

ただし上記の方法ではサイズを手動で入力する必要があります。以下の方法でサイズ変更を簡単にすることができます。

1. xterm に付属している知名度の低いユーティリティ resize で問題を解決できます。ターミナルエミュレータのウィンドウのサイズを変更した後にパラメータを付けずに起動してください:

$ resize

2. xterm をインストールしたくない場合、シンプルなシェル関数で同じことができます。以下の関数をシェルの設定ファイルに記述して、パラメータを付けずに実行してください:

rsz() {
	if [[ -t 0 && $# -eq 0 ]];then
		local IFS='[;' escape geometry x y
		print -n '\e7\e[r\e[999;999H\e[6n\e8'
		read -sd R escape geometry
		x=${geometry##*;} y=${geometry%%;*}
		if [[ ${COLUMNS} -eq ${x} && ${LINES} -eq ${y} ]];then
			print "${TERM} ${x}x${y}"
		else
			print "${COLUMNS}x${LINES} -> ${x}x${y}"
			stty cols ${x} rows ${y}
		fi
	else
		[[ -n ${commands[repo-elephant]} ]] && repo-elephant || print 'Usage: rsz'  ## Easter egg here :)
	fi
}

マルチポート拡張カードにポートがありません

デフォルトのカーネル構成で汎用 8250 ドライバーを使用するシリアルポートの数は、実行時に 4 に設定され、最大は 32 になります。これにより、/dev/ttyS4 以上の作成が防止されます。マザーボード上の一般的な内蔵シリアルポートを数えると、4 ポート拡張カードの 4 番目のシリアルポートは使用できなくなります。

これは カーネルパラメータ 8250.nr_uarts でオーバーライドできます。例えば:

8250.nr_uarts=5