1IPMI-RAW(8) System Commands IPMI-RAW(8)
2
6 ipmi-raw - execute IPMI commands by hex values
7
9 ipmi-raw [OPTION...] [<lun> <netfn> COMMAND-HEX-BYTES...]
10
12 Ipmi-raw is used to execute IPMI commands by hex values. Hex values may
13 be input on the command line, a file via the --file option, or via
14 stdin if neither of the previous are specified.
15 Listed below are general IPMI options, tool specific options, trouble
17 shooting information, workaround information, examples, and known
18 issues. For a general introduction to FreeIPMI please see freeipmi(7).
19
21 The following options are general options for configuring IPMI communi‐
22 cation and executing general tool commands.
23 -D IPMIDRIVER, --driver-type=IPMIDRIVER
25 Specify the driver type to use instead of doing an auto selec‐
26 tion. The currently available outofband drivers are LAN and
27 LAN_2_0, which perform IPMI 1.5 and IPMI 2.0 respectively. The
28 currently available inband drivers are KCS, SSIF, OPENIPMI,
29 SUNBMC, and INTELDCMI.
30 --disable-auto-probe
32 Do not probe in-band IPMI devices for default settings.
33 --driver-address=DRIVER-ADDRESS
35 Specify the in-band driver address to be used instead of the
36 probed value. DRIVER-ADDRESS should be prefixed with "0x" for a
37 hex value and '0' for an octal value.
38 --driver-device=DEVICE
40 Specify the in-band driver device path to be used instead of the
41 probed path.
42 --register-spacing=REGISTER-SPACING
44 Specify the in-band driver register spacing instead of the
45 probed value. Argument is in bytes (i.e. 32bit register spacing
46 = 4)
47 --target-channel-number=CHANNEL-NUMBER
49 Specify the in-band driver target channel number to send IPMI
50 requests to.
51 --target-slave-address=SLAVE-ADDRESS
53 Specify the in-band driver target slave number to send IPMI
54 requests to.
55 -h IPMIHOST1,IPMIHOST2,..., --hostname=IPMIHOST1[:PORT],IPMI‐
57 HOST2[:PORT],...
58 Specify the remote host(s) to communicate with. Multiple host‐
59 names may be separated by comma or may be specified in a range
60 format; see HOSTRANGED SUPPORT below. An optional port can be
61 specified with each host, which may be useful in port forwarding
62 or similar situations. If specifying an IPv6 address and port,
63 use the format [ADDRESS]:PORT.
64 -u USERNAME, --username=USERNAME
66 Specify the username to use when authenticating with the remote
67 host. If not specified, a null (i.e. anonymous) username is
68 assumed. The required user privilege will depend on the raw com‐
69 mands executed.
70 -p PASSWORD, --password=PASSWORD
72 Specify the password to use when authenticationg with the remote
73 host. If not specified, a null password is assumed. Maximum
74 password length is 16 for IPMI 1.5 and 20 for IPMI 2.0.
75 -P, --password-prompt
77 Prompt for password to avoid possibility of listing it in
78 process lists.
79 -k K_G, --k-g=K_G
81 Specify the K_g BMC key to use when authenticating with the
82 remote host for IPMI 2.0. If not specified, a null key is
83 assumed. To input the key in hexadecimal form, prefix the string
84 with '0x'. E.g., the key 'abc' can be entered with the either
85 the string 'abc' or the string '0x616263'
86 -K, --k-g-prompt
88 Prompt for k-g to avoid possibility of listing it in process
89 lists.
90 --session-timeout=MILLISECONDS
92 Specify the session timeout in milliseconds. Defaults to 20000
93 milliseconds (20 seconds) if not specified.
94 --retransmission-timeout=MILLISECONDS
96 Specify the packet retransmission timeout in milliseconds.
97 Defaults to 1000 milliseconds (1 second) if not specified. The
98 retransmission timeout cannot be larger than the session time‐
99 out.
100 -a AUTHENTICATION-TYPE, --authentication-type=AUTHENTICATION-TYPE
102 Specify the IPMI 1.5 authentication type to use. The currently
103 available authentication types are NONE, STRAIGHT_PASSWORD_KEY,
104 MD2, and MD5. Defaults to MD5 if not specified.
105 -I CIPHER-SUITE-ID, --cipher-suite-id=CIPHER-SUITE-ID
107 Specify the IPMI 2.0 cipher suite ID to use. The Cipher Suite ID
108 identifies a set of authentication, integrity, and confidential‐
109 ity algorithms to use for IPMI 2.0 communication. The authenti‐
110 cation algorithm identifies the algorithm to use for session
111 setup, the integrity algorithm identifies the algorithm to use
112 for session packet signatures, and the confidentiality algorithm
113 identifies the algorithm to use for payload encryption. Defaults
114 to cipher suite ID 3 if not specified. The following cipher
115 suite ids are currently supported:
116 0 - Authentication Algorithm = None; Integrity Algorithm = None;
118 Confidentiality Algorithm = None
119 1 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
121 None; Confidentiality Algorithm = None
122 2 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
124 HMAC-SHA1-96; Confidentiality Algorithm = None
125 3 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
127 HMAC-SHA1-96; Confidentiality Algorithm = AES-CBC-128
128 6 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
130 None; Confidentiality Algorithm = None
131 7 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
133 HMAC-MD5-128; Confidentiality Algorithm = None
134 8 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
136 HMAC-MD5-128; Confidentiality Algorithm = AES-CBC-128
137 11 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
139 MD5-128; Confidentiality Algorithm = None
140 12 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
142 MD5-128; Confidentiality Algorithm = AES-CBC-128
143 15 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
145 = None; Confidentiality Algorithm = None
146 16 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
148 = HMAC_SHA256_128; Confidentiality Algorithm = None
149 17 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
151 = HMAC_SHA256_128; Confidentiality Algorithm = AES-CBC-128
152 -l PRIVILEGE-LEVEL, --privilege-level=PRIVILEGE-LEVEL
154 Specify the privilege level to be used. The currently available
155 privilege levels are USER, OPERATOR, and ADMIN. Defaults to
156 ADMIN if not specified.
157 --config-file=FILE
159 Specify an alternate configuration file.
160 -W WORKAROUNDS, --workaround-flags=WORKAROUNDS
162 Specify workarounds to vendor compliance issues. Multiple work‐
163 arounds can be specified separated by commas. A special command
164 line flag of "none", will indicate no workarounds (may be useful
165 for overriding configured defaults). See WORKAROUNDS below for a
166 list of available workarounds.
167 --debug
169 Turn on debugging.
170 -?, --help
172 Output a help list and exit.
173 --usage
175 Output a usage message and exit.
176 -V, --version
178 Output the program version and exit.
179
181 The following options are specific to ipmi-raw.
182 --file=CMD-FILE
184 Specify a file to read command requests from.
185 --no-session
187 If performing out of band communication, do not establish an
188 IPMI session and send raw packets without having established a
189 session/authenticating. This option is predominantly for testing
190 the few IPMI packets that can work outside of a session and
191 should not be used by the majority of users.
192
194 The following options manipulate hostranged output. See HOSTRANGED SUP‐
195 PORT below for additional information on hostranges.
196 -B, --buffer-output
198 Buffer hostranged output. For each node, buffer standard output
199 until the node has completed its IPMI operation. When specifying
200 this option, data may appear to output slower to the user since
201 the the entire IPMI operation must complete before any data can
202 be output. See HOSTRANGED SUPPORT below for additional informa‐
203 tion.
204 -C, --consolidate-output
206 Consolidate hostranged output. The complete standard output from
207 every node specified will be consolidated so that nodes with
208 identical output are not output twice. A header will list those
209 nodes with the consolidated output. When this option is speci‐
210 fied, no output can be seen until the IPMI operations to all
211 nodes has completed. If the user breaks out of the program
212 early, all currently consolidated output will be dumped. See
213 HOSTRANGED SUPPORT below for additional information.
214 -F NUM, --fanout=NUM
216 Specify multiple host fanout. A "sliding window" (or fanout)
217 algorithm is used for parallel IPMI communication so that slower
218 nodes or timed out nodes will not impede parallel communication.
219 The maximum number of threads available at the same time is lim‐
220 ited by the fanout. The default is 64.
221 -E, --eliminate
223 Eliminate hosts determined as undetected by ipmidetect. This
224 attempts to remove the common issue of hostranged execution tim‐
225 ing out due to several nodes being removed from service in a
226 large cluster. The ipmidetectd daemon must be running on the
227 node executing the command.
228 --always-prefix
230 Always prefix output, even if only one host is specified or com‐
231 municating in-band. This option is primarily useful for script‐
232 ing purposes. Option will be ignored if specified with the -C
233 option.
234
236 Multiple hosts can be input either as an explicit comma separated lists
237 of hosts or a range of hostnames in the general form: prefix[n-m,l-
238 k,...], where n < m and l < k, etc. The later form should not be con‐
239 fused with regular expression character classes (also denoted by []).
240 For example, foo[19] does not represent foo1 or foo9, but rather repre‐
241 sents a degenerate range: foo19.
242 This range syntax is meant only as a convenience on clusters with a
244 prefixNN naming convention and specification of ranges should not be
245 considered necessary -- the list foo1,foo9 could be specified as such,
246 or by the range foo[1,9].
247 Some examples of range usage follow:
249 foo[01-05] instead of foo01,foo02,foo03,foo04,foo05
250 foo[7,9-10] instead of foo7,foo9,foo10
251 foo[0-3] instead of foo0,foo1,foo2,foo3
252 As a reminder to the reader, some shells will interpret brackets ([ and
254 ]) for pattern matching. Depending on your shell, it may be necessary
255 to enclose ranged lists within quotes.
256 When multiple hosts are specified by the user, a thread will be exe‐
258 cuted for each host in parallel up to the configured fanout (which can
259 be adjusted via the -F option). This will allow communication to large
260 numbers of nodes far more quickly than if done in serial.
261 By default, standard output from each node specified will be output
263 with the hostname prepended to each line. Although this output is read‐
264 able in many situations, it may be difficult to read in other situa‐
265 tions. For example, output from multiple nodes may be mixed together.
266 The -B and -C options can be used to change this default.
267 In-band IPMI Communication will be used when the host "localhost" is
269 specified. This allows the user to add the localhost into the hos‐
270 tranged output.
271
273 Most often, IPMI problems are due to configuration problems.
274 IPMI over LAN problems involve a misconfiguration of the remote
276 machine's BMC. Double check to make sure the following are configured
277 properly in the remote machine's BMC: IP address, MAC address, subnet
278 mask, username, user enablement, user privilege, password, LAN privi‐
279 lege, LAN enablement, and allowed authentication type(s). For IPMI 2.0
280 connections, double check to make sure the cipher suite privilege(s)
281 and K_g key are configured properly. The ipmi-config(8) tool can be
282 used to check and/or change these configuration settings.
283 Inband IPMI problems are typically caused by improperly configured
285 drivers or non-standard BMCs.
286 In addition to the troubleshooting tips below, please see WORKAROUNDS
288 below to also if there are any vendor specific bugs that have been dis‐
289 covered and worked around.
290 Listed below are many of the common issues for error messages. For
292 additional support, please e-mail the <freeipmi-users@gnu.org> mailing
293 list.
294 "username invalid" - The username entered (or a NULL username if none
296 was entered) is not available on the remote machine. It may also be
297 possible the remote BMC's username configuration is incorrect.
298 "password invalid" - The password entered (or a NULL password if none
300 was entered) is not correct. It may also be possible the password for
301 the user is not correctly configured on the remote BMC.
302 "password verification timeout" - Password verification has timed out.
304 A "password invalid" error (described above) or a generic "session
305 timeout" (described below) occurred. During this point in the protocol
306 it cannot be differentiated which occurred.
307 "k_g invalid" - The K_g key entered (or a NULL K_g key if none was
309 entered) is not correct. It may also be possible the K_g key is not
310 correctly configured on the remote BMC.
311 "privilege level insufficient" - An IPMI command requires a higher user
313 privilege than the one authenticated with. Please try to authenticate
314 with a higher privilege. This may require authenticating to a different
315 user which has a higher maximum privilege.
316 "privilege level cannot be obtained for this user" - The privilege
318 level you are attempting to authenticate with is higher than the maxi‐
319 mum allowed for this user. Please try again with a lower privilege. It
320 may also be possible the maximum privilege level allowed for a user is
321 not configured properly on the remote BMC.
322 "authentication type unavailable for attempted privilege level" - The
324 authentication type you wish to authenticate with is not available for
325 this privilege level. Please try again with an alternate authentication
326 type or alternate privilege level. It may also be possible the avail‐
327 able authentication types you can authenticate with are not correctly
328 configured on the remote BMC.
329 "cipher suite id unavailable" - The cipher suite id you wish to authen‐
331 ticate with is not available on the remote BMC. Please try again with
332 an alternate cipher suite id. It may also be possible the available
333 cipher suite ids are not correctly configured on the remote BMC.
334 "ipmi 2.0 unavailable" - IPMI 2.0 was not discovered on the remote
336 machine. Please try to use IPMI 1.5 instead.
337 "connection timeout" - Initial IPMI communication failed. A number of
339 potential errors are possible, including an invalid hostname specified,
340 an IPMI IP address cannot be resolved, IPMI is not enabled on the
341 remote server, the network connection is bad, etc. Please verify con‐
342 figuration and connectivity.
343 "session timeout" - The IPMI session has timed out. Please reconnect.
345 If this error occurs often, you may wish to increase the retransmission
346 timeout. Some remote BMCs are considerably slower than others.
347 "device not found" - The specified device could not be found. Please
349 check configuration or inputs and try again.
350 "driver timeout" - Communication with the driver or device has timed
352 out. Please try again.
353 "message timeout" - Communication with the driver or device has timed
355 out. Please try again.
356 "BMC busy" - The BMC is currently busy. It may be processing informa‐
358 tion or have too many simultaneous sessions to manage. Please wait and
359 try again.
360 "could not find inband device" - An inband device could not be found.
362 Please check configuration or specify specific device or driver on the
363 command line.
364 "driver timeout" - The inband driver has timed out communicating to the
366 local BMC or service processor. The BMC or service processor may be
367 busy or (worst case) possibly non-functioning.
368 "internal IPMI error" - An IPMI error has occurred that FreeIPMI does
370 not know how to handle. Please e-mail <freeipmi-users@gnu.org> to
371 report the issue.
372
374 With so many different vendors implementing their own IPMI solutions,
375 different vendors may implement their IPMI protocols incorrectly. The
376 following describes a number of workarounds currently available to han‐
377 dle discovered compliance issues. When possible, workarounds have been
378 implemented so they will be transparent to the user. However, some will
379 require the user to specify a workaround be used via the -W option.
380 The hardware listed below may only indicate the hardware that a problem
382 was discovered on. Newer versions of hardware may fix the problems
383 indicated below. Similar machines from vendors may or may not exhibit
384 the same problems. Different vendors may license their firmware from
385 the same IPMI firmware developer, so it may be worthwhile to try work‐
386 arounds listed below even if your motherboard is not listed.
387 If you believe your hardware has an additional compliance issue that
389 needs a workaround to be implemented, please contact the FreeIPMI main‐
390 tainers on <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
391 assumeio - This workaround flag will assume inband interfaces communi‐
393 cate with system I/O rather than being memory-mapped. This will work
394 around systems that report invalid base addresses. Those hitting this
395 issue may see "device not supported" or "could not find inband device"
396 errors. Issue observed on HP ProLiant DL145 G1.
397 spinpoll - This workaround flag will inform some inband drivers (most
399 notably the KCS driver) to spin while polling rather than putting the
400 process to sleep. This may significantly improve the wall clock running
401 time of tools because an operating system scheduler's granularity may
402 be much larger than the time it takes to perform a single IPMI message
403 transaction. However, by spinning, your system may be performing less
404 useful work by not contexting out the tool for a more useful task.
405 authcap - This workaround flag will skip early checks for username
407 capabilities, authentication capabilities, and K_g support and allow
408 IPMI authentication to succeed. It works around multiple issues in
409 which the remote system does not properly report username capabilities,
410 authentication capabilities, or K_g status. Those hitting this issue
411 may see "username invalid", "authentication type unavailable for
412 attempted privilege level", or "k_g invalid" errors. Issue observed on
413 Asus P5M2/P5MT-R/RS162-E4/RX4, Intel SR1520ML/X38ML, and Sun Fire
414 2200/4150/4450 with ELOM.
415 nochecksumcheck - This workaround flag will tell FreeIPMI to not check
417 the checksums returned from IPMI command responses. It works around
418 systems that return invalid checksums due to implementation errors, but
419 the packet is otherwise valid. Users are cautioned on the use of this
420 option, as it removes validation of packet integrity in a number of
421 circumstances. However, it is unlikely to be an issue in most situa‐
422 tions. Those hitting this issue may see "connection timeout", "session
423 timeout", or "password verification timeout" errors. On IPMI 1.5 con‐
424 nections, the "noauthcodecheck" workaround may also needed too. Issue
425 observed on Supermicro X9SCM-iiF, Supermicro X9DRi-F, and Supermicro
426 X9DRFR.
427 idzero - This workaround flag will allow empty session IDs to be
429 accepted by the client. It works around IPMI sessions that report empty
430 session IDs to the client. Those hitting this issue may see "session
431 timeout" errors. Issue observed on Tyan S2882 with M3289 BMC.
432 unexpectedauth - This workaround flag will allow unexpected non-null
434 authcodes to be checked as though they were expected. It works around
435 an issue when packets contain non-null authentication data when they
436 should be null due to disabled per-message authentication. Those hit‐
437 ting this issue may see "session timeout" errors. Issue observed on
438 Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware.
439 forcepermsg - This workaround flag will force per-message authentica‐
441 tion to be used no matter what is advertised by the remote system. It
442 works around an issue when per-message authentication is advertised as
443 disabled on the remote system, but it is actually required for the pro‐
444 tocol. Those hitting this issue may see "session timeout" errors.
445 Issue observed on IBM eServer 325.
446 endianseq - This workaround flag will flip the endian of the session
448 sequence numbers to allow the session to continue properly. It works
449 around IPMI 1.5 session sequence numbers that are the wrong endian.
450 Those hitting this issue may see "session timeout" errors. Issue
451 observed on some Sun ILOM 1.0/2.0 (depends on service processor
452 endian).
453 noauthcodecheck - This workaround flag will tell FreeIPMI to not check
455 the authentication codes returned from IPMI 1.5 command responses. It
456 works around systems that return invalid authentication codes due to
457 hashing or implementation errors. Users are cautioned on the use of
458 this option, as it removes an authentication check verifying the valid‐
459 ity of a packet. However, in most organizations, this is unlikely to be
460 a security issue. Those hitting this issue may see "connection time‐
461 out", "session timeout", or "password verification timeout" errors.
462 Issue observed on Xyratex FB-H8-SRAY, Intel Windmill, Quanta Winter‐
463 fell, and Wiwynn Windmill.
464 intel20 - This workaround flag will work around several Intel IPMI 2.0
466 authentication issues. The issues covered include padding of usernames,
467 and password truncation if the authentication algorithm is HMAC-
468 MD5-128. Those hitting this issue may see "username invalid", "password
469 invalid", or "k_g invalid" errors. Issue observed on Intel SE7520AF2
470 with Intel Server Management Module (Professional Edition).
471 supermicro20 - This workaround flag will work around several Supermicro
473 IPMI 2.0 authentication issues on motherboards w/ Peppercon IPMI
474 firmware. The issues covered include handling invalid length authenti‐
475 cation codes. Those hitting this issue may see "password invalid"
476 errors. Issue observed on Supermicro H8QME with SIMSO daughter card.
477 Confirmed fixed on newerver firmware.
478 sun20 - This workaround flag will work work around several Sun IPMI 2.0
480 authentication issues. The issues covered include invalid lengthed hash
481 keys, improperly hashed keys, and invalid cipher suite records. Those
482 hitting this issue may see "password invalid" or "bmc error" errors.
483 Issue observed on Sun Fire 4100/4200/4500 with ILOM. This workaround
484 automatically includes the "opensesspriv" workaround.
485 opensesspriv - This workaround flag will slightly alter FreeIPMI's IPMI
487 2.0 connection protocol to workaround an invalid hashing algorithm used
488 by the remote system. The privilege level sent during the Open Session
489 stage of an IPMI 2.0 connection is used for hashing keys instead of the
490 privilege level sent during the RAKP1 connection stage. Those hitting
491 this issue may see "password invalid", "k_g invalid", or "bad rmcpplus
492 status code" errors. Issue observed on Sun Fire 4100/4200/4500 with
493 ILOM, Inventec 5441/Dell Xanadu II, Supermicro X8DTH, Supermicro X8DTG,
494 Intel S5500WBV/Penguin Relion 700, Intel S2600JF/Appro 512X, and Quanta
495 QSSC-S4R/Appro GB812X-CN. This workaround is automatically triggered
496 with the "sun20" workaround.
497 integritycheckvalue - This workaround flag will work around an invalid
499 integrity check value during an IPMI 2.0 session establishment when
500 using Cipher Suite ID 0. The integrity check value should be 0 length,
501 however the remote motherboard responds with a non-empty field. Those
502 hitting this issue may see "k_g invalid" errors. Issue observed on
503 Supermicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin Relion
504 700, and Intel S2600JF/Appro 512X.
505 No IPMI 1.5 Support - Some motherboards that support IPMI 2.0 have been
507 found to not support IPMI 1.5. Those hitting this issue may see "ipmi
508 2.0 unavailable" or "connection timeout" errors. This issue can be
509 worked around by using IPMI 2.0 instead of IPMI 1.5 by specifying
510 --driver-type=LAN_2_0. Issue observed on HP Proliant DL 145.
511
513 # ipmi-raw 0 6 01
514 Execute command 0x01 with LUN 0x0 and NETFN 0x06 on the local machine.
516 # ipmi-raw -h ahost -u myusername -p mypassword 0 6 01
518 Execute command 0x01 with LUN 0x0 and NETFN 0x06 on a remote machine
520 using IPMI over LAN.
521 # ipmi-raw -h mycluster[0-127] -u myusername -p mypassword 0 6 01
523 Execute command 0x01 with LUN 0x0 and NETFN 0x06 across a cluster using
525 IPMI over LAN.
526 # ipmi-raw
528 Read LUN, NETFN, command and request data from standard input.
530 # ipmi-raw -f command-file
532 Read LUN/FN, command and request data from given file instead of stan‐
534 dard input.
535 # ipmi-raw < command-file
537 Read LUN, NETFN, command and request data from file as standard input.
539
541 Upon successful execution, exit status is 0. On error, exit status is
542 1.
543 If multiple hosts are specified for communication, the exit status is 0
545 if and only if all targets successfully execute. Otherwise the exit
546 status is 1.
547
549 On older operating systems, if you input your username, password, and
550 other potentially security relevant information on the command line,
551 this information may be discovered by other users when using tools like
552 the ps(1) command or looking in the /proc file system. It is generally
553 more secure to input password information with options like the -P or
554 -K options. Configuring security relevant information in the FreeIPMI
555 configuration file would also be an appropriate way to hide this infor‐
556 mation.
557 In order to prevent brute force attacks, some BMCs will temporarily
559 "lock up" after a number of remote authentication errors. You may need
560 to wait awhile in order to this temporary "lock up" to pass before you
561 may authenticate again.
562
564 Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
565
567 Copyright © 2005-2015 FreeIPMI Core Team
568 This program is free software; you can redistribute it and/or modify it
570 under the terms of the GNU General Public License as published by the
571 Free Software Foundation; either version 3 of the License, or (at your
572 option) any later version.
573
575 freeipmi.conf(5), freeipmi(7), ipmi-config(8), ipmi-oem(8)
576 http://www.gnu.org/software/freeipmi/
578IPMI Raw version 1.6.2 2018-05-03 IPMI-RAW(8)