ipmiutil man pages
IPMIUTIL
3.1 IPMIUTIL (ipmiutil)
IPMIUTIL(8) IPMIUTIL(8)
NAME
ipmiutil - a meta-command to invoke various IPMI functions.
SYNOPSIS
ipmiutil [-x -NUPREFJTVY] [other command options]
DESCRIPTION
This utility performs various IPMI functions. Each of the individual
commands in the ipmiutil project can be invoked via this meta-command.
The is one of the following:
alarms show/set the front panel alarm LEDs and relays (alarms)
leds show/set the front panel alarm LEDs and relays (alarms)
cmd send a specified raw IPMI command to the BMC (icmd)
config list/save/restore BMC configuration parameters (bmcconfig)
discover discover all IPMI servers on this LAN (idiscover)
events decode IPMI events and display them
fru show FRU inventory data, write asset tag (fruconfig)
getevt receive any IPMI events and display them (getevent)
health check and show the basic health of the BMC (bmchealth)
lan show/set IPMI LAN parameters and PEF table (pefconfig)
reset cause the BMC to reset or power down the system (hwreset)
sel show/clear firmware System Event Log records (showsel)
sensor show Sensor Data Records, readings, thresholds (sensor)
serial show/set IPMI Serial & Terminal Mode parameters (tmconfig)
sol start/stop an SOL console session (isolconsole)
wdt show/set/reset the watchdog timer (wdt)
For help on each command (e.g. ’sel’), enter:
ipmiutil sel -?
For man pages on each command, see the man page in parenthesis, or
refer to SEE ALSO below.
This utility can use either the /dev/ipmi0 driver from OpenIPMI, the
/dev/imb driver from Intel, the /dev/ipmikcs driver from valinux,
direct user-space IOs, or the IPMI LAN interface if -N.
OPTIONS
Command options are described in the man page for each command. Below
are a few of the common options.
-x Causes extra debug messages to be displayed.
-N nodename
Nodename or IP address of the remote target system. If a node-
name is specified, IPMI LAN interface is used. Otherwise the
local system management interface is used.
-U rmt_user
Remote username for the nodename given. The default is a null
username.
-P/-R rmt_pswd
Remote password for the nodename given. The default is a null
password.
-E Use the remote password from Environment variable IPMI_PASS-
WORD.
-F drv_t
Force the driver type to one of the followng: imb, va, open,
gnu, landesk, lan, lan2, lan2i, kcs, smb. Note that lan2i
means lan2 with intelplus. The default is to detect any avail-
able driver type and use it.
-J Use the specified LanPlus cipher suite (0 thru 14):
0=none/none/none, 1=sha1/none/none, 2=sha1/sha1/none,
3=sha1/sha1/cbc128, 4=sha1/sha1/xrc4_128, 5=sha1/sha1/xrc4_40,
6=md5/none/none, ... 14=md5/md5/xrc4_40. Default is 3.
-T Use a specified IPMI LAN Authentication Type: 0=None, 1=MD2,
2=MD5, 4=Straight Password, 5=OEM.
-V Use a specified IPMI LAN privilege level. 1=Callback level,
2=User level, 3=Operator level, 4=Administrator level
(default), 5=OEM level.
-Y Yes, do prompt the user for the IPMI LAN remote password.
Alternatives for the password are -E or -P.
EXAMPLES
ipmiutil sel
Shows the IPMI System Event Log entries.
ipmiutil wdt
Shows the watchdog timer values.
SEE ALSO
alarms(8) bmchealth(8) fruconfig(8) getevent(8) hwreset(8) pefcon-
fig(8) sensor(8) showsel(8) tmconfig(8) wdt(8) icmd(8) bmcconfig(8)
idiscover(8) ievents(8)
WARNINGS
See http://ipmiutil.sourceforge.net/ for the latest version of icmd
and any bug fix list.
ALARMS
3.2 ALARMS (ipmiutil alarms)
ALARMS(8) ALARMS(8)
NAME
alarms (ipmiutil alarms) - display and set alarm indicators
SYNOPSIS
alarms [-abcdimnoprx -N node -U user -P/-R pswd -EFJTVY]
DESCRIPTION
alarms is a program that uses IPMI commands to display and set alarm
indicators, which are usually LEDs on the system chassis front panel.
This utility can use either the /dev/ipmi0 driver from OpenIPMI, the
/dev/imb driver from Intel, the /dev/ipmikcs driver from valinux,
direct user-space IOs, or the IPMI LAN interface if -N. Note that a
LAN user must have Administrative privileges to read or write the
alarm LEDs.
Note that this utility may not be the only logic setting alarm states.
The BMC firmware, system management software, or cluster fault manager
may also want to set alarm states. Intel provides a Telco Alarms Man-
ager API which presents a consolidated interface for all alarm manage-
ment applications.
OPTIONS
Command line options are described below.
-r Read-only. Show the alarms status, but do not set any states.
This is also the default mode if no parameters are specified.
-iN Sets the Chassis Identify feature, which can be an LED or some
other alarm. If N=0, turn off the Chassis ID, otherwise turn
the ID on for N seconds. N=255 will turn on the ID indefi-
nitely, if it is IPMI 2.0.
-aN Sets Disk A Fault LED. If N=0, turn it off. If N=1, turn it
on. Used only for TIGPT1U platform.
-bN Sets Disk B Fault LED. If N=0, turn it off. If N=1, turn it
on. Used only for TIGPT1U platform.
-dXN Sets Disk X Fault LED, where X=0-6. If N=0, turn it off. If
N=1, turn it on. Used only for NSC2U platform.
-cN Sets the Critical Alarm. If N=0, turn it off. If N=1, turn it
on.
-mN Sets the Major Alarm. If N=0, turn it off. If N=1, turn it
on.
-nN Sets the Minor Alarm. If N=0, turn it off. If N=1, turn it
on.
-pN Sets the Power Alarm. If N=0, turn it off. If N=1, turn it
on. Note that the Power LED is also wired to the System Fault
LED in the back of the system, so this state may be off for
Power, but the LED could be lit for a System Fault reason
instead. Refer to the system Technical Product Specification
for System Faults.
-o Sets all alarms off, including the Chassis ID.
-x Causes extra debug messages to be displayed.
-N nodename
Nodename or IP address of the remote target system. If a node-
name is specified, IPMI LAN interface is used. Otherwise the
local system management interface is used.
-P/-R rmt_pswd
Remote password for the nodename given. The default is a null
password.
-U rmt_user
Remote username for the nodename given. The default is a null
username.
-E Use the remote password from Environment variable IPMI_PASS-
WORD.
-F drv_t
Force the driver type to one of the followng: imb, va, open,
gnu, landesk, lan, lan2, lan2i, kcs, smb. Note that lan2i
means lan2 with intelplus. The default is to detect any avail-
able driver type and use it.
-J Use the specified LanPlus cipher suite (0 thru 14):
0=none/none/none, 1=sha1/none/none, 2=sha1/sha1/none,
3=sha1/sha1/cbc128, 4=sha1/sha1/xrc4_128, 5=sha1/sha1/xrc4_40,
6=md5/none/none, ... 14=md5/md5/xrc4_40. Default is 3.
-T Use this IPMI LAN Authentication Type: 0=None, 1=MD2, 2=MD5,
4=Straight Password, 5=OEM.
-V Use this IPMI LAN privilege level. 1=Callback level, 2=User
level, 3=Operator level, 4=Administrator level (default), 5=OEM
level.
-Y Yes, do prompt the user for the IPMI LAN remote password.
Alternatives for the password are -E or -P.
SEE ALSO
bmchealth(8) fruconfig(8) getevent(8) hwreset(8) icmd(8) pefconfig(8)
sensor(8) showsel(8) tmconfig(8) wdt(8) ipmiutil(8)
WARNINGS
See http://ipmiutil.sourceforge.net/ for the latest version of alarms
and any bug fix list.
BMCHEALTH
3.3 BMCHEALTH (ipmiutil health)
BMCHEALTH(8) BMCHEALTH(8)
NAME
bmchealth (ipmiutil health)- show BMC health
SYNOPSIS
bmchealth [-hgsx -N node -U user -P/-R pswd -EFJTVY]
DESCRIPTION
bmchealth is a program that uses IPMI commands to show the health of
the BMC. This utility can use either the /dev/ipmi0 driver from
OpenIPMI, the /dev/imb driver from Intel, the /dev/ipmikcs driver from
valinux, direct user-space IOs, or the IPMI LAN interface if -N.
OPTIONS
Command line options are described below.
-h Check the health of the HotSwap Controller also.
-g Show the IPMI GUID of this system. The GUID is a read-only
unique identifier.
-s Show the IPMI LAN channel statistics also.
-x Causes extra debug messages to be displayed.
-N nodename
Nodename or IP address of the remote target system. If a node-
name is specified, IPMI LAN interface is used. Otherwise the
local system management interface is used.
-P/-R rmt_pswd
Remote password for the nodename given. The default is a null
password.
-U rmt_user
Remote username for the nodename given. The default is a null
username.
-E Use the remote password from Environment variable IPMI_PASS-
WORD.
-F drv_t
Force the driver type to one of the followng: imb, va, open,
gnu, landesk, lan, lan2, lan2i, kcs, smb. Note that lan2i
means lan2 with intelplus. The default is to detect any avail-
able driver type and use it.
-J Use the specified LanPlus cipher suite (0 thru 14):
0=none/none/none, 1=sha1/none/none, 2=sha1/sha1/none,
3=sha1/sha1/cbc128, 4=sha1/sha1/xrc4_128, 5=sha1/sha1/xrc4_40,
6=md5/none/none, ... 14=md5/md5/xrc4_40. Default is 3.
-T Use a specified IPMI LAN Authentication Type: 0=None, 1=MD2,
2=MD5, 4=Straight Password, 5=OEM.
-V Use a specified IPMI LAN privilege level. 1=Callback level,
2=User level, 3=Operator level, 4=Administrator level
(default), 5=OEM level.
-Y Yes, do prompt the user for the IPMI LAN remote password.
Alternatives for the password are -E or -P.
SEE ALSO
alarms(8) fruconfig(8) getevent(8) hwreset(8) icmd(8) pefconfig(8)
sensor(8) showsel(8) tmconfig(8) wdt(8)
WARNINGS
See http://ipmiutil.sourceforge.net/ for the latest version of alarms
and any bug fix list.
FRUCONFIG
3.4 FRUCONFIG (ipmiutil fru)
FRUCONFIG(8) FRUCONFIG(8)
NAME
fruconfig (ipmiutil fru) - show Field Replacable Unit configuration
data
SYNOPSIS
fruconfig [-abmsx -N node -U user -P/-R pswd -EFJTVY]
DESCRIPTION
fruconfig is a program that uses IPMI commands to show FRU configura-
tion data and optionally write an asset tag string into the FRU data.
Setting the asset tag is a function that can be used to uniquely iden-
tify the unit, even if the storage devices are removed or changed.
This utility can use either the /dev/ipmi0 driver from OpenIPMI, the
/dev/imb driver from Intel, the /dev/ipmikcs driver from valinux,
direct user-space IOs, or the IPMI LAN interface if -N.
OPTIONS
Command line options are described below.
-a asset_string
This option specifies an asset tag string to be written to the
baseboard FRU Product area. The asset tag length is limited by
the existing FRU Product data, but is usually allowed up to 16
characters.
-b Only show the Baseboard FRU data. The default behavior is to
also scan for any SDR FRU data or DIMM SPD data referenced by
the SDRs.
-m 002000
Show FRU for a specific MC (e.g. bus 00, sa 20, lun 00). This
would be used for PICMG or ATCA blade systems.
-s serial_num
This option specifies a serial number string to be written to
the baseboard FRU Product area. The serial number can be any
string up to 16 characters.
-x Causes eXtra debug messages to be displayed.
-N nodename
Nodename or IP address of the remote target system. If a node-
name is specified, IPMI LAN interface is used. Otherwise the
local system management interface is used.
-U rmt_user
Remote username for the nodename given. The default is a null
username.
-P/-R rmt_pswd
Remote password for the nodename given. The default is a null
password.
-E Use the remote password from Environment variable IPMI_PASS-
WORD.
-F drv_t
Force the driver type to one of the followng: imb, va, open,
gnu, landesk, lan, lan2, lan2i, kcs, smb. Note that lan2i
means lan2 with intelplus. The default is to detect any
available driver type and use it.
-J Use the specified LanPlus cipher suite (0 thru 14):
0=none/none/none, 1=sha1/none/none, 2=sha1/sha1/none,
3=sha1/sha1/cbc128, 4=sha1/sha1/xrc4_128, 5=sha1/sha1/xrc4_40,
6=md5/none/none, ... 14=md5/md5/xrc4_40. Default is 3.
-T Use a specified IPMI LAN Authentication Type: 0=None, 1=MD2,
2=MD5, 4=Straight Password, 5=OEM.
-V Use a specified IPMI LAN privilege level. 1=Callback level,
2=User level, 3=Operator level, 4=Administrator level
(default), 5=OEM level.
-Y Yes, do prompt the user for the IPMI LAN remote password.
Alternatives for the password are -E or -P.
SEE ALSO
alarms(8) bmchealth(8) getevent(8) hwreset(8) icmd(8) pefconfig(8)
sensor(8) showsel(8) tmconfig(8) wdt(8)
WARNINGS
See http://ipmiutil.sourceforge.net/ for the latest version of frucon-
fig and any bug fix list.
GETEVENT
3.5 GETEVENT (ipmiutil getevt)
GETEVENT(8) GETEVENT(8)
NAME
getevent (ipmiutil getevt) - wait for IPMI events
SYNOPSIS
getevent [-abosx -t secs -N node -U user -P/-R pswd -EFJTVY]
DESCRIPTION
getevent is a program that uses IPMI commands to wait for IPMI events
sent from the BMC firmware. These events are also sent to the IPMI
System Event Log (SEL). This utility can use either the /dev/ipmi0
driver from OpenIPMI, the /dev/imb driver from Intel, the /dev/ipmikcs
driver from valinux, direct user-space IOs, or the IPMI LAN interface
if -N.
Some server management functions want to trigger custom actions or
alerts when IPMI hardware-related events occur, but do not want to
track all events, just newly occurring events. This utility waits a
specified timeout period for any events, and returns interpreted out-
put for each event. It is designed as a scriptable command-line util-
ity, but if the timeout is infinite (-t 0), then this code could be
used for a sample service as well.
There are several methods to do this which are implemented here.
The SEL method:
This method polls the SEL once a second, keeps track of the last SEL
event read, and only new events are processed. This ensures that in a
series of rapid events, all events are received in order, however,
some transition-to-OK events may not be configured to write to the SEL
on certain platforms. This method is used if getevent -s is speci-
fied. This is the only method supported over IPMI LAN, i.e. with -N.
The ReadEventMessageBuffer method:
This uses an IPMI Message Buffer in the BMC firmware to read each new
event. This receives any event, but if two events occur nearly simul-
taneously, only the most recent of the two will be returned with this
method. An example of simultaneous events might be, if a fan
stops/fails, both the non-critical and critical fan threshold events
would occur at that time. This is the default method for getevent.
The OpenIPMI custom method:
Different IPMI drivers may have varying behavior. For instance, the
OpenIPMI driver uses the IPMI GetMessage commands internally and does
not allow client programs to use those commands. It has its own cus-
tom mechanism, see getevent_mv(). This method is used if the OpenIPMI
driver is detected, and no other method is specified.
The Async Event method:
This only gets certain Asynchronous requests from the BMC to an SMS OS
service, like a remote OS shutdown, and get_software_id. This method
is disabled by default and only turned on if the getevent -a option is
specified. This method is only supported via the Intel IMB and
OpenIPMI driver interfaces. There is an init script provided with
ipmiutil to automate the task of starting this async event daemon.
# chkconfig --add ipmiutil_asy (skip this if no chkconfig)
# /etc/init.d/ipmiutil_asy start
This listens for IPMI LAN requests for soft-shutdown, and logs the
output to /var/log/ipmiutil_asy.log
OPTIONS
Command line options are described below.
-a Use the Async request method, which receives SMS OS requests
from the BMC using the IMB or OpenIPMI driver interface. This
services remote SMS bridge agent requests, like remote OS shut-
down and get software_id.
-b Run in Background as a daemon. If this option is specified,
normal output will be redirected to /var/log/ipmiutil_evt.log.
The default is to run in foreground.
-o Only run one pass to wait for the first event. Default is to
loop for multiple events for the timeout period.
-s Use the SEL method to get events. This polls the SEL once a
second for new events. The last SEL record read is saved in
/usr/share/ipmiutil/evt.idx. Otherwise, the default is to use
the ReadEventMessageBuffer method to get new events.
-t N Set the timeout period to N seconds. Default is 120 seconds.
A timeout of 0 means an infinite period.
-x Causes extra debug messages to be displayed.
-N nodename
Nodename or IP address of the remote target system. If a node-
name is specified, IPMI LAN interface is used. Otherwise the
local system management interface is used.
-P/-R rmt_pswd
Remote password for the nodename given. The default is a null
password.
-U rmt_user
Remote username for the nodename given. The default is a null
username.
-E Use the remote password from Environment variable IPMI_PASS-
WORD.
-F drv_t
Force the driver type to one of the followng: imb, va, open,
gnu, landesk, lan, lan2, lan2i, kcs, smb. Note that lan2i
means lan2 with intelplus. The default is to detect any avail-
able driver type and use it.
-J Use the specified LanPlus cipher suite (0 thru 14):
0=none/none/none, 1=sha1/none/none, 2=sha1/sha1/none,
3=sha1/sha1/cbc128, 4=sha1/sha1/xrc4_128, 5=sha1/sha1/xrc4_40,
6=md5/none/none, ... 14=md5/md5/xrc4_40. Default is 3.
-T Use a specified IPMI LAN Authentication Type: 0=None, 1=MD2,
2=MD5, 4=Straight Password, 5=OEM.
-V Use a specified IPMI LAN privilege level. 1=Callback level,
2=User level, 3=Operator level, 4=Administrator level
(default), 5=OEM level.
-Y Yes, do prompt the user for the IPMI LAN remote password.
Alternatives for the password are -E or -P.
SEE ALSO
alarms(8) bmchealth(8) fruconfig(8) hwreset(8) icmd(8) pefconfig(8)
sensor(8) showsel(8) tmconfig(8) wdt(8) ievents(8)
WARNINGS
See http://ipmiutil.sourceforge.net/ for the latest version of alarms
and any bug fix list.
HWRESET
3.6 HWRESET (ipmiutil reset)
HWRESET(8) HWRESET(8)
NAME
hwreset (ipmiutil reset) - perform a hardware reset on the system
SYNOPSIS
hwreset [-dcnorsx -N node -U user -P/-R pswd -EFJTVY]
DESCRIPTION
hwreset is a program that uses IPMI commands to perform a hardware
reset of the chassis, or boot to a specific device. This utility can
use either the /dev/ipmi0 driver from OpenIPMI, the /dev/imb driver
from Intel, the /dev/ipmikcs driver from valinux, direct user-space
IOs, or the IPMI LAN interface if -N.
OPTIONS
Command line options are described below.
-c Power Cycle the system chassis
-d Power Down the system chassis
-u Power Up the system chassis
-n Send NMI to the system
-p Reboots to PXE network boot, for this reboot only.
-o Do a soft shutdown of the OS, and then reset. Note that remote
soft shutdown (-o -N) requires ipmiutil getevt -a running on
the target server.
-D Do a soft shutdown of the OS, and then power down. Note that
remote soft shutdown (-D -N) requires ipmiutil getevt -a run-
ning on the target server.
-s Do a hard reset and reboot to the Service Partition, for this
reboot only. Reboots to the default if no service partition is
configured.
-b Do a hard reset and reboot to the BIOS Setup menu, for this
reboot only.
-e Reboots to EFI, if EFI boot is enabled, for this reboot only.
-f Reboots to Floppy/Removable, for this reboot only.
-h Reboots to a Hard Disk, for this reboot only.
-m Reboots to CDROM Media, for this reboot only.
-p Reboots to PXE
-r Hard Reset the system chassis
-s Reset and boot to the Service Partition
-w Wait for BMC ready after a reset before exiting the utility.
-x Causes extra debug messages to be displayed.
-N nodename
Nodename or IP address of the remote target system. If a node-
name is specified, IPMI LAN interface is used. Otherwise the
local system management interface is used.
-P/-R rmt_pswd
Remote password for the nodename given. The default is a null
password.
-U rmt_user
Remote username for the nodename given. The default is a null
username.
-E Use the remote password from Environment variable IPMI_PASS-
WORD.
-F drv_t
Force the driver type to one of the followng: imb, va, open,
gnu, landesk, lan, lan2, lan2i, kcs, smb. Note that lan2i
means lan2 with intelplus. The default is to detect any avail-
able driver type and use it.
-J Use the specified LanPlus cipher suite (0 thru 14):
0=none/none/none, 1=sha1/none/none, 2=sha1/sha1/none,
3=sha1/sha1/cbc128, 4=sha1/sha1/xrc4_128, 5=sha1/sha1/xrc4_40,
6=md5/none/none, ... 14=md5/md5/xrc4_40. Default is 3.
-T Use a specified IPMI LAN Authentication Type: 0=None, 1=MD2,
2=MD5, 4=Straight Password, 5=OEM.
-V Use a specified IPMI LAN privilege level. 1=Callback level,
2=User level, 3=Operator level, 4=Administrator level
(default), 5=OEM level.
-Y Yes, do prompt the user for the IPMI LAN remote password.
Alternatives for the password are -E or -P.
SEE ALSO
alarms(8) bmchealth(8) fruconfig(8) getevent(8) icmd(8) pefconfig(8)
sensor(8) showsel(8) tmconfig(8) wdt(8) ipmiutil(8)
WARNINGS
See http://ipmiutil.sourceforge.net/ for the latest version of hwreset
and any bug fix list.
ICMD
3.7 ICMD (ipmiutil cmd)
ICMD(8) ICMD(8)
NAME
icmd (ipmiutil cmd) - a tool to send specific IPMI commands via the
command line.
SYNOPSIS
icmd [-qsx -NUPREFJTVY] bus rsSa netFn/lun cmd [data bytes]
DESCRIPTION
This icmd tool sends specific IPMI commands to the firmware. The com-
mands are composed as hex values on the command line. This tool was
written to allow in-band use to match the DOS CMDTOOL.EXE or IPMI-
TOOL.EXE program which is distributed with many Intel servers. Cer-
tain scripts or pre-written commands may have been supplied for the
DOS tool that can now be used while the system is running Linux or
Windows.
This utility can use either the /dev/ipmi0 driver from OpenIPMI, the
/dev/imb driver from Intel, the /dev/ipmikcs driver from valinux,
direct user-space IOs, or the IPMI LAN interface if -N.
This tool should only be used if you are familiar with the IPMI 1.5
specification, or you have specific pre-written commands to send.
OPTIONS
Command line options are described below.
-q Quiet mode. Show only minimal header information.
-s Skips the GetDeviceID command
-x Causes extra debug messages to be displayed.
-N nodename
Nodename or IP address of the remote target system. If a node-
name is specified, IPMI LAN interface is used. Otherwise the
local system management interface is used.
-U rmt_user
Remote username for the nodename given. The default is a null
username.
-P/-R rmt_pswd
Remote password for the nodename given. The default is a null
password.
-E Use the remote password from Environment variable IPMI_PASS-
WORD.
-F drv_t
Force the driver type to one of the followng: imb, va, open,
gnu, landesk, lan, lan2, lan2i, kcs, smb. Note that lan2i
means lan2 with intelplus. The default is to detect any avail-
able driver type and use it.
-J Use the specified LanPlus cipher suite (0 thru 14):
0=none/none/none, 1=sha1/none/none, 2=sha1/sha1/none,
3=sha1/sha1/cbc128, 4=sha1/sha1/xrc4_128, 5=sha1/sha1/xrc4_40,
6=md5/none/none, ... 14=md5/md5/xrc4_40. Default is 3.
-T Use a specified IPMI LAN Authentication Type: 0=None, 1=MD2,
2=MD5, 4=Straight Password, 5=OEM.
-V Use a specified IPMI LAN privilege level. 1=Callback level,
2=User level, 3=Operator level, 4=Administrator level
(default), 5=OEM level.
-Y Yes, do prompt the user for the IPMI LAN remote password.
Alternatives for the password are -E or -P.
PARAMETERS
The following parameters are used by icmd. Each is represented as a
two-digit hex byte. The parameters have no default values.
bus This byte contains the bus number for this command, usually 00.
rsSa This is the resource slave address, usually 0x20 for the BMC.
netFn/lun
This byte combines the net Function and Lun. The 2 low-order
bits are the Lun and the 6 high-order bits are the net Func-
tion. This representation is consistent with the DOS CMD-
TOOL/IPMITOOL.
cmd This byte contains the IPMI command.
[data bytes]
This is a sequence of zero to 16 bytes that represent data
bytes specific to this command.
EXAMPLES
icmd 00 20 18 01
Sends the GetDevice ID command to the BMC.
icmd 00 20 28 43 00 00 ff ff 00 ff
Sends a Get SEL entry command for the last entry in the firmware log.
SEE ALSO
alarms(8) bmchealth(8) fruconfig(8) getevent(8) hwreset(8) pefcon-
fig(8) sensor(8) showsel(8) tmconfig(8) wdt(8)
WARNINGS
See http://ipmiutil.sourceforge.net/ for the latest version of icmd
and any bug fix list.
PEFCONFIG
3.8 PEFCONFIG (ipmiutil lan)
PEFCONFIG(8) PEFCONFIG(8)
NAME
pefconfig (ipmiutil lan) - show and configure BMC LAN parameters and
set up a PEF entry to send BMC LAN Alerts for OS Critical Stop log
events
SYNOPSIS
pefconfig [-degjkloq#rstvxz -n pefnum -i eth1 -a alertnum ]
[-I ipadr -M macadr -S subnet -B baud_sol ]
[-G gwyip -H gwymac -L lan_channel_num ]
[-A alertip -X alertmac -C community ]
[-u user_to_set -p password_to_set ]
[-N nodename -U rmt_username -Fimb ]
[-P/-R rmt_node_pswd -EFJTVY ]
DESCRIPTION
pefconfig is a program that uses an IPMI driver to send IPMI commands
which configure a new Platform Event Filter table entry for an OS
Critical Stop (0x20) SEL firmware log event, so that it will be
enabled to send a BMC LAN Alert. This utility also sets up all of the
BMC LAN Parameters to enable sending the BMC LAN Alerts. The IP
address and MAC address of the local system, the default gateway, and
the alert destination can be defaulted to those specified in Linux, or
can be overridden by user parameters. This utility can use either the
/dev/ipmi0 driver from OpenIPMI, the /dev/imb driver from Intel, the
/dev/ipmikcs driver from valinux, direct user-space IOs, or the IPMI
LAN interface if -N. This utility is designed to be used on systems
with IPMI 1.5 or greater in order to support PEF records.
OPTIONS
Command line options are described below. Note that without options,
pefconfig behaves as if option -r were used. To configure IPMI LAN &
PEF, use option -e.
-a alertnum
Specify which PEF alert number is to be used. Default is 1.
This would only be used if extra PEF alert destinations had
been set.
-d This option disables the BMC LAN and PEF parameters, so as not
to allow BMC LAN connections or alerts.
-e This option enables the BMC LAN configuration and PEF event
alerts. The utility will attempt to obtain the default BMC LAN
parameters from the OS automatically, or they can be specified
with command options below.
-i ethif
By default, the eth0 interface is used to find IP and MAC
addresses. Sometimes, however, the first ethernet port on the
baseboard may be represented by Linux as eth1 or eth2 instead.
If so, use this option to indicate the correct ethernet inter-
face to use. By default, pefconfig will scan up to 32 eth
interfaces for the onboard one that BMC LAN uses.
-g This specifies the secondary gateway IP address to use for the
BMC LAN. The default is to omit this parameter and only use
the default gateway. See also -G.
-j This sets a custom PEF rule as the last PEF entry. The input
is a series of 10 hex bytes, forming the PEF entry. For
example, this sample PEF entry would perform a power down
action if the Baseboard Temp reached its threshold.
"ipmiutil lan -e -j020110ffff013001950a"
-k This causes pefconfig to also insert two rules to send alerts
for transition-to-OK events, including Power Redundancy OK and
Temperature OK.
-l This option enables the BMC LAN configuration, but not PEF
events. The utility will attempt to obtain the default BMC LAN
parameters from the OS automatically, or they can be specified
with command options below.
-n num By default, the new PEF entry for OS Critical Stop is inserted
at offset 12 into the table. This can be changed to insert it
at an offset > 12 if another entry already exists at offset 12.
-o Disable Only SOL. This could be used after the IPMI LAN was
configured, to disable Serial-Over-LAN console access but still
allow other IPMI LAN access.
-# Same as -q below.
-q Specify an alternate user number for the LAN username from the
-u option. This is normally user number 2, 3, or 4, where 2 is
the default. The maximum number of users is 15.
-r This option just reads the configuration without writing any
BMC LAN parameters or writing any new entries to the PEF table.
-s This option will also display some of the Serial parameters.
-t Test if the BMC LAN has already been configured. Returns 0 if
so.
-v priv
Set a specific access priVilege for this user, where priv can
be: 1=Callback, 2=User, 3=Operator, 4=Admin, 5=OEM, 15=NoAccess
The default if not specified or specified in error, is to use
4=Admin.
-x Causes extra debug messages to be displayed.
-z Also show the IPMI LAN Statistics
-B baud_sol
This specifies the Baud rate for SerialOverLan. The possible
values are: 9600, 19.2k, 38.4k, 57.6k, and 115.2k. The default
is 19.2k.
-D This causes the local IP address to be determined by DHCP
instead of a static IP address.
-I ip_addr
This specifies the local IP address to use for the BMC LAN on
eth0. The default is to automatically obtain this from the
Linux ifconfig.
-M mac_addr
This specifies the local MAC address to use for the BMC LAN on
eth0. The format can be either 11:22:33:44:55:66 or
11-22-33-44-55-66. The default is to automatically obtain this
from the Linux ifconfig.
-S subnet
This specifies the local subnet mask to use for the BMC LAN on
eth0. The default is to automatically obtain this from the
Linux ifconfig.
-G gwy_ip_addr
This specifies the default gateway IP address to use for the
BMC LAN. The default is to automatically obtain this from the
Linux route table.
-H gwy_mac_addr
This specifies the default gateway’s MAC address to use for the
BMC LAN. The format can be either 11:22:33:44:55:66 or
11-22-33-44-55-66. The default is to automatically obtain this
from the Linux arp cache.
-A alert_ip_addr
This specifies the SNMP Alert Destination IP address to use for
the BMC LAN. By default, this utility will attempt to obtain
this from the /etc/snmp/snmpd.conf file, via the trapsink
parameter. The alert destination will see the BMC LAN traps
with the enterprises.3183.1.1 OID. If no alert IP address is
specified in either snmpd.conf or this parameter, or if that IP
address does not respond, the other SNMP parameters for BMC LAN
will be skipped.
-X alert_mac_addr
This specifies the SNMP Alert Destinations’s MAC address to use
for the BMC LAN. The format can be either 11:22:33:44:55:66 or
11-22-33-44-55-66. The default is to attempt to obtain this
from the Linux arp cache. This parameter is ignored if there
is no Alert IP address.
-C snmp_community
This specifies the SNMP Community name to use for BMC LAN
Alerts. The default community string is "public". This param-
eter is ignored if there is no Alert IP address.
-u username_to_set
This specifies the firmware username to set for BMC LAN access.
If a username is specified, user 3 will be set. If not speci-
fied, the default user 1 will be used.
-p password_to_set
This specifies the firmware password to set for BMC LAN access.
If not specified, the user and password configuration will not
be changed.
-L lan_ch_num
This specifies the IPMI LAN channel number used for BMC LAN.
This varies by platform, and can be found in the platform tech-
nical specifications. By default, pefconfig scans all IPMI
channels to find a LAN channel for BMC LAN.
-N nodename
Nodename or IP address of the remote target system. If a node-
name is specified, IPMI LAN interface is used. Otherwise the
local system management interface is used.
-P/-R rmt_pswd
Remote password for the nodename given. The default is a null
password.
-U rmt_user
Remote username for the nodename given. The default is a null
username.
-E Use the remote password from Environment variable IPMI_PASS-
WORD.
-F drv_t
Force the driver type to one of the followng: imb, va, open,
gnu, landesk, lan, lan2, lan2i, kcs, smb. Note that lan2i
means lan2 with intelplus. The default is to detect any avail-
able driver type and use it.
-J Use the specified LanPlus cipher suite (0 thru 14):
0=none/none/none, 1=sha1/none/none, 2=sha1/sha1/none,
3=sha1/sha1/cbc128, 4=sha1/sha1/xrc4_128, 5=sha1/sha1/xrc4_40,
6=md5/none/none, ... 14=md5/md5/xrc4_40. Default is 3.
-T Use a specified IPMI LAN Authentication Type: 0=None, 1=MD2,
2=MD5, 4=Straight Password, 5=OEM.
-V Use a specified IPMI LAN privilege level. 1=Callback level,
2=User level, 3=Operator level, 4=Administrator level
(default), 5=OEM level.
-Y Yes, do prompt the user for the IPMI LAN remote password.
Alternatives for the password are -E or -P.
EXAMPLES
To read existing settings:
pefconfig -r
To enable IPMI LAN with default settings detected:
pefconfig -e
To set up IPMI LAN for a unique IP address and set PEF SNMP Alerts:
pefconfig -e -I 192.168.1.1 -A 192.168.1.10
To set the IPMI LAN password for the default user:
pefconfig -e -p mypassword
To disable access to the IPMI LAN channel:
pefconfig -d
SAMPLE PEF TABLE
These 11 PEF table entries are configured from the factory for various
Intel Sahalee BMC systems, and will be applied as the defaults for a
system with an empty PEF table:
PEF(01): 01 Temperature Sensor event - enabled for alert
01 c0 01 01 00 ff ff 01 ff 01 95 0a 00 00 00 00 00 00 00 00 00
PEF(02): 02 Voltage Sensor event - enabled for alert
02 c0 01 01 00 ff ff 02 ff 01 95 0a 00 00 00 00 00 00 00 00 00
PEF(03): 04 Fan Failure event - enabled for alert
03 c0 01 01 00 ff ff 04 ff 01 95 0a 00 00 00 00 00 00 00 00 00
PEF(04): 05 Chassis Intrusion event - enabled for alert
04 c0 01 01 00 ff ff 05 05 6f 01 00 00 00 00 00 00 00 00 00 00
PEF(05): 08 Power Supply Fault event - enabled for alert
05 c0 01 01 00 ff ff 08 ff 6f 06 00 00 00 00 00 00 00 00 00 00
PEF(06): 0c Memory ECC Error event - enabled for alert
06 c0 01 01 00 ff ff 0c 08 6f 02 00 00 00 00 00 00 00 00 00 00
PEF(07): 0f FRB Failure event - enabled for alert
07 c0 01 01 00 ff ff 0f 06 6f 01 00 00 00 00 00 00 00 00 00 00
PEF(08): 07 BIOS POST Error event - enabled for alert
08 c0 01 01 00 ff ff 07 ff 6f 1c 00 00 00 00 00 00 00 00 00 00
PEF(09): 13 Fatal NMI event - enabled for alert
09 c0 01 01 00 ff ff 13 ff 6f 3e 03 00 00 00 00 00 00 00 00 00
PEF(10): 23 Watchdog Timer Reset event - enabled for alert
0a c0 01 01 00 ff ff 23 03 6f 0e 00 00 00 00 00 00 00 00 00 00
PEF(11): 12 System Restart event - enabled for alert
0b c0 01 01 00 ff ff 12 ff 6f 02 00 00 00 00 00 00 00 00 00 00
SEE ALSO
alarms(8) bmchealth(8) fruconfig(8) getevent(8) hwreset(8) icmd(8)
sensor(8) showsel(8) tmconfig(8) wdt(8)
WARNINGS
See http://ipmiutil.sourceforge.net/ for the latest version of pefcon-
fig and any bug fix list.
SENSOR
3.9 SENSOR (ipmiutil sensor)
SENSOR(8) SENSOR(8)
NAME
sensor (ipmiutil sensor) - show Sensor Data Records
SYNOPSIS
sensor [-acmprstuvwx -g typ -i id -n snum -h tval -l tval -NUPREFJTVY]
DESCRIPTION
sensor is a program that uses IPMI commands to show and decode Sensor
Data Records and current sensor readings for all sensors in the sys-
tem. The readings are only retrieved for Full SDR records. This
utility can use either the /dev/ipmi0 driver from OpenIPMI, the
/dev/imb driver from Intel, the /dev/ipmikcs driver from valinux,
direct user-space IOs, or the IPMI LAN interface if -N.
Note that this utility currently only displays Sensor Data Records
reported by from the BMC chipset. Some systems may have other devices
with sensors that are also available via IPMI.
OPTIONS
Command line options are described below.
-a snum
ReArms the sensor number for events
-c Shows SDRs for the Child MCs on a PICMG or ATCA system.
-g sens_type
Shows only those SDRs matching the given sensor type group.
The sens_type string can be "fan", "temp", "voltage", or any
string matching those in the IPMI 2.0 Table 42-3 for Sensor
Types. Multiple types can be listed, separated by a comma (,)
but no spaces.
-h tval
Highest threshold value to set for the specified sensor. This
tval can be in decimal, or of the form 0x1a, to match the raw
reading value shown by sensor following the " = ". The value
passed is set as the non-critical threshold value, with the
more critical ones set by the utility as incrementally lower.
This simplifies the interface and ensures that the threshold
values do not get out of order. This requires specifying the
sensor number via -n.
-i ID Show or set only the sensor Index corresponding to ID, where ID
is the hex ID of the SDR as shown in the sensor output under
"_ID_". The ID argument can be one hex number (e.g. 0x0e or
0e), or a range of hex numbers (e.g. 0e-1a or 1a,2a or
0x0e-0x2a). This is useful to repeatedly view just a few sen-
sor readings for changes, or to set just one sensor quickly
without reading all of the SDRs.
-l tval
Lowest threshold value to set for the specified sensor. This
tval can be in decimal, or of the form 0x1a, to match the raw
reading value shown by sensor following the " = ". The value
passed is set as the non-critical threshold value, with the
more critical ones set by the utility as incrementally higher.
This simplifies the interface and ensures that the threshold
values do not get out of order. This requires specifying the
sensor number via -n.
-m 002000
Show SDRs for a specific MC (e.g. bus 00, sa 20, lun 00). This
would be used for PICMG or ATCA blade systems.
-n snum
Number of the sensor to set. This num can be in decimal, or of
the form 0x1a, to match the value shown by sensor following the
"snum" tag. This is required if setting hi/lo thresholds via
-h/-l.
-p Persist the threshold being set (as specified via -l or -h).
This writes a "sensor -i" script line to the file
/usr/share/ipmiutil/thresholds.sh, which can then be executed
at each reboot by including it in /etc/init.d for the desired
runlevel. For Windows, the filename is thresholds.cmd.
-r Show Raw SDR bytes also.
-s Show sensor list in a simpler format without uninterpreted
binary values. Only the user-friendly interpreted sensor
information is shown.
-t Show any Thresholds for each sensor also.
-u Set unique threshold values. The values are specified in a
string of threshold values. It can be in raw hex characters or
in float values. All 6 possible thresholds must be specified,
but only the ones that are valid for this sensor will be
applied. These values are validated for ordering. For example:
-u 6:5:4:60:65:69 (float) or
-u 0x0605043c4145 (raw hex)
would mean 0x06=noncrit_lo, 0x05=crit_lo, 0x04=nonrec_lo,
0x3c=noncrit_hi, 0x41=crit_hi, 0x45=nonrec_hi.
-v Show Verbose output, including volatile thresholds, SDR thresh-
olds, max/min, hysteresis, and BMC_TAM decoding.
-w Wrap the threshold data onto the same line as the sensor. This
may be convenient for scripting.
-x Causes eXtra debug messages to be displayed.
-L n Loop n times. This is useful along with -i. Default is one
loop.
-N nodename
Nodename or IP address of the remote target system. If a node-
name is specified, IPMI LAN interface is used. Otherwise the
local system management interface is used.
-P/-R rmt_pswd
Remote password for the nodename given. The default is a null
password.
-U rmt_user
Remote username for the nodename given. The default is a null
username.
-E Use the remote password from Environment variable IPMI_PASS-
WORD.
-F drv_t
Force the driver type to one of the followng: imb, va, open,
gnu, landesk, lan, lan2, lan2i, kcs, smb. Note that lan2i
means lan2 with intelplus. The default is to detect any
available driver type and use it.
-J Use the specified LanPlus cipher suite (0 thru 14):
0=none/none/none, 1=sha1/none/none, 2=sha1/sha1/none,
3=sha1/sha1/cbc128, 4=sha1/sha1/xrc4_128, 5=sha1/sha1/xrc4_40,
6=md5/none/none, ... 14=md5/md5/xrc4_40. Default is 3.
-T Use a specified IPMI LAN Authentication Type: 0=None, 1=MD2,
2=MD5, 4=Straight Password, 5=OEM.
-V Use a specified IPMI LAN privilege level. 1=Callback level,
2=User level, 3=Operator level, 4=Administrator level
(default), 5=OEM level.
-Y Yes, do prompt the user for the IPMI LAN remote password.
Alternatives for the password are -E or -P.
EXAMPLES
ipmiutil sensor sample output is below.
ipmiutil ver 2.21
sensor: version 2.21
-- BMC version 0.17, IPMI version 2.0
_ID_ SDR_Type_xx ET Own Typ S_Num Sens_Description Hex & Interp
Reading
000b SDR Full 01 01 20 a 01 snum 30 Baseboard Temp = 2e OK 46.00
degrees C
000e SDR Full 01 01 20 m 04 snum 50 Fan 1A = 6f OK 7659.00
RPM
0042 SDR Comp 02 6f 20 a 21 snum e0 DIMM 1A = 00 c0 04 00
Present
004e SDR FRU 11 1b dev: 20 03 80 00 0a 01 Pwr Supply 1 FRU
0050 SDR IPMB 12 1b dev: 20 00 bf 07 01 Basbrd Mgmt Ctlr
0051 SDR OEM c0 09 Intel: 02 02 00 01 70 71
0065 SDR OEM c0 11 Intel: SDR Package 17
[...]
Output Columns:
_ID_: This is an SDR ID or index number, in hex. This may vary from
chassis to chassis.
SDR_Type_xx: This shows the SDR Type and its hex representation. Some
SDR types have a custom display. The OEM SDRs only show the OEM ven-
dor by IANA number and then usually the data is listed in hex.
ET: For Full or Comp SDRs, this shows the Event Type. For other SDRs,
this shows the size of the SDR entry in hex (Sz).
Own: This is the hex slave address of the SDR Owner, usually 20 if
BMC.
a/m: This indicates whether this sensor is either automatically or
manually rearmed, respectively.
S_Num: This is the sensor number in hex. This remains consistent
across baseboards of the same type. The output can be parsed with the
"snum" delimiter to extract this value.
Sens_Description: This is the text description of this SDR, which is
stored within the SDR on the BMC.
Hex & Interp Reading: This is the raw hex value returned by GetSensor-
Reading, and its interpreted meaning.
SEE ALSO
alarms(8) bmchealth(8) fruconfig(8) getevent(8) hwreset(8) icmd(8)
pefconfig(8) showsel(8) tmconfig(8) wdt(8) bmcconfig(8) idiscover(8)
ipmiutil(8)
WARNINGS
See http://ipmiutil.sourceforge.net/ for the latest version of sensor
and any bug fix list.
SHOWSEL
3.10 SHOWSEL (ipmiutil sel)
SHOWSEL(8) SHOWSEL(8)
NAME
showsel (ipmiutil sel) - show firmware System Event Log records
SYNOPSIS
showsel [-bcflswvx -N node -P/-R pswd -U user -EFJTVY]
DESCRIPTION
showsel is a program that uses IPMI commands to to read and display
the System Event Log (SEL) which is stored by the BMC firmware. IPMI
commands are issued to read each record, and, if specified, incremen-
tally write records that have not previously been read into the Linux
syslog (/var/log/messages). This utility can use either the
/dev/ipmi0 driver from OpenIPMI, the /dev/imb driver from Intel, the
/dev/ipmikcs driver from valinux, direct user-space IOs, or the IPMI
LAN interface if -N.
OPTIONS
Command line options are described below.
-b bin_file
Interpret a file containing raw binary/hex SEL data dumped in
binary form, such as that produced by "ipmitool sel writeraw
bin_file". Each set of 16 bytes in the file will be inter-
preted as an IPMI event.
-c Clears the SEL of all records. If the SEL becomes full (free
space = 0), it no longer accepts new records, so the SEL should
be cleared periodically.
-f sel_file
Interpret a file containing raw ascii text SEL data captured
with ipmiutil sel -r, or some other similar utility. Each line
in the file should be in this form, with no leading spaces:
04 00 02 76 a9 4a 47 20 00 04 10 09 6f 42 0f ff
Lines not in this format will be ignored.
-l N Show last N SEL records, in reverse order (newest first). For
some BMC implementations, this may not show all N records spec-
ified.
-r Show the 16 raw hex bytes for each SEL entry. The default is
to display interpreted entries, and include relevant hex event
bytes.
-s By default, all SEL records are displayed. This option causes
only the records with sensor_type = 0x20 (OS Critical Stop) to
be displayed.
-v Only show the version information. This shows: the showsel
utility version, the BMC version, the IPMI version, the SEL
version, and the amount of free space in the SEL.
-w This option writes SEL records to the Linux syslog
(/var/log/messages) or Windows Application Log. It only writes
SEL records that have timestamps newer than the last record
written to syslog. It saves the last timestamp in an index
file named /usr/share/ipmiutil/sel.idx (.\sel.idx in Windows).
-x Causes extra debug messages to be displayed.
-N nodename
Nodename or IP address of the remote target system. If a node-
name is specified, IPMI LAN interface is used. Otherwise the
local system management interface is used.
-U rmt_user
Remote username for the nodename given. The default is a null
username.
-P/-R rmt_pswd
Remote password for the nodename given. The default is a null
password.
-E Use the remote password from Environment variable IPMI_PASS-
WORD.
-F drv_t
Force the driver type to one of the followng: imb, va, open,
gnu, landesk, lan, lan2, lan2i, kcs, smb. Note that lan2i
means lan2 with intelplus. The default is to detect any avail-
able driver type and use it.
-J Use the specified LanPlus cipher suite (0 thru 14):
0=none/none/none, 1=sha1/none/none, 2=sha1/sha1/none,
3=sha1/sha1/cbc128, 4=sha1/sha1/xrc4_128, 5=sha1/sha1/xrc4_40,
6=md5/none/none, ... 14=md5/md5/xrc4_40. Default is 3.
-T Use a specified IPMI LAN Authentication Type: 0=None, 1=MD2,
2=MD5, 4=Straight Password, 5=OEM.
-V Use a specified IPMI LAN privilege level. 1=Callback level,
2=User level, 3=Operator level, 4=Administrator level
(default), 5=OEM level.
-Y Yes, do prompt the user for the IPMI LAN remote password.
Alternatives for the password are -E or -P.
SEE ALSO
alarms(8) bmchealth(8) fruconfig(8) getevent(8) hwreset(8) icmd(8)
pefconfig(8) sensor(8) tmconfig(8) wdt(8) ievents(8)
WARNINGS
See http://ipmiutil.sourceforge.net/ for the latest version of showsel
and any bug fix list.
TMCONFIG
3.11 TMCONFIG (ipmiutil serial)
TMCONFIG(8) TMCONFIG(8)
NAME
tmconfig (ipmiutil serial) - configure a system for Serial/EMP manage-
ment functions, such as Terminal Mode, and optionally share the port
with the Serial Console.
SYNOPSIS
tmconfig [-bcdeflq#rsvxB -m0 -m1 -n ser_chan -u user -p passwd -NUPRE-
FJTVY]
DESCRIPTION
tmconfig is a program that uses an IPMI driver to send IPMI commands
which configure a system to enable EMP/serial Terminal Mode management
functions within the firmware, so that an administrator can use com-
mand-line character commands via the serial port to power cycle the
system and perform other functions, even if the system is not running
an OS. This level of access needs to be protected by a username/pass-
word login, which can be specified with this utility. This utility
can use either the /dev/ipmi0 driver from OpenIPMI, the /dev/imb
driver from Intel, the /dev/ipmikcs driver from valinux, direct user-
space IOs, or the IPMI LAN interface if -N.
OPTIONS
Command line options are described below.
-b Set up and enable the Serial Port EMP parameters for Basic Mode
management functions. This does not set a username or pass-
word.
-c Configure and enable the Serial Port EMP parameters for Termi-
nal Mode management functions, shared with BIOS Console Redi-
rection. Setting a new username and password for serial access
via -u and -p is recommended for security.
-d Disable the serial port access for IPMI commands. The serial
port is then only available for BIOS console and OS functions.
A side-effect of this option is that it sets the default user
(1) back to admin access.
-e Enable EMP Terminal Mode without shared BIOS console. The
serial port is then only available for EMP Terminal Mode func-
tions.
-f Specifies the Flow Control for the Serial EMP. 0 means no flow
control, and 1 means RTS/CTS flow control (default). This must
match the BIOS Serial Console setting.
-l Show LAN Parameters. This option reads and displays the LAN
Parameter configuration also.
-m0 Switch the Serial Port MUX to Baseboard/BIOS Console operation.
Set no other configuration parameters.
-m1 Switch the Serial Port MUX to Terminal Mode management. Set no
other configuration parameters.
-n ser_chan
Sets the IPMI channel number to use for the EMP serial channel
(often 4). Note that the IPMI channels for LAN, Serial, etc.
are numbered differently on each platform type. The default is
to detect the first available IPMI serial channel.
-# Same as -q below.
-q Specify an alternate user number for the EMP Username from the
-u option. This is normally user number 2, 3, or 4, where 3 is
the default. The maximum number of users is 15.
-r Read Only. This option just reads the Serial Parameter config-
uration without writing any values.
-s Set up and enable the Serial Port EMP parameters for Shared
operation between Basic Mode management functions and Baseboard
(BIOS) Remote Console. This option switches the Serial Port
MUX to Baseboard Console operation.
-t Configure and enable the Serial Port EMP parameters for Termi-
nal Mode management functions, shared with BIOS Console Redi-
rection. Same as -c, but easier to remember.
-u username
This specifies a username for the EMP Terminal Mode login. It
can be any string, up to 15 characters. If -u is not used, the
default user 1 (null) will be assumed. The username, if speci-
fied, will be set for user 3, unless option -q is specified.
-p password
This specifies a password for the EMP Terminal Mode login. It
can be any string, up to 15 characters. A null password is
used if none is specified. This password applies to user 3 if
-u is used, to user 1 otherwise.
-v priv
Set a specific access priVilege for this user, where priv can
be: 1=Callback, 2=User, 3=Operator, 4=Admin, 5=OEM, 15=NoAccess
The default if not specified or specified in error, is to use
4=Admin.
-x Causes extra debug messages to be displayed.
-B Set the Baud rate of the serial port to one of the following:
9600, 19,2K, 38.4K, 57.6K, or 115.2K. The default is 19.2K
bps.
-N nodename
Nodename or IP address of the remote target system. If a node-
name is specified, IPMI LAN interface is used. Otherwise the
local system management interface is used.
-P/-R rmt_pswd
Remote password for the nodename given. The default is a null
password.
-U rmt_user
Remote username for the nodename given. The default is a null
username.
-E Use the remote password from Environment variable IPMI_PASS-
WORD.
-F drv_t
Force the driver type to one of the followng: imb, va, open,
gnu, landesk, lan, lan2, lan2i, kcs, smb. Note that lan2i
means lan2 with intelplus. The default is to detect any avail-
able driver type and use it.
-J Use the specified LanPlus cipher suite (0 thru 14):
0=none/none/none, 1=sha1/none/none, 2=sha1/sha1/none,
3=sha1/sha1/cbc128, 4=sha1/sha1/xrc4_128, 5=sha1/sha1/xrc4_40,
6=md5/none/none, ... 14=md5/md5/xrc4_40. Default is 3.
-T Use a specified IPMI LAN Authentication Type: 0=None, 1=MD2,
2=MD5, 4=Straight Password, 5=OEM.
-V Use a specified IPMI LAN privilege level. 1=Callback level,
2=User level, 3=Operator level, 4=Administrator level
(default), 5=OEM level.
-Y Yes, do prompt the user for the IPMI LAN remote password.
Alternatives for the password are -E or -P.
EXAMPLES
tmconfig -t (or -c)
Enables Terminal Mode management functions, shared with BIOS
Serial Console redirection. The user can switch between serial
console operations and IPMI Terminal Mode commands by typing
ESC ’)’ and ESC ’Q’.
tmconfig -s
Enables Basic Mode management functions shared with BIOS Serial
Console redirection. The user can switch between serial con-
sole operations and IPMI Basic Mode management programs on the
same serial port.
tmconfig -d
Disables the serial port management functions. This would be
used if only the BIOS Serial Console were used and no BMC
serial management functions.
How to login to a Terminal Mode console:
ESC ( (switch to Terminal mode)
[SYS PWD -N ] (login for default user, null psw)
[SYS PWD -U ROOT -N PASSWORD] (syntax example for user 3)
[SYS 000157 ACTIVATE] (activate advanced commands)
[SYS HEALTH QUERY]
[SYS HELP]
[SYS PWD] (logoff)
ESC Q (switch to BIOS console)
See IPMI 1.5 Spec, Appendix E, and Intel TIGPR2U TPS for more informa-
tion.
DEPENDENCIES
The tmconfig utility is intended to configure the EMP serial port on
the server for shared access between BMC/IPMI functions and BIOS Con-
sole Redirection. Some platforms only support only Basic Mode for
BMC/IPMI functions. Basic Mode requires a remote client application
to utilize it (Windows ISC Console/DPC, or a special modified Linux
telnet). There are some platforms which implement Terminal Mode via
IPMI v1.5 Appendix E to make remote management with character commands
available on the serial port without a special remote client applica-
tion.
For example, Intel TSRLT2 systems would use "tmconfig -s" for Basic
Mode shared functions, but Intel TIGPR2U systems could use "tmconfig
-c" to configure Terminal Mode functions. On your system, run "tmcon-
fig -r" to check whether Serial Param(29): "Terminal Mode Config" is
supported. If not, configure Basic Mode via "tmconfig -s".
PLATFORM SERIAL PORT CONFIGURATION EXAMPLES
First, enter BIOS Setup for Serial Console Redirection parameters:
(these vary by platform)
Console Redirection = Serial Port B
ACPI Redirection = Disabled
Baud Rate = 115.2K
Flow Control = CTS/RTS
Terminal Type = VT100
Legacy Redirection = Enabled
Note that the Baud Rate can vary, but it must match in all locations
where it is used (BIOS, IPMI, and Linux).
For some non-Intel platforms, the serial console would be COM1 instead
of COM2, but should be enabled in BIOS.
From Linux, run "tmconfig -c" for Terminal Mode shared configuration.
Or, on older Intel TSRLT2 platforms: From Linux, run "tmconfig -s" for
Basic Mode Shared configuration.
LINUX CONFIGURATION FOR SERIAL CONSOLE
If using lilo, in /etc/lilo.conf, add
append="console=ttyS1,19200n8 console=tty0"
(and comment out the "message=" line because it includes graphics)
Note that the append line can be placed in the global section and
removed from each kernel section if there are no other differences.
Or, if using grub, edit /boot/grub/grub.conf as follows:
#Omit the splashimage or gfxmenu
# splashimage=(hd0,0)/grub/splash.xpm.gz
#The serial and terminal lines are not usually needed
# serial --unit=1 --speed=19200 --word=8 --parity=no --stop=1
# terminal --timeout=10 serial console
#Add the console=ttyS* parameter to the kernel line
kernel (hd0,0) /vmlinuz root=/dev/sda2 console=ttyS1,19200n8
Add this line to /etc/initab, if ttyS1 is not already there:
co:2345:respawn:/sbin/agetty ttyS1 19200 vt100
Add this line to /etc/securetty, if ttyS1 is not already there:
ttyS1
SEE ALSO
alarms(8) bmchealth(8) fruconfig(8) getevent(8) hwreset(8) icmd(8)
pefconfig(8) sensor(8) showsel(8) wdt(8)
WARNINGS
See http://ipmiutil.sourceforge.net/ for the latest version of tmcon-
fig and any bug fix list.
WDT
3.12 WDT (ipmiutil wdt)
WDT(8) WDT(8)
NAME
wdt (ipmiutil wdt)- display and set WatchDog Timer parameters
SYNOPSIS
wdt [-adelrtx -N node -P/-R pswd -U user -EFJTVY]
DESCRIPTION
wdt is a program that uses IPMI commands to display and set WatchDog
Timer parameters.
This utility can use either the /dev/ipmi0 driver from OpenIPMI, the
/dev/imb driver from Intel, the /dev/ipmikcs driver from valinux,
direct user-space IOs, or the IPMI LAN interface if -N.
This utility is an example of how to access the IPMI watchdog parame-
ters directly, which allows changing the timer configuration.
There is an init script provided with ipmiutil to automate the task of
managing the watchdog timer in user-space. # chkconfig --add ipmiu-
til_wdt (skip this if no chkconfig) # /etc/init.d/ipmiutil_wdt
start This sets the watchdog timer to reset the system if the wdt is
not restarted within 90 seconds. It creates an /etc/cron.d/wdt file
to restart wdt every 60 seconds. See also ipmiutil UserGuide section
4.4 for more information.
OPTIONS
Command line options are described below.
-a N Set watchdog event Action to N. Values: 0 = No action, 1 = Hard
Reset(default), 2 = Power down, 3 = Power cycle.
-d Disables the watchdog timer.
-e Enables the watchdog timer. The timer is not actually started,
however, until the timer is reset. The pre-timeout action is
not enabled.
-l Set the watchdog dontLog bit to not log watchdog events in the
SEL.
-p N Set watchdog Pretimeout event action to N. Values: 0 = No
action(default), 1 = SMI, 2 = NMI, 3 = Messaging Interrupt. If
this is set to an action other than 0, the pretimeout will also
be set to 90% of the timeout. However, if the timeout is less
than 20 seconds, the pretimeout will not be enabled.
-r Resets the watchdog timer. This should be done every N seconds
if the timer is running to prevent the watchdog action (usually
a system reset) from occurring.
-tN Set the watchdog Timeout to N seconds. The default is 120 sec-
onds (2 minutes).
-x Causes extra debug messages to be displayed.
-N nodename
Nodename or IP address of the remote target system. If a node-
name is specified, IPMI LAN interface is used. Otherwise the
local system management interface is used.
-P/-R rmt_pswd
Remote password for the nodename given. The default is a null
password.
-U rmt_user
Remote username for the nodename given. The default is a null
username.
-E Use the remote password from Environment variable IPMI_PASS-
WORD.
-F drv_t
Force the driver type to one of the followng: imb, va, open,
gnu, landesk, lan, lan2, lan2i, kcs, smb. Note that lan2i
means lan2 with intelplus. The default is to detect any avail-
able driver type and use it.
-J Use the specified LanPlus cipher suite (0 thru 14):
0=none/none/none, 1=sha1/none/none, 2=sha1/sha1/none,
3=sha1/sha1/cbc128, 4=sha1/sha1/xrc4_128, 5=sha1/sha1/xrc4_40,
6=md5/none/none, ... 14=md5/md5/xrc4_40. Default is 3.
-T Use a specified IPMI LAN Authentication Type: 0=None, 1=MD2,
2=MD5, 4=Straight Password, 5=OEM.
-V Use a specified IPMI LAN privilege level. 1=Callback level,
2=User level, 3=Operator level, 4=Administrator level
(default), 5=OEM level.
-Y Yes, do prompt the user for the IPMI LAN remote password.
Alternatives for the password are -E or -P.
SEE ALSO
alarms(8) bmchealth(8) fruconfig(8) getevent(8) hwreset(8) icmd(8)
pefconfig(8) sensor(8) showsel(8) tmconfig(8)
WARNINGS
See http://ipmiutil.sourceforge.net/ for the latest version of wdt and
any bug fix list.
ISOLCONSOLE
3.13 ISOLCONSOLE (ipmiutil sol)
ISOLCONSOLE(8) ISOLCONSOLE(8)
NAME
isolconsole (ipmiutil sol) - an IPMI Serial-Over-LAN Console applica-
tion
SYNOPSIS
isolconsole [-acdelrvwxz -NUPREFJTVY]
DESCRIPTION
This utility starts an IPMI Serial-Over-LAN console session. A
Serial-over-LAN console allows the client to see and modify functions
before the OS boots, such as BIOS setup, grub, etc. This utility uses
either the IPMI LAN 1.5 or 2.0 SOL interface. The 1.5 SOL interface
is specific to Intel BMCs, while any IPMI 2.0 BMC should support 2.0
SOL. The target system/node must first have these parameters config-
ured before SOL sessions can be started:
- [BIOS] serial console redirection parameters,
- [IPMI] lan and SOL parameters (see ipmiutil lan or pefconfig), and
- [OS] For Linux, edit grub.conf, inittab, and securetty parameters.
Be sure that the baud rate matches in all of the above places. See
the ipmiutil UserGuide section 4.8 for details.
OPTIONS
-a Activate the SOL Console session, and enter console mode. Use
the escape character (’~’) to exit the session.
-c^ Set the escape Character to ^, or other ANSI character. This
character will end the SOL session. The default escape charac-
ter is ~.
-d Deactivate the SOL Console session. Use this if the previous
session was aborted abnormally and starting a new session gives
an error.
-e Turn Encryption off in negotiation when activating a session.
By default, encryption is on for Serial-Over-LAN console ses-
sions.
-l Use Legacy BIOS mapping for Enter key (CR+LF) instead of just
LF. This is needed for BIOS Setup menus and DOS, but causes an
extra LF to occur in Linux. So, only use this option if doing
BIOS or DOS changes. This should be seldom be needed since the
default is now to automatically detect BIOS Setup menus and
change the mapping.
-r (Windows only) Use Raw terminal I/O instead of custom VT100 to
ANSI translation. Use this option if the server is configured
in BIOS and BMC for ANSI and the utility is being invoked from
Windows.
-i input_file
Use this file as an input script. The input_file will be read
after the session is established. This can be used to automate
certain tasks. The input_file is read one line at a time. If
the input_file does not have an escape character (~) to end the
session, then the input is returned to the keyboard when the
file ends.
-o output_file
Use a Trace log. The output_file is created and all SOL screen
output is written to the file, including VT100 escape
sequences. If the output_file exists, the output is appended
to it. This can be used to log what the user has done in an
SOL session.
-w (Windows only) Do not use the Windows Console buffer, but use
Windows stdio instead. This does not handle cursor positioning
correctly in some cases, however.
-v log_file
Causes debug messages to be displayed to the specified debug
log_file. The default log_file is isoldbg.log in the current
directory.
-x Causes debug messages to be displayed to the debug log file.
-z Causes more verbose debug messages to be displayed to the debug
log file.
-N nodename
Nodename or IP address of the remote target system. If a node-
name is specified, IPMI LAN interface is used. Otherwise the
local system management interface is used.
-U rmt_user
Remote username for the nodename given. The default is a null
username.
-P/-R rmt_pswd
Remote password for the nodename given. The default is a null
password.
-E Use the remote password from Environment variable IPMI_PASS-
WORD.
-F drv_t
Force the driver type to one of the followng: imb, va, open,
gnu, landesk, lan, lan2, lan2i, kcs, smb. Note that lan2i
means lan2 with intelplus. The default is to detect any sup-
ported driver type and use it.
-J Use the specified LanPlus cipher suite (0 thru 14):
0=none/none/none, 1=sha1/none/none, 2=sha1/sha1/none,
3=sha1/sha1/cbc128, 4=sha1/sha1/xrc4_128, 5=sha1/sha1/xrc4_40,
6=md5/none/none, ... 14=md5/md5/xrc4_40. Default is 3.
-T Use a specified IPMI LAN Authentication Type: 0=None, 1=MD2,
2=MD5, 4=Straight Password, 5=OEM.
-V Use a specified IPMI LAN privilege level. 1=Callback level,
2=User level, 3=Operator level, 4=Administrator level
(default), 5=OEM level.
-Y Yes, do prompt the user for the IPMI LAN remote password.
Alternatives for the password are -E or -P.
EXAMPLES
isolconsole -a -N nodename -U username -P password
Starts an SOL console session to the nodename. Detect the lan proto-
col.
isolconsole -a -N nodename -U username -P password -Flan2
Starts an SOL console session to the nodename. Force lan protocol to
2.0.
SEE ALSO
alarms(8) bmchealth(8) fruconfig(8) getevent(8) hwreset(8) pefcon-
fig(8) sensor(8) showsel(8) tmconfig(8) wdt(8) icmd(8) ipmiutil(8)
WARNINGS
See http://ipmiutil.sourceforge.net/ for the latest version of icmd
and any bug fix list.
IDISCOVER
3.14 IDISCOVER (ipmiutil discover)
IDISCOVER(8) IDISCOVER(8)
NAME
idiscover (ipmiutil discover) - discover IPMI LAN-enabled nodes
SYNOPSIS
idiscover [-abegisx]
DESCRIPTION
idiscover is a program that uses IPMI LAN commands to discover any
nodes on the LAN that are available, by probing the RMCP port (623.)
on those nodes. This utility uses IPMI LAN, so no IPMI drivers are
needed. There are three methods that can be used:
-a = broadcast RMCP ping method
-g = GetChannelAuthCap command method
else = specific RMCP ping method
A beginning IP address can be specified with -b for broadcast and spe-
cific methods. An ending IP can be specified for non-broadcast meth-
ods.
OPTIONS
Command line options are described below.
-a All nodes, use the broadcast ping method. This will detect the
first enabled ethernet interface, and defaults to the broadcast
address of that interface for the x.x.x.255 subnet.
-b
Beginning IP address, required, unless using broadcast with
defaults. This could be a specific IP address, or a broadcast
address, ending in 255, if the broadcast method (-a) is used.
-e
Endign IP address of the range. Not used for broadcast method.
If this is not specified, a range of one IP address matching
the beginning IP is assumed.
-g Use the GetChannelAuthenticationCapabilities command method
over IPMI LAN instead of the RMCP ping. Not compatible with
broadcast. This may be useful if the vendor BMC does not sup-
port RMCP ping for some reason.
-r N Repeat the ping N times to each node. Default is to send 1
ping per node.
-i eth0
The interface name to use when sending the probes. The default
is to detect the first enabled ethernet interface (e.g. eth0).
-x Causes extra debug messages to be displayed.
EXAMPLES
idiscover -a -b 192.168.1.255
Sends a broadcast RMCP ping to discover IPMI LAN nodes on the speci-
fied subnet.
idiscover -b 192.168.1.100 -e 192.168.1.254
Sends RMCP pings to a range of IP addresses.
idiscover -g -b 192.168.1.100 -e 192.168.1.254
Sends GetChannelAuthCap commands to a range of IP addresses.
SEE ALSO
alarms(8) bmchealth(8) fruconfig(8) getevent(8) hwreset(8) icmd(8)
pefconfig(8) sensor(8) showsel(8) tmconfig(8) ipmiutil(8)
WARNINGS
See http://ipmiutil.sourceforge.net/ for the latest version of wdt and
any bug fix list.
IEVENTS
3.15 IEVENTS (ipmiutil events)
IEVENTS(8) IEVENTS(8)
NAME
ievents - decode IPMI and PET event data
SYNOPSIS
ievents [-bfhprsx] 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f 10
DESCRIPTION
ievents is a standalone utility delivered with ipmiutil, used to
interpret raw hex data from IPMI events or from IPMI PET SNMP trap
varbind data. This utility uses the same interpretation logic as is
used by "ipmiutil sel" (showsel) and "ipmiutil getevt" (getevents).
The data bytes in the input are always assumed to be in hex form.
This could be useful if a utility other than "ipmiutil sel" were used
to obtain IPMI SEL records or events and interpretation is needed.
This would also be needed at an enterprise management station to
interpret the PET SNMP trap hex data into human-readable form, see
option -p.
OPTIONS
-b bin_file
Interpret a file containing raw binary/hex SEL data dumped in
binary form, such as that produced by "ipmitool sel writeraw
bin_file". Each set of 16 bytes in the file will be inter-
preted as an IPMI event. (same as -h)
-f sel_file
Interpret a file containing raw ascii text SEL data captured
with ipmiutil sel -r, or some other similar utility. Each line
in the file should be in this form, with no leading spaces:
04 00 02 76 a9 4a 47 20 00 04 10 09 6f 42 0f ff
If this option is not specified, the default is to use the 16
bytes taken from the command-line arguments. (same as -r)
-h bin_file
Interpret a file containing raw binary/hex SEL data dumped in
binary form, such as that produced by "ipmitool sel writeraw
bin_file". Each set of 16 bytes in the file will be inter-
preted as an IPMI event. (same as -b)
-p Decode as PET event bytes, where the input is 34 PET hex data
bytes, skipping the first 8 of the 47-byte PET data. The
default without -p assumes that the input is a 16-byte IPMI
event.
-r sel_file
Interpret a file containing raw ascii text SEL data captured
with ipmiutil sel -r, or some other similar utility. (same as
-f)
-s sensor_file
Sensor file with the output of "ipmiutil sensor", used to get
the PET sensor_type from the sensor_num. The default is
/usr/share/ipmiutil/sensor_out.txt as generated during the
ipmiutil rpm installation. This is only needed with PET inter-
pretation (-p).
-x show eXtra debug messages
SEE ALSO
ipmiutil(8) alarms(8) bmchealth(8) fruconfig(8) getevent(8) hwreset(8)
icmd(8) pefconfig(8) sensor(8) showsel(8) tmconfig(8) wdt(8) bmc-
config(8)
WARNINGS
See http://ipmiutil.sourceforge.net/ for the latest version of ipmiu-
til and any bug fix list.
BMCCONFIG
3.16 BMCCONFIG (ipmiutil config)
BMCCONFIG(8) BMCCONFIG(8)
NAME
bmcconfig (ipmiutil config) - list, save, and restore BMC configura-
tion parameters
SYNOPSIS
bmcconfig [-lpxLNUPREFJTVY] [-r file] [-s file]
DESCRIPTION
bmcconfig is a program that uses an IPMI driver to send IPMI commands
which list, save and restore BMC configuration parameters for LAN,
Serial, PEF, SOL, User, Channel. This combines the functionality of
pefconfig (ipmiutil lan) and tmconfig (ipmiutil serial). Note that
some of the LAN parameters cannot be restored remotely over the IPMI
LAN, changing the configuration that is in use. This utility can use
either the /dev/ipmi0 driver from OpenIPMI, the /dev/imb driver from
Intel, the /dev/ipmikcs driver from valinux, direct user-space IOs, or
the IPMI LAN interface if -N.
OPTIONS
Command line options are described below.
-l Lists BMC configuration parameters with a keyword, index, and
its hex values. This is the default behavior if no options are
specified.
-r config_file
Restores BMC configuration from config_file, which was produced
with -s below.
-s config_file
Saves BMC configuration to config_file. This file could be
edited, in certain cases, such as to vary the BMC IP address
(LanParam 3), or to use the UserPassword records. Note that
lines beginning with ’#’ are comments and are ignored. For
editing UserPassword records, convert your text value to hex
format; for example "echo ’mypassword’ |od -t x1", and leave
off the trailing 0a.
-x Causes extra debug messages to be displayed.
-p password_to_set
This specifies the firmware password to set for BMC LAN access
for all users during the restore. If not specified, the pass-
word configuration will not be changed, unless a valid User-
Password record is present in the file to be restored. Note
that user passwords are write-only via standard IPMI commands.
-L lan_ch_num
This specifies the IPMI LAN channel number used for BMC LAN.
This varies by platform, and can be found in the platform tech-
nical specifications. By default, bmcconfig scans all IPMI
channels to find a LAN channel for BMC LAN.
-N nodename
Nodename or IP address of the remote target system. If a node-
name is specified, IPMI LAN interface is used. Otherwise the
local system management interface is used.
-P/-R rmt_pswd
Remote password for the nodename given. The default is a null
password.
-U rmt_user
Remote username for the nodename given. The default is a null
username.
-E Use the remote password from Environment variable IPMI_PASS-
WORD.
-F drv_t
Force the driver type to one of the followng: imb, va, open,
gnu, landesk, lan, lan2, lan2i, kcs, smb. Note that lan2i
means lan2 with intelplus. The default is to detect any avail-
able driver type and use it.
-J Use the specified LanPlus cipher suite (0 thru 14):
0=none/none/none, 1=sha1/none/none, 2=sha1/sha1/none,
3=sha1/sha1/cbc128, 4=sha1/sha1/xrc4_128, 5=sha1/sha1/xrc4_40,
6=md5/none/none, ... 14=md5/md5/xrc4_40. Default is 3.
-T Use a specified IPMI LAN Authentication Type: 0=None, 1=MD2,
2=MD5, 4=Straight Password, 5=OEM.
-V Use a specified IPMI LAN privilege level. 1=Callback level,
2=User level, 3=Operator level, 4=Administrator level
(default), 5=OEM level.
-Y Yes, do prompt the user for the IPMI LAN remote password.
Alternatives for the password are -E or -P.
SEE ALSO
alarms(8) bmchealth(8) fruconfig(8) getevent(8) hwreset(8) icmd(8)
sensor(8) showsel(8) tmconfig(8) wdt(8) ipmiutil(8)
WARNINGS
See http://ipmiutil.sourceforge.net/ for the latest version of bmc-
config and any bug fix list.
HOME