1ILAN(8) System Manager's Manual ILAN(8)
2
6 ipmiutil lan - show and configure BMC LAN parameters and set up a PEF
7 entry to send BMC LAN Alerts for OS Critical Stop log events
8
10 ipmiutil lan [-bcdegjkloq#rstvxz -n pefnum -i eth1 -a alertnum ]
11 [-I ipadr -M macadr -S subnet -B baud_sol ]
12 [-G gwyip -H gwymac -L lan_channel_num ]
13 [-A alertip -X alertmac -C community ]
14 [-u user_to_set -p password_to_set ]
15 [-N nodename -U rmt_username -Fimb ]
16 [-P/-R rmt_node_pswd -EFJTVY ]
17
20 ipmiutil lan shows or sets all of the IPMI LAN Parameters to enable
21 remote LAN sessions or BMC LAN Alerts. The IP address and MAC address
22 of the local system, the default gateway, and the alert destination can
23 be defaulted to those specified in Linux, or can be overridden by user
24 parameters. It also creates a new Platform Event Filter table entry
25 for an OS Critical Stop (0x20) SEL firmware log event, so that it will
26 be enabled to send a BMC LAN Alert. This utility will skip the PEF
27 records if the system does not support IPMI 1.5 or greater. This util‐
28 ity can use either the /dev/ipmi0 driver from OpenIPMI, the /dev/imb
29 driver from Intel, the /dev/ipmikcs driver from valinux, direct user-
30 space IOs, or the IPMI LAN interface if -N.
31
34 Command line options are described below. Note that without options,
35 ipmiutil lan behaves as if option -r were used. To configure IPMI LAN
36 & PEF, use option -e.
37 -a alertnum
40 Specify which PEF alert number is to be used. Default is 1.
41 This would only be used if extra PEF alert destinations had been
42 set.
43 -b authmask
45 Specify a certain authtype mask in hex to use when configuring
46 this channel. The default mask is 0x16, so to include authtype
47 None (bit 0), it would require entering '-b 17'.
48 -c Show Canonical output, which shows only interpreted text and
50 streamlines the parameters shown, using a common delimiter.
51 -d This option disables the BMC LAN and PEF parameters, so as not
53 to allow BMC LAN connections or alerts.
54 -e This option enables the BMC LAN configuration and PEF event
56 alerts. The utility will attempt to obtain the default BMC LAN
57 parameters from the OS automatically, or they can be specified
58 with command options below.
59 -i ethif
61 By default, the eth0 interface is used to find IP and MAC
62 addresses. Sometimes, however, the first ethernet port on the
63 baseboard may be represented by Linux as eth1 or eth2 instead.
64 If so, use this option to indicate the correct ethernet inter‐
65 face to use. By default, ipmiutil lan will scan up to 32 eth
66 interfaces for the onboard one that BMC LAN uses.
67 -g This specifies the secondary gateway IP address to use for the
69 BMC LAN. The default is to omit this parameter and only use the
70 default gateway. See also -G.
71 -j This sets a custom PEF rule as the last PEF entry. The input is
73 a series of 10 hex bytes, forming the PEF entry. For example,
74 this sample PEF entry would perform a power down action if the
75 Baseboard Temp reached its threshold.
76 "ipmiutil lan -e -j020110ffff013001950a"
77 -k This causes ipmiutil lan to also insert two rules to send alerts
79 for transition-to-OK events, including Power Redundancy OK and
80 Temperature OK.
81 -l This option enables the BMC LAN configuration, but not PEF
83 events. The utility will attempt to obtain the default BMC LAN
84 parameters from the OS automatically, or they can be specified
85 with command options below.
86 -n num By default, the new PEF entry for OS Critical Stop is inserted
88 at offset 12 into the table. This can be changed to insert it
89 at an offset > 12 if another entry already exists at offset 12.
90 -o Disable Only SOL. This could be used after the IPMI LAN was
92 configured, to disable Serial-Over-LAN console access but still
93 allow other IPMI LAN access.
94 -p password_to_set
96 This specifies the firmware password to set for BMC LAN access.
97 If not specified, the user and password configuration will not
98 be changed.
99 -q Specify an alternate user number for the LAN username from the
101 -u option. This is normally user number 2, 3, or 4, where 2 is
102 the default. The maximum number of users is 15. Same as -#
103 below.
104 -# Specify an alternate user number for the LAN username from the
106 -u option. Same as -q above.
107 -r This option just reads the configuration without writing any BMC
109 LAN parameters or writing any new entries to the PEF table.
110 -s This option will also display some of the Serial parameters.
112 -t Test if the BMC LAN has already been configured. Returns 0 if
114 so.
115 -u username_to_set
117 This specifies the firmware username to set for BMC LAN access.
118 If a username is specified, user 3 will be set. If not speci‐
119 fied, the default user 1 will be used.
120 -v priv
122 Set a specific access priVilege for this user, where priv can
123 be: 1=Callback, 2=User, 3=Operator, 4=Admin, 5=OEM, 15=NoAccess
124 The default if not specified or specified in error, is to use
125 4=Admin.
126 -w N Set the Gratuitous ARP Interval to N seconds. This has no
128 effect if the firmware does not support Grat-ARP, as shown in
129 Lan Param 10. If not set, the interval remains at the firmware
130 default.
131 -x Causes extra debug messages to be displayed.
133 -z Also show the IPMI LAN Statistics
135 -A alert_ip_addr
137 This specifies the SNMP Alert Destination IP address to use for
138 the BMC LAN. By default, this utility will attempt to obtain
139 this from the /etc/snmp/snmpd.conf file, via the trapsink param‐
140 eter. The alert destination will see the BMC LAN traps with the
141 enterprises.3183.1.1 OID. If no alert IP address is specified
142 in either snmpd.conf or this parameter, or if that IP address
143 does not respond, the other SNMP parameters for BMC LAN will be
144 skipped.
145 -B baud_sol
147 This specifies the Baud rate for SerialOverLan. The possible
148 values are: 9600, 19.2k, 38.4k, 57.6k, and 115.2k. The default
149 is 19.2k.
150 -C snmp_community
152 This specifies the SNMP Community name to use for BMC LAN
153 Alerts. The default community string is "public". This parame‐
154 ter is ignored if there is no Alert IP address.
155 -D This causes the local IP address to be determined by DHCP
157 instead of a static IP address.
158 -E Use the remote password from Environment variable IPMI_PASSWORD.
160 -F drv_t
162 Force the driver type to one of the followng: imb, va, open,
163 gnu, landesk, lan, lan2, lan2i, kcs, smb. Note that lan2i means
164 lan2 with intelplus. The default is to detect any available
165 driver type and use it.
166 -G gwy_ip_addr
168 This specifies the default gateway IP address to use for the BMC
169 LAN. The default is to automatically obtain this from the Linux
170 route table.
171 -H gwy_mac_addr
173 This specifies the default gateway MAC address to use for the
174 BMC LAN. The format can be either 11:22:33:44:55:66 or
175 11-22-33-44-55-66. The default is to try to automatically
176 obtain this by sending an arp request from an OS LAN eth inter‐
177 face: the default one, or as specified by -i.
178 -I ip_addr
180 This specifies the local IP address to use for the BMC LAN on
181 eth0. The default is to automatically obtain this from the
182 Linux ifconfig.
183 -J Use the specified LanPlus cipher suite (0 thru 14):
185 0=none/none/none, 1=sha1/none/none, 2=sha1/sha1/none,
186 3=sha1/sha1/cbc128, 4=sha1/sha1/xrc4_128, 5=sha1/sha1/xrc4_40,
187 6=md5/none/none, ... 14=md5/md5/xrc4_40. Default is 3.
188 -L lan_ch_num
190 This specifies the IPMI LAN channel number used for BMC LAN.
191 This varies by platform, and can be found in the platform tech‐
192 nical specifications. By default, ipmiutil lan scans all IPMI
193 channels to find a LAN channel for BMC LAN.
194 -M mac_addr
196 This specifies the local MAC address to use for the BMC LAN on
197 eth0. The format can be either 11:22:33:44:55:66 or
198 11-22-33-44-55-66. The default is to automatically obtain this
199 from the Linux ifconfig.
200 -N nodename
202 Nodename or IP address of the remote target system. If a node‐
203 name is specified, IPMI LAN interface is used. Otherwise the
204 local system management interface is used.
205 -P rmt_pswd
207 Remote password for the nodename given. The default is a null
208 password. Same as -R below.
209 -R rmt_pswd
211 Remote password for the nodename given. The default is a null
212 password. Same as -P above.
213 -S subnet
215 This specifies the local subnet mask to use for the BMC LAN on
216 eth0. The default is to automatically obtain this from the
217 Linux ifconfig.
218 -T Use a specified IPMI LAN Authentication Type: 0=None, 1=MD2,
220 2=MD5, 4=Straight Password, 5=OEM.
221 -U rmt_user
223 Remote username for the nodename given. The default is a null
224 username.
225 -V Use a specified IPMI LAN privilege level. 1=Callback level,
227 2=User level, 3=Operator level, 4=Administrator level (default),
228 5=OEM level.
229 -X alert_mac_addr
231 This specifies the SNMP Alert Destinations's MAC address to use
232 for the BMC LAN. The format can be either 11:22:33:44:55:66 or
233 11-22-33-44-55-66. The default is to attempt to obtain this
234 from the Linux arp cache. This parameter is ignored if there is
235 no Alert IP address.
236 -Y Yes, do prompt the user for the IPMI LAN remote password.
238 Alternatives for the password are -E or -P.
239
242 To read existing settings:
243 ipmiutil lan -r
244 To enable IPMI LAN with default settings detected, assuming shared
246 MAC/IP:
247 ipmiutil lan -e
248 To set up IPMI LAN for a unique IP address and set PEF SNMP Alerts:
250 ipmiutil lan -e -I 192.168.1.1 -A 192.168.1.10
251 To set the IPMI LAN password for the default user:
253 ipmiutil lan -e -p mypassword
254 To disable access to the IPMI LAN channel:
256 ipmiutil lan -d
257
260 These 11 PEF table entries are configured from the factory for various
261 Intel Sahalee BMC systems, and will be applied as the defaults for a
262 system with an empty PEF table:
263 PEF(01): 01 Temperature Sensor event - enabled for alert
264 01 c0 01 01 00 ff ff 01 ff 01 95 0a 00 00 00 00 00 00 00 00 00
265 PEF(02): 02 Voltage Sensor event - enabled for alert
266 02 c0 01 01 00 ff ff 02 ff 01 95 0a 00 00 00 00 00 00 00 00 00
267 PEF(03): 04 Fan Failure event - enabled for alert
268 03 c0 01 01 00 ff ff 04 ff 01 95 0a 00 00 00 00 00 00 00 00 00
269 PEF(04): 05 Chassis Intrusion event - enabled for alert
270 04 c0 01 01 00 ff ff 05 05 6f 01 00 00 00 00 00 00 00 00 00 00
271 PEF(05): 08 Power Supply Fault event - enabled for alert
272 05 c0 01 01 00 ff ff 08 ff 6f 06 00 00 00 00 00 00 00 00 00 00
273 PEF(06): 0c Memory ECC Error event - enabled for alert
274 06 c0 01 01 00 ff ff 0c 08 6f 02 00 00 00 00 00 00 00 00 00 00
275 PEF(07): 0f FRB Failure event - enabled for alert
276 07 c0 01 01 00 ff ff 0f 06 6f 01 00 00 00 00 00 00 00 00 00 00
277 PEF(08): 07 BIOS POST Error event - enabled for alert
278 08 c0 01 01 00 ff ff 07 ff 6f 1c 00 00 00 00 00 00 00 00 00 00
279 PEF(09): 13 Fatal NMI event - enabled for alert
280 09 c0 01 01 00 ff ff 13 ff 6f 3e 03 00 00 00 00 00 00 00 00 00
281 PEF(10): 23 Watchdog Timer Reset event - enabled for alert
282 0a c0 01 01 00 ff ff 23 03 6f 0e 00 00 00 00 00 00 00 00 00 00
283 PEF(11): 12 System Restart event - enabled for alert
284 0b c0 01 01 00 ff ff 12 ff 6f 02 00 00 00 00 00 00 00 00 00 00
285
288 ipmiutil(8) ialarms(8) iconfig(8) icmd(8) idiscover(8) ievents(8)
289 ifru(8) igetevent(8) ihealth(8) ireset(8) isel(8) isensor(8) iserial(8)
290 isol(8) iwdt(8)
291
294 See http://ipmiutil.sourceforge.net/ for the latest version of ipmiutil
295 and any bug fix list.
296
299 Copyright (C) 2009 Kontron America, Inc.
300 See the file COPYING in the distribution for more details regarding
302 redistribution.
303 This utility is distributed in the hope that it will be useful, but
305 WITHOUT ANY WARRANTY.
306
309 Andy Cress <arcress at users.sourceforge.net>
310 Version 1.8: 17 Feb 2010 ILAN(8)