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

NAME

6       ipmiutil_lan  -  show and configure IPMI LAN parameters, users, and set
7       up a PEF rule to send BMC LAN Alerts for OS Critical Stop log events
8

SYNOPSIS

10       ipmiutil lan [-abcdefghijklmnopq#rstuvwxyzBDQK -i eth1 ]
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 username -Fimb ]
16                [-P/-R rmt_node_pswd -EFJTVY ]
17
18

DESCRIPTION

20       ipmiutil lan shows or sets all of the IPMI LAN Parameters and users  to
21       enable  remote  LAN sessions or BMC LAN Alerts.  The IP address and MAC
22       address of the local system, the default gateway, and the alert  desti‐
23       nation can be defaulted to those specified in Linux, or can be overrid‐
24       den by specific parameters.  It also creates a new Platform Event  Fil‐
25       ter  table  rule for an OS Critical Stop (0x20) SEL firmware log event,
26       so that it will be enabled to send a BMC LAN Alert.  This utility  will
27       skip  the  PEF  records  if  the  system  does  not support IPMI 1.5 or
28       greater.  This utility  can  use  either  the  /dev/ipmi0  driver  from
29       OpenIPMI,  the /dev/imb driver from Intel, the /dev/ipmikcs driver from
30       valinux, direct user-space IOs, or the IPMI LAN interface if -N.
31
32

