|
0
|
1 |
'\" t
|
|
|
2 |
.\"
|
|
|
3 |
.\" CDDL HEADER START
|
|
|
4 |
.\"
|
|
|
5 |
.\" The contents of this file are subject to the terms of the
|
|
|
6 |
.\" Common Development and Distribution License (the "License").
|
|
|
7 |
.\" You may not use this file except in compliance with the License.
|
|
|
8 |
.\"
|
|
|
9 |
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
|
|
|
10 |
.\" or http://www.opensolaris.org/os/licensing.
|
|
|
11 |
.\" See the License for the specific language governing permissions
|
|
|
12 |
.\" and limitations under the License.
|
|
|
13 |
.\"
|
|
|
14 |
.\" When distributing Covered Code, include this CDDL HEADER in each
|
|
|
15 |
.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
|
|
|
16 |
.\" If applicable, add the following below this CDDL HEADER, with the
|
|
|
17 |
.\" fields enclosed by brackets "[]" replaced with your own identifying
|
|
|
18 |
.\" information: Portions Copyright [yyyy] [name of copyright owner]
|
|
|
19 |
.\"
|
|
|
20 |
.\" CDDL HEADER END
|
|
|
21 |
.\"
|
|
11
|
22 |
.\" ident "@(#)ipmitool.1m.sunman 1.8 10/03/16 SMI"
|
|
|
23 |
.\" "Copyright 2010 Sun Microsystems, Inc. All rights reserved."
|
|
0
|
24 |
.\" "Use is subject to license terms."
|
|
|
25 |
.\"
|
|
|
26 |
.TH ipmitool 1m "10 December 2008"
|
|
|
27 |
.SH NAME
|
|
|
28 |
ipmitool \- utility for controlling IPMI\-enabled devices
|
|
|
29 |
.SH SYNOPSIS
|
|
|
30 |
.B ipmitool
|
|
|
31 |
[\-chvV] \-I lan \-H hostname [\-p <port>] [\-U <username>] [\-f <password_file>] [\-S <sdrcache>] <command>
|
|
|
32 |
|
|
|
33 |
.B ipmitool
|
|
|
34 |
[\-chvV] \-I lanplus \-H hostname [\-p <port>] [\-U <username>] [\-f <password_file>] [\-S <sdrcache>] <command>
|
|
|
35 |
|
|
|
36 |
.B ipmitool
|
|
|
37 |
[\-chvV] \-I bmc [\-S <sdrcache>] <command>
|
|
|
38 |
|
|
|
39 |
.SH DESCRIPTION
|
|
|
40 |
This program lets you manage Intelligent Platform Management Interface
|
|
|
41 |
(IPMI) functions of either the local system, via a kernel device driver,
|
|
|
42 |
or a remote system, using IPMI v1.5 and IPMI v2.0. These functions include printing
|
|
|
43 |
FRU information, LAN configuration, sensor readings, and remote chassis
|
|
|
44 |
power control.
|
|
|
45 |
|
|
|
46 |
IPMI management by a remote station is disabled on platforms as they
|
|
|
47 |
are shipped. It can be enabled only by the root user on the local system.
|
|
|
48 |
|
|
|
49 |
.SH SECURITY WARNING
|
|
|
50 |
There are several security issues to be considered before enabling the
|
|
|
51 |
IPMI LAN interface. A remote station has the ability to control a system's power
|
|
|
52 |
state as well as being able to gather certain platform information. To reduce
|
|
|
53 |
vulnerability it is strongly advised that the IPMI LAN interface only be
|
|
|
54 |
enabled in 'trusted' environments where system security is not an issue or
|
|
|
55 |
where there is a dedicated secure 'management network'.
|
|
|
56 |
|
|
|
57 |
Further it is strongly advised that you should not enable IPMI for
|
|
|
58 |
remote access without setting a password, and that that password should
|
|
|
59 |
not be the same as any other password on that system.
|
|
|
60 |
|
|
|
61 |
When an IPMI password is changed on a remote machine the new password is
|
|
|
62 |
sent across the network as clear text. This could be observed and then
|
|
|
63 |
used to attack the remote system. It is thus recommended that IPMI
|
|
|
64 |
password management only be done using a tool, such as 'ipmitool', running
|
|
|
65 |
on the local station.
|
|
|
66 |
|
|
|
67 |
.SH OPTIONS
|
|
|
68 |
.TP
|
|
|
69 |
\-c
|
|
|
70 |
Present output in CSV (comma separated variable) format.
|
|
|
71 |
.TP
|
|
|
72 |
\-f <password_file>
|
|
|
73 |
Specifies a file containing the remote server password. If this
|
|
|
74 |
option is absent, or if password_file is empty, the password
|
|
|
75 |
will default to NULL.
|
|
|
76 |
|
|
|
77 |
If the \-f option is not present, ipmitool will prompt the
|
|
|
78 |
user for a password. If no password is entered at the prompt,
|
|
|
79 |
the remote server password will default to NULL.
|
|
|
80 |
|
|
|
81 |
For IPMI v1.5, the maximum password length is 16 characters.
|
|
|
82 |
Passwords longer than 16 characters will be truncated.
|
|
|
83 |
|
|
|
84 |
For IPMI v2.0, the maximum password length is 20 characters;
|
|
|
85 |
longer passwords are truncated.
|
|
|
86 |
The longer password length is supported by the lanplus interface.
|
|
|
87 |
.TP
|
|
|
88 |
\-h
|
|
|
89 |
Get basic usage help from the command line.
|
|
|
90 |
.TP
|
|
|
91 |
\-H <hostname>
|
|
|
92 |
Remote server address, can be IP address or hostname.
|
|
|
93 |
This option is required for the LAN interface connection.
|
|
|
94 |
.TP
|
|
|
95 |
\-I <interface>
|
|
|
96 |
Selects IPMI interface to use. Possible interfaces are
|
|
|
97 |
lan, lanplus or bmc.
|
|
|
98 |
.TP
|
|
|
99 |
\-p <port>
|
|
|
100 |
Selects remote port (default is 623).
|
|
|
101 |
.TP
|
|
|
102 |
\-S <sdrcache>
|
|
|
103 |
Uses Sensor Data Repository information from the file
|
|
|
104 |
<sdrcache> to dramatically speed up the `sdr' and
|
|
|
105 |
`sel elist' commands. This file is typically created
|
|
|
106 |
with the `sdr dump <sdrcache>' command.
|
|
|
107 |
.TP
|
|
|
108 |
\-U <username>
|
|
|
109 |
Remote username, default is NULL user.
|
|
|
110 |
.TP
|
|
|
111 |
\-v
|
|
|
112 |
Increase verbose output level. This option may be
|
|
|
113 |
specified multiple times to increase the level of debug
|
|
|
114 |
output. If given three times you will get hexdumps of
|
|
|
115 |
all incoming and outgoing packets.
|
|
|
116 |
.TP
|
|
|
117 |
\-V
|
|
|
118 |
Display version information.
|
|
|
119 |
|
|
|
120 |
|
|
|
121 |
.SH COMMANDS
|
|
|
122 |
.TP
|
|
|
123 |
help This can be used to get command\-line help on ipmitool
|
|
|
124 |
commands. It may also be placed at the end of commands
|
|
|
125 |
to get option usage help.
|
|
|
126 |
|
|
|
127 |
ipmitool \-I bmc help
|
|
|
128 |
.br
|
|
|
129 |
Commands:
|
|
|
130 |
raw Send a RAW IPMI request and print
|
|
|
131 |
response
|
|
|
132 |
i2c Send an I2C Master Write-Read
|
|
|
133 |
command and print response
|
|
|
134 |
spd Print SPD information from remote
|
|
|
135 |
I2C device
|
|
|
136 |
lan Configure LAN Channels
|
|
|
137 |
chassis Get chassis status and set power
|
|
|
138 |
state
|
|
|
139 |
power Alias for chassis power commands
|
|
|
140 |
event Send pre-defined events to MC
|
|
|
141 |
mc Management Controller status and
|
|
|
142 |
global enables
|
|
|
143 |
sdr Print Sensor Data Repository
|
|
|
144 |
entries and readings
|
|
|
145 |
sensor Print detailed sensor information
|
|
|
146 |
fru Print built-in FRU and scan SDR
|
|
|
147 |
for FRU locators
|
|
|
148 |
sel Print System Event Log (SEL)
|
|
|
149 |
pef Configure Platform Event Filtering
|
|
|
150 |
(PEF)
|
|
|
151 |
sol Configure IPMIv2.0 Serial-over-LAN
|
|
|
152 |
isol Configure IPMIv1.5 Serial-over-LAN
|
|
|
153 |
user Configure Management Controller
|
|
|
154 |
users
|
|
|
155 |
channel Configure Management Controller
|
|
|
156 |
channels
|
|
|
157 |
sunoem OEM Commands for Sun servers
|
|
|
158 |
kontronoem OEM Commands for Kontron
|
|
|
159 |
picmg Run a PICMG/ATA extended command
|
|
|
160 |
firewall Configure firmware firewall
|
|
|
161 |
session Print session information
|
|
|
162 |
exec Run list of commands from file
|
|
|
163 |
set Set runtime variable for shell and
|
|
|
164 |
exec
|
|
|
165 |
echo Echo lines to stdout in scripts
|
|
|
166 |
ekanalyzer Run FRU-Ekeying analyzer using FRU
|
|
|
167 |
files
|
|
|
168 |
|
|
|
169 |
ipmitool \-I bmc chassis help
|
|
|
170 |
.br
|
|
|
171 |
Chassis Commands: status, power, identify, policy, restart_cause, poh, bootdev, bootparam, selftest
|
|
|
172 |
|
|
|
173 |
ipmitool \-I bmc chassis power help
|
|
|
174 |
.br
|
|
|
175 |
chassis power Commands: status, on, off, cycle, reset, diag, soft
|
|
|
176 |
.TP
|
|
|
177 |
bmc|mc
|
|
|
178 |
.RS
|
|
|
179 |
.TP
|
|
|
180 |
reset <warm|cold>
|
|
|
181 |
.br
|
|
|
182 |
|
|
|
183 |
Instructs the BMC to perform a warm or cold reset.
|
|
|
184 |
.TP
|
|
|
185 |
info
|
|
|
186 |
.br
|
|
|
187 |
|
|
|
188 |
Displays information about the BMC hardware, including device revision,
|
|
|
189 |
firmware revision, IPMI version supported, manufacturer ID,
|
|
|
190 |
and information on additional device support.
|
|
|
191 |
.TP
|
|
|
192 |
watchdog
|
|
|
193 |
.br
|
|
|
194 |
|
|
|
195 |
These commands allow a user to view and change the current
|
|
|
196 |
state of the watchdog timer.
|
|
|
197 |
.RS
|
|
|
198 |
.TP
|
|
|
199 |
get
|
|
|
200 |
.br
|
|
|
201 |
|
|
|
202 |
Show current Watchdog Timer settings and countdown state.
|
|
|
203 |
.TP
|
|
|
204 |
reset
|
|
|
205 |
.br
|
|
|
206 |
|
|
|
207 |
Reset the Watchdog Timer to its most recent state and restart the
|
|
|
208 |
countdown timer.
|
|
|
209 |
.TP
|
|
|
210 |
off
|
|
|
211 |
.br
|
|
|
212 |
|
|
|
213 |
Turn off a currently running Watchdog countdown timer.
|
|
|
214 |
.RE
|
|
|
215 |
.TP
|
|
|
216 |
selftest
|
|
|
217 |
.br
|
|
|
218 |
|
|
|
219 |
Check on the basic health of the BMC by executing the Get Self Test
|
|
|
220 |
results command and reporting the results.
|
|
|
221 |
.TP
|
|
|
222 |
getenables
|
|
|
223 |
.br
|
|
|
224 |
|
|
|
225 |
Displays a list of the currently enabled options for the BMC.
|
|
|
226 |
.br
|
|
|
227 |
.TP
|
|
|
228 |
setenables <option>=[on|off]
|
|
|
229 |
.br
|
|
|
230 |
|
|
|
231 |
Enables or disables the given \fIoption\fR. Currently supported
|
|
|
232 |
values for \fIoption\fR include:
|
|
|
233 |
.RS
|
|
|
234 |
.TP
|
|
|
235 |
recv_msg_intr
|
|
|
236 |
.br
|
|
|
237 |
|
|
|
238 |
Receive Message Queue Interrupt
|
|
|
239 |
.TP
|
|
|
240 |
event_msg_intr
|
|
|
241 |
.br
|
|
|
242 |
|
|
|
243 |
Event Message Buffer Full Interrupt
|
|
|
244 |
.TP
|
|
|
245 |
event_msg
|
|
|
246 |
.br
|
|
|
247 |
|
|
|
248 |
Event Message Buffer
|
|
|
249 |
.TP
|
|
|
250 |
system_event_log
|
|
|
251 |
.br
|
|
|
252 |
|
|
|
253 |
System Event Logging
|
|
|
254 |
.TP
|
|
|
255 |
oem0
|
|
|
256 |
.br
|
|
|
257 |
|
|
|
258 |
OEM-Defined option #0
|
|
|
259 |
.TP
|
|
|
260 |
oem1
|
|
|
261 |
.br
|
|
|
262 |
|
|
|
263 |
OEM-Defined option #1
|
|
|
264 |
.TP
|
|
|
265 |
oem2
|
|
|
266 |
.br
|
|
|
267 |
|
|
|
268 |
OEM-Defined option #2
|
|
|
269 |
.RE
|
|
|
270 |
.RE
|
|
|
271 |
.TP
|
|
|
272 |
channel
|
|
|
273 |
.RS
|
|
|
274 |
.TP
|
|
|
275 |
authcap <channel number> <max priv>
|
|
|
276 |
|
|
|
277 |
Displays information about the
|
|
|
278 |
authentication capabilities of the selected channel
|
|
|
279 |
at the specified privilege level.
|
|
|
280 |
.RS
|
|
|
281 |
.TP
|
|
|
282 |
Possible privilege levels are:
|
|
|
283 |
.br
|
|
|
284 |
1 Callback level
|
|
|
285 |
.br
|
|
|
286 |
2 User level
|
|
|
287 |
.br
|
|
|
288 |
3 Operator level
|
|
|
289 |
.br
|
|
|
290 |
4 Administrator level
|
|
|
291 |
.br
|
|
|
292 |
5 OEM Proprietary level
|
|
|
293 |
.RE
|
|
|
294 |
.TP
|
|
|
295 |
info [channel number]
|
|
|
296 |
|
|
|
297 |
Displays information about the
|
|
|
298 |
selected channel. If no channel is given it will
|
|
|
299 |
display information about the currently used channel:
|
|
|
300 |
.RS
|
|
|
301 |
.PP
|
|
|
302 |
ipmitool \-I bmc channel info
|
|
|
303 |
.br
|
|
|
304 |
Channel 0xf info:
|
|
|
305 |
.br
|
|
|
306 |
Channel Medium Type : System Interface
|
|
|
307 |
.br
|
|
|
308 |
Channel Protocol Type : KCS
|
|
|
309 |
.br
|
|
|
310 |
Session Support : session\-less
|
|
|
311 |
.br
|
|
|
312 |
Active Session Count : 0
|
|
|
313 |
.br
|
|
|
314 |
Protocol Vendor ID : 7154
|
|
|
315 |
.RE
|
|
|
316 |
.TP
|
|
|
317 |
getaccess <channel number> [userid]
|
|
|
318 |
.br
|
|
|
319 |
|
|
|
320 |
Configure the given userid as the default on the given channel number.
|
|
|
321 |
When the given channel is subsequently used, the user is identified
|
|
|
322 |
implicitly by the given userid.
|
|
|
323 |
.TP
|
|
|
324 |
setaccess <channel number> <userid> [callin=on|off]
|
|
|
325 |
[ipmi=on|off] [link=on|off] [privilege=level]
|
|
|
326 |
.br
|
|
|
327 |
|
|
|
328 |
Configure user access information on the given channel for the given userid.
|
|
|
329 |
.TP
|
|
|
330 |
getciphers <all | supported> <ipmi | sol> [channel]
|
|
|
331 |
.br
|
|
|
332 |
|
|
|
333 |
Displays the list of cipher suites supported for the given
|
|
|
334 |
application (ipmi or sol) on the given channel.
|
|
|
335 |
.RE
|
|
|
336 |
.TP
|
|
|
337 |
chassis
|
|
|
338 |
.RS
|
|
|
339 |
.TP
|
|
|
340 |
status
|
|
|
341 |
.br
|
|
|
342 |
|
|
|
343 |
Displays information regarding the high-level
|
|
|
344 |
status of the system chassis and main power
|
|
|
345 |
subsystem.
|
|
|
346 |
.TP
|
|
|
347 |
poh
|
|
|
348 |
.br
|
|
|
349 |
|
|
|
350 |
This command will return the Power\-On Hours counter.
|
|
|
351 |
.TP
|
|
|
352 |
identify <interval>
|
|
|
353 |
|
|
|
354 |
Control the front panel identify light. Default interval
|
|
|
355 |
is 15 seconds. Use 0 to turn off. Use "force" to turn on
|
|
|
356 |
indefinitely.
|
|
|
357 |
.TP
|
|
|
358 |
restart_cause
|
|
|
359 |
.br
|
|
|
360 |
|
|
|
361 |
Query the chassis for the cause of the last system restart.
|
|
|
362 |
.TP
|
|
|
363 |
selftest
|
|
|
364 |
.br
|
|
|
365 |
|
|
|
366 |
Check on the basic health of the BMC by executing the Get Self Test
|
|
|
367 |
results command and reporting the results.
|
|
|
368 |
.TP
|
|
|
369 |
policy
|
|
|
370 |
.br
|
|
|
371 |
|
|
|
372 |
Set the chassis power policy in the event power failure.
|
|
|
373 |
.RS
|
|
|
374 |
.TP
|
|
|
375 |
list
|
|
|
376 |
.br
|
|
|
377 |
|
|
|
378 |
Return supported policies.
|
|
|
379 |
.TP
|
|
|
380 |
always\-on
|
|
|
381 |
.br
|
|
|
382 |
|
|
|
383 |
Turn on when power is restored.
|
|
|
384 |
.TP
|
|
|
385 |
previous
|
|
|
386 |
.br
|
|
|
387 |
|
|
|
388 |
Returned to previous state when power is restored.
|
|
|
389 |
.TP
|
|
|
390 |
always\-off
|
|
|
391 |
.br
|
|
|
392 |
|
|
|
393 |
Stay off after power is restored.
|
|
|
394 |
.RE
|
|
|
395 |
.TP
|
|
|
396 |
power
|
|
|
397 |
.br
|
|
|
398 |
|
|
|
399 |
Performs a chassis control command to view and
|
|
|
400 |
change the power state.
|
|
|
401 |
.RS
|
|
|
402 |
.TP
|
|
|
403 |
status
|
|
|
404 |
.br
|
|
|
405 |
|
|
|
406 |
Show current chassis power status.
|
|
|
407 |
.TP
|
|
|
408 |
on
|
|
|
409 |
.br
|
|
|
410 |
|
|
|
411 |
Power up chassis.
|
|
|
412 |
.TP
|
|
|
413 |
off
|
|
|
414 |
.br
|
|
|
415 |
|
|
|
416 |
Power down chassis into soft off (S4/S5
|
|
|
417 |
state). WARNING: This command does not initiate a clean
|
|
|
418 |
shutdown of the operating system prior to powering down the system.
|
|
|
419 |
.TP
|
|
|
420 |
cycle
|
|
|
421 |
.br
|
|
|
422 |
|
|
|
423 |
Provides a power off interval of
|
|
|
424 |
at least 1 second. No action should occur if
|
|
|
425 |
chassis power is in S4/S5 state, but it is
|
|
|
426 |
recommended to check power state first and
|
|
|
427 |
only issue a power cycle command if the system power is
|
|
|
428 |
on or in lower sleep state than S4/S5.
|
|
|
429 |
.TP
|
|
|
430 |
reset
|
|
|
431 |
.br
|
|
|
432 |
|
|
|
433 |
This command will perform a hard reset.
|
|
|
434 |
.TP
|
|
|
435 |
diag
|
|
|
436 |
.br
|
|
|
437 |
|
|
|
438 |
Pulse a diagnostic interrupt (NMI) directly to the processor(s).
|
|
|
439 |
.TP
|
|
|
440 |
soft
|
|
|
441 |
.br
|
|
|
442 |
|
|
|
443 |
Initiate a soft\-shutdown of OS via ACPI by
|
|
|
444 |
emulating a fatal overtemperature.
|
|
|
445 |
.RE
|
|
|
446 |
.TP
|
|
|
447 |
bootdev <device> [clear-cmos=yes|no] [options=help,...]
|
|
|
448 |
.br
|
|
|
449 |
|
|
|
450 |
Request the system to boot from an alternate boot device on next reboot. If the optional
|
|
|
451 |
`clear-cmos` argument is present, the parameter given will be used to determine if the
|
|
|
452 |
values stored in persistent CMOS memory are cleared the next time the system is rebooted.
|
|
|
453 |
Note that this command is not supported on many platforms.
|
|
|
454 |
Various options may be used to modify the boot device settings.
|
|
|
455 |
Run "bootdev none options=help" for a list of available boot device
|
|
|
456 |
modifiers/options.
|
|
|
457 |
|
|
|
458 |
.RS
|
|
|
459 |
.TP
|
|
|
460 |
Currently supported values for <device> are:
|
|
|
461 |
.TP
|
|
|
462 |
pxe
|
|
|
463 |
.br
|
|
|
464 |
|
|
|
465 |
Force PXE boot
|
|
|
466 |
.TP
|
|
|
467 |
disk
|
|
|
468 |
.br
|
|
|
469 |
|
|
|
470 |
Force boot from BIOS default boot device
|
|
|
471 |
.TP
|
|
|
472 |
safe
|
|
|
473 |
.br
|
|
|
474 |
|
|
|
475 |
Force boot from BIOS default boot device, request Safe Mode
|
|
|
476 |
.TP
|
|
|
477 |
diag
|
|
|
478 |
.br
|
|
|
479 |
|
|
|
480 |
Force boot from diagnostic partition
|
|
|
481 |
.TP
|
|
|
482 |
cdrom
|
|
|
483 |
.br
|
|
|
484 |
|
|
|
485 |
Force boot from CD/DVD
|
|
|
486 |
.TP
|
|
|
487 |
bios
|
|
|
488 |
.br
|
|
|
489 |
|
|
|
490 |
Force boot into BIOS setup
|
|
|
491 |
.TP
|
|
|
492 |
floppy
|
|
|
493 |
.br
|
|
|
494 |
|
|
|
495 |
Force boot from Floppy/primary removable media
|
|
|
496 |
.RE
|
|
|
497 |
.TP
|
|
|
498 |
bootparam
|
|
|
499 |
.br
|
|
|
500 |
|
|
|
501 |
Get or set various system boot option parameters.
|
|
|
502 |
.RS
|
|
|
503 |
.TP
|
|
|
504 |
get <param #>
|
|
|
505 |
.br
|
|
|
506 |
|
|
|
507 |
Get boot parameter. Currently supported values for <param #> are:
|
|
|
508 |
|
|
|
509 |
0 - Set In Progress
|
|
|
510 |
|
|
|
511 |
1 - Service Partition Selector
|
|
|
512 |
|
|
|
513 |
2 - Service Partition Scan
|
|
|
514 |
|
|
|
515 |
3 - BMC Boot Flag Valid Bit Clearing
|
|
|
516 |
|
|
|
517 |
4 - Boot Info Acknowledge
|
|
|
518 |
|
|
|
519 |
5 - Boot Flags
|
|
|
520 |
|
|
|
521 |
6 - Boot Initiator Info
|
|
|
522 |
|
|
|
523 |
7 - Boot Initiator Mailbox
|
|
|
524 |
.br
|
|
|
525 |
|
|
|
526 |
.TP
|
|
|
527 |
set <option> [value ...]
|
|
|
528 |
.br
|
|
|
529 |
|
|
|
530 |
Set boot parameter.
|
|
|
531 |
|
|
|
532 |
.RS
|
|
|
533 |
.TP
|
|
|
534 |
Currently supported values for <option> are:
|
|
|
535 |
.TP
|
|
|
536 |
force_pxe
|
|
|
537 |
.br
|
|
|
538 |
|
|
|
539 |
Force PXE boot
|
|
|
540 |
.TP
|
|
|
541 |
force_disk
|
|
|
542 |
.br
|
|
|
543 |
|
|
|
544 |
Force boot from default hard-drive
|
|
|
545 |
.TP
|
|
|
546 |
force_safe
|
|
|
547 |
.br
|
|
|
548 |
|
|
|
549 |
Force boot from default hard-drive, request Safe Mode
|
|
|
550 |
.TP
|
|
|
551 |
force_diag
|
|
|
552 |
.br
|
|
|
553 |
|
|
|
554 |
Force boot from diagnostic partition
|
|
|
555 |
.TP
|
|
|
556 |
force_cdrom
|
|
|
557 |
.br
|
|
|
558 |
|
|
|
559 |
Force boot from CD/DVD
|
|
|
560 |
.TP
|
|
|
561 |
force_bios
|
|
|
562 |
.br
|
|
|
563 |
|
|
|
564 |
Force boot into BIOS setup
|
|
|
565 |
|
|
|
566 |
.RE
|
|
|
567 |
.RE
|
|
|
568 |
.RE
|
|
|
569 |
.TP
|
|
|
570 |
ekanalyzer <command> <xx=file1> <xx=file2> [<rc=file3>] ...
|
|
|
571 |
.RS
|
|
|
572 |
|
|
|
573 |
.br
|
|
|
574 |
NOTE : This command can support a maximum of 8 files per command line
|
|
|
575 |
.TP
|
|
|
576 |
file1
|
|
|
577 |
.br
|
|
|
578 |
binary file that stores FRU data of a Carrier or an AMC module
|
|
|
579 |
.TP
|
|
|
580 |
file2
|
|
|
581 |
.br
|
|
|
582 |
binary file that stores FRU data of an AMC module.
|
|
|
583 |
These binary files can be generated from command:
|
|
|
584 |
ipmitool fru read <id> <file>
|
|
|
585 |
.TP
|
|
|
586 |
file3
|
|
|
587 |
.br
|
|
|
588 |
configuration file used for configuring On-Carrier Device ID
|
|
|
589 |
or OEM GUID. This file is optional.
|
|
|
590 |
.TP
|
|
|
591 |
.br
|
|
|
592 |
xx : indicates the type of the file.
|
|
|
593 |
.br
|
|
|
594 |
It can take the following value:
|
|
|
595 |
.RS
|
|
|
596 |
.TP
|
|
|
597 |
.br
|
|
|
598 |
oc : On-Carrier device
|
|
|
599 |
.TP
|
|
|
600 |
.br
|
|
|
601 |
a1 : AMC slot A1
|
|
|
602 |
.TP
|
|
|
603 |
.br
|
|
|
604 |
a2 : AMC slot A2
|
|
|
605 |
.TP
|
|
|
606 |
.br
|
|
|
607 |
a3 : AMC slot A3
|
|
|
608 |
.TP
|
|
|
609 |
.br
|
|
|
610 |
a4 : AMC slot A4
|
|
|
611 |
.TP
|
|
|
612 |
.br
|
|
|
613 |
b1 : AMC slot B1
|
|
|
614 |
.TP
|
|
|
615 |
.br
|
|
|
616 |
b2 : AMC slot B2
|
|
|
617 |
.TP
|
|
|
618 |
.br
|
|
|
619 |
b3 : AMC slot B3
|
|
|
620 |
.TP
|
|
|
621 |
.br
|
|
|
622 |
b4 : AMC slot B4
|
|
|
623 |
.TP
|
|
|
624 |
.br
|
|
|
625 |
sm : Shelf Manager
|
|
|
626 |
|
|
|
627 |
.RE
|
|
|
628 |
.TP
|
|
|
629 |
.br
|
|
|
630 |
The available commands for ekanalyzer are:
|
|
|
631 |
|
|
|
632 |
.TP
|
|
|
633 |
print [<carrier | power | all>]
|
|
|
634 |
.RS
|
|
|
635 |
.TP
|
|
|
636 |
carrier (default) <oc=file1> <oc=file2> ...
|
|
|
637 |
.br
|
|
|
638 |
|
|
|
639 |
Display point-to-point physical connectivity between carriers and AMC modules.
|
|
|
640 |
Example:
|
|
|
641 |
ipmitool ekanalyzer print carrier oc=fru oc=carrierfru
|
|
|
642 |
From Carrier file: fru
|
|
|
643 |
Number of AMC bays supported by Carrier: 2
|
|
|
644 |
AMC slot B1 topology:
|
|
|
645 |
Port 0 =====> On Carrier Device ID 0, Port 16
|
|
|
646 |
Port 1 =====> On Carrier Device ID 0, Port 12
|
|
|
647 |
Port 2 =====> AMC slot B2, Port 2
|
|
|
648 |
AMC slot B2 topology:
|
|
|
649 |
Port 0 =====> On Carrier Device ID 0, Port 3
|
|
|
650 |
Port 2 =====> AMC slot B1, Port 2
|
|
|
651 |
*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
|
|
|
652 |
From Carrier file: carrierfru
|
|
|
653 |
On Carrier Device ID 0 topology:
|
|
|
654 |
Port 0 =====> AMC slot B1, Port 4
|
|
|
655 |
Port 1 =====> AMC slot B1, Port 5
|
|
|
656 |
Port 2 =====> AMC slot B2, Port 6
|
|
|
657 |
Port 3 =====> AMC slot B2, Port 7
|
|
|
658 |
AMC slot B1 topology:
|
|
|
659 |
Port 0 =====> AMC slot B2, Port 0
|
|
|
660 |
AMC slot B1 topology:
|
|
|
661 |
Port 1 =====> AMC slot B2, Port 1
|
|
|
662 |
Number of AMC bays supported by Carrier: 2
|
|
|
663 |
|
|
|
664 |
.TP
|
|
|
665 |
power <xx=file1> <xx=file2> ...
|
|
|
666 |
.br
|
|
|
667 |
|
|
|
668 |
Display power supply information between carrier and AMC modules.
|
|
|
669 |
.TP
|
|
|
670 |
all <xx=file> <xx=file> ...
|
|
|
671 |
.br
|
|
|
672 |
|
|
|
673 |
Display both physical connectivity and power supply of each carrier and AMC
|
|
|
674 |
modules.
|
|
|
675 |
|
|
|
676 |
.RE
|
|
|
677 |
.TP
|
|
|
678 |
frushow <xx=file>
|
|
|
679 |
.br
|
|
|
680 |
|
|
|
681 |
Convert a binary FRU file into human readable text format. Use -v option to get
|
|
|
682 |
more display information.
|
|
|
683 |
|
|
|
684 |
.RE
|
|
|
685 |
.RS
|
|
|
686 |
.TP
|
|
|
687 |
summary [<match | unmatch | all>]
|
|
|
688 |
.RS
|
|
|
689 |
.TP
|
|
|
690 |
match (default) <xx=file> <xx=file> ...
|
|
|
691 |
.br
|
|
|
692 |
|
|
|
693 |
Display only matched results of Ekeying match between an On-Carrier device
|
|
|
694 |
and an AMC module or between 2 AMC modules. Example:
|
|
|
695 |
ipmitool ekanalyzer summary match oc=fru b1=amcB1 a2=amcA2
|
|
|
696 |
On-Carrier Device vs AMC slot B1
|
|
|
697 |
AMC slot B1 port 0 ==> On-Carrier Device 0 port 16
|
|
|
698 |
Matching Result
|
|
|
699 |
- From On-Carrier Device ID 0
|
|
|
700 |
-Channel ID 11 || Lane 0: enable
|
|
|
701 |
-Link Type: AMC.2 Ethernet
|
|
|
702 |
-Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link
|
|
|
703 |
-Link Group ID: 0 || Link Asym. Match: exact match
|
|
|
704 |
- To AMC slot B1
|
|
|
705 |
-Channel ID 0 || Lane 0: enable
|
|
|
706 |
-Link Type: AMC.2 Ethernet
|
|
|
707 |
-Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link
|
|
|
708 |
-Link Group ID: 0 || Link Asym. Match: exact match
|
|
|
709 |
*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
|
|
|
710 |
AMC slot B1 port 1 ==> On-Carrier Device 0 port 12
|
|
|
711 |
Matching Result
|
|
|
712 |
- From On-Carrier Device ID 0
|
|
|
713 |
-Channel ID 6 || Lane 0: enable
|
|
|
714 |
-Link Type: AMC.2 Ethernet
|
|
|
715 |
-Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link
|
|
|
716 |
-Link Group ID: 0 || Link Asym. Match: exact match
|
|
|
717 |
- To AMC slot B1
|
|
|
718 |
-Channel ID 1 || Lane 0: enable
|
|
|
719 |
-Link Type: AMC.2 Ethernet
|
|
|
720 |
-Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link
|
|
|
721 |
-Link Group ID: 0 || Link Asym. Match: exact match
|
|
|
722 |
*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
|
|
|
723 |
On-Carrier Device vs AMC slot A2
|
|
|
724 |
AMC slot A2 port 0 ==> On-Carrier Device 0 port 3
|
|
|
725 |
Matching Result
|
|
|
726 |
- From On-Carrier Device ID 0
|
|
|
727 |
-Channel ID 9 || Lane 0: enable
|
|
|
728 |
-Link Type: AMC.2 Ethernet
|
|
|
729 |
-Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link
|
|
|
730 |
-Link Group ID: 0 || Link Asym. Match: exact match
|
|
|
731 |
- To AMC slot A2
|
|
|
732 |
-Channel ID 0 || Lane 0: enable
|
|
|
733 |
-Link Type: AMC.2 Ethernet
|
|
|
734 |
-Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link
|
|
|
735 |
-Link Group ID: 0 || Link Asym. Match: exact match
|
|
|
736 |
*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
|
|
|
737 |
AMC slot B1 vs AMC slot A2
|
|
|
738 |
AMC slot A2 port 2 ==> AMC slot B1 port 2
|
|
|
739 |
Matching Result
|
|
|
740 |
- From AMC slot B1
|
|
|
741 |
-Channel ID 2 || Lane 0: enable
|
|
|
742 |
-Link Type: AMC.3 Storage
|
|
|
743 |
-Link Type extension: Serial Attached SCSI (SAS/SATA)
|
|
|
744 |
-Link Group ID: 0 || Link Asym. Match: FC or SAS interface {exact match}
|
|
|
745 |
- To AMC slot A2
|
|
|
746 |
-Channel ID 2 || Lane 0: enable
|
|
|
747 |
-Link Type: AMC.3 Storage
|
|
|
748 |
-Link Type extension: Serial Attached SCSI (SAS/SATA)
|
|
|
749 |
-Link Group ID: 0 || Link Asym. Match: FC or SAS interface {exact match}
|
|
|
750 |
*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
|
|
|
751 |
.TP
|
|
|
752 |
unmatch <xx=file> <xx=file> ...
|
|
|
753 |
.br
|
|
|
754 |
|
|
|
755 |
Display the unmatched results of Ekeying match between an On-Carrier device
|
|
|
756 |
and an AMC module or between 2 AMC modules
|
|
|
757 |
.TP
|
|
|
758 |
all <xx=file> <xx=file> ...
|
|
|
759 |
.br
|
|
|
760 |
|
|
|
761 |
Display both matched result and unmatched results of Ekeying match between two
|
|
|
762 |
cards or two modules.
|
|
|
763 |
.RE
|
|
|
764 |
.RE
|
|
|
765 |
.TP
|
|
|
766 |
event
|
|
|
767 |
.RS
|
|
|
768 |
.TP
|
|
|
769 |
<predefined event number n>
|
|
|
770 |
.br
|
|
|
771 |
|
|
|
772 |
Send a pre-defined test event to the System Event Log. The following events are
|
|
|
773 |
included as a means to test the functionality of the System Event Log component
|
|
|
774 |
of the BMC (an entry will be added each time the event \fIn\fR command is
|
|
|
775 |
executed).
|
|
|
776 |
|
|
|
777 |
Currently supported values for \fIn\fR are:
|
|
|
778 |
.br
|
|
|
779 |
1 Temperature: Upper Critical: Going High
|
|
|
780 |
.br
|
|
|
781 |
2 Voltage Threshold: Lower Critical: Going Low
|
|
|
782 |
.br
|
|
|
783 |
3 Memory: Correctable ECC
|
|
|
784 |
.br
|
|
|
785 |
|
|
|
786 |
\fINOTE\fR: These pre-defined events will likely not
|
|
|
787 |
produce "accurate" SEL records for a particular system because they will
|
|
|
788 |
not be correctly tied to a valid sensor number, but they are sufficient
|
|
|
789 |
to verify correct operation of the SEL.
|
|
|
790 |
|
|
|
791 |
.TP
|
|
|
792 |
file <filename>
|
|
|
793 |
.br
|
|
|
794 |
|
|
|
795 |
Event log records specified in \fIfilename\fR will be added to the System Event Log.
|
|
|
796 |
|
|
|
797 |
The format of each line in the file is as follows:
|
|
|
798 |
|
|
|
799 |
<{EvM Revision} {Sensor Type} {Sensor Num} {Event Dir/Type} {Event Data 0} {Event Data 1} {Event Data 2}>[# COMMENT]
|
|
|
800 |
|
|
|
801 |
e.g.:
|
|
|
802 |
.br
|
|
|
803 |
0x4 0x2 0x60 0x1 0x52 0x0 0x0 # Voltage threshold: Lower Critical: Going Low
|
|
|
804 |
.br
|
|
|
805 |
|
|
|
806 |
EvM Revision -
|
|
|
807 |
The "Event Message Revision" is 0x04 for messages that comply with the IPMI 2.0
|
|
|
808 |
Specification and 0x03 for messages that comply with the IPMI 1.0 Specification.
|
|
|
809 |
|
|
|
810 |
Sensor Type -
|
|
|
811 |
Indicates the Event Type or Class.
|
|
|
812 |
|
|
|
813 |
Sensor Num -
|
|
|
814 |
Represents the 'sensor' within the management controller that generated
|
|
|
815 |
the Event Message.
|
|
|
816 |
|
|
|
817 |
Event Dir/Type -
|
|
|
818 |
This field is encoded with the event direction as the high bit
|
|
|
819 |
(bit 7) and the event type as the low 7 bits. Event direction is
|
|
|
820 |
0 for an assertion event and 1 for a deassertion event.
|
|
|
821 |
|
|
|
822 |
See the IPMI 2.0 specification for further details on the definitions for
|
|
|
823 |
each field.
|
|
|
824 |
|
|
|
825 |
.TP
|
|
|
826 |
<sensorid> <list>
|
|
|
827 |
.br
|
|
|
828 |
|
|
|
829 |
Get a list of all the possible Sensor States and pre-defined Sensor State
|
|
|
830 |
Shortcuts available for a particular sensor. \fIsensorid\fR is the character
|
|
|
831 |
string representation of the sensor and must be enclosed in double quotes
|
|
|
832 |
if it includes white space. Several different commands including
|
|
|
833 |
\fIipmitool sensor list\fR may be used to obtain a list that includes
|
|
|
834 |
the \fIsensorid\fR strings representing the sensors on a given system.
|
|
|
835 |
.RS
|
|
|
836 |
.PP
|
|
|
837 |
ipmitool \-I open event "PS 2T Fan Fault" list
|
|
|
838 |
.br
|
|
|
839 |
Finding sensor PS 2T Fan Fault... ok
|
|
|
840 |
.br
|
|
|
841 |
Sensor States:
|
|
|
842 |
.br
|
|
|
843 |
State Deasserted
|
|
|
844 |
.br
|
|
|
845 |
State Asserted
|
|
|
846 |
.br
|
|
|
847 |
Sensor State Shortcuts:
|
|
|
848 |
.br
|
|
|
849 |
present absent
|
|
|
850 |
.br
|
|
|
851 |
assert deassert
|
|
|
852 |
.br
|
|
|
853 |
limit nolimit
|
|
|
854 |
.br
|
|
|
855 |
fail nofail
|
|
|
856 |
.br
|
|
|
857 |
yes no
|
|
|
858 |
.br
|
|
|
859 |
on off
|
|
|
860 |
.br
|
|
|
861 |
up down
|
|
|
862 |
|
|
|
863 |
.RE
|
|
|
864 |
.TP
|
|
|
865 |
<sensorid> <sensor state> [<direction>]
|
|
|
866 |
|
|
|
867 |
Generate a custom event based on existing sensor information.
|
|
|
868 |
The optional event \fBdirection\fR can be either \fIassert\fR
|
|
|
869 |
(the default) or \fIdeassert\fR.
|
|
|
870 |
|
|
|
871 |
.RS
|
|
|
872 |
.PP
|
|
|
873 |
ipmitool event "PS 2T Fan Fault" "State Asserted"
|
|
|
874 |
.br
|
|
|
875 |
Finding sensor PS 2T Fan Fault... ok
|
|
|
876 |
.br
|
|
|
877 |
0 | Pre-Init Time-stamp | Fan PS 2T Fan Fault | State Asserted
|
|
|
878 |
.RE
|
|
|
879 |
.RS
|
|
|
880 |
.PP
|
|
|
881 |
ipmitool event "PS 2T Fan Fault" "State Deasserted"
|
|
|
882 |
.br
|
|
|
883 |
Finding sensor PS 2T Fan Fault... ok
|
|
|
884 |
.br
|
|
|
885 |
0 | Pre-Init Time-stamp | Fan PS 2T Fan Fault | State Desserted
|
|
|
886 |
.RE
|
|
|
887 |
.RS
|
|
|
888 |
.PP
|
|
|
889 |
.RE
|
|
|
890 |
|
|
|
891 |
.RE
|
|
|
892 |
.TP
|
|
|
893 |
exec <filename>
|
|
|
894 |
|
|
|
895 |
.RS
|
|
|
896 |
Execute ipmitool commands from \fIfilename\fR. Each line
|
|
|
897 |
is a complete command. The syntax of the commands
|
|
|
898 |
are defined by the COMMANDS section in this manpage.
|
|
|
899 |
Each line may have an optional comment at the end
|
|
|
900 |
of the line, delimited with a `#' symbol.
|
|
|
901 |
|
|
|
902 |
e.g., a command file with one line:
|
|
|
903 |
|
|
|
904 |
sdr list # get a list of sdr records
|
|
|
905 |
.br
|
|
|
906 |
.RE
|
|
|
907 |
.TP
|
|
|
908 |
fru
|
|
|
909 |
.RS
|
|
|
910 |
.TP
|
|
|
911 |
print
|
|
|
912 |
.br
|
|
|
913 |
|
|
|
914 |
This command will read all Field Replaceable Unit (FRU)
|
|
|
915 |
inventory data and extract such information as
|
|
|
916 |
serial number, part number, asset tags, and short
|
|
|
917 |
strings describing the chassis, board, or product.
|
|
|
918 |
.TP
|
|
|
919 |
read <fru id> <fru file>
|
|
|
920 |
.br
|
|
|
921 |
|
|
|
922 |
\fIfru id\fR is the digit ID of the FRU (see output of 'fru print').
|
|
|
923 |
\fIfru file\fR is the absolute pathname of a file in which to dump the
|
|
|
924 |
binary FRU data pertaining to the specified FRU entity.
|
|
|
925 |
.TP
|
|
|
926 |
write <fru id> <fru file>
|
|
|
927 |
.br
|
|
|
928 |
|
|
|
929 |
\fIfru id\fR is the digit ID of the FRU (see output of 'fru print').
|
|
|
930 |
\fIfru file\fR is the absolute pathname of a file from which to pull
|
|
|
931 |
the binary FRU data before uploading it to the specified FRU.
|
|
|
932 |
.TP
|
|
|
933 |
upgEkey <fru id> <fru file>
|
|
|
934 |
.br
|
|
|
935 |
|
|
|
936 |
Update a multirecord FRU location.
|
|
|
937 |
\fIfru id\fR is the digit ID of the FRU (see output of 'fru print').
|
|
|
938 |
\fIfru file\fR is the absolute pathname of a file from which to pull the
|
|
|
939 |
binary FRU data to upload into the specified multirecord FRU entity.
|
|
|
940 |
|
|
|
941 |
.TP
|
|
|
942 |
edit <fru id>
|
|
|
943 |
.br
|
|
|
944 |
|
|
|
945 |
This command provides interactive editing of some supported records, namely
|
|
|
946 |
PICMG Carrier Activation Record. \fIfru id\fR is the digit ID of the FRU
|
|
|
947 |
(see output of 'fru print'); default is 0.
|
|
|
948 |
|
|
|
949 |
.TP
|
|
|
950 |
edit <fru id> field <section> <index> <string>
|
|
|
951 |
.br
|
|
|
952 |
|
|
|
953 |
This command may be used to set a field string to a new value. It replaces
|
|
|
954 |
the FRU data found at \fIindex\fR in the specified \fIsection\fR with the
|
|
|
955 |
supplied \fIstring\fR.
|
|
|
956 |
|
|
|
957 |
.RS
|
|
|
958 |
.TP
|
|
|
959 |
fru id
|
|
|
960 |
.br
|
|
|
961 |
|
|
|
962 |
is the digit ID of the FRU (see output of 'fru print').
|
|
|
963 |
.TP
|
|
|
964 |
section
|
|
|
965 |
.br
|
|
|
966 |
|
|
|
967 |
is a string which refers to FRU Inventory Information
|
|
|
968 |
Storage Areas and may be refer to:
|
|
|
969 |
.RS
|
|
|
970 |
.TP
|
|
|
971 |
c FRU Inventory Chassis Info Area
|
|
|
972 |
.br
|
|
|
973 |
.TP
|
|
|
974 |
b FRU Inventory Board Info Area
|
|
|
975 |
.br
|
|
|
976 |
.TP
|
|
|
977 |
p FRU Inventory Product Info Area
|
|
|
978 |
.RE
|
|
|
979 |
.TP
|
|
|
980 |
index
|
|
|
981 |
.br
|
|
|
982 |
|
|
|
983 |
specifies the field number. Field numbering starts on the first 'english text' field type. For instance in the <\fBboard\fR> info area field '0' is <\fBBoard Manufacturer\fR> and field '2' is <\fBBoard Serial Number\fR>; see IPMI Platform Management FRU Information Storage Definition v1.0 R1.1 for field locations.
|
|
|
984 |
.TP
|
|
|
985 |
string
|
|
|
986 |
.br
|
|
|
987 |
|
|
|
988 |
must be the same length as the string being replaced and must be 8-bit ASCII (0xCx).
|
|
|
989 |
.RE
|
|
|
990 |
.TP
|
|
|
991 |
edit <fru id> oem iana <record> <format> [<args>]
|
|
|
992 |
.br
|
|
|
993 |
|
|
|
994 |
This command edits the data found in the multirecord area. Support for
|
|
|
995 |
OEM specific records is limited.
|
|
|
996 |
.RE
|
|
|
997 |
.TP
|
|
|
998 |
firewall
|
|
|
999 |
.br
|
|
|
1000 |
|
|
|
1001 |
This command supports the firmware firewall capability. It may be used to
|
|
|
1002 |
add or remove security-based restrictions on certain commands/command
|
|
|
1003 |
sub-functions or to list the current firmware firewall restrictions set on
|
|
|
1004 |
any commands. For each firmware firewall command listed below, parameters
|
|
|
1005 |
may be included to cause the command to be executed with increasing
|
|
|
1006 |
granularity on a specific LUN, for a specific NetFn, for a specific IPMI
|
|
|
1007 |
Command, and finally for a specific command's sub-function (see Appendix H in the
|
|
|
1008 |
IPMI 2.0 Specification for a listing of any sub-function numbers that may
|
|
|
1009 |
be associated with a particular command).
|
|
|
1010 |
|
|
|
1011 |
Parameter syntax and dependencies are as follows:
|
|
|
1012 |
|
|
|
1013 |
[<channel H>] [<lun L> [<netfn N> [<command C [<subfn S>]]]]
|
|
|
1014 |
|
|
|
1015 |
Note that if "netfn <\fBN\fR>" is specified, then "lun <\fBL\fR>" must also be
|
|
|
1016 |
specified; if "command <\fBC\fR>" is specified, then "netfn <\fBN\fR>" (and
|
|
|
1017 |
therefore "lun <\fBL\fR>") must also be specified, and so forth.
|
|
|
1018 |
|
|
|
1019 |
"channel <\fBH\fR>" is an optional and standalone parameter. If not specified,
|
|
|
1020 |
the requested operation will be performed on the current channel. Note that
|
|
|
1021 |
command support may vary from channel to channel.
|
|
|
1022 |
|
|
|
1023 |
Firmware firewall commands:
|
|
|
1024 |
.RS
|
|
|
1025 |
.TP
|
|
|
1026 |
info [<parms as described above>]
|
|
|
1027 |
.br
|
|
|
1028 |
|
|
|
1029 |
List firmware firewall information for the specified LUN, NetFn, and
|
|
|
1030 |
Command (if supplied) on the current or specified channel. Listed
|
|
|
1031 |
information includes the support, configurable, and enabled bits for
|
|
|
1032 |
the specified command or commands.
|
|
|
1033 |
|
|
|
1034 |
Some usage examples:
|
|
|
1035 |
.RS
|
|
|
1036 |
.TP
|
|
|
1037 |
info [<channel H>] [<lun L>]
|
|
|
1038 |
.br
|
|
|
1039 |
|
|
|
1040 |
This command will list firmware firewall information for all NetFns for the
|
|
|
1041 |
specified LUN on either the current or the specified channel.
|
|
|
1042 |
.TP
|
|
|
1043 |
info [<channel H>] [<lun L> [<netfn N>]]
|
|
|
1044 |
.br
|
|
|
1045 |
|
|
|
1046 |
This command will print out all command information for a single LUN/NetFn pair.
|
|
|
1047 |
.TP
|
|
|
1048 |
info [<channel H>] [<lun L> [<netfn N> [<command C]]]
|
|
|
1049 |
.br
|
|
|
1050 |
|
|
|
1051 |
This prints out detailed, human-readable information showing the support, configurable,
|
|
|
1052 |
and enabled bits for the specified command on the specified LUN/NetFn pair. Information
|
|
|
1053 |
will be printed about each of the command subfunctions.
|
|
|
1054 |
.TP
|
|
|
1055 |
info [<channel H>] [<lun L> [<netfn N> [<command C [<subfn S>]]]]
|
|
|
1056 |
.br
|
|
|
1057 |
|
|
|
1058 |
Print out information for a specific sub-function.
|
|
|
1059 |
.RE
|
|
|
1060 |
.TP
|
|
|
1061 |
enable [<parms as described above>]
|
|
|
1062 |
.br
|
|
|
1063 |
|
|
|
1064 |
This command is used to enable commands for a given NetFn/LUN combination on
|
|
|
1065 |
the specified channel.
|
|
|
1066 |
.TP
|
|
|
1067 |
disable [<parms as described above>] [force]
|
|
|
1068 |
.br
|
|
|
1069 |
|
|
|
1070 |
This command is used to disable commands for a given NetFn/LUN combination on
|
|
|
1071 |
the specified channel. Great care should be taken if using the "force"
|
|
|
1072 |
option so as not to disable the "Set Command Enables" command.
|
|
|
1073 |
.TP
|
|
|
1074 |
reset [<parms as described above>]
|
|
|
1075 |
.br
|
|
|
1076 |
|
|
|
1077 |
This command may be used to reset the firmware firewall back to a state
|
|
|
1078 |
where all commands and command sub-functions are enabled.
|
|
|
1079 |
|
|
|
1080 |
.RE
|
|
|
1081 |
.TP
|
|
|
1082 |
i2c <i2caddr> <read bytes> [<write data>]
|
|
|
1083 |
.br
|
|
|
1084 |
|
|
|
1085 |
Sends an I^2C Master Write-Read command (if <write data> is supplied,
|
|
|
1086 |
it is written to the I^2C master first)
|
|
|
1087 |
to the device at address <i2caddr> and displays <read bytes> bytes of response.
|
|
|
1088 |
.br
|
|
|
1089 |
|
|
|
1090 |
Note: this command is not supported by all BMCs.
|
|
|
1091 |
.br
|
|
|
1092 |
|
|
|
1093 |
The following command writes the values 0x2, 0x3, and 0x4, then attempts to read 5 bytes from the I^2C master
|
|
|
1094 |
at address 0xa:
|
|
|
1095 |
.br
|
|
|
1096 |
|
|
|
1097 |
ipmitool i2c 0xa 5 0x2 0x3 0x4
|
|
|
1098 |
|
|
|
1099 |
.TP
|
|
|
1100 |
isol
|
|
|
1101 |
.RS
|
|
|
1102 |
.TP
|
|
|
1103 |
info
|
|
|
1104 |
.br
|
|
|
1105 |
|
|
|
1106 |
Retrieve information about the Intel IPMI v1.5 Serial\-Over\-LAN
|
|
|
1107 |
configuration.
|
|
|
1108 |
.TP
|
|
|
1109 |
set <parameter> <value>
|
|
|
1110 |
.br
|
|
|
1111 |
|
|
|
1112 |
Configure parameters for Intel IPMI v1.5 Serial\-over\-LAN.
|
|
|
1113 |
.RS
|
|
|
1114 |
.TP
|
|
|
1115 |
Valid parameters and values are:
|
|
|
1116 |
.br
|
|
|
1117 |
.TP
|
|
|
1118 |
enabled
|
|
|
1119 |
true, false
|
|
|
1120 |
.TP
|
|
|
1121 |
privilege\-level
|
|
|
1122 |
user, operator, admin, oem
|
|
|
1123 |
.TP
|
|
|
1124 |
bit\-rate
|
|
|
1125 |
9.6, 19.2, 38.4, 57.6, 115.2
|
|
|
1126 |
.RE
|
|
|
1127 |
.TP
|
|
|
1128 |
activate
|
|
|
1129 |
.br
|
|
|
1130 |
|
|
|
1131 |
Causes ipmitool to enter Intel IPMI v1.5 Serial Over LAN mode. An RMCP+
|
|
|
1132 |
connection is made to the BMC, the terminal is set to raw mode, and user
|
|
|
1133 |
input is sent to the serial console on the remote server. On exit, the
|
|
|
1134 |
the SOL payload mode is deactivated and the terminal is reset to its
|
|
|
1135 |
original settings.
|
|
|
1136 |
.RS
|
|
|
1137 |
|
|
|
1138 |
Special escape sequences are provided to control the SOL session:
|
|
|
1139 |
.RS
|
|
|
1140 |
.TP
|
|
|
1141 |
~. Terminate connection
|
|
|
1142 |
.TP
|
|
|
1143 |
~^Z Suspend ipmitool
|
|
|
1144 |
.TP
|
|
|
1145 |
~^X Suspend ipmitool, but don't restore tty on restart
|
|
|
1146 |
.TP
|
|
|
1147 |
~B Send break
|
|
|
1148 |
.TP
|
|
|
1149 |
~~ Send the escape character by typing it twice
|
|
|
1150 |
.TP
|
|
|
1151 |
~? Print the supported escape sequences
|
|
|
1152 |
.RE
|
|
|
1153 |
|
|
|
1154 |
Note that escapes are only recognized immediately after newline.
|
|
|
1155 |
.RE
|
|
|
1156 |
|
|
|
1157 |
.RE
|
|
|
1158 |
.TP
|
|
|
1159 |
kontronoem
|
|
|
1160 |
.RS
|
|
|
1161 |
|
|
|
1162 |
OEM commands specific to Kontron devices.
|
|
|
1163 |
.TP
|
|
|
1164 |
setsn
|
|
|
1165 |
.br
|
|
|
1166 |
|
|
|
1167 |
Set FRU serial number.
|
|
|
1168 |
.TP
|
|
|
1169 |
setmfgdate
|
|
|
1170 |
.br
|
|
|
1171 |
|
|
|
1172 |
Set FRU manufacturing date.
|
|
|
1173 |
.TP
|
|
|
1174 |
nextboot <boot device>
|
|
|
1175 |
.br
|
|
|
1176 |
|
|
|
1177 |
Select the next boot order on the Kontron CP6012.
|
|
|
1178 |
.RE
|
|
|
1179 |
.TP
|
|
|
1180 |
lan
|
|
|
1181 |
.RS
|
|
|
1182 |
.TP
|
|
|
1183 |
print [<channel>]
|
|
|
1184 |
.br
|
|
|
1185 |
|
|
|
1186 |
Print the current configuration for the given channel.
|
|
|
1187 |
The default will print information on the first found LAN channel.
|
|
|
1188 |
.TP
|
|
|
1189 |
set <channel> <command> <parameter>
|
|
|
1190 |
.br
|
|
|
1191 |
|
|
|
1192 |
Set the given command and parameter on the given channel.
|
|
|
1193 |
Valid command/parameters are:
|
|
|
1194 |
.RS
|
|
|
1195 |
.TP
|
|
|
1196 |
ipaddr <x.x.x.x>
|
|
|
1197 |
.br
|
|
|
1198 |
|
|
|
1199 |
Set the IP address for this channel.
|
|
|
1200 |
.TP
|
|
|
1201 |
netmask <x.x.x.x>
|
|
|
1202 |
.br
|
|
|
1203 |
|
|
|
1204 |
Set the netmask for this channel.
|
|
|
1205 |
.TP
|
|
|
1206 |
macaddr <xx:xx:xx:xx:xx:xx>
|
|
|
1207 |
.br
|
|
|
1208 |
|
|
|
1209 |
Set the MAC address for this channel.
|
|
|
1210 |
.TP
|
|
|
1211 |
defgw ipaddr <x.x.x.x>
|
|
|
1212 |
.br
|
|
|
1213 |
|
|
|
1214 |
Set the default gateway IP address.
|
|
|
1215 |
.TP
|
|
|
1216 |
defgw macaddr <xx:xx:xx:xx:xx:xx>
|
|
|
1217 |
.br
|
|
|
1218 |
|
|
|
1219 |
Set the default gateway MAC address.
|
|
|
1220 |
.TP
|
|
|
1221 |
bakgw ipaddr <x.x.x.x>
|
|
|
1222 |
.br
|
|
|
1223 |
|
|
|
1224 |
Set the backup gateway IP address.
|
|
|
1225 |
.TP
|
|
|
1226 |
bakgw macaddr <xx:xx:xx:xx:xx:xx>
|
|
|
1227 |
.br
|
|
|
1228 |
|
|
|
1229 |
Set the backup gateway MAC address.
|
|
|
1230 |
.TP
|
|
|
1231 |
password <pass>
|
|
|
1232 |
.br
|
|
|
1233 |
|
|
|
1234 |
Set the null user password.
|
|
|
1235 |
.TP
|
|
|
1236 |
snmp <community string>
|
|
|
1237 |
.br
|
|
|
1238 |
|
|
|
1239 |
Set the SNMP community string.
|
|
|
1240 |
.TP
|
|
|
1241 |
user
|
|
|
1242 |
.br
|
|
|
1243 |
|
|
|
1244 |
Enable user access mode for userid 1 (issue the `user'
|
|
|
1245 |
command to display information about userids for a given channel).
|
|
|
1246 |
.TP
|
|
|
1247 |
access <on|off>
|
|
|
1248 |
.br
|
|
|
1249 |
|
|
|
1250 |
Set LAN channel access mode.
|
|
|
1251 |
.TP
|
|
|
1252 |
alert <on|off>
|
|
|
1253 |
.br
|
|
|
1254 |
|
|
|
1255 |
Enable or disable PEF alerting for this channel.
|
|
|
1256 |
.TP
|
|
|
1257 |
ipsrc <source>
|
|
|
1258 |
.br
|
|
|
1259 |
|
|
|
1260 |
Set the IP address source:
|
|
|
1261 |
.br
|
|
|
1262 |
none = unspecified
|
|
|
1263 |
.br
|
|
|
1264 |
static = manually configured static IP address
|
|
|
1265 |
.br
|
|
|
1266 |
dhcp = address obtained by BMC running DHCP
|
|
|
1267 |
.br
|
|
|
1268 |
bios = address loaded by BIOS or system software
|
|
|
1269 |
.TP
|
|
|
1270 |
arp respond <on|off>
|
|
|
1271 |
.br
|
|
|
1272 |
|
|
|
1273 |
Set BMC generated ARP responses.
|
|
|
1274 |
.TP
|
|
|
1275 |
arp generate <on|off>
|
|
|
1276 |
.br
|
|
|
1277 |
|
|
|
1278 |
Set BMC generated gratuitous ARPs.
|
|
|
1279 |
.TP
|
|
|
1280 |
arp interval <seconds>
|
|
|
1281 |
.br
|
|
|
1282 |
|
|
|
1283 |
Set BMC generated gratuitous ARP interval.
|
|
|
1284 |
.TP
|
|
|
1285 |
auth <level,...> <type,...>
|
|
|
1286 |
.br
|
|
|
1287 |
|
|
|
1288 |
Set the valid authtypes for a given auth level.
|
|
|
1289 |
.br
|
|
|
1290 |
Levels: callback, user, operator, admin
|
|
|
1291 |
.br
|
|
|
1292 |
Types: none, md2, md5, password, oem
|
|
|
1293 |
.TP
|
|
|
1294 |
cipher_privs <privlist>
|
|
|
1295 |
.br
|
|
|
1296 |
|
|
|
1297 |
Correlates cipher suite numbers with the maximum privilege
|
|
|
1298 |
level that is allowed to use it. In this way, cipher suites can restricted
|
|
|
1299 |
to users with a given privilege level, so that, for example,
|
|
|
1300 |
administrators are required to use a stronger cipher suite than
|
|
|
1301 |
normal users.
|
|
|
1302 |
|
|
|
1303 |
The format of \fIprivlist\fR is as follows. Each character represents a privilege level
|
|
|
1304 |
and the character position identifies the cipher suite number. For example, the
|
|
|
1305 |
first character represents cipher suite 1 (cipher suite 0 is reserved), the second represents
|
|
|
1306 |
cipher suite 2, and so on. \fIprivlist\fR must be 15 characters in length.
|
|
|
1307 |
|
|
|
1308 |
Characters used in \fIprivlist\fR and their associated privilege levels are:
|
|
|
1309 |
|
|
|
1310 |
X Cipher Suite Unused
|
|
|
1311 |
.br
|
|
|
1312 |
c CALLBACK
|
|
|
1313 |
.br
|
|
|
1314 |
u USER
|
|
|
1315 |
.br
|
|
|
1316 |
o OPERATOR
|
|
|
1317 |
.br
|
|
|
1318 |
a ADMIN
|
|
|
1319 |
.br
|
|
|
1320 |
O OEM
|
|
|
1321 |
.br
|
|
|
1322 |
|
|
|
1323 |
So, to set the maximum privilege for cipher suite 1 to USER and suite 2 to
|
|
|
1324 |
ADMIN, issue the following command:
|
|
|
1325 |
|
|
|
1326 |
ipmitool -I \fIinterface\fR lan set \fIchannel\fR cipher_privs uaXXXXXXXXXXXXX
|
|
|
1327 |
|
|
|
1328 |
.RE
|
|
|
1329 |
.TP
|
|
|
1330 |
alert print [<channel>] [<destination>]
|
|
|
1331 |
.br
|
|
|
1332 |
|
|
|
1333 |
Print alert information for the specified channel and destination.
|
|
|
1334 |
The default will print all alerts for all alert destinations on the
|
|
|
1335 |
first found LAN channel.
|
|
|
1336 |
|
|
|
1337 |
.TP
|
|
|
1338 |
alert set <channel> <destination> <command> <parameter>
|
|
|
1339 |
.br
|
|
|
1340 |
|
|
|
1341 |
Set an alert on the given LAN channel and destination. Alert Destinations are
|
|
|
1342 |
listed via the 'lan alert print' command. Valid command/parameters are:
|
|
|
1343 |
.RS
|
|
|
1344 |
.TP
|
|
|
1345 |
ipaddr <x.x.x.x>
|
|
|
1346 |
.br
|
|
|
1347 |
|
|
|
1348 |
Set alert IP address.
|
|
|
1349 |
.TP
|
|
|
1350 |
macaddr <xx:xx:xx:xx:xx:xx>
|
|
|
1351 |
.br
|
|
|
1352 |
|
|
|
1353 |
Set alert MAC address.
|
|
|
1354 |
.TP
|
|
|
1355 |
gateway <default | backup>
|
|
|
1356 |
.br
|
|
|
1357 |
|
|
|
1358 |
Set the channel gateway to use for alerts.
|
|
|
1359 |
.TP
|
|
|
1360 |
ack <on | off>
|
|
|
1361 |
.br
|
|
|
1362 |
|
|
|
1363 |
Set Alert Acknowledge on or off.
|
|
|
1364 |
.TP
|
|
|
1365 |
type <pet | oem1 | oem2>
|
|
|
1366 |
.br
|
|
|
1367 |
|
|
|
1368 |
Set the destination type as PET or OEM.
|
|
|
1369 |
.TP
|
|
|
1370 |
time <seconds>
|
|
|
1371 |
.br
|
|
|
1372 |
|
|
|
1373 |
Set ack timeout or unack retry interval.
|
|
|
1374 |
.TP
|
|
|
1375 |
retry <number>
|
|
|
1376 |
.br
|
|
|
1377 |
|
|
|
1378 |
Set the number of alert retries.
|
|
|
1379 |
.RE
|
|
|
1380 |
.TP
|
|
|
1381 |
stats get [<channel>]
|
|
|
1382 |
.br
|
|
|
1383 |
|
|
|
1384 |
Retrieve information about the IP connections on the specified channel.
|
|
|
1385 |
The default will retrieve statistics on the first found LAN channel.
|
|
|
1386 |
.TP
|
|
|
1387 |
stats clear [<channel>]
|
|
|
1388 |
.br
|
|
|
1389 |
|
|
|
1390 |
Clear all IP/UDP/RMCP Statistics to 0 on the specified channel.
|
|
|
1391 |
The default will clear statistics on the first found LAN channel.
|
|
|
1392 |
.RE
|
|
|
1393 |
.TP
|
|
|
1394 |
pef
|
|
|
1395 |
.RS
|
|
|
1396 |
.TP
|
|
|
1397 |
info
|
|
|
1398 |
.br
|
|
|
1399 |
|
|
|
1400 |
This command will query the BMC and print information about the PEF supported features.
|
|
|
1401 |
.TP
|
|
|
1402 |
status
|
|
|
1403 |
.br
|
|
|
1404 |
|
|
|
1405 |
This command prints the current PEF status (the last SEL entry processed by the BMC, etc).
|
|
|
1406 |
.TP
|
|
|
1407 |
policy
|
|
|
1408 |
.br
|
|
|
1409 |
|
|
|
1410 |
This command lists the PEF policy table entries. Each policy
|
|
|
1411 |
entry describes an alert destination. A policy set is a
|
|
|
1412 |
collection of table entries. PEF alert actions reference policy sets.
|
|
|
1413 |
.TP
|
|
|
1414 |
list
|
|
|
1415 |
.br
|
|
|
1416 |
|
|
|
1417 |
This command lists the PEF table entries. Each PEF entry
|
|
|
1418 |
relates a sensor event to an action. When PEF is active,
|
|
|
1419 |
each platform event causes the BMC to scan this table for
|
|
|
1420 |
entries matching the event, and possible actions to be taken.
|
|
|
1421 |
Actions are performed in priority order (higher criticality first).
|
|
|
1422 |
.RE
|
|
|
1423 |
.TP
|
|
|
1424 |
picmg <properties>
|
|
|
1425 |
.RS
|
|
|
1426 |
|
|
|
1427 |
Run a PICMG/ATA extended command. Get PICMG properties may be used to
|
|
|
1428 |
obtain and print Extension major version information, PICMG identifier,
|
|
|
1429 |
FRU Device ID and Max FRU Device ID.
|
|
|
1430 |
.TP
|
|
|
1431 |
addrinfo
|
|
|
1432 |
.br
|
|
|
1433 |
|
|
|
1434 |
Get address information. This command may return information on the Hardware
|
|
|
1435 |
address, IPMB-0 Address, FRU ID, Site/Entity ID, and Site/Entity Type.
|
|
|
1436 |
.TP
|
|
|
1437 |
frucontrol <fru id> <options>
|
|
|
1438 |
.br
|
|
|
1439 |
|
|
|
1440 |
Set various control options:
|
|
|
1441 |
.RS
|
|
|
1442 |
.TP
|
|
|
1443 |
0x00 - Cold Reset
|
|
|
1444 |
.br
|
|
|
1445 |
.TP
|
|
|
1446 |
0x01 - Warm Reset
|
|
|
1447 |
.br
|
|
|
1448 |
.TP
|
|
|
1449 |
0x02 - Graceful Reboot
|
|
|
1450 |
.br
|
|
|
1451 |
.TP
|
|
|
1452 |
0x03 - Issue Diagnostic Interrupt
|
|
|
1453 |
.br
|
|
|
1454 |
.TP
|
|
|
1455 |
0x04 - Quiesce [AMC only]
|
|
|
1456 |
.br
|
|
|
1457 |
.TP
|
|
|
1458 |
0x05-0xFF - Cold Reset
|
|
|
1459 |
.br
|
|
|
1460 |
.RE
|
|
|
1461 |
.TP
|
|
|
1462 |
activate <fru id>
|
|
|
1463 |
.br
|
|
|
1464 |
|
|
|
1465 |
Activate the specified FRU.
|
|
|
1466 |
.TP
|
|
|
1467 |
deactivate <fru id>
|
|
|
1468 |
.br
|
|
|
1469 |
|
|
|
1470 |
Deactivate the specified FRU.
|
|
|
1471 |
.TP
|
|
|
1472 |
policy get <fru id>
|
|
|
1473 |
.br
|
|
|
1474 |
|
|
|
1475 |
Get FRU activation policy.
|
|
|
1476 |
.TP
|
|
|
1477 |
policy set <fru id> <lockmask> <lock>
|
|
|
1478 |
.br
|
|
|
1479 |
|
|
|
1480 |
Set FRU activation policy. \fIlockmask\fR is 1 or 0 to indicate action
|
|
|
1481 |
on the deactivation or activation locked bit respectively. \fIlock\fR is
|
|
|
1482 |
1 or 0 to set/clear locked bit.
|
|
|
1483 |
.TP
|
|
|
1484 |
portstate set|getall|getgranted|getdenied <parameters>
|
|
|
1485 |
.br
|
|
|
1486 |
|
|
|
1487 |
Get or set various port states. See usage for parameter details.
|
|
|
1488 |
.RE
|
|
|
1489 |
.TP
|
|
|
1490 |
power <chassis power command>
|
|
|
1491 |
.br
|
|
|
1492 |
|
|
|
1493 |
Alias for the "chassis power" commands.
|
|
|
1494 |
See the "chassis power" commands for usage information.
|
|
|
1495 |
.TP
|
|
|
1496 |
raw <netfn> <cmd> [<data>]
|
|
|
1497 |
.br
|
|
|
1498 |
|
|
|
1499 |
This will allow you to execute raw IPMI commands. For
|
|
|
1500 |
example to query the POH counter with a raw command:
|
|
|
1501 |
|
|
|
1502 |
ipmitool \-v \-I bmc raw 0x0 0xf
|
|
|
1503 |
.br
|
|
|
1504 |
RAW REQ (netfn=0x0 cmd=0xf data_len=0)
|
|
|
1505 |
.br
|
|
|
1506 |
RAW RSP (5 bytes)
|
|
|
1507 |
.br
|
|
|
1508 |
3c 72 0c 00 00
|
|
|
1509 |
.TP
|
|
|
1510 |
sdr
|
|
|
1511 |
.RS
|
|
|
1512 |
.TP
|
|
|
1513 |
info
|
|
|
1514 |
.br
|
|
|
1515 |
|
|
|
1516 |
This command will query the BMC for Sensor Data Record (SDR) Repository information.
|
|
|
1517 |
.TP
|
|
|
1518 |
type [list|<sensor type>]
|
|
|
1519 |
.br
|
|
|
1520 |
|
|
|
1521 |
Displays sensor data records only for the sensor type (e.g. `temperature', `voltage', etc.)
|
|
|
1522 |
chosen. A list of all supported sensor types may be displayed if the `list' keyword is used instead
|
|
|
1523 |
of a sensor type. Note that the sensor type is not case sensitive. Also note that there may be a large
|
|
|
1524 |
delay before any information is displayed, because ipmitool does a full scan of all sensor records and builds
|
|
|
1525 |
a list of just those that meet the type criterion given.
|
|
|
1526 |
.TP
|
|
|
1527 |
list|elist [all|full|compact|event|mcloc|fru|generic]
|
|
|
1528 |
.br
|
|
|
1529 |
|
|
|
1530 |
This command will read the Sensor Data Records (SDR) and
|
|
|
1531 |
extract sensor information of a given type, then query each sensor and
|
|
|
1532 |
print its name, reading, and status. The `elist' form of this command
|
|
|
1533 |
prints additional information about each data record (e.g. threshold type,
|
|
|
1534 |
sensor number, sensor entity).
|
|
|
1535 |
.RS
|
|
|
1536 |
.TP
|
|
|
1537 |
Valid types are:
|
|
|
1538 |
.RS
|
|
|
1539 |
.TP
|
|
|
1540 |
all
|
|
|
1541 |
.br
|
|
|
1542 |
|
|
|
1543 |
All SDR records (Sensor and Locator)
|
|
|
1544 |
.TP
|
|
|
1545 |
full
|
|
|
1546 |
.br
|
|
|
1547 |
|
|
|
1548 |
Full Sensor Record
|
|
|
1549 |
.TP
|
|
|
1550 |
compact
|
|
|
1551 |
.br
|
|
|
1552 |
|
|
|
1553 |
Compact Sensor Record
|
|
|
1554 |
.TP
|
|
|
1555 |
event
|
|
|
1556 |
.br
|
|
|
1557 |
|
|
|
1558 |
Event-Only Sensor Record
|
|
|
1559 |
.TP
|
|
|
1560 |
mcloc
|
|
|
1561 |
.br
|
|
|
1562 |
|
|
|
1563 |
Management Controller Locator Record
|
|
|
1564 |
.TP
|
|
|
1565 |
fru
|
|
|
1566 |
.br
|
|
|
1567 |
|
|
|
1568 |
FRU Locator Record
|
|
|
1569 |
.TP
|
|
|
1570 |
generic
|
|
|
1571 |
.br
|
|
|
1572 |
|
|
|
1573 |
Generic SDR records
|
|
|
1574 |
.RE
|
|
|
1575 |
.RE
|
|
|
1576 |
.TP
|
|
|
1577 |
entity <id>[.<instance>]
|
|
|
1578 |
.br
|
|
|
1579 |
|
|
|
1580 |
Displays all sensors associated with an entity. Get a list of
|
|
|
1581 |
valid entity ids on the target system by issuing the `sdr list' command
|
|
|
1582 |
with the verbose option (`-v'). A list of all entity ids can be found
|
|
|
1583 |
in the IPMI specifications.
|
|
|
1584 |
.TP
|
|
|
1585 |
dump <file>
|
|
|
1586 |
.br
|
|
|
1587 |
|
|
|
1588 |
Dumps raw SDR data to a file. This file may also be used as the sdr cache, supplied to ipmitool
|
|
|
1589 |
with the `\-S' option, dramatically speeding up the `sdr' and `sel elist' commands.
|
|
|
1590 |
.TP
|
|
|
1591 |
fill sensors
|
|
|
1592 |
.br
|
|
|
1593 |
|
|
|
1594 |
Create the SDR Repository for the current configuration. Will perform
|
|
|
1595 |
a 'Clear SDR Repository' command so be careful.
|
|
|
1596 |
.TP
|
|
|
1597 |
fill file <filename>
|
|
|
1598 |
.br
|
|
|
1599 |
|
|
|
1600 |
Fill the SDR Repository using records stored in a binary data file. Will perform
|
|
|
1601 |
a 'Clear SDR Repository' command so be careful.
|
|
|
1602 |
.RE
|
|
|
1603 |
.TP
|
|
|
1604 |
sel
|
|
|
1605 |
.br
|
|
|
1606 |
|
|
|
1607 |
NOTE: System Event Log (SEL) entry-times are displayed as
|
|
|
1608 |
`Pre-Init Time-stamp' if the SEL clock needs to be set.
|
|
|
1609 |
Ensure that the SEL clock is accurate by invoking the
|
|
|
1610 |
`sel time get' and
|
|
|
1611 |
`sel time set <time string>' commands.
|
|
|
1612 |
.RS
|
|
|
1613 |
.TP
|
|
|
1614 |
info
|
|
|
1615 |
.br
|
|
|
1616 |
|
|
|
1617 |
This command will query the BMC for information
|
|
|
1618 |
about the System Event Log (SEL) and its contents.
|
|
|
1619 |
.TP
|
|
|
1620 |
clear
|
|
|
1621 |
.br
|
|
|
1622 |
|
|
|
1623 |
This command will clear the contents of the SEL.
|
|
|
1624 |
It cannot be undone so be careful.
|
|
|
1625 |
.TP
|
|
|
1626 |
list|elist
|
|
|
1627 |
.br
|
|
|
1628 |
|
|
|
1629 |
When this command is invoked without arguments, the entire
|
|
|
1630 |
contents of the SEL are displayed. In addition to the information
|
|
|
1631 |
displayed by the `list' command, the `elist' command will cross-reference
|
|
|
1632 |
SEL records with SDR records to produce descriptive event output.
|
|
|
1633 |
|
|
|
1634 |
.RS
|
|
|
1635 |
.TP
|
|
|
1636 |
<count> | first <count>
|
|
|
1637 |
.br
|
|
|
1638 |
|
|
|
1639 |
Displays the first \fIcount\fR (least-recent) entries in the SEL.
|
|
|
1640 |
If \fIcount\fR is zero, all entries are displayed.
|
|
|
1641 |
.TP
|
|
|
1642 |
last <count>
|
|
|
1643 |
.br
|
|
|
1644 |
|
|
|
1645 |
Displays the last \fIcount\fR (most-recent) entries in the SEL.
|
|
|
1646 |
If \fIcount\fR is zero, all entries are displayed.
|
|
|
1647 |
.RE
|
|
|
1648 |
.TP
|
|
|
1649 |
delete <SEL Record ID> ... <SEL Record ID>
|
|
|
1650 |
.br
|
|
|
1651 |
|
|
|
1652 |
Delete one or more SEL event records.
|
|
|
1653 |
.TP
|
|
|
1654 |
add <file>
|
|
|
1655 |
.br
|
|
|
1656 |
|
|
|
1657 |
Read event entries from a file and add them to the SEL. New SEL
|
|
|
1658 |
entries area added onto the SEL after the last record in the SEL.
|
|
|
1659 |
Record added is of type 2 and is automatically timestamped.
|
|
|
1660 |
.TP
|
|
|
1661 |
get <SEL Record ID>
|
|
|
1662 |
.br
|
|
|
1663 |
|
|
|
1664 |
Print information on the specified SEL Record entry.
|
|
|
1665 |
.TP
|
|
|
1666 |
save <file>
|
|
|
1667 |
|
|
|
1668 |
Save SEL records to a text file that can be fed back into the
|
|
|
1669 |
`event file' ipmitool command. This can be useful for
|
|
|
1670 |
testing Event generation by building an appropriate Platform
|
|
|
1671 |
Event Message file based on existing events. Please see the
|
|
|
1672 |
available help for the 'event file ...' command for a description of
|
|
|
1673 |
the format of this file.
|
|
|
1674 |
.TP
|
|
|
1675 |
writeraw <file>
|
|
|
1676 |
|
|
|
1677 |
Save SEL records to a file in raw, binary format. This file can
|
|
|
1678 |
be fed back to the `sel readraw' ipmitool command for viewing.
|
|
|
1679 |
.TP
|
|
|
1680 |
readraw <file>
|
|
|
1681 |
|
|
|
1682 |
Read and display SEL records from a binary file. Such a file can
|
|
|
1683 |
be created using the `sel writeraw' ipmitool command.
|
|
|
1684 |
.TP
|
|
|
1685 |
time
|
|
|
1686 |
.RS
|
|
|
1687 |
.TP
|
|
|
1688 |
get
|
|
|
1689 |
.br
|
|
|
1690 |
|
|
|
1691 |
Displays the SEL clock's current time.
|
|
|
1692 |
.TP
|
|
|
1693 |
set <time string>
|
|
|
1694 |
.br
|
|
|
1695 |
|
|
|
1696 |
Sets the SEL clock. Future SEL entries will use the time
|
|
|
1697 |
set by this command. <time string> is of the
|
|
|
1698 |
form "MM/DD/YYYY HH:MM:SS". Note that hours are in 24-hour
|
|
|
1699 |
form. It is recommended that the SEL be cleared before
|
|
|
1700 |
setting the time.
|
|
|
1701 |
.RE
|
|
|
1702 |
.RE
|
|
|
1703 |
.TP
|
|
|
1704 |
sensor
|
|
|
1705 |
.RS
|
|
|
1706 |
.TP
|
|
|
1707 |
list
|
|
|
1708 |
.br
|
|
|
1709 |
|
|
|
1710 |
Lists sensors and thresholds in a wide table format.
|
|
|
1711 |
.TP
|
|
|
1712 |
get <id> ... [id]
|
|
|
1713 |
.br
|
|
|
1714 |
|
|
|
1715 |
Prints information for sensors specified by name.
|
|
|
1716 |
.TP
|
|
|
1717 |
thresh <id> <threshold> <setting>
|
|
|
1718 |
.br
|
|
|
1719 |
|
|
|
1720 |
This allows you to set a particular sensor threshold
|
|
|
1721 |
value. The sensor is specified by name.
|
|
|
1722 |
.RS
|
|
|
1723 |
.TP
|
|
|
1724 |
Valid thresholds are:
|
|
|
1725 |
.br
|
|
|
1726 |
unr Upper Non\-Recoverable
|
|
|
1727 |
.br
|
|
|
1728 |
ucr Upper Critical
|
|
|
1729 |
.br
|
|
|
1730 |
unc Upper Non\-Critical
|
|
|
1731 |
.br
|
|
|
1732 |
lnc Lower Non\-Critical
|
|
|
1733 |
.br
|
|
|
1734 |
lcr Lower Critical
|
|
|
1735 |
.br
|
|
|
1736 |
lnr Lower Non\-Recoverable
|
|
|
1737 |
.RE
|
|
|
1738 |
.RE
|
|
|
1739 |
.TP
|
|
|
1740 |
session
|
|
|
1741 |
.RS
|
|
|
1742 |
.TP
|
|
|
1743 |
info <active | all | id 0xnnnnnnnn | handle 0xnn>
|
|
|
1744 |
.br
|
|
|
1745 |
|
|
|
1746 |
Get information about the specified session(s). You may identify
|
|
|
1747 |
sessions by their id, by their handle number, by their active status,
|
|
|
1748 |
or by using the keyword `all' to specify all sessions.
|
|
|
1749 |
.RE
|
|
|
1750 |
.TP
|
|
|
1751 |
sol
|
|
|
1752 |
.RS
|
|
|
1753 |
.TP
|
|
|
1754 |
info [<channel number>]
|
|
|
1755 |
.br
|
|
|
1756 |
|
|
|
1757 |
Retrieve information about the Serial-Over-LAN configuration on
|
|
|
1758 |
the specified channel. If no channel is given, it will display
|
|
|
1759 |
SOL configuration data for the currently used channel.
|
|
|
1760 |
.TP
|
|
|
1761 |
payload <enable | disable> <channel> <userid>
|
|
|
1762 |
.br
|
|
|
1763 |
|
|
|
1764 |
Enable or disable SOL payload for the user on the specified channel.
|
|
|
1765 |
.TP
|
|
|
1766 |
set <parameter> <value> [channel]
|
|
|
1767 |
.br
|
|
|
1768 |
|
|
|
1769 |
Configure parameters for Serial Over Lan. If no channel is given,
|
|
|
1770 |
it will display SOL configuration data for the currently used
|
|
|
1771 |
channel. Configuration parameter updates are automatically guarded
|
|
|
1772 |
with the updates to the set-in-progress parameter.
|
|
|
1773 |
.RS
|
|
|
1774 |
.TP
|
|
|
1775 |
Valid parameters and values are:
|
|
|
1776 |
.br
|
|
|
1777 |
.TP
|
|
|
1778 |
set-in-progress
|
|
|
1779 |
set-complete set-in-progress commit-write
|
|
|
1780 |
.TP
|
|
|
1781 |
enabled
|
|
|
1782 |
true false
|
|
|
1783 |
.TP
|
|
|
1784 |
force-encryption
|
|
|
1785 |
true false
|
|
|
1786 |
.TP
|
|
|
1787 |
force-authentication
|
|
|
1788 |
true false
|
|
|
1789 |
.TP
|
|
|
1790 |
privilege-level
|
|
|
1791 |
user operator admin oem
|
|
|
1792 |
.TP
|
|
|
1793 |
character-accumulate-level
|
|
|
1794 |
Decimal number given in 5-millisecond increments
|
|
|
1795 |
.TP
|
|
|
1796 |
character-send-threshold
|
|
|
1797 |
Decimal number
|
|
|
1798 |
.TP
|
|
|
1799 |
retry-count
|
|
|
1800 |
Decimal number. 0 indicates no retries after packet is transmitted.
|
|
|
1801 |
.TP
|
|
|
1802 |
retry-interval
|
|
|
1803 |
Decimal number in 10 millisend increments. 0 indicates
|
|
|
1804 |
that retries should be sent back to back.
|
|
|
1805 |
.TP
|
|
|
1806 |
non-volatile-bit-rate
|
|
|
1807 |
serial, 19.2, 38.4, 57.6, 115.2. Setting this value to
|
|
|
1808 |
serial indicates that the BMC should use the setting used
|
|
|
1809 |
by the IPMI over serial channel.
|
|
|
1810 |
.TP
|
|
|
1811 |
volatile-bit-rate
|
|
|
1812 |
serial, 19.2, 38.4, 57.6, 115.2. Setting this value to
|
|
|
1813 |
serial indiates that the BMC should use the setting used
|
|
|
1814 |
by the IPMI over serial channel.
|
|
|
1815 |
.RE
|
|
|
1816 |
.TP
|
|
|
1817 |
activate [usesolkeepalive | nokeepalive]
|
|
|
1818 |
.br
|
|
|
1819 |
|
|
|
1820 |
Causes ipmitool to enter Serial Over LAN
|
|
|
1821 |
mode, and is only available when using the lanplus
|
|
|
1822 |
interface. An RMCP+ connection is made to the BMC,
|
|
|
1823 |
the terminal is set to raw mode, and user input is
|
|
|
1824 |
sent to the serial console on the remote server.
|
|
|
1825 |
On exit,the the SOL payload mode is deactivated and
|
|
|
1826 |
the terminal is reset to its original settings.
|
|
|
1827 |
.RS
|
|
|
1828 |
|
|
|
1829 |
Special escape sequences are provided to control the SOL session:
|
|
|
1830 |
.RS
|
|
|
1831 |
.TP
|
|
|
1832 |
~. Terminate connection
|
|
|
1833 |
.TP
|
|
|
1834 |
~^Z Suspend ipmitool
|
|
|
1835 |
.TP
|
|
|
1836 |
~^X Suspend ipmitool, but don't restore tty on restart
|
|
|
1837 |
.TP
|
|
|
1838 |
~B Send break
|
|
|
1839 |
.TP
|
|
|
1840 |
~~ Send the escape character by typing it twice
|
|
|
1841 |
.TP
|
|
|
1842 |
~? Print the supported escape sequences
|
|
|
1843 |
.RE
|
|
|
1844 |
|
|
|
1845 |
Note that escapes are only recognized immediately after newline.
|
|
|
1846 |
.RE
|
|
|
1847 |
.TP
|
|
|
1848 |
deactivate
|
|
|
1849 |
.br
|
|
|
1850 |
|
|
|
1851 |
Deactivates Serial Over LAN mode on the BMC.
|
|
|
1852 |
Exiting Serial Over LAN mode should automatically cause
|
|
|
1853 |
this command to be sent to the BMC, but in the case of an
|
|
|
1854 |
unintentional exit from SOL mode, this command may be
|
|
|
1855 |
necessary to reset the state of the BMC.
|
|
|
1856 |
.RE
|
|
|
1857 |
.TP
|
|
|
1858 |
spd <i2cbus> <i2caddr> [<channel>] [<maxread>]
|
|
|
1859 |
.br
|
|
|
1860 |
|
|
|
1861 |
This command may be used to read SPD (Serial Presence Detect) data using the
|
|
|
1862 |
I2C Master Write-Read IPMI command.
|
|
|
1863 |
|
|
|
1864 |
.TP
|
|
|
1865 |
sunoem
|
|
|
1866 |
.br
|
|
|
1867 |
|
|
|
1868 |
Sun OEM-specific IPMI commands. Support for these commands depends heavily on the Sun platform targeted.
|
|
|
1869 |
Please consult your Sun Hardware Reference Guide for information on Sun OEM-specific IPMI
|
|
|
1870 |
functionality to determine if the following commands are supported on your desired platform.
|
|
|
1871 |
.RS
|
|
|
1872 |
.TP
|
|
|
1873 |
fan speed <0-100>
|
|
|
1874 |
.br
|
|
|
1875 |
|
|
|
1876 |
Sets the system fan speed (in units of PWM duty cycle)
|
|
|
1877 |
.RE
|
|
|
1878 |
.RS
|
|
|
1879 |
.TP
|
|
|
1880 |
sshkey
|
|
|
1881 |
.br
|
|
|
1882 |
|
|
|
1883 |
Administer SSH keys for service processor users.
|
|
|
1884 |
.RS
|
|
|
1885 |
.TP
|
|
|
1886 |
set <userid> <id_rsa.pub>
|
|
|
1887 |
.br
|
|
|
1888 |
|
|
|
1889 |
Sets the SSH key for the given userid to the key found in the given file. (A
|
|
|
1890 |
list of users may be obtained with the 'user list' command).
|
|
|
1891 |
.RE
|
|
|
1892 |
.RS
|
|
|
1893 |
.TP
|
|
|
1894 |
del <userid>
|
|
|
1895 |
.br
|
|
|
1896 |
|
|
|
1897 |
Delete the SSH key for the given userid.
|
|
|
1898 |
.RE
|
|
|
1899 |
.RE
|
|
|
1900 |
|
|
|
1901 |
.RS
|
|
|
1902 |
.TP
|
|
|
1903 |
led
|
|
|
1904 |
.br
|
|
|
1905 |
|
|
|
1906 |
Manipulate the settings for LEDs found via the `sdr elist generic' command.
|
|
|
1907 |
Once the sensor ID of the LED is found (the `elist' command displayed the sensor ID),
|
|
|
1908 |
it may be used in the following subcommands. When an LED type is required, it can
|
|
|
1909 |
be one of the following values: `OK2RM' (OK to Remove), `SERVICE' (Service Required),
|
|
|
1910 |
`ACT' (Activity), or `LOCATE' (Locate). When an LED mode is required, it can be one
|
|
|
1911 |
of the following values: `OFF' (Off), `ON' (Steady On), `STANDBY' (100ms ON, 2900ms OFF blink rate),
|
|
|
1912 |
`SLOW' (1HZ blink rate), or `FAST' (4HZ blink rate).
|
|
|
1913 |
|
|
|
1914 |
.RS
|
|
|
1915 |
.TP
|
|
|
1916 |
get <sensorid> [<ledtype>]
|
|
|
1917 |
.br
|
|
|
1918 |
|
|
|
1919 |
Read the status of the LED with the given <sensorid>. If <sensorid> is the special keyword `all', then
|
|
|
1920 |
the status of all LEDs will be displayed. The optional parameter, <ledtype>, further restricts the output
|
|
|
1921 |
to LEDs of the given type.
|
|
|
1922 |
.RE
|
|
|
1923 |
.RS
|
|
|
1924 |
.TP
|
|
|
1925 |
set <sensorid> <ledmode> [<ledtype>]
|
|
|
1926 |
.br
|
|
|
1927 |
|
|
|
1928 |
Sets the mode of the LED with the given <sensorid> (and optionally the given type <ledtype>) to the given <ledmode>.
|
|
|
1929 |
If <sensorid> is the special keyword `all', then the status of all LEDs will be set (optionally qualified by the
|
|
|
1930 |
given type <ledtype>).
|
|
|
1931 |
.RE
|
|
|
1932 |
.RE
|
|
|
1933 |
.TP
|
|
|
1934 |
user
|
|
|
1935 |
.RS
|
|
|
1936 |
.TP
|
|
|
1937 |
summary
|
|
|
1938 |
.br
|
|
|
1939 |
|
|
|
1940 |
Displays a summary of userid information, including maximum number of userids,
|
|
|
1941 |
the number of enabled users, and the number of fixed names defined.
|
|
|
1942 |
.TP
|
|
|
1943 |
list
|
|
|
1944 |
.br
|
|
|
1945 |
|
|
|
1946 |
Displays a list of user information for all defined userids.
|
|
|
1947 |
.TP
|
|
|
1948 |
set
|
|
|
1949 |
.RS
|
|
|
1950 |
.TP
|
|
|
1951 |
name <userid> <username>
|
|
|
1952 |
.br
|
|
|
1953 |
|
|
|
1954 |
Sets the username associated with the given userid.
|
|
|
1955 |
.TP
|
|
|
1956 |
password <userid> [<password>]
|
|
|
1957 |
.br
|
|
|
1958 |
|
|
|
1959 |
Sets the password for the given userid. If no password is given,
|
|
|
1960 |
the password is cleared (set to the NULL password). Be careful when
|
|
|
1961 |
removing passwords from administrator-level accounts.
|
|
|
1962 |
.RE
|
|
|
1963 |
.TP
|
|
|
1964 |
disable <userid>
|
|
|
1965 |
.br
|
|
|
1966 |
|
|
|
1967 |
Disables access to the BMC by the given userid.
|
|
|
1968 |
.TP
|
|
|
1969 |
enable <userid>
|
|
|
1970 |
.br
|
|
|
1971 |
|
|
|
1972 |
Enables access to the BMC by the given userid.
|
|
|
1973 |
.TP
|
|
|
1974 |
priv <userid> <privilege level> [<channel>]
|
|
|
1975 |
.br
|
|
|
1976 |
|
|
|
1977 |
Set user privilege level on the specified channel. If the channel is not
|
|
|
1978 |
specified, the current channel will be used.
|
|
|
1979 |
.TP
|
|
|
1980 |
test <userid> <16|20> [<password>]
|
|
|
1981 |
.br
|
|
|
1982 |
|
|
|
1983 |
Determine whether a password has been stored as 16 or 20 bytes.
|
|
|
1984 |
.RE
|
|
|
1985 |
|
|
|
1986 |
\fINOTE\fR: Sun systems, such
|
|
|
1987 |
as the v20z and v40z, maintain the LAN interface on
|
|
|
1988 |
channel 1. To determine on which channel the LAN interface
|
|
|
1989 |
is located, issue the `channel info \fIchannel\fR' command.
|
|
|
1990 |
.SH BMC INTERFACE
|
|
|
1991 |
The ipmitool bmc interface utilizes the bmc device driver.
|
|
|
1992 |
|
|
|
1993 |
In order to force ipmitool to make use of the device interface
|
|
|
1994 |
you can specify it on the command line:
|
|
|
1995 |
|
|
|
1996 |
ipmitool \-I bmc <command>
|
|
|
1997 |
|
|
|
1998 |
.SH LAN INTERFACE
|
|
|
1999 |
The ipmitool lan interface communicates with a remote BMC over an
|
|
|
2000 |
Ethernet LAN connection using UDP over IPv4. UDP datagrams
|
|
|
2001 |
are formatted to contain IPMI request/response messages with
|
|
|
2002 |
IPMI session headers and RMCP headers.
|
|
|
2003 |
|
|
|
2004 |
IPMI\-over\-LAN uses version 1 of the Remote Management Control
|
|
|
2005 |
Protocol (RMCP) to support pre\-OS and OS\-absent management.
|
|
|
2006 |
RMCP is a request\-response protocol delivered using
|
|
|
2007 |
UDP datagrams to port 623.
|
|
|
2008 |
|
|
|
2009 |
The LAN interface is an authenticated multi\-session connection;
|
|
|
2010 |
messages delivered to the BMC can (and should) be
|
|
|
2011 |
authenticate with a challenge/response protocol with either
|
|
|
2012 |
straight password/key or MD5 message\-digest.
|
|
|
2013 |
ipmitool will attempt to connect with administrator
|
|
|
2014 |
privilege level as this is required to perform chassis power
|
|
|
2015 |
functions.
|
|
|
2016 |
|
|
|
2017 |
You can tell ipmitool to use the lan interface with the \-I
|
|
|
2018 |
option:
|
|
|
2019 |
|
|
|
2020 |
ipmitool \-I lan \-H <hostname> [\-f password_file] <command>
|
|
|
2021 |
|
|
|
2022 |
A hostname must be given on the command line in order to use
|
|
|
2023 |
the lan interface with 'ipmitool'. The \fIpassword_file\fR
|
|
|
2024 |
is optional but, if present, should contain the password to be
|
|
|
2025 |
used for authentication. If no password is given, ipmitool will
|
|
|
2026 |
attempt to connect without authentication.
|
|
|
2027 |
|
|
|
2028 |
If \fIpassword_file\fR is present and non\-empty ipmitool will
|
|
|
2029 |
attempt to authenticate with an MD5 message-digest if MD5 is
|
|
|
2030 |
supported by the BMC. If MD5 is not supported by the BMC,
|
|
|
2031 |
straight password/key authentication will be attempted.
|
|
|
2032 |
|
|
|
2033 |
.SH LANPLUS INTERFACE
|
|
|
2034 |
|
|
|
2035 |
.LP
|
|
|
2036 |
Like the \fIlan\fP interface, the \fIlanplus\fP interface
|
|
|
2037 |
communicates with the BMC over an Ethernet LAN connection
|
|
|
2038 |
using UDP over IPv4. The difference is that the \fIlanplus\fP
|
|
|
2039 |
interface uses the RMCP+ protocol as described in the IPMI v2.0
|
|
|
2040 |
specification. RMCP+ allows for improved authentication and data
|
|
|
2041 |
integrity checks, as well as encryption and the ability to carry
|
|
|
2042 |
multiple types of payloads. Generic Serial-over-LAN support
|
|
|
2043 |
requires RMCP+, so the ipmitool \fIsol activate\fP command requires
|
|
|
2044 |
the use of the \fIlanplus\fP interface.
|
|
|
2045 |
.LP
|
|
|
2046 |
Establishing a RMCP+ session uses RAKP (Remote
|
|
|
2047 |
Authenticated Key-Exchange Protocol), which enables the negotiation of
|
|
|
2048 |
many options. ipmitool does not yet allow the user to specify
|
|
|
2049 |
values for all the options, defaulting to the most obvious settings for those
|
|
|
2050 |
settings marked as required in the v2.0 specification. Authentication and integrity
|
|
|
2051 |
HMACs use the SHA-1 algorithm, and encryption is performed with AES, in CBC mode,
|
|
|
2052 |
at 128-bits of strength. Role-level logins are not supported. ipmitool must
|
|
|
2053 |
be configured with the appropriate option for the \fIlanplus\fP interface
|
|
|
2054 |
to be available, as it is not enabled by default. This interface currently
|
|
|
2055 |
requires the OpenSSL library.
|
|
|
2056 |
.LP
|
|
|
2057 |
You can tell ipmitool to use the lanplus interface with the \fB\-I\fR option:
|
|
|
2058 |
.PP
|
|
|
2059 |
ipmitool \-I lanplus \-H <hostname> [\-U username] [\-f password_file] <expression>
|
|
|
2060 |
.LP
|
|
|
2061 |
The options available for the \fIlanplus\fP interface are identical to those available for
|
|
|
2062 |
the \fIlan\fP interface.
|
|
|
2063 |
|
|
|
2064 |
.SH EXIT STATUS
|
|
|
2065 |
|
|
|
2066 |
Upon successful completion, ipmitool returns 0. On failure, 1 is returned.
|
|
|
2067 |
|
|
|
2068 |
.SH EXAMPLES
|
|
|
2069 |
.TP
|
|
|
2070 |
Example 1 : Listing remote sensors:
|
|
|
2071 |
|
|
|
2072 |
> ipmitool \-I lan \-H 1.2.3.4 \-f passfile sdr list
|
|
|
2073 |
.br
|
|
|
2074 |
Baseboard 1.25V | 1.24 Volts | ok
|
|
|
2075 |
.br
|
|
|
2076 |
Baseboard 2.5V | 2.49 Volts | ok
|
|
|
2077 |
.br
|
|
|
2078 |
Baseboard 3.3V | 3.32 Volts | ok
|
|
|
2079 |
.TP
|
|
|
2080 |
Example 2: Displaying status of a remote sensor:
|
|
|
2081 |
|
|
|
2082 |
> ipmitool \-I lan \-H 1.2.3.4 \-f passfile sensor get "Baseboard 1.25V"
|
|
|
2083 |
.br
|
|
|
2084 |
Locating sensor record...
|
|
|
2085 |
.br
|
|
|
2086 |
Sensor ID : Baseboard 1.25V (0x10)
|
|
|
2087 |
.br
|
|
|
2088 |
Sensor Type (Analog) : Voltage
|
|
|
2089 |
.br
|
|
|
2090 |
Sensor Reading : 1.245 (+/\- 0.039) Volts
|
|
|
2091 |
.br
|
|
|
2092 |
Status : ok
|
|
|
2093 |
.br
|
|
|
2094 |
Lower Non\-Recoverable : na
|
|
|
2095 |
.br
|
|
|
2096 |
Lower Critical : 1.078
|
|
|
2097 |
.br
|
|
|
2098 |
Lower Non\-Critical : 1.107
|
|
|
2099 |
.br
|
|
|
2100 |
Upper Non\-Critical : 1.382
|
|
|
2101 |
.br
|
|
|
2102 |
Upper Critical : 1.431
|
|
|
2103 |
.br
|
|
|
2104 |
Upper Non\-Recoverable : na
|
|
|
2105 |
.TP
|
|
|
2106 |
Example 3: Displaying the power status of a remote chassis:
|
|
|
2107 |
|
|
|
2108 |
> ipmitool \-I lan \-H 1.2.3.4 \-f passfile chassis power status
|
|
|
2109 |
.br
|
|
|
2110 |
Chassis Power is on
|
|
|
2111 |
.TP
|
|
|
2112 |
Example 4: Controlling the power on a remote chassis:
|
|
|
2113 |
|
|
|
2114 |
> ipmitool \-I lan \-H 1.2.3.4 \-f passfile chassis power on
|
|
|
2115 |
.br
|
|
|
2116 |
Chassis Power Control: Up/On
|
|
|
2117 |
|
|
|
2118 |
.SH FILES
|
|
|
2119 |
|
|
|
2120 |
\fB/platform/i86pc/kernel/drv/bmc\fR
|
|
|
2121 |
.in +30n
|
|
|
2122 |
.sp
|
|
|
2123 |
32-bit \fBELF\fR kernel module for the bmc driver.
|
|
|
2124 |
.sp
|
|
|
2125 |
.in -30n
|
|
|
2126 |
\fB/platform/i86pc/kernel/drv/amd64/bmc\fR
|
|
|
2127 |
.in +30n
|
|
|
2128 |
.sp
|
|
|
2129 |
64-bit \fBELF\fR kernel module for the bmc driver.
|
|
|
2130 |
.in -30n
|
|
|
2131 |
\fB/dev/bmc\fR
|
|
|
2132 |
.in +30n
|
|
|
2133 |
.sp
|
|
|
2134 |
Character device node used to communicate with the bmc driver.
|
|
|
2135 |
.in -30n
|
|
|
2136 |
|
|
|
2137 |
.SH ATTRIBUTES
|
|
|
2138 |
See attributes(5) for descriptions of the following attributes:
|
|
|
2139 |
.sp
|
|
|
2140 |
.TS
|
|
|
2141 |
box;
|
|
|
2142 |
cbp-1 | cbp-1
|
|
|
2143 |
l | l .
|
|
|
2144 |
ATTRIBUTE TYPE ATTRIBUTE VALUE
|
|
|
2145 |
_
|
|
11
|
2146 |
Availability system/ipmi/ipmitool
|
|
0
|
2147 |
_
|
|
|
2148 |
Interface Stability Volatile
|
|
|
2149 |
.TE
|
|
|
2150 |
.SH SEE ALSO
|
|
|
2151 |
attributes(5)
|
|
|
2152 |
.TP
|
|
|
2153 |
IPMI Specifications
|
|
|
2154 |
http://www.intel.com/design/servers/ipmi/spec.htm
|
|
|
2155 |
.SH NOTES
|
|
|
2156 |
IPMI V1.5 and, at the time of writing, IPMI V2.X only support IPv4.
|
|
|
2157 |
There is no requirement for a BMC to use the same IP address as its
|
|
|
2158 |
host system. In an IPv6 environment the host system can have an IPv6
|
|
|
2159 |
address and 'ipmitool' can be used to assign an IPv4 address to the
|
|
|
2160 |
BMC.
|