1
.TH "ipmitool" "1" "" "Duncan Laurie" ""
4
ipmitool \- utility for controlling IPMI-enabled devices
7
ipmitool [\fB\-ghcvV\fR] \fB\-I\fR \fIlan\fP \fB\-H\fR \fIhostname\fP [\fB\-L\fR \fIprivlvl\fP] [\fB\-a\fR|\fB\-E\fR|\fB\-P\fR \fIpassword\fP] <\fIexpression\fP>
9
ipmitool [\fB\-ghcvV\fR] \fB\-I\fR \fIlanplus\fP \fB\-H\fR \fIhostname\fP [\fB\-L\fR \fIprivlvl\fP] [\fB\-a\fR|\fB\-E\fR|\fB\-P\fR \fIpassword\fP] <\fIexpression\fP>
11
ipmitool [\fB\-ghcvV\fR] \fB\-I\fR \fIopen\fP <\fIexpression\fP>
14
This program lets you manage Intelligent Platform Management Interface
15
(IPMI) functions of either the local system, via a kernel device driver,
16
or a remote system, using IPMI V1.5 . These functions include printing
17
FRU information, LAN configuration, sensor readings, and remote chassis
23
Get basic usage help from the command line.
26
Display output with comma field separator instead of spaces. Not available with all commands.
29
Display version information.
32
Increase verbose output level. This option may be specified multiple times to increase the level of debug output.
34
\fB\-I\fR <\fIinterface\fP>
35
Selects IPMI interface to use. Possible interfaces are \fIlan\fP, \fIlanplus\fP or \fIopen\fP.
37
\fB\-H\fR <\fIaddress\fP>
38
Remote server address, can be IP address or hostname. This option is required for the LAN interface connection.
40
\fB\-U\fR <\fIusername\fP>
41
Remote username, default is NULL user.
43
\fB\-L\fR <\fIprivlvl\fP>
44
Force session privilege level. Can be CALLBACK, USER, OPERATOR, ADMIN. Default is ADMIN.
47
Prompt for the remote server password, 16 character maximum. This is optional for the LAN interface, if a password is not provided the session will not be authenticated.
50
The remote server password is specified by the environment variable \fBIPMI_PASSWORD\fR. This option is intended for shell scripts.
52
\fB\-f\fR <\fIfile\fP>
53
Read remote server password from file.
55
\fB\-P\fR <\fIpassword\fP>
56
Remote server password. \fBNote!\fR Specifying the password as a commandline option is not recommended since it will be visible in the process list.
61
This can be used to get command-line help on ipmitool commands. It may also be placed at the end of commands to get option usage help.
66
Commands: bmc, chassis, event, fru, lan, raw, sdr, sel, sensor, sol, userinfo, channel
69
ipmitool -I open chassis help
71
Chassis Commands: status, power, identify, policy, restart_cause, poh
74
ipmitool -I open chassis power help
76
Chassis Power Commands: status, on, off, cycle, reset, diag, soft
80
\fIraw\fP <\fBnetfn\fR> <\fBcmd\fR> [\fBdata\fR]
81
This will allow you to execute raw IPMI commands. For example to query the POH counter with a raw command:
84
ipmitool -v -I open raw 0x0 0xf
86
RAW REQ (netfn=0x0 cmd=0xf data_len=0)
97
\fIauthcap\fP <\fBchannel number\fR> <\fBmax priv\fR>
98
This command will display information about the authentication capabilities of the selected channel at the specified privelige level.
101
Possible privilege levels are:
109
4 Administrator level
111
5 OEM Proprietary level
115
\fIinfo\fP [\fBchannel number\fR]
116
This command will display information about the selected channel. If no channel is given it will display information about the currently used channel:
119
ipmitool -I open chaninfo
123
Channel Medium Type : System Interface
125
Channel Protocol Type : KCS
127
Session Support : session-less
129
Active Session Count : 0
131
Protocol Vendor ID : 7154
135
\fIuser\fP <\fBchannel number\fR> [\fBuser number\fR]
136
This command will display information about configured user information on a specific LAN channel. This command will fail on system interfaces.
139
ipmitool -I open channel user 6
145
Fixed Name User IDs : 1
147
Access Available : call-in / callback
149
Link Authentication : disabled
151
IPMI Messaging : enabled
160
This command returns information about the high-level status of the system chassis and main power subsystem.
163
This command will return the Power-On Hours counter.
165
\fIidentify\fP <\fBinterval\fR>
166
Control the front panel identify light. Default is 15. Use 0 to turn off.
169
Query the chassis for the cause of the last system restart.
172
Set the chassis power policy in the event power failure.
176
Return supported policies.
179
Turn on when power is restored.
182
Returned to previous state when power is restored.
185
Stay off after power is restored.
189
Performs a chassis control command to view and change the power state.
193
Show current chassis power status.
199
Power down chassis into soft off (S4/S5 state). WARNING: this command does not initiate a clean shutdown of the operating system prior to powering down the system.
202
This command provides a power off interval of at least 1 second. No action should occur if chassis power is in S4/S5 state, but it is recommended to check power state first and only issue a power cycle command if the system power is on or in lower sleep state than S4/S5.
205
This command will perform a hard reset.
208
Pulse a version of a diagnostic interrupt (NMI) that goes directly to the processor(s).
211
Initiate a soft\-shutdown of OS via ACPI by emulating a fatal overtemperature.
218
\fIprint\fP <\fBchannel\fR>
219
Print the current configuration for the given channel.
221
\fIset\fP <\fBchannel\fR> <\fBparameter\fR>
222
Set the given parameter on the given channel. Valid parameters are:
225
\fIipaddr\fP <\fBx.x.x.x\fR>
226
Set the IP address for this channel.
228
\fInetmask\fP <\fBx.x.x.x\fR>
229
Set the netmask for this channel.
231
\fImacaddr\fP <\fBxx:xx:xx:xx:xx:xx\fR>
232
Set the MAC adddress for this channel.
234
\fIdefgw\fP \fIipaddr\fP <\fBx.x.x.x\fR>
235
Set the default gateway IP address.
237
\fIdefgw\fP \fImacaddr\fP <\fBxx:xx:xx:xx:xx:xx\fR>
238
Set the default gateway MAC address.
240
\fIbakgw\fP \fIipaddr\fP <\fBx.x.x.x\fR>
241
Set the backup gateway IP address.
243
\fIbakgw\fP \fImacaddr\fP <\fBxx:xx:xx:xx:xx:xx\fR>
244
Set the backup gateway MAC address.
246
\fIpassword\fP <\fBpass\fR>
247
Set the null user password.
249
\fIsnmp\fP <\fBcommunity string\fR>
250
Set the SNMP community string.
253
Enable user access mode.
255
\fIaccess\fP <\fBon|off\fR>
256
Set LAN channel access mode.
258
\fIipsrc\fP <\fBsource\fR>
259
Set the IP address source:
263
static = manually configured static IP address
265
dhcp = address obtained by BMC running DHCP
267
bios = address loaded by BIOS or system software
269
\fIarp\fP \fIrespond\fP <\fBon|off\fR>
270
Set BMC generated ARP responses.
272
\fIarp\fP \fIgenerate\fP <\fBon|off\fR>
273
Set BMC generated gratuitous ARPs.
275
\fIarp\fP \fIinterval\fP <\fBseconds\fR>
276
Set BMC generated gratuitous ARP interval.
278
\fIauth\fP <\fBlevel,...\fR> <\fBtype,...\fR>
279
Set the valid authtypes for a given auth level.
300
This command will read all Field Replacable Unit inventory data and extract such information as serial number, part number, asset tags, and short strings describing the chassis, board, or product.
307
This command will query the BMC for information about the SDR.
310
This command will read the SDR and extract sensor information, then query each sensor and print its name, reading, and status.
317
This command will query the BMC and print information about the PEF supported features.
320
This command prints the current PEF status (the last SEL entry processed by the BMC, etc).
323
This command lists the PEF policy table entries. Each policy entry describes an alert destination. A policy set is a collection of table entries. PEF alert actions reference policy sets.
326
This command lists the PEF table entries. Each PEF entry relates a sensor event to an action. When PEF is active, each platform event causes the BMC to scan this table for entries matching the event, and possible actions to be taken. Actions are performed in priority order (higher criticality first).
333
This command will list sensors and thresholds in a wide table format.
335
\fIget\fP <\fBid\fR> ... [\fBid\fR]
336
This command will print info for sensors specified by name.
338
\fIthresh\fP <\fBid\fR> <\fBthreshold\fR> <\fBsetting\fR>
339
This allows you to set a particular sensor threshold value. The sensor is specified by name.
342
Valid thresholds are:
344
unr Upper Non-Recoverable
348
unc Uperr Non-Critical
350
lnc Lower Non-Critical
354
lnr Lower Non-Recoverable
363
This command will query the BMC for information about the SEL and its contents.
366
This command will clear the contents of the SEL. It cannot be undone so be careful.
369
This command will list the contents of the SEL.
375
\fIinfo\fP <\fBparameter\fR> [\fBargument\fR]
376
This command will query the BMC for information about its session capabilities and current sessions. Valid parameters are:
380
Queries the BMC for information about the current session. That is, the session used to execute this command.
383
Queries the BMC for information about all active sessions
386
Queries the BMC for information about the session with the specified ID. The ID should be specified in hex.
388
\fIhandle\fP <\fBhandle\fR>
389
Queries the BMC for information about the session with the specified handle. The handle should be specified in hex.
396
\fIinfo\fP [\fBchannel\fR]
397
Retrieve information about the Serial-Over-LAN configuration on the specified channel. If no channel is given, it will display SOL configuration data for the currently used channel.
401
\fIset\fP <\fBparameter\fR> <\fBvalue\fR> [\fBchannel\fR]
402
Configure parameters for Serial Over Lan. If no channel is given, it will display SOL configuration data for the currently used channel. Configuration parameter updates are automatically guarded with the updates to the set-in-progress parameter.
405
Valid parameters and values are:
409
set-complete set-in-progress commit-write
421
user operator admin oem
423
character-accumulate-level
424
Decimal number given in 5 milliseconds increments
426
character-send-threshold
430
Decimal number. 0 indicates no retries after packet is transmitted.
433
Decimal number in 10 millisend increments. 0 indicates that retries should be sent back to back.
435
non-volatile-bit-rate
436
serial, 19.2, 38.4, 57.6, 115.2. Setting this value to serial indiates that the BMC should use the setting used by the IPMI over serial channel.
439
serial, 19.2, 38.4, 57.6, 115.2. Setting this value to serial indiates that the BMC should use the setting used by the IPMI over serial channel.
446
This command causes ipmitool to enter Serial Over LAN mode, and is only available when using the lanplus interface. An RMCP+ connection is made to the BMC, the terminal is set to raw mode, and user input is sent to the serial console on the remote server. On exit, the the SOL payload mode is deactivated and the terminal is reset to its original settings.
449
Special escape sequences are provided to control the SOL session:
450
~. Terminate connection
456
~~ Send the escape character by typing it twice
458
~? Print the supported escape sequences
465
This command deactivates Serial Over LAN mode on the BMC. Exiting Serial Over LAN mode should automatically cause this command to be sent to the BMC, but in the case of an unintentional exit from SOL mode, this command may be necessary to reset the state of the BMC.
470
The ipmitool \fIopen\fP interface utilizes the MontaVista OpenIPMI kernel device driver. This driver is present in 2.5.57 and later development kernels and in 2.4.21pre1 and later stable kernels. There are also IPMI driver kernel patches for different versions available from the OpenIPMI homepage.
472
The following kernel modules must be loaded in order for ipmitool to work:
475
Incoming and outgoing message handler for IPMI interfaces.
478
An IPMI Keyboard Controler Style (KCS) interface driver for the message handler.
481
Linux character device interface for the message handler.
483
Once they are loaded there will be a dynamic char device entry that must exist at \fB/dev/ipmi0\fR. Usually if this is the first dynamic device it will be major number \fB254\fR and minor number \fB0\fR so you would create the dev entry with:
485
.I mknod /dev/ipmi0 c 254 0
487
In order to force ipmitool to make use of the OpenIPMI device interface you can specifiy it on the command line:
489
ipmitool \-I open <expression>
490
.SH "LIPMI INTERFACE"
492
The ipmitool \fIlipmi\fP interface uses the Solaris x86 IPMI kernel device driver.
494
You can tell ipmitool to use the Solaris IPMI driver with the \fB-I\fR option:
496
ipmitool \-I lipmi <expression>
499
The ipmitool \fIlan\fP interface communicates with the BMC over an Ethernet LAN connection using UDP under IPv4. UDP datagrams are formatted to contain IPMI request/response messages with a IPMI session headers and RMCP headers.
501
IPMI\-over\-LAN uses version 1 of the Remote Management Control Protocol (RMCP) to support \fIpre\-OS\fP and \fIOS\-absent\fP management. RMCP is a request\-response protocol delivered using UDP datagrams to port 623.
503
The LAN interface is an authenticatiod multi\-session connection; messages delivered to the BMC can (and should) be authenticated with a challenge/response protocol with either straight password/key or MD5 message\-digest algorithm. ipmitool will attempt to connect with administrator privilege level as this is required to perform chassis power functions.
505
You can tell ipmitool to use the lan interface with the \fB\-I\fR option:
507
ipmitool \-I lan \-H <hostname> [\-U username] [\-P password] <expression>
509
A hostname \fBmust\fR be given on the command line in order to use the lan interface with ipmitool. The password field is optional; if you do not provide a password on the command line, ipmitool will attempt to connect without authentication. If you specify a password it will use MD5 authentication if supported by the BMC and straight password/key otherwise.
510
.SH "LANPLUS INTERFACE"
512
Like the \fIlan\fP interface, the \fIlanplus\fP interface communicates with the BMC over an Ethernet LAN connection using UDP under IPv4. The difference is that the \fIlanplus\fP interface uses the RMCP+ protocol as described in the IMPI v2.0 specification. RMCP+ allows for improved authentication and data integrity checks, as well as encryption and the ability to carry multiple types of payloads. Generic Serial Over LAN support requires RMCP+, so the ipmitool \fIsol activate\fP command requires the use of the \fIlanplus\fP interface.
514
RMCP+ session establishment uses a protocol call RAKP (Remote Authenticated Key-Exchange Protocol) which allows the negotiation of many options. ipmitool does not yet allow the user to specify the value of every option, defaulting to the most obvious settings, marked as required in the v2.0 specification. Authentication and integrity HMACS are produced with SHA1, and encryption is performed with AES-CBC-128. Role-level logins are not supported. ipmitool must be configured with the appropriate option for the \fIlanplus\fP interface to be available, as it is not enabled by default. This interface currently requires the OpenSSL library.
516
You can tell ipmitool to use the lanplus interface with the \fB\-I\fR option:
518
ipmitool \-I lanplus \-H <hostname> [\-U username] [\-P password] <expression>
520
The options available for the \fIlanplus\fP inteface are identical to those available for the \fIlan\fP inteface.
524
This character device file is used by the OpenIPMI kernel driver.
527
If you want to remotely control the power of an IPMI\-over\-LAN enabled system you can use:
529
ipmitool \-I lan \-H 192.168.1.1 \-P password chassis power on
531
Chassis Power Control: Up/On
533
ipmitool \-I lan \-H 192.168.1.1 \-P password chassis power status
538
Duncan Laurie <duncan@iceblink.org>
543
http://ipmitool.sourceforge.net
545
Intelligent Platform Management Interface Specification
546
http://www.intel.com/design/servers/ipmi/spec.htm
548
OpenIPMI project (MontaVista IPMI kernel driver)
549
http://openipmi.sourceforge.net