OPTIONS

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
38
39       -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
44       -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
49       -c     Show Canonical output, which shows  only  interpreted  text  and
50              streamlines the parameters shown, using a common delimiter.
51
52       -d     This  option disables the IPMI LAN and PEF parameters, so as not
53              to allow BMC LAN connections or alerts.  This option  also  sets
54              the IP address to zeros.
55
56       -e     This  option  enables  the  BMC  LAN configuration and PEF event
57              alerts.  The utility will attempt to obtain the default BMC  LAN
58              parameters  from  the OS automatically, or they can be specified
59              with command options below.
60
61       -f     Set the ARP control parameter to 1 = gratuituous ARPs, 2  =  ARP
62              responses,  or 3 = both grat ARP and ARP responses.  The default
63              is 1.
64
65       -g     This specifies the secondary gateway IP address to use  for  the
66              BMC LAN.  The default is to omit this parameter and only use the
67              default gateway.  See also -G.
68
69       -h     Set the IPMI VLAN ID to this value.  Setting to a  value  >=4096
70              disables  the  VLAN ID.  The default behavior is not to set this
71              parameter.
72
73       -i ethif
74              By default, the eth0 interface  is  used  to  find  IP  and  MAC
75              addresses.   Sometimes,  however, the first ethernet port on the
76              baseboard may be represented by Linux as eth1 or  eth2  instead.
77              If  so,  use this option to indicate the correct ethernet inter‐
78              face to use.  By default, ipmiutil lan will scan up  to  32  eth
79              interfaces for the onboard one that BMC LAN uses.
80
81       -j     This sets a custom PEF rule as the last PEF entry.  The input is
82              a series of 10 hex bytes, forming the PEF entry.   For  example,
83              this  sample  PEF entry would perform a power down action if the
84              Baseboard Temp reached its threshold.
85                "ipmiutil lan -e -j020110ffff013001950a"
86
87       -k     This causes ipmiutil lan to also insert two rules to send alerts
88              for  transition-to-OK  events, including Power Redundancy OK and
89              Temperature OK.
90
91       -l     This option enables the  BMC  LAN  configuration,  but  not  PEF
92              events.   The utility will attempt to obtain the default BMC LAN
93              parameters from the OS automatically, or they can  be  specified
94              with command options below.
95
96       -n num By  default,  the new PEF entry for OS Critical Stop is inserted
97              at offset 12 into the table.  This can be changed to  insert  it
98              at an offset > 12 if another entry already exists at offset 12.
99
100       -o     Disable  Only  SOL.   This  could be used after the IPMI LAN was
101              configured, to disable Serial-Over-LAN console access but  still
102              allow other IPMI LAN access.
103
104       -p password_to_set
105              This  specifies the firmware password to set for BMC LAN access.
106              If not specified, the user and password configuration  will  not
107              be changed.
108
109       -q     Specify  an  alternate user number for the LAN username from the
110              -u option.  This is normally user number 2, 3, or 4, where 2  is
111              the  default.   The  maximum  number  of users is 15. Same as -#
112              below.
113
114       -#     Specify an alternate user number for the LAN username  from  the
115              -u option.  Same as -q above.
116
117       -r     This option just reads the configuration without writing any BMC
118              LAN parameters or writing any new entries to the PEF table.
119
120       -s     This option will also display some of the Serial parameters.
121
122       -t     Test if the BMC LAN has already been configured.  Returns  0  if
123              so.
124
125       -u username_to_set
126              This  specifies the firmware username to set for BMC LAN access.
127              If a username is specified, user 3 will be set.  If  not  speci‐
128              fied, the default user 1 will be used.
129
130       -v priv
131              Set  a  specific  access priVilege for this user, where priv can
132              be: 1=Callback, 2=User, 3=Operator, 4=Admin, 5=OEM,  15=NoAccess
133              The  default  if  not specified or specified in error, is to use
134              4=Admin.
135
136       -w N   Set the Gratuitous ARP Interval  to  N  seconds.   This  has  no
137              effect  if  the  firmware does not support Grat-ARP, as shown in
138              Lan Param 10.  If not set, the interval remains at the  firmware
139              default.
140
141       -x     Causes extra debug messages to be displayed.
142
143       -y N   Set  the  OEM  LAN  Failover  parameter to N.  Values for N with
144              Intel Romley/S2600 baseboards:  1 = enable, 0 = disable.    Val‐
145              ues for N with SuperMicro baseboards: 2 = failover, 1 = lan1 , 0
146              = dedicated.
147
148       -z     Also show the IPMI LAN Statistics
149
150       -A alert_ip_addr
151              This specifies the SNMP Alert Destination IP address to use  for
152              the  BMC  LAN.   By default, this utility will attempt to obtain
153              this from the /etc/snmp/snmpd.conf file, via the trapsink param‐
154              eter.  The alert destination will see the BMC LAN traps with the
155              enterprises.3183.1.1 OID.  If no alert IP address  is  specified
156              in  either  snmpd.conf  or this parameter, or if that IP address
157              does not respond, the other SNMP parameters for BMC LAN will  be
158              skipped.
159
160       -B baud_sol
161              This  specifies  the  Baud rate for SerialOverLan.  The possible
162              values are: 9600, 19.2k, 38.4k, 57.6k, and 115.2k.  The  default
163              is 19.2k.
164
165       -C snmp_community
166              This  specifies  the  SNMP  Community  name  to  use for BMC LAN
167              Alerts.  The default community string is "public".  This parame‐
168              ter is ignored if there is no Alert IP address.
169
170       -D     This  causes  the  local  IP  address  to  be determined by DHCP
171              instead of a static IP address.
172
173       -E     Use the remote password from Environment variable IPMI_PASSWORD.
174
175       -F drv_t
176              Force the driver type to one of the  followng:  imb,  va,  open,
177              gnu, landesk, lan, lan2, lan2i, kcs, smb.  Note that lan2i means
178              lan2 with intelplus.  The default is  to  detect  any  available
179              driver type and use it.
180
181       -G gwy_ip_addr
182              This specifies the default gateway IP address to use for the BMC
183              LAN.  The default is to automatically obtain this from the Linux
184              route table.
185
186       -H gwy_mac_addr
187              This  specifies  the  default gateway MAC address to use for the
188              BMC  LAN.   The  format  can  be  either  11:22:33:44:55:66   or
189              11-22-33-44-55-66.   The  default  is  to  try  to automatically
190              obtain this by sending an arp request from an OS LAN eth  inter‐
191              face: the default one, or as specified by -i.
192
193       -K hostname
194              This  specifies  the  IPMI  hostname to set, for Kontron servers
195              only.  This enables the firmware to properly map the IP  address
196              to  a  hostname, especially with the web interface.  The default
197              is not to set this parameter, and use IP address only.
198
199       -I ip_addr
200              This specifies the local IP address to use for the  BMC  LAN  on
201              eth0.   The  default  is  to  automatically obtain this from the
202              Linux ifconfig.
203
204       -J     Use  the  specified  LanPlus   cipher   suite   (0   thru   17):
205              0=none/none/none,       1=sha1/none/none,      2=sha1/sha1/none,
206              3=sha1/sha1/cbc128,  4=sha1/sha1/xrc4_128,  5=sha1/sha1/xrc4_40,
207              6=md5/none/none, ... 14=md5/md5/xrc4_40.  Default is 3.
208
209       -L lan_ch_num
210              This  specifies  the  IPMI  LAN channel number used for BMC LAN.
211              This varies by platform, and can be found in the platform  tech‐
212              nical specifications.  For instance, Intel platforms usually use
213              channels 1 & 2 for onboard NICs, and channel 3 for optional  RMM
214              NICs.   By default, ipmiutil lan scans all IPMI channels to find
215              the first LAN channel for BMC LAN.  To just list all IPMI  chan‐
216              nels  to see what is available, use the string 'list' instead of
217              a LAN channel number.  This will list the channels and exit.
218
219       -M mac_addr
220              This specifies the local MAC address to use for the BMC  LAN  on
221              eth0.    The   format   can   be   either  11:22:33:44:55:66  or
222              11-22-33-44-55-66.  The default is to automatically obtain  this
223              from the Linux ifconfig.
224
225       -N nodename
226              Nodename  or IP address of the remote target system.  If a node‐
227              name is specified, IPMI LAN interface is  used.   Otherwise  the
228              local system management interface is used.
229
230       -O     Observe  security.   Disables  the default null user and disable
231              cipher 0.
232
233       -P rmt_pswd
234              Remote password for the nodename given.  The default is  a  null
235              password.  Same as -R below.
236
237       -Q     Set the IPMI VLAN Priority.  The default priority is 0.
238
239       -R rmt_pswd
240              Remote  password  for the nodename given.  The default is a null
241              password.  Same as -P above.
242
243       -S subnet
244              This specifies the local subnet mask to use for the BMC  LAN  on
245              eth0.   The  default  is  to  automatically obtain this from the
246              Linux ifconfig.
247
248       -T     Use a specified IPMI LAN  Authentication  Type:  0=None,  1=MD2,
249              2=MD5, 4=Straight Password, 5=OEM.
250
251       -U rmt_user
252              Remote  username  for the nodename given.  The default is a null
253              username.
254
255       -V     Use a specified IPMI  LAN  privilege  level.  1=Callback  level,
256              2=User level, 3=Operator level, 4=Administrator level (default),
257              5=OEM level.
258
259       -X alert_mac_addr
260              This specifies the SNMP Alert Destinations's MAC address to  use
261              for  the BMC LAN.  The format can be either 11:22:33:44:55:66 or
262              11-22-33-44-55-66.  The default is to  attempt  to  obtain  this
263              from the Linux arp cache.  This parameter is ignored if there is
264              no Alert IP address.
265
266       -Y     Yes, do prompt the  user  for  the  IPMI  LAN  remote  password.
267              Alternatives for the password are -E or -P.
268
269

