1BMC-DEVICE(8) System Commands BMC-DEVICE(8)
2
6 bmc-device - perform advanced BMC commands
7
9 bmc-device [OPTION...]
10
12 bmc-device supports a variety of IPMI commands to perform advanced BMC
13 functions. This tool is primarily used for development debugging, BMC
14 error recovery, retrieving detailed technical information, and other
15 advanced purposes. Most IPMI users will not need to use this tool. Some
16 of the bmc-device commands are not supported on all motherboards.
17 Listed below are general IPMI options, tool specific options, trouble
19 shooting information, workaround information, examples, and known
20 issues. For a general introduction to FreeIPMI please see freeipmi(7).
21
23 The following options are general options for configuring IPMI communi‐
24 cation and executing general tool commands.
25 -D IPMIDRIVER, --driver-type=IPMIDRIVER
27 Specify the driver type to use instead of doing an auto selec‐
28 tion. The currently available outofband drivers are LAN and
29 LAN_2_0, which perform IPMI 1.5 and IPMI 2.0 respectively. The
30 currently available inband drivers are KCS, SSIF, OPENIPMI,
31 SUNBMC, and INTELDCMI.
32 --disable-auto-probe
34 Do not probe in-band IPMI devices for default settings.
35 --driver-address=DRIVER-ADDRESS
37 Specify the in-band driver address to be used instead of the
38 probed value. DRIVER-ADDRESS should be prefixed with "0x" for a
39 hex value and '0' for an octal value.
40 --driver-device=DEVICE
42 Specify the in-band driver device path to be used instead of the
43 probed path.
44 --register-spacing=REGISTER-SPACING
46 Specify the in-band driver register spacing instead of the
47 probed value. Argument is in bytes (i.e. 32bit register spacing
48 = 4)
49 --target-channel-number=CHANNEL-NUMBER
51 Specify the in-band driver target channel number to send IPMI
52 requests to.
53 --target-slave-address=SLAVE-ADDRESS
55 Specify the in-band driver target slave number to send IPMI
56 requests to.
57 -h IPMIHOST1,IPMIHOST2,..., --hostname=IPMIHOST1[:PORT],IPMI‐
59 HOST2[:PORT],...
60 Specify the remote host(s) to communicate with. Multiple host‐
61 names may be separated by comma or may be specified in a range
62 format; see HOSTRANGED SUPPORT below. An optional port can be
63 specified with each host, which may be useful in port forwarding
64 or similar situations. If specifying an IPv6 address and port,
65 use the format [ADDRESS]:PORT.
66 -u USERNAME, --username=USERNAME
68 Specify the username to use when authenticating with the remote
69 host. If not specified, a null (i.e. anonymous) username is
70 assumed. The user must have atleast USER privileges in order for
71 this tool to operate fully.
72 -p PASSWORD, --password=PASSWORD
74 Specify the password to use when authenticationg with the remote
75 host. If not specified, a null password is assumed. Maximum
76 password length is 16 for IPMI 1.5 and 20 for IPMI 2.0.
77 -P, --password-prompt
79 Prompt for password to avoid possibility of listing it in
80 process lists.
81 -k K_G, --k-g=K_G
83 Specify the K_g BMC key to use when authenticating with the
84 remote host for IPMI 2.0. If not specified, a null key is
85 assumed. To input the key in hexadecimal form, prefix the string
86 with '0x'. E.g., the key 'abc' can be entered with the either
87 the string 'abc' or the string '0x616263'
88 -K, --k-g-prompt
90 Prompt for k-g to avoid possibility of listing it in process
91 lists.
92 --session-timeout=MILLISECONDS
94 Specify the session timeout in milliseconds. Defaults to 20000
95 milliseconds (20 seconds) if not specified.
96 --retransmission-timeout=MILLISECONDS
98 Specify the packet retransmission timeout in milliseconds.
99 Defaults to 1000 milliseconds (1 second) if not specified. The
100 retransmission timeout cannot be larger than the session time‐
101 out.
102 -a AUTHENTICATION-TYPE, --authentication-type=AUTHENTICATION-TYPE
104 Specify the IPMI 1.5 authentication type to use. The currently
105 available authentication types are NONE, STRAIGHT_PASSWORD_KEY,
106 MD2, and MD5. Defaults to MD5 if not specified.
107 -I CIPHER-SUITE-ID, --cipher-suite-id=CIPHER-SUITE-ID
109 Specify the IPMI 2.0 cipher suite ID to use. The Cipher Suite ID
110 identifies a set of authentication, integrity, and confidential‐
111 ity algorithms to use for IPMI 2.0 communication. The authenti‐
112 cation algorithm identifies the algorithm to use for session
113 setup, the integrity algorithm identifies the algorithm to use
114 for session packet signatures, and the confidentiality algorithm
115 identifies the algorithm to use for payload encryption. Defaults
116 to cipher suite ID 3 if not specified. The following cipher
117 suite ids are currently supported:
118 0 - Authentication Algorithm = None; Integrity Algorithm = None;
120 Confidentiality Algorithm = None
121 1 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
123 None; Confidentiality Algorithm = None
124 2 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
126 HMAC-SHA1-96; Confidentiality Algorithm = None
127 3 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
129 HMAC-SHA1-96; Confidentiality Algorithm = AES-CBC-128
130 6 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
132 None; Confidentiality Algorithm = None
133 7 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
135 HMAC-MD5-128; Confidentiality Algorithm = None
136 8 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
138 HMAC-MD5-128; Confidentiality Algorithm = AES-CBC-128
139 11 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
141 MD5-128; Confidentiality Algorithm = None
142 12 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
144 MD5-128; Confidentiality Algorithm = AES-CBC-128
145 15 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
147 = None; Confidentiality Algorithm = None
148 16 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
150 = HMAC_SHA256_128; Confidentiality Algorithm = None
151 17 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
153 = HMAC_SHA256_128; Confidentiality Algorithm = AES-CBC-128
154 -l PRIVILEGE-LEVEL, --privilege-level=PRIVILEGE-LEVEL
156 Specify the privilege level to be used. The currently available
157 privilege levels are USER, OPERATOR, and ADMIN. Defaults to
158 ADMIN if not specified.
159 --config-file=FILE
161 Specify an alternate configuration file.
162 -W WORKAROUNDS, --workaround-flags=WORKAROUNDS
164 Specify workarounds to vendor compliance issues. Multiple work‐
165 arounds can be specified separated by commas. A special command
166 line flag of "none", will indicate no workarounds (may be useful
167 for overriding configured defaults). See WORKAROUNDS below for a
168 list of available workarounds.
169 --debug
171 Turn on debugging.
172 -?, --help
174 Output a help list and exit.
175 --usage
177 Output a usage message and exit.
178 -V, --version
180 Output the program version and exit.
181
183 The following options are specific to bmc-device.
184 --cold-reset
186 Perform a cold reset.
187 --warm-reset
189 Perform a warm reset.
190 --get-self-test-results
192 Output BMC self test results.
193 --get-acpi-power-state
195 Get ACPI system and device power state.
196 --set-acpi-power-state
198 Set ACPI power state. Must be specified to use the
199 --set-acpi-system-power-state, and --set-acpi-device-power-state
200 options listed below.
201 --set-acpi-system-power-state=SYSTEM_POWER_STATE
203 Set ACPI system power state. Allowed values: S0_G0, S1, S2, S3,
204 S4, S5_G2, S4_S5, G3, SLEEPING, G1_SLEEPING, OVERRIDE,
205 LEGACY_ON, LEGACY_OFF, UNKNOWN. Used with the
206 --set-acpi-power-state option.
207 --set-acpi-device-power-state=DEVICE_POWER_STATE
209 Set ACPI device power state. Allowed values: D0, D1, D2, D3,
210 UNKNOWN. Used with the --set-acpi-power-state option.
211 --get-lan-statistics
213 Get IP, UDP, and RMCP statistics.
214 --clear-lan-statistics
216 Clear IP, UDP, and RMCP statistics.
217 --rearm-sensor="<record_id> [<assertion_bitmask> <deassertion_bit‐
219 mask>]"
220 Re-arm a sensor. Re-arming a sensor informs the internal device
221 to reset and re-evaluate a sensor reading and events. Most sen‐
222 sors are automatically re-armed, however a rare few do require
223 manual re-arming. This option may also be useful to reset a sen‐
224 sor reading or event that may be stuck due to an internal hard‐
225 ware or firmware error. If the assertion_bitmask and deasser‐
226 tion_bitmask are specified, only the specific events will be re-
227 armed. If not specified, all possible events will be re-armed.
228 This command requires the loading of the SDR.
229 --get-sdr-repository-time
231 Get SDR repository time.
232 --set-sdr-repository-time=TIME
234 Set SDR repository time. Input format = "MM/DD/YYYY - HH:MM:SS".
235 Note that hours are input in 24 hour form. Alternatively, the
236 local system time can be specified with "now".
237 --get-sel-time
239 Get SEL time.
240 --set-sel-time=TIME
242 Set SEL time. Input format = "MM/DD/YYYY - HH:MM:SS". Note that
243 hours are input in 24 hour form. Alternatively, the local system
244 time can be specified with "now".
245 --get-sel-time-utc-offset
247 Get SEL time UTC offset.
248 --set-sel-time-utc-offset=MINUTES
250 Set SEL time UTC offset. Input is in minutes difference from UTC
251 time, ranging from -1440 to 1440 minutes. A special case value
252 of "none" can be specified so no UTC offset is specified.
253 --platform-event="[generator_id] <event_message_format_version> <sen‐
255 sor_type> <sensor_number> <event_type> <event_direction> <event_data1>
256 <event_data2> <event_data3>"
257 Instruct the BMC to process the specified event data. Typically,
258 this data will be logged to the System Event Log (SEL), but
259 depending on implementation it may be processed by other subsys‐
260 tems such as Platform Event Filtering (PEF). The keywords asser‐
261 tion or deassertion may be used for event_direction, or the
262 numerical values may be used instead. The event_message_for‐
263 mat_version is 0x03 for IPMI 1.0 and 0x04 for IPMI 1.5. The gen‐
264 erator_id above is optional, however it is required if generat‐
265 ing the event via a system interface (i.e. inband). If generat‐
266 ing the event via a system interface, the system management
267 software generator id range is 0x41 to 6Fh.
268 --set-sensor-reading-and-event-status="<sensor_number> <sensor_reading>
270 <sensor_reading_operation> <assertion_bitmask> <assertion_bitmask_oper‐
271 ation> <deassertion_bitmask> <deassertion_bitmask_operation>
272 <event_data1> <event_data2> <event_data3> <event_data_operation>"
273 Instruct the BMC to set a sensor reading and/or event status.
274 How the various fields are written depends on a set of operation
275 instructions specified. The sensor_reading can be written or not
276 changed with the respective operation write and nochange. For
277 the assertion_bitmask and deassertion_bitmask, the 0 bits of the
278 bitmask can clear the bits of the status, the 1 bits of the bit‐
279 mask can set the bits of the status, the entire bitmask can be
280 written as the status, or the status cannot be changed
281 respecitvely with the respective operations clear0bits,
282 set1bits, write, and nochange. The event_data1 byte can be writ‐
283 ten fully, written without the event offset (bits 3:0), or not
284 be changed via the write, nooffsetwrite, or nochange operations.
285 --get-mca-auxiliary-log-status
287 Get machine check architecture (MCA) auxiliary log status infor‐
288 mation.
289 --get-ssif-interface-capabilities
291 Get SSIF interface capabilities.
292 --get-kcs-interface-capabilities
294 Get KCS interface capabilities.
295 --get-bt-interface-capabilities
297 Get BT interface capabilities.
298 --get-bmc-global-enables
300 Get BMC Global Enables.
301 --set-system-firmware-version=STRING
303 Set System Firmware Version.
304 --set-system-name=STRING
306 Set System Name.
307 --set-primary-operating-system-name=STRING
309 Set Primary Operating System Name.
310 --set-operating-system-name=STRING
312 Set Operating System Name.
313 --set-present-os-version-number=STRING
315 Set Present OS Version Number.
316 --set-bmc-url=STRING
318 Set BMC URL.
319 --set-base-os-hypervisor-url=STRING
321 Set Base OS/Hypervisor URL.
322 --read-fru=FILENAME
324 Read the contents of a FRU device ID and store it in the speci‐
325 fied file. Requires setting of a device ID via --device-id.
326 --write-fru=FILENAME
328 Write the contents of the specified file into a FRU device id.
329 Requires setting of a device ID via --device-id. If --verbose is
330 specified, progress percent will also be output.
331 --device-id=IDNUM
333 Specify a specific FRU device ID. For use with --read-fru and
334 --write-fru.
335 --verbose
337 Increase verbosity in output.
338
340 This tool requires access to the sensor data repository (SDR) cache for
341 general operation. By default, SDR data will be downloaded and cached
342 on the local machine. The following options apply to the SDR cache.
343 --flush-cache
345 Flush a cached version of the sensor data repository (SDR)
346 cache. The SDR is typically cached for faster subsequent access.
347 However, it may need to be flushed and re-generated if the SDR
348 has been updated on a system.
349 --quiet-cache
351 Do not output information about cache creation/deletion. May be
352 useful in scripting.
353 --sdr-cache-recreate
355 If the SDR cache is out of date or invalid, automatically recre‐
356 ate the sensor data repository (SDR) cache. This option may be
357 useful for scripting purposes.
358 --sdr-cache-file=FILE
360 Specify a specific sensor data repository (SDR) cache file to be
361 stored or read from. If this option is used when multiple hosts
362 are specified, the same SDR cache file will be used for all
363 hosts.
364 --sdr-cache-directory=DIRECTORY
366 Specify an alternate directory for sensor data repository (SDR)
367 caches to be stored or read from. Defaults to the home directory
368 if not specified.
369
371 By IPMI definition, all IPMI times and timestamps are stored in local‐
372 time. However, in many situations, the timestamps will not be stored in
373 localtime. Whether or not a system truly stored the timestamps in
374 localtime varies on many factors, such as the vendor, BIOS, and operat‐
375 ing system. The following options will allow the user to adjust the
376 interpretation of the stored timestamps and how they should be output.
377 --utc-to-localtime
379 Assume all times are reported in UTC time and convert the time
380 to localtime before being output.
381 --localtime-to-utc
383 Convert all localtime timestamps to UTC before being output.
384 --utc-offset=SECONDS
386 Specify a specific UTC offset in seconds to be added to time‐
387 stamps. Value can range from -86400 to 86400 seconds. Defaults
388 to 0.
389
391 The following options manipulate hostranged output. See HOSTRANGED SUP‐
392 PORT below for additional information on hostranges.
393 -B, --buffer-output
395 Buffer hostranged output. For each node, buffer standard output
396 until the node has completed its IPMI operation. When specifying
397 this option, data may appear to output slower to the user since
398 the the entire IPMI operation must complete before any data can
399 be output. See HOSTRANGED SUPPORT below for additional informa‐
400 tion.
401 -C, --consolidate-output
403 Consolidate hostranged output. The complete standard output from
404 every node specified will be consolidated so that nodes with
405 identical output are not output twice. A header will list those
406 nodes with the consolidated output. When this option is speci‐
407 fied, no output can be seen until the IPMI operations to all
408 nodes has completed. If the user breaks out of the program
409 early, all currently consolidated output will be dumped. See
410 HOSTRANGED SUPPORT below for additional information.
411 -F NUM, --fanout=NUM
413 Specify multiple host fanout. A "sliding window" (or fanout)
414 algorithm is used for parallel IPMI communication so that slower
415 nodes or timed out nodes will not impede parallel communication.
416 The maximum number of threads available at the same time is lim‐
417 ited by the fanout. The default is 64.
418 -E, --eliminate
420 Eliminate hosts determined as undetected by ipmidetect. This
421 attempts to remove the common issue of hostranged execution tim‐
422 ing out due to several nodes being removed from service in a
423 large cluster. The ipmidetectd daemon must be running on the
424 node executing the command.
425 --always-prefix
427 Always prefix output, even if only one host is specified or com‐
428 municating in-band. This option is primarily useful for script‐
429 ing purposes. Option will be ignored if specified with the -C
430 option.
431
433 Multiple hosts can be input either as an explicit comma separated lists
434 of hosts or a range of hostnames in the general form: prefix[n-m,l-
435 k,...], where n < m and l < k, etc. The later form should not be con‐
436 fused with regular expression character classes (also denoted by []).
437 For example, foo[19] does not represent foo1 or foo9, but rather repre‐
438 sents a degenerate range: foo19.
439 This range syntax is meant only as a convenience on clusters with a
441 prefixNN naming convention and specification of ranges should not be
442 considered necessary -- the list foo1,foo9 could be specified as such,
443 or by the range foo[1,9].
444 Some examples of range usage follow:
446 foo[01-05] instead of foo01,foo02,foo03,foo04,foo05
447 foo[7,9-10] instead of foo7,foo9,foo10
448 foo[0-3] instead of foo0,foo1,foo2,foo3
449 As a reminder to the reader, some shells will interpret brackets ([ and
451 ]) for pattern matching. Depending on your shell, it may be necessary
452 to enclose ranged lists within quotes.
453 When multiple hosts are specified by the user, a thread will be exe‐
455 cuted for each host in parallel up to the configured fanout (which can
456 be adjusted via the -F option). This will allow communication to large
457 numbers of nodes far more quickly than if done in serial.
458 By default, standard output from each node specified will be output
460 with the hostname prepended to each line. Although this output is read‐
461 able in many situations, it may be difficult to read in other situa‐
462 tions. For example, output from multiple nodes may be mixed together.
463 The -B and -C options can be used to change this default.
464 In-band IPMI Communication will be used when the host "localhost" is
466 specified. This allows the user to add the localhost into the hos‐
467 tranged output.
468
470 Most often, IPMI problems are due to configuration problems.
471 IPMI over LAN problems involve a misconfiguration of the remote
473 machine's BMC. Double check to make sure the following are configured
474 properly in the remote machine's BMC: IP address, MAC address, subnet
475 mask, username, user enablement, user privilege, password, LAN privi‐
476 lege, LAN enablement, and allowed authentication type(s). For IPMI 2.0
477 connections, double check to make sure the cipher suite privilege(s)
478 and K_g key are configured properly. The ipmi-config(8) tool can be
479 used to check and/or change these configuration settings.
480 Inband IPMI problems are typically caused by improperly configured
482 drivers or non-standard BMCs.
483 In addition to the troubleshooting tips below, please see WORKAROUNDS
485 below to also if there are any vendor specific bugs that have been dis‐
486 covered and worked around.
487 Listed below are many of the common issues for error messages. For
489 additional support, please e-mail the <freeipmi-users@gnu.org> mailing
490 list.
491 "username invalid" - The username entered (or a NULL username if none
493 was entered) is not available on the remote machine. It may also be
494 possible the remote BMC's username configuration is incorrect.
495 "password invalid" - The password entered (or a NULL password if none
497 was entered) is not correct. It may also be possible the password for
498 the user is not correctly configured on the remote BMC.
499 "password verification timeout" - Password verification has timed out.
501 A "password invalid" error (described above) or a generic "session
502 timeout" (described below) occurred. During this point in the protocol
503 it cannot be differentiated which occurred.
504 "k_g invalid" - The K_g key entered (or a NULL K_g key if none was
506 entered) is not correct. It may also be possible the K_g key is not
507 correctly configured on the remote BMC.
508 "privilege level insufficient" - An IPMI command requires a higher user
510 privilege than the one authenticated with. Please try to authenticate
511 with a higher privilege. This may require authenticating to a different
512 user which has a higher maximum privilege.
513 "privilege level cannot be obtained for this user" - The privilege
515 level you are attempting to authenticate with is higher than the maxi‐
516 mum allowed for this user. Please try again with a lower privilege. It
517 may also be possible the maximum privilege level allowed for a user is
518 not configured properly on the remote BMC.
519 "authentication type unavailable for attempted privilege level" - The
521 authentication type you wish to authenticate with is not available for
522 this privilege level. Please try again with an alternate authentication
523 type or alternate privilege level. It may also be possible the avail‐
524 able authentication types you can authenticate with are not correctly
525 configured on the remote BMC.
526 "cipher suite id unavailable" - The cipher suite id you wish to authen‐
528 ticate with is not available on the remote BMC. Please try again with
529 an alternate cipher suite id. It may also be possible the available
530 cipher suite ids are not correctly configured on the remote BMC.
531 "ipmi 2.0 unavailable" - IPMI 2.0 was not discovered on the remote
533 machine. Please try to use IPMI 1.5 instead.
534 "connection timeout" - Initial IPMI communication failed. A number of
536 potential errors are possible, including an invalid hostname specified,
537 an IPMI IP address cannot be resolved, IPMI is not enabled on the
538 remote server, the network connection is bad, etc. Please verify con‐
539 figuration and connectivity.
540 "session timeout" - The IPMI session has timed out. Please reconnect.
542 If this error occurs often, you may wish to increase the retransmission
543 timeout. Some remote BMCs are considerably slower than others.
544 "device not found" - The specified device could not be found. Please
546 check configuration or inputs and try again.
547 "driver timeout" - Communication with the driver or device has timed
549 out. Please try again.
550 "message timeout" - Communication with the driver or device has timed
552 out. Please try again.
553 "BMC busy" - The BMC is currently busy. It may be processing informa‐
555 tion or have too many simultaneous sessions to manage. Please wait and
556 try again.
557 "could not find inband device" - An inband device could not be found.
559 Please check configuration or specify specific device or driver on the
560 command line.
561 "driver timeout" - The inband driver has timed out communicating to the
563 local BMC or service processor. The BMC or service processor may be
564 busy or (worst case) possibly non-functioning.
565
567 With so many different vendors implementing their own IPMI solutions,
568 different vendors may implement their IPMI protocols incorrectly. The
569 following describes a number of workarounds currently available to han‐
570 dle discovered compliance issues. When possible, workarounds have been
571 implemented so they will be transparent to the user. However, some will
572 require the user to specify a workaround be used via the -W option.
573 The hardware listed below may only indicate the hardware that a problem
575 was discovered on. Newer versions of hardware may fix the problems
576 indicated below. Similar machines from vendors may or may not exhibit
577 the same problems. Different vendors may license their firmware from
578 the same IPMI firmware developer, so it may be worthwhile to try work‐
579 arounds listed below even if your motherboard is not listed.
580 If you believe your hardware has an additional compliance issue that
582 needs a workaround to be implemented, please contact the FreeIPMI main‐
583 tainers on <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
584 assumeio - This workaround flag will assume inband interfaces communi‐
586 cate with system I/O rather than being memory-mapped. This will work
587 around systems that report invalid base addresses. Those hitting this
588 issue may see "device not supported" or "could not find inband device"
589 errors. Issue observed on HP ProLiant DL145 G1.
590 spinpoll - This workaround flag will inform some inband drivers (most
592 notably the KCS driver) to spin while polling rather than putting the
593 process to sleep. This may significantly improve the wall clock running
594 time of tools because an operating system scheduler's granularity may
595 be much larger than the time it takes to perform a single IPMI message
596 transaction. However, by spinning, your system may be performing less
597 useful work by not contexting out the tool for a more useful task.
598 authcap - This workaround flag will skip early checks for username
600 capabilities, authentication capabilities, and K_g support and allow
601 IPMI authentication to succeed. It works around multiple issues in
602 which the remote system does not properly report username capabilities,
603 authentication capabilities, or K_g status. Those hitting this issue
604 may see "username invalid", "authentication type unavailable for
605 attempted privilege level", or "k_g invalid" errors. Issue observed on
606 Asus P5M2/P5MT-R/RS162-E4/RX4, Intel SR1520ML/X38ML, and Sun Fire
607 2200/4150/4450 with ELOM.
608 nochecksumcheck - This workaround flag will tell FreeIPMI to not check
610 the checksums returned from IPMI command responses. It works around
611 systems that return invalid checksums due to implementation errors, but
612 the packet is otherwise valid. Users are cautioned on the use of this
613 option, as it removes validation of packet integrity in a number of
614 circumstances. However, it is unlikely to be an issue in most situa‐
615 tions. Those hitting this issue may see "connection timeout", "session
616 timeout", or "password verification timeout" errors. On IPMI 1.5 con‐
617 nections, the "noauthcodecheck" workaround may also needed too. Issue
618 observed on Supermicro X9SCM-iiF, Supermicro X9DRi-F, and Supermicro
619 X9DRFR.
620 idzero - This workaround flag will allow empty session IDs to be
622 accepted by the client. It works around IPMI sessions that report empty
623 session IDs to the client. Those hitting this issue may see "session
624 timeout" errors. Issue observed on Tyan S2882 with M3289 BMC.
625 unexpectedauth - This workaround flag will allow unexpected non-null
627 authcodes to be checked as though they were expected. It works around
628 an issue when packets contain non-null authentication data when they
629 should be null due to disabled per-message authentication. Those hit‐
630 ting this issue may see "session timeout" errors. Issue observed on
631 Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware.
632 forcepermsg - This workaround flag will force per-message authentica‐
634 tion to be used no matter what is advertised by the remote system. It
635 works around an issue when per-message authentication is advertised as
636 disabled on the remote system, but it is actually required for the pro‐
637 tocol. Those hitting this issue may see "session timeout" errors.
638 Issue observed on IBM eServer 325.
639 endianseq - This workaround flag will flip the endian of the session
641 sequence numbers to allow the session to continue properly. It works
642 around IPMI 1.5 session sequence numbers that are the wrong endian.
643 Those hitting this issue may see "session timeout" errors. Issue
644 observed on some Sun ILOM 1.0/2.0 (depends on service processor
645 endian).
646 noauthcodecheck - This workaround flag will tell FreeIPMI to not check
648 the authentication codes returned from IPMI 1.5 command responses. It
649 works around systems that return invalid authentication codes due to
650 hashing or implementation errors. Users are cautioned on the use of
651 this option, as it removes an authentication check verifying the valid‐
652 ity of a packet. However, in most organizations, this is unlikely to be
653 a security issue. Those hitting this issue may see "connection time‐
654 out", "session timeout", or "password verification timeout" errors.
655 Issue observed on Xyratex FB-H8-SRAY, Intel Windmill, Quanta Winter‐
656 fell, and Wiwynn Windmill.
657 intel20 - This workaround flag will work around several Intel IPMI 2.0
659 authentication issues. The issues covered include padding of usernames,
660 and password truncation if the authentication algorithm is HMAC-
661 MD5-128. Those hitting this issue may see "username invalid", "password
662 invalid", or "k_g invalid" errors. Issue observed on Intel SE7520AF2
663 with Intel Server Management Module (Professional Edition).
664 supermicro20 - This workaround flag will work around several Supermicro
666 IPMI 2.0 authentication issues on motherboards w/ Peppercon IPMI
667 firmware. The issues covered include handling invalid length authenti‐
668 cation codes. Those hitting this issue may see "password invalid"
669 errors. Issue observed on Supermicro H8QME with SIMSO daughter card.
670 Confirmed fixed on newerver firmware.
671 sun20 - This workaround flag will work work around several Sun IPMI 2.0
673 authentication issues. The issues covered include invalid lengthed hash
674 keys, improperly hashed keys, and invalid cipher suite records. Those
675 hitting this issue may see "password invalid" or "bmc error" errors.
676 Issue observed on Sun Fire 4100/4200/4500 with ILOM. This workaround
677 automatically includes the "opensesspriv" workaround.
678 opensesspriv - This workaround flag will slightly alter FreeIPMI's IPMI
680 2.0 connection protocol to workaround an invalid hashing algorithm used
681 by the remote system. The privilege level sent during the Open Session
682 stage of an IPMI 2.0 connection is used for hashing keys instead of the
683 privilege level sent during the RAKP1 connection stage. Those hitting
684 this issue may see "password invalid", "k_g invalid", or "bad rmcpplus
685 status code" errors. Issue observed on Sun Fire 4100/4200/4500 with
686 ILOM, Inventec 5441/Dell Xanadu II, Supermicro X8DTH, Supermicro X8DTG,
687 Intel S5500WBV/Penguin Relion 700, Intel S2600JF/Appro 512X, Quanta
688 QSSC-S4R/Appro GB812X-CN, and Dell C5220. This workaround is automati‐
689 cally triggered with the "sun20" workaround.
690 integritycheckvalue - This workaround flag will work around an invalid
692 integrity check value during an IPMI 2.0 session establishment when
693 using Cipher Suite ID 0. The integrity check value should be 0 length,
694 however the remote motherboard responds with a non-empty field. Those
695 hitting this issue may see "k_g invalid" errors. Issue observed on
696 Supermicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin Relion
697 700, and Intel S2600JF/Appro 512X.
698 assumemaxsdrrecordcount - This workaround will inform SDR reading to
700 stop reading after a known maximum number of SDR records have been
701 read. This will work around systems that have mis-implemented SDR read‐
702 ing functions. Those hitting this issue may see "SDR record count
703 invalid" errors. Issue observed on unspecified Inspur motherboard.
704 No IPMI 1.5 Support - Some motherboards that support IPMI 2.0 have been
706 found to not support IPMI 1.5. Those hitting this issue may see "ipmi
707 2.0 unavailable" or "connection timeout" errors. This issue can be
708 worked around by using IPMI 2.0 instead of IPMI 1.5 by specifying
709 --driver-type=LAN_2_0. Issue observed on HP Proliant DL 145.
710
712 # bmc-device --cold-reset
713 Perform a cold reset.
715 # bmc-device -h ahost -u myusername -p mypassword --cold-reset
717 Perform a cold reset of a remote machine using IPMI over LAN.
719 # bmc-device -h mycluster[0-127] -u myusername -p mypassword --cold-
721 reset
722 Perform a cold reset across a cluster using IPMI over LAN.
724
726 Upon successful execution, exit status is 0. On error, exit status is
727 1.
728 If multiple hosts are specified for communication, the exit status is 0
730 if and only if all targets successfully execute. Otherwise the exit
731 status is 1.
732
734 On older operating systems, if you input your username, password, and
735 other potentially security relevant information on the command line,
736 this information may be discovered by other users when using tools like
737 the ps(1) command or looking in the /proc file system. It is generally
738 more secure to input password information with options like the -P or
739 -K options. Configuring security relevant information in the FreeIPMI
740 configuration file would also be an appropriate way to hide this infor‐
741 mation.
742 In order to prevent brute force attacks, some BMCs will temporarily
744 "lock up" after a number of remote authentication errors. You may need
745 to wait awhile in order to this temporary "lock up" to pass before you
746 may authenticate again.
747
749 Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
750
752 Copyright © 2008-2015 FreeIPMI Core Team.
753 This program is free software; you can redistribute it and/or modify it
755 under the terms of the GNU General Public License as published by the
756 Free Software Foundation; either version 3 of the License, or (at your
757 option) any later version.
758
760 freeipmi.conf(5), freeipmi(7)
761 http://www.gnu.org/software/freeipmi/
763bmc-device 1.6.4 2019-08-21 BMC-DEVICE(8)