1ipmipower(8) System Commands ipmipower(8)
2
6 ipmipower - IPMI power control utility
7
9 ipmipower [OPTION...]
10
12 ipmipower allows users to remotely power on, off, cycle, hard reset,
13 get a power status query, perform a pulse diagnostic interrupt, or ini‐
14 tiate a soft-shutdown of the OS via ACPI through the IPMI over LAN pro‐
15 tocol.
16 When a power command (--on, --off, --cycle, --reset, --stat, --pulse,
18 or --soft) is specified on the command line, ipmipower will attempt to
19 run the power command on all hostnames listed on the command line then
20 exit.
21 If no power commands are specified on the command line, ipmipower will
23 run in interactive mode. Interactive mode gives the user a command line
24 interface to enter various commands. Details of the interactive command
25 line interface can be found below under INTERACTIVE COMMANDS.
26 Listed below are general IPMI options, tool specific options, trouble
28 shooting information, workaround information, examples, and known
29 issues. For a general introduction to FreeIPMI please see freeipmi(7).
30
32 The following options are general options for configuring IPMI communi‐
33 cation and executing general tool commands.
34 -D IPMIDRIVER, --driver-type=IPMIDRIVER
36 Specify the driver type to use instead of doing an auto selec‐
37 tion. The currently available outofband drivers are LAN and
38 LAN_2_0, which perform IPMI 1.5 and IPMI 2.0 respectively.
39 -h IPMIHOST1,IPMIHOST2,..., --hostname=IPMIHOST1[:PORT],IPMI‐
41 HOST2[:PORT],...
42 Specify the remote host(s) to communicate with. Multiple host‐
43 names may be separated by comma or may be specified in a range
44 format; see HOSTRANGED SUPPORT below. An optional port can be
45 specified with each host, which may be useful in port forwarding
46 or similar situations.
47 -u USERNAME, --username=USERNAME
49 Specify the username to use when authenticating with the remote
50 host. If not specified, a null (i.e. anonymous) username is
51 assumed. The user must have atleast OPERATOR privileges to run
52 the --on, --off, --reset, --cycle, --pulse, or --soft power con‐
53 trol commands. The user must have atleast USER privileges to
54 determine the power status of the machine through --stat.
55 -p PASSWORD, --password=PASSWORD
57 Specify the password to use when authenticationg with the remote
58 host. If not specified, a null password is assumed. Maximum
59 password length is 16 for IPMI 1.5 and 20 for IPMI 2.0.
60 -P, --password-prompt
62 Prompt for password to avoid possibility of listing it in
63 process lists.
64 -k K_G, --k-g=K_G
66 Specify the K_g BMC key to use when authenticating with the
67 remote host for IPMI 2.0. If not specified, a null key is
68 assumed. To input the key in hexadecimal form, prefix the string
69 with '0x'. E.g., the key 'abc' can be entered with the either
70 the string 'abc' or the string '0x616263'
71 -K, --k-g-prompt
73 Prompt for k-g to avoid possibility of listing it in process
74 lists.
75 --session-timeout=MILLISECONDS
77 Specify the session timeout in milliseconds. Defaults to 20000
78 milliseconds (20 seconds) if not specified.
79 --retransmission-timeout=MILLISECONDS
81 Specify the packet retransmission timeout in milliseconds.
82 Defaults to 400 milliseconds (0.4 seconds) if not specified.
83 -a AUTHENTICATION-TYPE, --authentication-type=AUTHENTICATION-TYPE
85 Specify the IPMI 1.5 authentication type to use. The currently
86 available authentication types are NONE, STRAIGHT_PASSWORD_KEY,
87 MD2, and MD5. Defaults to MD5 if not specified.
88 -I CIPHER-SUITE-ID, --cipher-suite-id=CIPHER-SUITE-ID
90 Specify the IPMI 2.0 cipher suite ID to use. The Cipher Suite ID
91 identifies a set of authentication, integrity, and confidential‐
92 ity algorithms to use for IPMI 2.0 communication. The authenti‐
93 cation algorithm identifies the algorithm to use for session
94 setup, the integrity algorithm identifies the algorithm to use
95 for session packet signatures, and the confidentiality algorithm
96 identifies the algorithm to use for payload encryption. Defaults
97 to cipher suite ID 3 if not specified. The following cipher
98 suite ids are currently supported:
99 0 - Authentication Algorithm = None; Integrity Algorithm = None;
101 Confidentiality Algorithm = None
102 1 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
104 None; Confidentiality Algorithm = None
105 2 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
107 HMAC-SHA1-96; Confidentiality Algorithm = None
108 3 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
110 HMAC-SHA1-96; Confidentiality Algorithm = AES-CBC-128
111 6 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
113 None; Confidentiality Algorithm = None
114 7 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
116 HMAC-MD5-128; Confidentiality Algorithm = None
117 8 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
119 HMAC-MD5-128; Confidentiality Algorithm = AES-CBC-128
120 11 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
122 MD5-128; Confidentiality Algorithm = None
123 12 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
125 MD5-128; Confidentiality Algorithm = AES-CBC-128
126 15 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
128 = None; Confidentiality Algorithm = None
129 16 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
131 = HMAC_SHA256_128; Confidentiality Algorithm = None
132 17 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
134 = HMAC_SHA256_128; Confidentiality Algorithm = AES-CBC-128
135 -l PRIVILEGE-LEVEL, --privilege-level=PRIVILEGE-LEVEL
137 Specify the privilege level to be used. The currently available
138 privilege levels are USER, OPERATOR, and ADMIN. Defaults to
139 OPERATOR if not specified.
140 --config-file=FILE
142 Specify an alternate configuration file.
143 -W WORKAROUNDS, --workaround-flags=WORKAROUNDS
145 Specify workarounds to vendor compliance issues. Multiple work‐
146 arounds can be specified separated by commas. A special command
147 line flag of "none", will indicate no workarounds (may be useful
148 for overriding configured defaults). See WORKAROUNDS below for a
149 list of available workarounds.
150 --debug
152 Turn on debugging.
153 -?, --help
155 Output a help list and exit.
156 --usage
158 Output a usage message and exit.
159 -V, --version
161 Output the program version and exit.
162
164 The following options are specific to ipmipower.
165 -n, --on
167 Power on the target hosts.
168 -f, --off
170 Power off the target hosts.
171 -c, --cycle
173 Power cycle the target hosts.
174 -r, --reset
176 Reset the target hosts.
177 -s, --stat
179 Get power status of the target hosts.
180 --pulse
182 Send power diagnostic interrupt to target hosts.
183 --soft Initiate a soft-shutdown of the OS via ACPI.
185 --on-if-off
187 The IPMI specification does not require the power cycle or hard
188 reset commands to turn on a machine that is currently powered
189 off. This option will force ipmipower to issue a power on com‐
190 mand instead of a power cycle or hard reset command if the
191 remote machine's power is currently off.
192 --wait-until-on
194 The IPMI specification allows power on commands to return prior
195 to the power on actually taking place. This option will force
196 ipmipower to regularly query the remote BMC and return only
197 after the machine has powered on.
198 --wait-until-off
200 The IPMI specification allows power off commands to return prior
201 the power off actually taking place. This option will force
202 ipmipower to regularly query the remote BMC and return only
203 after the machine has powered off.
204 --oem-power-type=OEM-POWER-TYPE
206 This option informs ipmipower to initiate power control opera‐
207 tions via an IPMI OEM specific power control extension. The cur‐
208 rently available POWERTYPEs are NONE and C410X. Please see OEM
209 POWER EXTENSIONS below for additional information.
210
212 The following options are used to change the networking behavior of
213 ipmipower.
214 --retransmission-wait-timeout=MILLISECONDS
216 Specify the retransmission wait timeout length in milliseconds.
217 The retransmission wait timeout is similar to the retransmission
218 timeout above, but is used specifically for power completion
219 verification with the --wait-until-on and --wait-until-off
220 options. Defaults to 500 milliseconds (0.5 seconds).
221 --retransmission-backoff-count=COUNT
223 Specify the retransmission backoff count for retransmissions.
224 After ever COUNT retransmissions, the retransmission timeout
225 length will be increased by another factor. Defaults to 8.
226 --ping-interval=MILLISECONDS
228 Specify the ping interval length in milliseconds. When running
229 in interactive mode, RMCP (Remote Management Control Protocol)
230 discovery messages will be sent to all configured remote hosts
231 every MILLISECONDS to confirm their support of IPMI. Power com‐
232 mands cannot be sent to a host until it is discovered (or re-
233 discovered if previously lost). Defaults to 5000 milliseconds (5
234 seconds). Ping discovery messages can be disabled by setting
235 this valu to 0. RMCP ping discovery messages are automatically
236 disabled in non-interactive mode.
237 --ping-timeout=MILLISECONDS
239 Specify the ping timeout length in milliseconds. When running in
240 interactive mode, RMCP (Remote Management Control Protocol) mes‐
241 sages discovery will be sent to all configured remote hosts to
242 confirm their support of IPMI. A remote host is considered
243 undiscovered if the host does not respond in MILLISECONDS time.
244 Defaults to 30000 milliseconds (30 seconds). The ping timeout
245 cannot be larger than the ping interval.
246 --ping-packet-count=COUNT
248 Specify the ping packet count size. Defaults to 10. See the
249 --ping-percent-fR option below for more information on this
250 option.
251 --ping-percent=PERCENT
253 Specify the ping percent value. Defaults to 50. Since IPMI is
254 based on UDP, it is difficult for ipmipower to distinguish
255 between a missing machine and a bad (or heavily loaded) network
256 connection in interactive mode. when running in interactive
257 mode. For example, suppose a link consistently drops 80% of the
258 packets to a particular machine. The power control operation may
259 have difficulty completing, although a recent pong response from
260 RMCP makes ipmipower believe the machine is up and functioning
261 properly. The ping packet acount and percent options are used
262 to alleviate this problem. Ipmipower will monitor RMCP ping
263 packets in packet count chunks. If ipmipower does not receive a
264 response to greater than ping percent of those packets,
265 ipmipower will assume the link to this node is bad and will not
266 send power control operations to that node until the connection
267 is determined to be reliable. This heuristic can be disabled by
268 setting either the ping packet count or ping percent to 0. This
269 feature is not used if ping interval is set to 0.
270 --ping-consec-count=COUNT
272 Specify the ping consecutive count. This is another heuristic
273 used to determine if a node should be considered discovered,
274 undiscovered, or with a bad connection. If a valid RMCP pong
275 response was received for the last COUNT ping packets, a node
276 will be considered discovered, regardless of other heuristics
277 listed above. Defaults to 5. This heuristic can be disabled by
278 setting this value to 0. This feature is not used if other ping
279 features described above are disabled.
280
282 The following options manipulate hostranged output. See HOSTRANGED SUP‐
283 PORT below for additional information on hostranges.
284 -B, --buffer-output
286 Buffer hostranged output. For each node, buffer standard output
287 until the node has completed its IPMI operation. When specifying
288 this option, data may appear to output slower to the user since
289 the the entire IPMI operation must complete before any data can
290 be output. See HOSTRANGED SUPPORT below for additional informa‐
291 tion.
292 -C, --consolidate-output
294 Consolidate hostranged output. The complete standard output from
295 every node specified will be consolidated so that nodes with
296 identical output are not output twice. A header will list those
297 nodes with the consolidated output. When this option is speci‐
298 fied, no output can be seen until the IPMI operations to all
299 nodes has completed. If the user breaks out of the program
300 early, all currently consolidated output will be dumped. See
301 HOSTRANGED SUPPORT below for additional information.
302 -F NUM, --fanout=NUM
304 Specify multiple host fanout. Indicates the maximum number of
305 power control operations that can be executed in parallel.
306 -E, --eliminate
308 Eliminate hosts determined as undetected by ipmidetect. This
309 attempts to remove the common issue of hostranged execution tim‐
310 ing out due to several nodes being removed from service in a
311 large cluster. The ipmidetectd daemon must be running on the
312 node executing the command.
313 --always-prefix
315 Always prefix output, even if only one host is specified or com‐
316 municating in-band. This option is primarily useful for script‐
317 ing purposes. Option will be ignored if specified with the -C
318 option.
319
321 ipmipower provides the following interactive commands at the ipmipower>
322 prompt. Before any power commands (on, off, cycle, reset, stat, pulse,
323 or soft) can be used, hostnames must be configured into ipmipower,
324 either through the command prompt or the hostname command below. The
325 parameters and options to the commands below mirror their appropriate
326 command line options.
327 hostname [IPMIHOST(s)]
329 Specify a new set of hosts. No input to unconfigure all hosts.
330 username [USERNAME]
332 Specify a new username. No input for null username.
333 password [PASSWORD]
335 Specify a new password. No input for null password.
336 k_g [K_G]
338 Specify a new K_g BMC Key. No input for null key. Prefix with
339 '0x' to enter a key in hexadecimal
340 ipmi-version IPMIVERSION
342 Specify the ipmi version to use.
343 session-timeout MILLISECONDS
345 Specify a new session timeout length.
346 retransmission-timeout MILLISECONDS
348 Specify a new retransmiision timeout length.
349 authentication-type AUTHENTICATION-TYPE
351 Specify the authentication type to use.
352 cipher-suite-id CIPHER-SUITE-ID
354 Specify the cipher suite id to use.
355 privilege-level PRIVILEGE-LEVEL
357 Specify the privilege level to use.
358 workaround-flags WORKAROUNDS
360 Specify workaround flags.
361 debug [on|off]
363 Toggle debug output.
364 on [IPMIHOST(s)]
366 Turn on all configured hosts or specified hosts.
367 off [IPMIHOST(s)]
369 Turn off all configured hosts or specified hosts.
370 cycle [IPMIHOST(s)]
372 Power cycle all configured hosts or specified hosts.
373 reset [IPMIHOST(s)]
375 Reset all configured hosts or specified hosts.
376 stat [IPMIHOST(s)]
378 Query power status for all configured hosts or specified hosts.
379 pulse [IPMIHOST(s)]
381 Pulse diagnostic interrupt all configured hosts or specified
382 hosts.
383 soft [IPMIHOST(s)]
385 Initiate a soft-shutdown for all configured hosts or specified
386 hosts.
387 identify-on [IPMIHOST(s)]
389 Turn on physical system identification.
390 identify-off [IPMIHOST(s)]
392 Turn off physical system identification.
393 identify-status [IPMIHOST(s)]
395 Query physical system identification status.
396 on-if-off [on|off]
398 Toggle on-if-off functionality.
399 wait-until-on [on|off]
401 Toggle wait-until-on functionality.
402 wait-until-off [on|off]
404 Toggle wait-until-off functionality.
405 retransmission-wait-timeout MILLISECONDS
407 Specify a new retransmission wait timeout length.
408 retransmission-backoff-count COUNT
410 Specify a new retransmission backoff count.
411 ping-interval MILLISECONDS
413 Specify a new ping interval length.
414 ping-timeout MILLISECONDS
416 Specify a new ping timeout length.
417 ping-packet-count COUNT
419 Specify a new ping packet count.
420 ping-percent PERCENT
422 Specify a new ping percent.
423 ping-consec-count COUNT
425 Specify a new ping consec count.
426 buffer-output [on|off]
428 Toggle buffer-output functionality.
429 consolidate-output [on|off]
431 Toggle consolidate-output functionality.
432 fanout COUNT
434 Specify a fanout.
435 always-prefix [on|off]
437 Toggle always-prefix functionality.
438 help Output help menu.
440 version
442 Output version.
443 config Output the current configuration.
445 quit Quit program. ipmipower.
447
449 Some motherboards include IPMI OEM extensions for alternate power con‐
450 trol mechanisms. For example, these power control mechanisms may allow
451 you to power control a sub-device within the system rather than the
452 entire system itself.
453 By specifying an OEM power type via --oem-power-type on the command
455 line or freeipmi.conf(5), you can instruct ipmipower to execute alter‐
456 nate power control implementations over the standard ones. Depending on
457 the OEM extension, some power control commands may no longer be avail‐
458 able. For example, an OEM extension may allow on but not cycle. Spe‐
459 cific ipmipower options may not longer function either.
460 Some OEM extensions may require additional arguments for their power
462 control action, such as a sub-device identifier. Additional arguments
463 can be provided by appending a plus sign ('+') and the extra informa‐
464 tion to the end of the hostname. This can be done on the command line
465 or in interactive mode. For example, the hostname mynode+18 would indi‐
466 cate the power control operation should be sent to the host mynode, and
467 18 is the identifier of a possible sub-device to be power controlled.
468 The --consolidate-output option is commonly disabled when using an OEM
469 power control that requires extra arguments.
470 Because OEM power control may involve subtypes, it is possible a user
472 may wish to power control multiple sub-devices on the same host. For
473 example, you might specify the hosts mynode+1,mynode+2, indicating to
474 power control subdevice 1 and 2 on mynode. Because many BMCs cannot
475 handle multiple IPMI sessions, power control operations to the same
476 host will be serialized internally by ipmipower.
477 The following are the current OEM power types available, along with
479 information on the systems they work with and the power control opera‐
480 tions available.
481 C410X This OEM power type supports the power control of PCIe slots on
483 Dell Poweredge C410x systems. It supports on, off, and stat. The
484 PCIe slot number ranges from 1-16 and must always be specified
485 when attempting to power control with this extension. For exam‐
486 ple, the hostname mynode+2 would inform ipmipower to operate on
487 slot number 2 on mynode. The C410x appears to have difficulty
488 handling new slot power control requests until prior ones have
489 completed. Users may wish to strongly consider using the
490 --wait-until-on and --wait-until-off options if multiple slots
491 will be power controlled in short succession.
492 NONE This informs ipmipower that no OEM power type extension is to be
494 used and standard IPMI power control is used. This is the
495 default.
496
498 Multiple hosts can be input either as an explicit comma separated lists
499 of hosts or a range of hostnames in the general form: prefix[n-m,l-
500 k,...], where n < m and l < k, etc. The later form should not be con‐
501 fused with regular expression character classes (also denoted by []).
502 For example, foo[19] does not represent foo1 or foo9, but rather repre‐
503 sents a degenerate range: foo19.
504 This range syntax is meant only as a convenience on clusters with a
506 prefixNN naming convention and specification of ranges should not be
507 considered necessary -- the list foo1,foo9 could be specified as such,
508 or by the range foo[1,9].
509 Some examples of range usage follow:
511 foo[01-05] instead of foo01,foo02,foo03,foo04,foo05
512 foo[7,9-10] instead of foo7,foo9,foo10
513 foo[0-3] instead of foo0,foo1,foo2,foo3
514 As a reminder to the reader, some shells will interpret brackets ([ and
516 ]) for pattern matching. Depending on your shell, it may be necessary
517 to enclose ranged lists within quotes.
518 When multiple hosts are specified by the user, a socket will be created
520 for each host and polled on, effectively allowing communication to all
521 hosts in parallel. This will allow communication to large numbers of
522 nodes far more quickly than if done in serial. The -F option can con‐
523 figure the number of nodes that can be communicated with in parallel at
524 the same time.
525 By default, standard output from each node specified will be output
527 with the hostname prepended to each line. Although this output is read‐
528 able in many situations, it may be difficult to read in other situa‐
529 tions. For example, output from multiple nodes may be mixed together.
530 The -B and -C options can be used to change this default.
531
533 Determine the power status of foo[0-2] with null username and password
534 ipmipower -h foo[0-2] --stat
535 Determine the power status of foo[0-2] with non-null username and pass‐
537 word
538 ipmipower -h foo[0-2] -u foo -p bar --stat
539 Hard reset nodes foo[0-2] with non-null username and password
541 ipmipower -h foo[0-2] -u foo -p bar --reset
542
544 Most often, IPMI problems are due to configuration problems.
545 IPMI over LAN problems involve a misconfiguration of the remote
547 machine's BMC. Double check to make sure the following are configured
548 properly in the remote machine's BMC: IP address, MAC address, subnet
549 mask, username, user enablement, user privilege, password, LAN privi‐
550 lege, LAN enablement, and allowed authentication type(s). For IPMI 2.0
551 connections, double check to make sure the cipher suite privilege(s)
552 and K_g key are configured properly. The ipmi-config(8) tool can be
553 used to check and/or change these configuration settings.
554 In addition to the troubleshooting tips below, please see WORKAROUNDS
556 below to also if there are any vendor specific bugs that have been dis‐
557 covered and worked around.
558 Listed below are many of the common issues for error messages. For
560 additional support, please e-mail the <freeipmi-users@gnu.org> mailing
561 list.
562 "username invalid" - The username entered (or a NULL username if none
564 was entered) is not available on the remote machine. It may also be
565 possible the remote BMC's username configuration is incorrect.
566 "password invalid" - The password entered (or a NULL password if none
568 was entered) is not correct. It may also be possible the password for
569 the user is not correctly configured on the remote BMC.
570 "password verification timeout" - Password verification has timed out.
572 A "password invalid" error (described above) or a generic "session
573 timeout" (described below) occurred. During this point in the protocol
574 it cannot be differentiated which occurred.
575 "k_g invalid" - The K_g key entered (or a NULL K_g key if none was
577 entered) is not correct. It may also be possible the K_g key is not
578 correctly configured on the remote BMC.
579 "privilege level insufficient" - An IPMI command requires a higher user
581 privilege than the one authenticated with. Please try to authenticate
582 with a higher privilege. This may require authenticating to a different
583 user which has a higher maximum privilege.
584 "privilege level cannot be obtained for this user" - The privilege
586 level you are attempting to authenticate with is higher than the maxi‐
587 mum allowed for this user. Please try again with a lower privilege. It
588 may also be possible the maximum privilege level allowed for a user is
589 not configured properly on the remote BMC.
590 "authentication type unavailable for attempted privilege level" - The
592 authentication type you wish to authenticate with is not available for
593 this privilege level. Please try again with an alternate authentication
594 type or alternate privilege level. It may also be possible the avail‐
595 able authentication types you can authenticate with are not correctly
596 configured on the remote BMC.
597 "cipher suite id unavailable" - The cipher suite id you wish to authen‐
599 ticate with is not available on the remote BMC. Please try again with
600 an alternate cipher suite id. It may also be possible the available
601 cipher suite ids are not correctly configured on the remote BMC.
602 "ipmi 2.0 unavailable" - IPMI 2.0 was not discovered on the remote
604 machine. Please try to use IPMI 1.5 instead.
605 "connection timeout" - Initial IPMI communication failed. A number of
607 potential errors are possible, including an invalid hostname specified,
608 an IPMI IP address cannot be resolved, IPMI is not enabled on the
609 remote server, the network connection is bad, etc. Please verify con‐
610 figuration and connectivity.
611 "session timeout" - The IPMI session has timed out. Please reconnect.
613 If this error occurs often, you may wish to increase the retransmission
614 timeout. Some remote BMCs are considerably slower than others.
615 "internal IPMI error" - An IPMI error has occurred that FreeIPMI does
617 not know how to handle. Please e-mail <freeipmi-users@gnu.org> to
618 report the issue.
619
621 When powering on a powered off machine, the client must have a means by
622 which to resolve the MAC address of the remote machine's ethernet card.
623 While most modern IPMI solutions support the ability to ARP and resolve
624 addresses when the machine is powered off, some older machines do not.
625 This is typically solved in one of two ways:
626 1) Enable gratuitous ARPs on the remote machine. The remote machine
628 will send out a gratuitous ARP, which advertises the ethernet IP and
629 MAC address so that other machines on the network this information
630 their local ARP cache. For large clusters, this method is not recom‐
631 mended since gratuitous ARPs can flood the network with unnecessary
632 traffic.
633 2) Permanently store the remote machine's MAC address in the local ARP
635 cache. This is the more common approach on large clusters.
636 Other methods are listed in the IPMI specification.
638
640 With so many different vendors implementing their own IPMI solutions,
641 different vendors may implement their IPMI protocols incorrectly. The
642 following describes a number of workarounds currently available to han‐
643 dle discovered compliance issues. When possible, workarounds have been
644 implemented so they will be transparent to the user. However, some will
645 require the user to specify a workaround be used via the -W option.
646 The hardware listed below may only indicate the hardware that a problem
648 was discovered on. Newer versions of hardware may fix the problems
649 indicated below. Similar machines from vendors may or may not exhibit
650 the same problems. Different vendors may license their firmware from
651 the same IPMI firmware developer, so it may be worthwhile to try work‐
652 arounds listed below even if your motherboard is not listed.
653 If you believe your hardware has an additional compliance issue that
655 needs a workaround to be implemented, please contact the FreeIPMI main‐
656 tainers on <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
657 authcap - This workaround flag will skip early checks for username
659 capabilities, authentication capabilities, and K_g support and allow
660 IPMI authentication to succeed. It works around multiple issues in
661 which the remote system does not properly report username capabilities,
662 authentication capabilities, or K_g status. Those hitting this issue
663 may see "username invalid", "authentication type unavailable for
664 attempted privilege level", or "k_g invalid" errors. Issue observed on
665 Asus P5M2/P5MT-R/RS162-E4/RX4, Intel SR1520ML/X38ML, and Sun Fire
666 2200/4150/4450 with ELOM.
667 nochecksumcheck - This workaround flag will tell FreeIPMI to not check
669 the checksums returned from IPMI command responses. It works around
670 systems that return invalid checksums due to implementation errors, but
671 the packet is otherwise valid. Users are cautioned on the use of this
672 option, as it removes validation of packet integrity in a number of
673 circumstances. However, it is unlikely to be an issue in most situa‐
674 tions. Those hitting this issue may see "connection timeout", "session
675 timeout", or "password verification timeout" errors. On IPMI 1.5 con‐
676 nections, the "noauthcodecheck" workaround may also needed too. Issue
677 observed on Supermicro X9SCM-iiF, Supermicro X9DRi-F, and Supermicro
678 X9DRFR.
679 idzero - This workaround flag will allow empty session IDs to be
681 accepted by the client. It works around IPMI sessions that report empty
682 session IDs to the client. Those hitting this issue may see "session
683 timeout" errors. Issue observed on Tyan S2882 with M3289 BMC.
684 unexpectedauth - This workaround flag will allow unexpected non-null
686 authcodes to be checked as though they were expected. It works around
687 an issue when packets contain non-null authentication data when they
688 should be null due to disabled per-message authentication. Those hit‐
689 ting this issue may see "session timeout" errors. Issue observed on
690 Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware.
691 forcepermsg - This workaround flag will force per-message authentica‐
693 tion to be used no matter what is advertised by the remote system. It
694 works around an issue when per-message authentication is advertised as
695 disabled on the remote system, but it is actually required for the pro‐
696 tocol. Those hitting this issue may see "session timeout" errors.
697 Issue observed on IBM eServer 325.
698 endianseq - This workaround flag will flip the endian of the session
700 sequence numbers to allow the session to continue properly. It works
701 around IPMI 1.5 session sequence numbers that are the wrong endian.
702 Those hitting this issue may see "session timeout" errors. Issue
703 observed on some Sun ILOM 1.0/2.0 (depends on service processor
704 endian).
705 noauthcodecheck - This workaround flag will tell FreeIPMI to not check
707 the authentication codes returned from IPMI 1.5 command responses. It
708 works around systems that return invalid authentication codes due to
709 hashing or implementation errors. Users are cautioned on the use of
710 this option, as it removes an authentication check verifying the valid‐
711 ity of a packet. However, in most organizations, this is unlikely to be
712 a security issue. Those hitting this issue may see "connection time‐
713 out", "session timeout", or "password verification timeout" errors.
714 Issue observed on Xyratex FB-H8-SRAY, Intel Windmill, Quanta Winter‐
715 fell, and Wiwynn Windmill.
716 intel20 - This workaround flag will work around several Intel IPMI 2.0
718 authentication issues. The issues covered include padding of usernames,
719 and password truncation if the authentication algorithm is HMAC-
720 MD5-128. Those hitting this issue may see "username invalid", "password
721 invalid", or "k_g invalid" errors. Issue observed on Intel SE7520AF2
722 with Intel Server Management Module (Professional Edition).
723 supermicro20 - This workaround flag will work around several Supermicro
725 IPMI 2.0 authentication issues on motherboards w/ Peppercon IPMI
726 firmware. The issues covered include handling invalid length authenti‐
727 cation codes. Those hitting this issue may see "password invalid"
728 errors. Issue observed on Supermicro H8QME with SIMSO daughter card.
729 Confirmed fixed on newerver firmware.
730 sun20 - This workaround flag will work work around several Sun IPMI 2.0
732 authentication issues. The issues covered include invalid lengthed hash
733 keys, improperly hashed keys, and invalid cipher suite records. Those
734 hitting this issue may see "password invalid" or "bmc error" errors.
735 Issue observed on Sun Fire 4100/4200/4500 with ILOM. This workaround
736 automatically includes the "opensesspriv" workaround.
737 opensesspriv - This workaround flag will slightly alter FreeIPMI's IPMI
739 2.0 connection protocol to workaround an invalid hashing algorithm used
740 by the remote system. The privilege level sent during the Open Session
741 stage of an IPMI 2.0 connection is used for hashing keys instead of the
742 privilege level sent during the RAKP1 connection stage. Those hitting
743 this issue may see "password invalid", "k_g invalid", or "bad rmcpplus
744 status code" errors. Issue observed on Sun Fire 4100/4200/4500 with
745 ILOM, Inventec 5441/Dell Xanadu II, Supermicro X8DTH, Supermicro X8DTG,
746 Intel S5500WBV/Penguin Relion 700, Intel S2600JF/Appro 512X, and Quanta
747 QSSC-S4R/Appro GB812X-CN. This workaround is automatically triggered
748 with the "sun20" workaround.
749 integritycheckvalue - This workaround flag will work around an invalid
751 integrity check value during an IPMI 2.0 session establishment when
752 using Cipher Suite ID 0. The integrity check value should be 0 length,
753 however the remote motherboard responds with a non-empty field. Those
754 hitting this issue may see "k_g invalid" errors. Issue observed on
755 Supermicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin Relion
756 700, and Intel S2600JF/Appro 512X.
757 ipmiping - This workaround option will inform ipmipower to use IPMI
759 based ping packets instead of RMCP ping packets. Some motherboards have
760 been observed to not implement RMCP ping/pong support despite being
761 required by the IPMI specification. Issue observed on Intel Windmill,
762 Quanta Winterfell, and Wiwynn Windmill.
763 No IPMI 1.5 Support - Some motherboards that support IPMI 2.0 have been
765 found to not support IPMI 1.5. Those hitting this issue may see "ipmi
766 2.0 unavailable" or "connection timeout" errors. This issue can be
767 worked around by using IPMI 2.0 instead of IPMI 1.5 by specifying
768 --driver-type=LAN_2_0. Issue observed on HP Proliant DL 145.
769
771 Upon successful execution, exit status is 0. On error, exit status is
772 1.
773 If multiple hosts are specified for communication, the exit status is 0
775 if and only if all targets successfully execute. Otherwise the exit
776 status is 1.
777 When operating in interactive mode, the exit value will be based on the
779 last power operation executed.
780
782 On older operating systems, if you input your username, password, and
783 other potentially security relevant information on the command line,
784 this information may be discovered by other users when using tools like
785 the ps(1) command or looking in the /proc file system. It is generally
786 more secure to input password information with options like the -P or
787 -K options. Configuring security relevant information in the FreeIPMI
788 configuration file would also be an appropriate way to hide this infor‐
789 mation.
790 In order to prevent brute force attacks, some BMCs will temporarily
792 "lock up" after a number of remote authentication errors. You may need
793 to wait awhile in order to this temporary "lock up" to pass before you
794 may authenticate again.
795 IPMI specifications do not require BMCs to perform a power control
797 operation before returning a completion code to the caller. Therefore,
798 it is possible for ipmipower to return power status queries opposite of
799 what you are expecting. For example, if a "power off" operation is
800 performed, a BMC may return a successful completion code to ipmipower
801 before the "power off" operation is actually performed. Subsequent
802 power status queries may return "on" for several seconds, until the BMC
803 actually performs the "power off" operation.
804
806 Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
807
809 Copyright (C) 2007-2015 Lawrence Livermore National Security, LLC.
810 Copyright (C) 2003-2007 The Regents of the University of California.
811 This program is free software; you can redistribute it and/or modify it
813 under the terms of the GNU General Public License as published by the
814 Free Software Foundation; either version 3 of the License, or (at your
815 option) any later version.
816
818 freeipmi.conf(5), freeipmi(7), ipmi-config(8), ipmi-oem(8)
819 http://www.gnu.org/software/freeipmi/
821ipmipower 1.5.7 2018-04-11 ipmipower(8)