xref: /openbmc/docs/console.md (revision 309abc9187735439077138246f0e657aad902789)
1# OpenBMC host console support
2
3This document describes how to connect to the host UART console from an OpenBMC
4management system.
5
6The console infrastructure allows multiple shared connections to a single host
7UART. UART data from the host is output to all connections, and input from any
8connection is sent to the host.
9
10## Remote console connections
11
12To connect to an OpenBMC console session remotely, just ssh to your BMC on
13port 2200. Use the same login credentials you would for a normal ssh session:
14
15```bash
16ssh -p 2200 [user]@[bmc-hostname]
17```
18
19## Local console connections
20
21If you're already logged into an OpenBMC machine, you can start a console
22session directly, using:
23
24```bash
25obmc-console-client
26```
27
28To exit from a console, type:
29
30```text
31    return ~ .
32```
33
34Note that if you're on an ssh connection, you'll need to 'escape' the ~
35character, by entering it twice:
36
37```text
38    return ~ ~ .
39```
40
41This is because obmc-console-client is an ssh session, and a double `~` is
42required to escape the "inner" (obmc-console-client) ssh session.
43
44## Logging
45
46Console logs are kept in: `/var/log/obmc-console.log`
47
48This log is limited in size, and will wrap after hitting that limit (currently
49set at 16kB).
50