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