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