xref: /openbmc/docs/console.md (revision f4febd00)
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    $ ssh -p 2200 [user]@[bmc-hostname]
16
17## Local console connections
18
19If you're already logged into an OpenBMC machine, you can start a console
20session directly, using:
21
22    $ obmc-console-client
23
24To exit from a console, type:
25
26    return ~ .
27
28Note that if you're on an ssh connection, you'll need to 'escape' the ~
29character, by entering it twice:
30
31    return ~ ~ .
32
33This is because obmc-console-client is an ssh session, and a double `~` is
34required to escape the "inner" (obmc-console-client) ssh session.
35
36## Logging
37
38Console logs are kept in:
39
40    /var/log/obmc-console.log
41
42This log is limited in size, and will wrap after hitting that limit (currently
43set at 16kB).
44