1ISOL(8) System Manager's Manual ISOL(8)
2
6 ipmiutil sol - an IPMI Serial-Over-LAN Console application
7
10 ipmiutil sol [-acdeilorsvwxz -NUPREFJTVY]
11
14 This utility starts an IPMI Serial-Over-LAN console session. A Serial-
15 over-LAN console allows the client to see and modify functions before
16 the OS boots, such as BIOS setup, grub, etc. This utility uses either
17 the IPMI LAN 1.5 or 2.0 SOL interface. The 1.5 SOL interface is spe‐
18 cific to Intel BMCs, while any IPMI 2.0 BMC should support 2.0 SOL.
19 The target system/node must first have these parameters configured
20 before SOL sessions can be started:
21 - [BIOS] serial console redirection parameters,
22 - [IPMI] lan and SOL parameters (see ipmiutil lan or ilan), and
23 - [OS] For Linux, edit grub.conf, inittab, and securetty parameters.
24 Be sure that the baud rate matches in all of the above places. See the
25 ipmiutil UserGuide section 4.8 for details.
26
29 -a Activate the SOL Console session, and enter console mode. Use
30 the escape sequence ('~.') to exit the session.
31 -c '^' Set the escape Character to '^', or another ANSI character.
33 This changes the default two-character escape sequence ('~.') to
34 the specified single escape character, which will end the SOL
35 session.
36 -d Deactivate the SOL Console session. Use this if the previous
38 session was aborted abnormally and starting a new session gives
39 an error.
40 -e Turn Encryption off in negotiation when activating a session.
42 By default, encryption is on for Serial-Over-LAN console ses‐
43 sions.
44 -l Use Legacy BIOS mapping for Enter key (CR+LF) instead of just
46 LF. This is needed for BIOS Setup menus and DOS, but causes an
47 extra LF to occur in Linux. So, only use this option if doing
48 BIOS or DOS changes. This should be seldom be needed since now
49 the default is to automatically detect these menus with colored
50 backgrounds and change the mapping.
51 -i input_file
53 Use this file as an input script. The input_file will be read
54 after the session is established. This can be used to automate
55 certain tasks. The input_file is read one line at a time. If
56 the input_file does not have an escape character (~) to end the
57 session, then the input is returned to the keyboard when the
58 file ends.
59 -o output_file
61 Use a Trace log. The output_file is created and all SOL screen
62 output is written to the file, including VT100 escape sequences.
63 If the output_file exists, the output is appended to it. This
64 can be used to log what the user has done in an SOL session.
65 -r Use Raw terminal I/O instead of custom VT100 to ANSI translation
67 (in Windows). Use this option if the server is configured in
68 BIOS and BMC for ANSI and the utility is being invoked from Win‐
69 dows.
70 -s NNN For a slow link with high latency, this adds a delay of NNN
72 microseconds between sending and receiving SOL packets. The
73 default is 100 microseconds.
74 -w (Windows only) Do not use the Windows Console buffer, but use
76 Windows stdio instead. This does not handle cursor positioning
77 correctly in some cases, however.
78 -v log_file
80 Causes debug messages to be displayed to the specified debug
81 log_file. The default log_file is isoldbg.log in the current
82 directory.
83 -x Causes debug messages to be displayed to the debug log file.
85 -z Causes more verbose debug messages to be displayed to the debug
87 log file.
88 -N nodename
90 Nodename or IP address of the remote target system. If a node‐
91 name is specified, IPMI LAN interface is used. Otherwise the
92 local system management interface is used.
93 -U rmt_user
95 Remote username for the nodename given. The default is a null
96 username.
97 -P/-R rmt_pswd
99 Remote password for the nodename given. The default is a null
100 password.
101 -E Use the remote password from Environment variable IPMI_PASSWORD.
103 -F drv_t
105 Force the driver type to one of the followng: imb, va, open,
106 gnu, landesk, lan, lan2, lan2i, kcs, smb. Note that lan2i means
107 lan2 with intelplus. The default is to detect any supported
108 driver type and use it.
109 -J Use the specified LanPlus cipher suite (0 thru 14):
111 0=none/none/none, 1=sha1/none/none, 2=sha1/sha1/none,
112 3=sha1/sha1/cbc128, 4=sha1/sha1/xrc4_128, 5=sha1/sha1/xrc4_40,
113 6=md5/none/none, ... 14=md5/md5/xrc4_40. Default is 3.
114 -T Use a specified IPMI LAN Authentication Type: 0=None, 1=MD2,
116 2=MD5, 4=Straight Password, 5=OEM.
117 -V Use a specified IPMI LAN privilege level. 1=Callback level,
119 2=User level, 3=Operator level, 4=Administrator level (default),
120 5=OEM level.
121 -Y Yes, do prompt the user for the IPMI LAN remote password.
123 Alternatives for the password are -E or -P.
124
127 ipmiutil sol -a -N nodename -U username -P password
128 Starts an SOL console session to the nodename. Detect the lan proto‐
129 col.
130 ipmiutil sol -a -N nodename -U username -P password -Flan2
132 Starts an SOL console session to the nodename. Force lan protocol to
133 2.0.
134
136 ipmiutil(8) ialarms(8) iconfig(8) icmd(8) idiscover(8) ievents(8)
137 ifru(8) igetevent(8) ihealth(8) ilan(8) ireset(8) isel(8) isensor(8)
138 iserial(8) iwdt(8)
139
142 See http://ipmiutil.sourceforge.net/ for the latest version of ipmiutil
143 and any bug fix list.
144
147 Copyright (C) 2009 Kontron America, Inc.
148 See the file COPYING in the distribution for more details regarding
150 redistribution.
151 This utility is distributed in the hope that it will be useful, but
153 WITHOUT ANY WARRANTY.
154
157 Andy Cress <arcress at users.sourceforge.net>
158 Version 1.1: 17 Feb 2010 ISOL(8)