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, and
29 SUNBMC.
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.
63 -u USERNAME, --username=USERNAME
65 Specify the username to use when authenticating with the remote
66 host. If not specified, a null (i.e. anonymous) username is
67 assumed. The required user privilege will depend on the raw com‐
68 mands executed.
69 -p PASSWORD, --password=PASSWORD
71 Specify the password to use when authenticationg with the remote
72 host. If not specified, a null password is assumed. Maximum
73 password length is 16 for IPMI 1.5 and 20 for IPMI 2.0.
74 -P, --password-prompt
76 Prompt for password to avoid possibility of listing it in
77 process lists.
78 -k K_G, --k-g=K_G
80 Specify the K_g BMC key to use when authenticating with the
81 remote host for IPMI 2.0. If not specified, a null key is
82 assumed. To input the key in hexadecimal form, prefix the string
83 with '0x'. E.g., the key 'abc' can be entered with the either
84 the string 'abc' or the string '0x616263'
85 -K, --k-g-prompt
87 Prompt for k-g to avoid possibility of listing it in process
88 lists.
89 --session-timeout=MILLISECONDS
91 Specify the session timeout in milliseconds. Defaults to 20000
92 milliseconds (20 seconds) if not specified.
93 --retransmission-timeout=MILLISECONDS
95 Specify the packet retransmission timeout in milliseconds.
96 Defaults to 1000 milliseconds (1 second) if not specified. The
97 retransmission timeout cannot be larger than the session time‐
98 out.
99 -a AUTHENTICATION-TYPE, --authentication-type=AUTHENTICATION-TYPE
101 Specify the IPMI 1.5 authentication type to use. The currently
102 available authentication types are NONE, STRAIGHT_PASSWORD_KEY,
103 MD2, and MD5. Defaults to MD5 if not specified.
104 -I CIPHER-SUITE-ID, --cipher-suite-id=CIPHER-SUITE-ID
106 Specify the IPMI 2.0 cipher suite ID to use. The Cipher Suite ID
107 identifies a set of authentication, integrity, and confidential‐
108 ity algorithms to use for IPMI 2.0 communication. The authenti‐
109 cation algorithm identifies the algorithm to use for session
110 setup, the integrity algorithm identifies the algorithm to use
111 for session packet signatures, and the confidentiality algorithm
112 identifies the algorithm to use for payload encryption. Defaults
113 to cipher suite ID 3 if not specified. The following cipher
114 suite ids are currently supported:
115 0 - Authentication Algorithm = None; Integrity Algorithm = None;
117 Confidentiality Algorithm = None
118 1 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
120 None; Confidentiality Algorithm = None
121 2 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
123 HMAC-SHA1-96; Confidentiality Algorithm = None
124 3 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
126 HMAC-SHA1-96; Confidentiality Algorithm = AES-CBC-128
127 6 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
129 None; Confidentiality Algorithm = None
130 7 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
132 HMAC-MD5-128; Confidentiality Algorithm = None
133 8 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
135 HMAC-MD5-128; Confidentiality Algorithm = AES-CBC-128
136 11 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
138 MD5-128; Confidentiality Algorithm = None
139 12 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
141 MD5-128; Confidentiality Algorithm = AES-CBC-128
142 15 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
144 = None; Confidentiality Algorithm = None
145 16 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
147 = HMAC_SHA256_128; Confidentiality Algorithm = None
148 17 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
150 = HMAC_SHA256_128; Confidentiality Algorithm = AES-CBC-128
151 -l PRIVILEGE-LEVEL, --privilege-level=PRIVILEGE-LEVEL
153 Specify the privilege level to be used. The currently available
154 privilege levels are USER, OPERATOR, and ADMIN. Defaults to
155 ADMIN if not specified.
156 --config-file=FILE
158 Specify an alternate configuration file.
159 -W WORKAROUNDS, --workaround-flags=WORKAROUNDS
161 Specify workarounds to vendor compliance issues. Multiple work‐
162 arounds can be specified separated by commas. A special command
163 line flag of "none", will indicate no workarounds (may be useful
164 for overriding configured defaults). See WORKAROUNDS below for a
165 list of available workarounds.
166 --debug
168 Turn on debugging.
169 -?, --help
171 Output a help list and exit.
172 --usage
174 Output a usage message and exit.
175 -V, --version
177 Output the program version and exit.
178
180 The following options are specific to Ipmi-raw.
181 -f, --file=CMD-FILE
183 Specify a file to read command requests from.
184
186 The following options manipulate hostranged output. See HOSTRANGED SUP‐
187 PORT below for additional information on hostranges.
188 -B, --buffer-output
190 Buffer hostranged output. For each node, buffer standard output
191 until the node has completed its IPMI operation. When specifying
192 this option, data may appear to output slower to the user since
193 the the entire IPMI operation must complete before any data can
194 be output. See HOSTRANGED SUPPORT below for additional informa‐
195 tion.
196 -C, --consolidate-output
198 Consolidate hostranged output. The complete standard output from
199 every node specified will be consolidated so that nodes with
200 identical output are not output twice. A header will list those
201 nodes with the consolidated output. When this option is speci‐
202 fied, no output can be seen until the IPMI operations to all
203 nodes has completed. If the user breaks out of the program
204 early, all currently consolidated output will be dumped. See
205 HOSTRANGED SUPPORT below for additional information.
206 -F NUM, --fanout=NUM
208 Specify multiple host fanout. A "sliding window" (or fanout)
209 algorithm is used for parallel IPMI communication so that slower
210 nodes or timed out nodes will not impede parallel communication.
211 The maximum number of threads available at the same time is lim‐
212 ited by the fanout. The default is 64.
213 -E, --eliminate
215 Eliminate hosts determined as undetected by ipmidetect. This
216 attempts to remove the common issue of hostranged execution tim‐
217 ing out due to several nodes being removed from service in a
218 large cluster. The ipmidetectd daemon must be running on the
219 node executing the command.
220 --always-prefix
222 Always prefix output, even if only one host is specified or com‐
223 municating in-band. This option is primarily useful for script‐
224 ing purposes. Option will be ignored if specified with the -C
225 option.
226
228 Multiple hosts can be input either as an explicit comma separated lists
229 of hosts or a range of hostnames in the general form: prefix[n-m,l-
230 k,...], where n < m and l < k, etc. The later form should not be con‐
231 fused with regular expression character classes (also denoted by []).
232 For example, foo[19] does not represent foo1 or foo9, but rather repre‐
233 sents a degenerate range: foo19.
234 This range syntax is meant only as a convenience on clusters with a
236 prefixNN naming convention and specification of ranges should not be
237 considered necessary -- the list foo1,foo9 could be specified as such,
238 or by the range foo[1,9].
239 Some examples of range usage follow:
241 foo[01-05] instead of foo01,foo02,foo03,foo04,foo05
242 foo[7,9-10] instead of foo7,foo9,foo10
243 foo[0-3] instead of foo0,foo1,foo2,foo3
244 As a reminder to the reader, some shells will interpret brackets ([ and
246 ]) for pattern matching. Depending on your shell, it may be necessary
247 to enclose ranged lists within quotes.
248 When multiple hosts are specified by the user, a thread will be exe‐
250 cuted for each host in parallel up to the configured fanout (which can
251 be adjusted via the -F option). This will allow communication to large
252 numbers of nodes far more quickly than if done in serial.
253 By default, standard output from each node specified will be output
255 with the hostname prepended to each line. Although this output is read‐
256 able in many situations, it may be difficult to read in other situa‐
257 tions. For example, output from multiple nodes may be mixed together.
258 The -B and -C options can be used to change this default.
259 In-band IPMI Communication will be used when the host "localhost" is
261 specified. This allows the user to add the localhost into the hos‐
262 tranged output.
263
265 Most often, IPMI problems are due to configuration problems.
266 IPMI over LAN problems involve a misconfiguration of the remote
268 machine's BMC. Double check to make sure the following are configured
269 properly in the remote machine's BMC: IP address, MAC address, subnet
270 mask, username, user enablement, user privilege, password, LAN privi‐
271 lege, LAN enablement, and allowed authentication type(s). For IPMI 2.0
272 connections, double check to make sure the cipher suite privilege(s)
273 and K_g key are configured properly. The bmc-config(8) tool can be used
274 to check and/or change these configuration settings.
275 Inband IPMI problems are typically caused by improperly configured
277 drivers or non-standard BMCs.
278 In addition to the troubleshooting tips below, please see WORKAROUNDS
280 below to also if there are any vendor specific bugs that have been dis‐
281 covered and worked around.
282 Listed below are many of the common issues for error messages. For
284 additional support, please e-mail the <freeipmi-users@gnu.org> mailing
285 list.
286 "username invalid" - The username entered (or a NULL username if none
288 was entered) is not available on the remote machine. It may also be
289 possible the remote BMC's username configuration is incorrect.
290 "password invalid" - The password entered (or a NULL password if none
292 was entered) is not correct. It may also be possible the password for
293 the user is not correctly configured on the remote BMC.
294 "password verification timeout" - Password verification has timed out.
296 A "password invalid" error (described above) or a generic "session
297 timeout" (described below) occurred. During this point in the protocol
298 it cannot be differentiated which occurred.
299 "k_g invalid" - The K_g key entered (or a NULL K_g key if none was
301 entered) is not correct. It may also be possible the K_g key is not
302 correctly configured on the remote BMC.
303 "privilege level insufficient" - An IPMI command requires a higher user
305 privilege than the one authenticated with. Please try to authenticate
306 with a higher privilege. This may require authenticating to a different
307 user which has a higher maximum privilege.
308 "privilege level cannot be obtained for this user" - The privilege
310 level you are attempting to authenticate with is higher than the maxi‐
311 mum allowed for this user. Please try again with a lower privilege. It
312 may also be possible the maximum privilege level allowed for a user is
313 not configured properly on the remote BMC.
314 "authentication type unavailable for attempted privilege level" - The
316 authentication type you wish to authenticate with is not available for
317 this privilege level. Please try again with an alternate authentication
318 type or alternate privilege level. It may also be possible the avail‐
319 able authentication types you can authenticate with are not correctly
320 configured on the remote BMC.
321 "cipher suite id unavailable" - The cipher suite id you wish to authen‐
323 ticate with is not available on the remote BMC. Please try again with
324 an alternate cipher suite id. It may also be possible the available
325 cipher suite ids are not correctly configured on the remote BMC.
326 "ipmi 2.0 unavailable" - IPMI 2.0 was not discovered on the remote
328 machine. Please try to use IPMI 1.5 instead.
329 "connection timeout" - Initial IPMI communication failed. A number of
331 potential errors are possible, including an invalid hostname specified,
332 an IPMI IP address cannot be resolved, IPMI is not enabled on the
333 remote server, the network connection is bad, etc. Please verify con‐
334 figuration and connectivity.
335 "session timeout" - The IPMI session has timed out. Please reconnect.
337 If this error occurs often, you may wish to increase the retransmission
338 timeout. Some remote BMCs are considerably slower than others.
339 "device not found" - The specified device could not be found. Please
341 check configuration or inputs and try again.
342 "driver timeout" - Communication with the driver or device has timed
344 out. Please try again.
345 "message timeout" - Communication with the driver or device has timed
347 out. Please try again.
348 "BMC busy" - The BMC is currently busy. It may be processing informa‐
350 tion or have too many simultaneous sessions to manage. Please wait and
351 try again.
352 "could not find inband device" - An inband device could not be found.
354 Please check configuration or specify specific device or driver on the
355 command line.
356 "driver timeout" - The inband driver has timed out communicating to the
358 local BMC or service processor. The BMC or service processor may be
359 busy or (worst case) possibly non-functioning.
360
362 With so many different vendors implementing their own IPMI solutions,
363 different vendors may implement their IPMI protocols incorrectly. The
364 following describes a number of workarounds currently available to han‐
365 dle discovered compliance issues. When possible, workarounds have been
366 implemented so they will be transparent to the user. However, some will
367 require the user to specify a workaround be used via the -W option.
368 The hardware listed below may only indicate the hardware that a problem
370 was discovered on. Newer versions of hardware may fix the problems
371 indicated below. Similar machines from vendors may or may not exhibit
372 the same problems. Different vendors may license their firmware from
373 the same IPMI firmware developer, so it may be worthwhile to try work‐
374 arounds listed below even if your motherboard is not listed.
375 If you believe your hardware has an additional compliance issue that
377 needs a workaround to be implemented, please contact the FreeIPMI main‐
378 tainers on <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
379 assumeio - This workaround flag will assume inband interfaces communi‐
381 cate with system I/O rather than being memory-mapped. This will work
382 around systems that report invalid base addresses. Those hitting this
383 issue may see "device not supported" or "could not find inband device"
384 errors. Issue observed on HP ProLiant DL145 G1.
385 spinpoll - This workaround flag will inform some inband drivers (most
387 notably the KCS driver) to spin while polling rather than putting the
388 process to sleep. This may significantly improve the wall clock running
389 time of tools because an operating system scheduler's granularity may
390 be much larger than the time it takes to perform a single IPMI message
391 transaction. However, by spinning, your system may be performing less
392 useful work by not contexting out the tool for a more useful task.
393 authcap - This workaround flag will skip early checks for username
395 capabilities, authentication capabilities, and K_g support and allow
396 IPMI authentication to succeed. It works around multiple issues in
397 which the remote system does not properly report username capabilities,
398 authentication capabilities, or K_g status. Those hitting this issue
399 may see "username invalid", "authentication type unavailable for
400 attempted privilege level", or "k_g invalid" errors. Issue observed on
401 Asus P5M2/P5MT-R/RS162-E4/RX4, Intel SR1520ML/X38ML, and Sun Fire
402 2200/4150/4450 with ELOM.
403 idzero - This workaround flag will allow empty session IDs to be
405 accepted by the client. It works around IPMI sessions that report empty
406 session IDs to the client. Those hitting this issue may see "session
407 timeout" errors. Issue observed on Tyan S2882 with M3289 BMC.
408 unexpectedauth - This workaround flag will allow unexpected non-null
410 authcodes to be checked as though they were expected. It works around
411 an issue when packets contain non-null authentication data when they
412 should be null due to disabled per-message authentication. Those hit‐
413 ting this issue may see "session timeout" errors. Issue observed on
414 Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware.
415 forcepermsg - This workaround flag will force per-message authentica‐
417 tion to be used no matter what is advertised by the remote system. It
418 works around an issue when per-message authentication is advertised as
419 disabled on the remote system, but it is actually required for the pro‐
420 tocol. Those hitting this issue may see "session timeout" errors.
421 Issue observed on IBM eServer 325.
422 endianseq - This workaround flag will flip the endian of the session
424 sequence numbers to allow the session to continue properly. It works
425 around IPMI 1.5 session sequence numbers that are the wrong endian.
426 Those hitting this issue may see "session timeout" errors. Issue
427 observed on some Sun ILOM 1.0/2.0 (depends on service processor
428 endian).
429 noauthcodecheck - This workaround flag will tell FreeIPMI to not check
431 the authentication codes returned from IPMI 1.5 command responses. It
432 works around systems to return invalid authentication codes due to
433 hashing or implementation errors. Users are cautioned on the use of
434 this option, as it removes an authentication check verifying the valid‐
435 ity of a packet. However, in most organizations, this is unlikely to be
436 a security issue. Those hitting this issue may see "connection time‐
437 out", "session timeout", or "password verification timeout" errors.
438 Issue observed on Xyratex FB-H8-SRAY.
439 intel20 - This workaround flag will work around several Intel IPMI 2.0
441 authentication issues. The issues covered include padding of usernames,
442 and password truncation if the authentication algorithm is HMAC-
443 MD5-128. Those hitting this issue may see "username invalid", "password
444 invalid", or "k_g invalid" errors. Issue observed on Intel SE7520AF2
445 with Intel Server Management Module (Professional Edition).
446 supermicro20 - This workaround flag will work around several Supermicro
448 IPMI 2.0 authentication issues on motherboards w/ Peppercon IPMI
449 firmware. The issues covered include handling invalid length authenti‐
450 cation codes. Those hitting this issue may see "password invalid"
451 errors. Issue observed on Supermicro H8QME with SIMSO daughter card.
452 Confirmed fixed on newerver firmware.
453 sun20 - This workaround flag will work work around several Sun IPMI 2.0
455 authentication issues. The issues covered include invalid lengthed hash
456 keys, improperly hashed keys, and invalid cipher suite records. Those
457 hitting this issue may see "password invalid" or "bmc error" errors.
458 Issue observed on Sun Fire 4100/4200/4500 with ILOM. This workaround
459 automatically includes the "opensesspriv" workaround.
460 opensesspriv - This workaround flag will slightly alter FreeIPMI's IPMI
462 2.0 connection protocol to workaround an invalid hashing algorithm used
463 by the remote system. The privilege level sent during the Open Session
464 stage of an IPMI 2.0 connection is used for hashing keys instead of the
465 privilege level sent during the RAKP1 connection stage. Those hitting
466 this issue may see "password invalid", "k_g invalid", or "bad rmcpplus
467 status code" errors. Issue observed on Sun Fire 4100/4200/4500 with
468 ILOM, Inventec 5441/Dell Xanadu II, Supermicro X8DTH, Supermicro X8DTG,
469 Intel S5500WBV/Penguin Relion 700, Intel S2600JF/Appro 512X, and Quanta
470 QSSC-S4R//Appro GB812X-CN. This workaround is automatically triggered
471 with the "sun20" workaround.
472 integritycheckvalue - This workaround flag will work around an invalid
474 integrity check value during an IPMI 2.0 session establishment when
475 using Cipher Suite ID 0. The integrity check value should be 0 length,
476 however the remote motherboard responds with a non-empty field. Those
477 hitting this issue may see "k_g invalid" errors. Issue observed on
478 Supermicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin Relion
479 700, and Intel S2600JF/Appro 512X.
480 No IPMI 1.5 Support - Some motherboards that support IPMI 2.0 have been
482 found to not support IPMI 1.5. Those hitting this issue may see "ipmi
483 2.0 unavailable" or "connection timeout" errors. This issue can be
484 worked around by using IPMI 2.0 instead of IPMI 1.5 by specifying
485 --driver-address=LAN_2_0. Issue observed on HP Proliant DL 145.
486
488 # ipmi-raw 0 6 01
489 Execute command 0x01 with LUN 0x0 and NETFN 0x06 on the local machine.
491 # ipmi-raw -h ahost -u myusername -p mypassword 0 6 01
493 Execute command 0x01 with LUN 0x0 and NETFN 0x06 on a remote machine
495 using IPMI over LAN.
496 # ipmi-raw -h mycluster[0-127] -u myusername -p mypassword 0 6 01
498 Execute command 0x01 with LUN 0x0 and NETFN 0x06 across a cluster using
500 IPMI over LAN.
501 # ipmi-raw
503 Read LUN, NETFN, command and request data from standard input.
505 # ipmi-raw -f command-file
507 Read LUN/FN, command and request data from given file instead of stan‐
509 dard input.
510 # ipmi-raw < command-file
512 Read LUN, NETFN, command and request data from file as standard input.
514
516 Upon successful execution, exit status is 0. On error, exit status is
517 1.
518 If multiple hosts are specified for communication, the exit status is 0
520 if and only if all targets successfully execute. Otherwise the exit
521 status is 1.
522
524 On older operating systems, if you input your username, password, and
525 other potentially security relevant information on the command line,
526 this information may be discovered by other users when using tools like
527 the ps(1) command or looking in the /proc file system. It is generally
528 more secure to input password information with options like the -P or
529 -K options. Configuring security relevant information in the FreeIPMI
530 configuration file would also be an appropriate way to hide this infor‐
531 mation.
532 In order to prevent brute force attacks, some BMCs will temporarily
534 "lock up" after a number of remote authentication errors. You may need
535 to wait awhile in order to this temporary "lock up" to pass before you
536 may authenticate again.
537
539 Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
540
542 Copyright © 2005-2012 FreeIPMI Core Team
543 This program is free software; you can redistribute it and/or modify it
545 under the terms of the GNU General Public License as published by the
546 Free Software Foundation; either version 3 of the License, or (at your
547 option) any later version.
548
550 freeipmi.conf(5), freeipmi(7), bmc-config(8), ipmi-oem(8)
551 http://www.gnu.org/software/freeipmi/
553IPMI Raw version 1.2.1 2017-03-22 IPMI-RAW(8)