EXAMPLES

271       To read existing settings:
272       ipmiutil lan -r
273
274       To  enable  IPMI  LAN  with  default settings detected, assuming shared
275       MAC/IP:
276       ipmiutil lan -e
277
278       To set up IPMI LAN for a unique IP address and set PEF SNMP Alerts:
279       ipmiutil lan -e -I 192.168.1.1 -A 192.168.1.10
280
281       To set the IPMI LAN password for the default user:
282       ipmiutil lan -e -p mypassword
283
284       To disable access to the IPMI LAN channel:
285       ipmiutil lan -d
286
287

SAMPLE PEF TABLE

289       These 11 PEF table entries are configured from the factory for  various
290       Intel  Sahalee  BMC  systems, and will be applied as the defaults for a
291       system with an empty PEF table:
292       PEF(01): 01 Temperature Sensor event - enabled for alert
293       01 c0 01 01 00 ff ff 01 ff 01 95 0a 00 00 00 00 00 00 00 00 00
294       PEF(02): 02 Voltage Sensor event - enabled for alert
295       02 c0 01 01 00 ff ff 02 ff 01 95 0a 00 00 00 00 00 00 00 00 00
296       PEF(03): 04 Fan Failure event - enabled for alert
297       03 c0 01 01 00 ff ff 04 ff 01 95 0a 00 00 00 00 00 00 00 00 00
298       PEF(04): 05 Chassis Intrusion event - enabled for alert
299       04 c0 01 01 00 ff ff 05 05 6f 01 00 00 00 00 00 00 00 00 00 00
300       PEF(05): 08 Power Supply Fault event - enabled for alert
301       05 c0 01 01 00 ff ff 08 ff 6f 06 00 00 00 00 00 00 00 00 00 00
302       PEF(06): 0c Memory ECC Error event - enabled for alert
303       06 c0 01 01 00 ff ff 0c 08 6f 02 00 00 00 00 00 00 00 00 00 00
304       PEF(07): 0f FRB Failure event - enabled for alert
305       07 c0 01 01 00 ff ff 0f 06 6f 01 00 00 00 00 00 00 00 00 00 00
306       PEF(08): 07 BIOS POST Error event - enabled for alert
307       08 c0 01 01 00 ff ff 07 ff 6f 1c 00 00 00 00 00 00 00 00 00 00
308       PEF(09): 13 Fatal NMI event - enabled for alert
309       09 c0 01 01 00 ff ff 13 ff 6f 3e 03 00 00 00 00 00 00 00 00 00
310       PEF(10): 23 Watchdog Timer Reset event - enabled for alert
311       0a c0 01 01 00 ff ff 23 03 6f 0e 00 00 00 00 00 00 00 00 00 00
312       PEF(11): 12 System Restart event - enabled for alert
313       0b c0 01 01 00 ff ff 12 ff 6f 02 00 00 00 00 00 00 00 00 00 00
314
315

SEE ALSO

317       ipmiutil(8)  ialarms(8)  iconfig(8)  icmd(8)  idiscover(8)   ievents(8)
318       ifru(8) igetevent(8) ihealth(8) ireset(8) isel(8) isensor(8) iserial(8)
319       isol(8) iwdt(8)
320
321

WARNINGS

323       See http://ipmiutil.sourceforge.net/ for the latest version of ipmiutil
324       and any bug fix list.
325
326
328       Copyright (C) 2009  Kontron America, Inc.
329
330       See  the  file  COPYING  in the distribution for more details regarding
331       redistribution.
332
333       This utility is distributed in the hope that it  will  be  useful,  but
334       WITHOUT ANY WARRANTY.
335
336

AUTHOR

338       Andy Cress <arcress at users.sourceforge.net>
339
340
341
342
343                           Version 1.8: 17 Feb 2010                    ILAN(8)
Impressum