1ISOL(8)                     System Manager's Manual                    ISOL(8)
2
3
4

NAME

6       ipmiutil_sol - an IPMI Serial-Over-LAN Console application
7
8

SYNOPSIS

10       ipmiutil sol [-acdeilorsvwxz -NUPREFJTVY]
11
12

DESCRIPTION

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
27

OPTIONS

29       -a     Activate the SOL Console session, and enter console  mode.   Use
30              the escape sequence ('~.') to exit the session.
31
32       -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
37       -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
41       -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
45       -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
52       -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
60       -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
66       -p     Port to use.  Defaults to RMCP port 623.
67
68       -r     Use Raw terminal I/O instead of custom VT100 to ANSI translation
69              (in Windows).  Use this option if the server  is  configured  in
70              BIOS and BMC for ANSI and the utility is being invoked from Win‐
71              dows.
72
73       -s NNN For a slow link with high latency, this  adds  a  delay  of  NNN
74              microseconds  between  sending  and  receiving SOL packets.  The
75              default is 100 microseconds.
76
77       -w     (Windows only) Do not use the Windows Console  buffer,  but  use
78              Windows  stdio instead.  This does not handle cursor positioning
79              correctly in some cases, however.
80
81       -v log_file
82              Causes debug messages to be displayed  to  the  specified  debug
83              log_file.   The  default  log_file is isoldbg.log in the current
84              directory.
85
86       -x     Causes debug messages to be displayed to the debug log file.
87
88       -z     Causes more verbose debug messages to be displayed to the  debug
89              log file.
90
91       -N nodename
92              Nodename  or IP address of the remote target system.  If a node‐
93              name is specified, IPMI LAN interface is  used.   Otherwise  the
94              local system management interface is used.
95
96       -U rmt_user
97              Remote  username  for the nodename given.  The default is a null
98              username.
99
100       -P/-R rmt_pswd
101              Remote password for the nodename given.  The default is  a  null
102              password.
103
104       -E     Use the remote password from Environment variable IPMI_PASSWORD.
105
106       -F drv_t
107              Force  the  driver  type  to one of the followng: imb, va, open,
108              gnu, landesk, lan, lan2, lan2i, kcs, smb.  Note that lan2i means
109              lan2  with  intelplus.   The  default is to detect any supported
110              driver type and use it.
111
112       -J     Use  the  specified  LanPlus   cipher   suite   (0   thru   17):
113              0=none/none/none,       1=sha1/none/none,      2=sha1/sha1/none,
114              3=sha1/sha1/cbc128,  4=sha1/sha1/xrc4_128,  5=sha1/sha1/xrc4_40,
115              6=md5/none/none, ... 14=md5/md5/xrc4_40.  Default is 3.
116
117       -T     Use  a  specified  IPMI  LAN Authentication Type: 0=None, 1=MD2,
118              2=MD5, 4=Straight Password, 5=OEM.
119
120       -V     Use a specified IPMI  LAN  privilege  level.  1=Callback  level,
121              2=User level, 3=Operator level, 4=Administrator level (default),
122              5=OEM level.
123
124       -Y     Yes, do prompt the  user  for  the  IPMI  LAN  remote  password.
125              Alternatives for the password are -E or -P.
126
127

EXAMPLES

129       ipmiutil sol -a -N nodename -U username -P password
130       Starts  an  SOL console session to the nodename.  Detect the lan proto‐
131       col.
132
133       ipmiutil sol -a -N nodename -U username -P password  -Flan2
134       Starts an SOL console session to the nodename.  Force lan  protocol  to
135       2.0.
136

PLATFORM SERIAL PORT CONFIGURATION EXAMPLES

138       First,  enter  BIOS  Setup  for  Serial Console Redirection parameters:
139       (these vary by platform)
140         Console Redirection = Serial Port B
141         ACPI Redirection = Disabled
142         Baud Rate = 115.2K
143         Flow Control = CTS/RTS
144         Terminal Type = VT100
145         Legacy Redirection = Enabled
146       Note that the Baud Rate can vary, but it must match  in  all  locations
147       where it is used (BIOS, IPMI, and Linux).
148       For  some non-Intel platforms, the serial console would be COM1 instead
149       of COM2, but should be enabled in BIOS.
150       From Linux, run "ipmiutil serial -c" for Terminal Mode shared  configu‐
151       ration.
152       Or,  on  older Intel TSRLT2 platforms: From Linux, run "ipmiutil serial
153       -s" for Basic Mode Shared configuration.
154
155

LINUX CONFIGURATION FOR SERIAL CONSOLE

157       If using lilo, in /etc/lilo.conf, add
158         append="console=ttyS1,19200n8 console=tty0"
159       (and comment out the "message=" line because it includes graphics)
160       Note that the append line can be  placed  in  the  global  section  and
161       removed from each kernel section if there are no other differences.
162
163
164       Or, if using grub, edit /boot/grub/grub.conf as follows:
165         #Omit the splashimage or gfxmenu
166         # splashimage=(hd0,0)/grub/splash.xpm.gz
167         #The serial and terminal lines are not usually needed
168         # serial --unit=1 --speed=19200 --word=8 --parity=no --stop=1
169         # terminal --timeout=10 serial console
170         #Add the console=ttyS* parameter to the kernel line
171           kernel (hd0,0) /vmlinuz root=/dev/sda2 console=ttyS1,19200n8
172
173
174       Add this line to /etc/initab, if ttyS1 is not already there:
175         co:2345:respawn:/sbin/agetty ttyS1 19200 vt100
176
177       Add this line to /etc/securetty, if ttyS1 is not already there:
178         ttyS1
179
180

SEE ALSO

182       ipmiutil(8)   ialarms(8)  iconfig(8)  icmd(8)  idiscover(8)  ievents(8)
183       ifru(8) igetevent(8) ihealth(8) ilan(8)  ireset(8)  isel(8)  isensor(8)
184       iserial(8) iwdt(8)
185
186

WARNINGS

188       See http://ipmiutil.sourceforge.net/ for the latest version of ipmiutil
189       and any bug fix list.
190
191
193       Copyright (C) 2009  Kontron America, Inc.
194
195       See the file COPYING in the distribution  for  more  details  regarding
196       redistribution.
197
198       This  utility  is  distributed  in the hope that it will be useful, but
199       WITHOUT ANY WARRANTY.
200
201

AUTHOR

203       Andy Cress <arcress at users.sourceforge.net>
204
205
206
207
208                           Version 1.1: 17 Feb 2010                    ISOL(8)
Impressum