1ISERIAL(8) System Manager's Manual ISERIAL(8)
2
6 ipmiutil serial - configure a system for Serial/EMP management func‐
7 tions, such as Terminal Mode, and optionally share the port with the
8 Serial Console.
9
11 ipmiutil serial [-bcdeflq#rsvxB -m0 -m1 -n ser_chan -u user -p passwd
12 -NUPREFJTVY]
13
16 ipmiutil serial is a program that uses an IPMI driver to send IPMI com‐
17 mands which configure a system to enable EMP/serial Terminal Mode man‐
18 agement functions within the firmware, so that an administrator can use
19 command-line character commands via the serial port to power cycle the
20 system and perform other functions, even if the system is not running
21 an OS. This level of access needs to be protected by a username/pass‐
22 word login, which can be specified with this utility. This utility can
23 use either the /dev/ipmi0 driver from OpenIPMI, the /dev/imb driver
24 from Intel, the /dev/ipmikcs driver from valinux, direct user-space
25 IOs, or the IPMI LAN interface if -N.
26
29 Command line options are described below.
30 -b Set up and enable the Serial Port EMP parameters for Basic Mode
32 management functions. This does not set a username or password.
33 -c Configure and enable the Serial Port EMP parameters for Terminal
35 Mode management functions, shared with BIOS Console Redirection.
36 Setting a new username and password for serial access via -u and
37 -p is recommended for security.
38 -d Disable the serial port access for IPMI commands. The serial
40 port is then only available for BIOS console and OS functions.
41 A side-effect of this option is that it sets the default user
42 (1) back to admin access.
43 -e Enable EMP Terminal Mode without shared BIOS console. The
45 serial port is then only available for EMP Terminal Mode func‐
46 tions.
47 -f Specifies the Flow Control for the Serial EMP. 0 means no flow
49 control, and 1 means RTS/CTS flow control (default). This must
50 match the BIOS Serial Console setting.
51 -l Show LAN Parameters. This option reads and displays the LAN
53 Parameter configuration also.
54 -m0 Switch the Serial Port MUX to Baseboard/BIOS Console operation.
56 Set no other configuration parameters.
57 -m1 Switch the Serial Port MUX to Terminal Mode management. Set no
59 other configuration parameters.
60 -n ser_chan
62 Sets the IPMI channel number to use for the EMP serial channel
63 (often 4). Note that the IPMI channels for LAN, Serial, etc.
64 are numbered differently on each platform type. The default is
65 to detect the first available IPMI serial channel.
66 -# Same as -q below.
68 -q Specify an alternate user number for the EMP Username from the
70 -u option. This is normally user number 2, 3, or 4, where 3 is
71 the default. The maximum number of users is 15.
72 -r Read Only. This option just reads the Serial Parameter configu‐
74 ration without writing any values.
75 -s Set up and enable the Serial Port EMP parameters for Shared
77 operation between Basic Mode management functions and Baseboard
78 (BIOS) Remote Console. This option switches the Serial Port MUX
79 to Baseboard Console operation.
80 -t Configure and enable the Serial Port EMP parameters for Terminal
82 Mode management functions, shared with BIOS Console Redirection.
83 Same as -c, but easier to remember.
84 -u username
86 This specifies a username for the EMP Terminal Mode login. It
87 can be any string, up to 15 characters. If -u is not used, the
88 default user 1 (null) will be assumed. The username, if speci‐
89 fied, will be set for user 3, unless option -q is specified.
90 -p password
92 This specifies a password for the EMP Terminal Mode login. It
93 can be any string, up to 15 characters. A null password is used
94 if none is specified. This password applies to user 3 if -u is
95 used, to user 1 otherwise.
96 -v priv
98 Set a specific access priVilege for this user, where priv can
99 be: 1=Callback, 2=User, 3=Operator, 4=Admin, 5=OEM, 15=NoAccess
100 The default if not specified or specified in error, is to use
101 4=Admin.
102 -x Causes extra debug messages to be displayed.
104 -B Set the Baud rate of the serial port to one of the following:
106 9600, 19,2K, 38.4K, 57.6K, or 115.2K. The default is 19.2K bps.
107 -N nodename
110 Nodename or IP address of the remote target system. If a node‐
111 name is specified, IPMI LAN interface is used. Otherwise the
112 local system management interface is used.
113 -P/-R rmt_pswd
115 Remote password for the nodename given. The default is a null
116 password.
117 -U rmt_user
119 Remote username for the nodename given. The default is a null
120 username.
121 -E Use the remote password from Environment variable IPMI_PASSWORD.
123 -F drv_t
125 Force the driver type to one of the followng: imb, va, open,
126 gnu, landesk, lan, lan2, lan2i, kcs, smb. Note that lan2i means
127 lan2 with intelplus. The default is to detect any available
128 driver type and use it.
129 -J Use the specified LanPlus cipher suite (0 thru 14):
131 0=none/none/none, 1=sha1/none/none, 2=sha1/sha1/none,
132 3=sha1/sha1/cbc128, 4=sha1/sha1/xrc4_128, 5=sha1/sha1/xrc4_40,
133 6=md5/none/none, ... 14=md5/md5/xrc4_40. Default is 3.
134 -T Use a specified IPMI LAN Authentication Type: 0=None, 1=MD2,
136 2=MD5, 4=Straight Password, 5=OEM.
137 -V Use a specified IPMI LAN privilege level. 1=Callback level,
139 2=User level, 3=Operator level, 4=Administrator level (default),
140 5=OEM level.
141 -Y Yes, do prompt the user for the IPMI LAN remote password.
143 Alternatives for the password are -E or -P.
144
147 ipmiutil serial -t (or -c)
148 Enables Terminal Mode management functions, shared with BIOS
149 Serial Console redirection. The user can switch between serial
150 console operations and IPMI Terminal Mode commands by typing ESC
151 ')' and ESC 'Q'.
152 ipmiutil serial -s
155 Enables Basic Mode management functions shared with BIOS Serial
156 Console redirection. The user can switch between serial console
157 operations and IPMI Basic Mode management programs on the same
158 serial port.
159 ipmiutil serial -d
162 Disables the serial port management functions. This would be
163 used if only the BIOS Serial Console were used and no BMC serial
164 management functions.
165 How to login to a Terminal Mode console:
168 ESC ( (switch to Terminal mode)
169 [SYS PWD -N ] (login for default user, null psw)
170 [SYS PWD -U ROOT -N PASSWORD] (syntax example for user 3)
171 [SYS 000157 ACTIVATE] (activate advanced commands)
172 [SYS HEALTH QUERY]
173 [SYS HELP]
174 [SYS PWD] (logoff)
175 ESC Q (switch to BIOS console)
176 See IPMI 1.5 Spec, Appendix E, and Intel TIGPR2U TPS for more informa‐
177 tion.
178
181 The ipmiutil serial utility is intended to configure the EMP serial
182 port on the server for shared access between BMC/IPMI functions and
183 BIOS Console Redirection. Some platforms only support only Basic Mode
184 for BMC/IPMI functions. Basic Mode requires a remote client applica‐
185 tion to utilize it (Windows ISC Console/DPC, or a special modified
186 Linux telnet). There are some platforms which implement Terminal Mode
187 via IPMI v1.5 Appendix E to make remote management with character com‐
188 mands available on the serial port without a special remote client
189 application.
190 For example, Intel TSRLT2 systems would use "ipmiutil serial -s" for
192 Basic Mode shared functions, but Intel TIGPR2U systems could use
193 "ipmiutil serial -c" to configure Terminal Mode functions. On your
194 system, run "ipmiutil serial -r" to check whether Serial Param(29):
195 "Terminal Mode Config" is supported. If not, configure Basic Mode via
196 "ipmiutil serial -s".
197
201 First, enter BIOS Setup for Serial Console Redirection parameters:
202 (these vary by platform)
203 Console Redirection = Serial Port B
204 ACPI Redirection = Disabled
205 Baud Rate = 115.2K
206 Flow Control = CTS/RTS
207 Terminal Type = VT100
208 Legacy Redirection = Enabled
209 Note that the Baud Rate can vary, but it must match in all locations
210 where it is used (BIOS, IPMI, and Linux).
211 For some non-Intel platforms, the serial console would be COM1 instead
212 of COM2, but should be enabled in BIOS.
213 From Linux, run "ipmiutil serial -c" for Terminal Mode shared configu‐
214 ration.
215 Or, on older Intel TSRLT2 platforms: From Linux, run "ipmiutil serial
216 -s" for Basic Mode Shared configuration.
217
220 If using lilo, in /etc/lilo.conf, add
221 append="console=ttyS1,19200n8 console=tty0"
222 (and comment out the "message=" line because it includes graphics)
223 Note that the append line can be placed in the global section and
224 removed from each kernel section if there are no other differences.
225 Or, if using grub, edit /boot/grub/grub.conf as follows:
228 #Omit the splashimage or gfxmenu
229 # splashimage=(hd0,0)/grub/splash.xpm.gz
230 #The serial and terminal lines are not usually needed
231 # serial --unit=1 --speed=19200 --word=8 --parity=no --stop=1
232 # terminal --timeout=10 serial console
233 #Add the console=ttyS* parameter to the kernel line
234 kernel (hd0,0) /vmlinuz root=/dev/sda2 console=ttyS1,19200n8
235 Add this line to /etc/initab, if ttyS1 is not already there:
238 co:2345:respawn:/sbin/agetty ttyS1 19200 vt100
239 Add this line to /etc/securetty, if ttyS1 is not already there:
241 ttyS1
242
245 ipmiutil(8) ialarms(8) iconfig(8) icmd(8) idiscover(8) ievents(8)
246 ifru(8) igetevent(8) ihealth(8) ilan(8) ireset(8) isel(8) isensor(8)
247 isol(8) iwdt(8)
248
251 See http://ipmiutil.sourceforge.net/ for the latest version of ipmiutil
252 and any bug fix list.
253
256 Copyright (C) 2009 Kontron America, Inc.
257 See the file COPYING in the distribution for more details regarding
259 redistribution.
260 This utility is distributed in the hope that it will be useful, but
262 WITHOUT ANY WARRANTY.
263
266 Andy Cress <arcress at users.sourceforge.net>
267 Version 2.2: 17 Feb 2010 ISERIAL(8)