docs/s390x: document 3270
[qemu.git] / docs / system / s390x / 3270.rst
blob1774cdcadf01e8ed3473c230aa672719e0332081
1 3270 devices
2 ============
4 QEMU supports connecting an external 3270 terminal emulator (such as
5 ``x3270``) to make a single 3270 device available to a guest. Note that this
6 supports basic features only.
8 To provide a 3270 device to a guest, create a ``x-terminal3270`` linked to
9 a ``tn3270`` chardev. The guest will see a 3270 channel device. In order
10 to actually be able to use it, attach the ``x3270`` emulator to the chardev.
12 Example configuration
13 ---------------------
15 * Add a ``tn3270`` chardev and a ``x-terminal3270`` to the QEMU command line::
17     -chardev socket,id=char_0,host=0.0.0.0,port=2300,nowait,server,tn3270
18     -device x-terminal3270,chardev=char_0,devno=fe.0.000a,id=terminal_0
20 * Start the guest. In the guest, use ``chccwdev -e 0.0.000a`` to enable
21   the device.
23 * On the host, start the ``x3270`` emulator::
25     x3270 <host>:2300
27 * In the guest, locate the 3270 device node under ``/dev/3270/`` (say,
28   ``tty1``) and start a getty on it::
30     systemctl start serial-getty@3270-tty1.service
32 This should get you an addtional tty for logging into the guest.