1IPMI-OEM(8) System Commands IPMI-OEM(8)
2
6 ipmi-oem - IPMI OEM utility
7
9 ipmi-oem [OPTION...] <OEMID> <OEMCOMMAND> [OEMOPTION...]
10
12 Ipmi-oem is used to execute OEM specific IPMI commands. It is intended
13 to provide a better user interface for OEM specific IPMI commands
14 rather than using ipmi-raw(8). Please see SUPPORTED OEM IDS and COM‐
15 MANDS below for a list of supported OEM specific IPMI commands. A list
16 of supported OEM specific commands may also be generated using the
17 --list option. There are no guarantees that the below OEM commands
18 will work on any particular motherboard. OEM extensions may or may not
19 exist on particular hardware revisions and/or firmware revisions of
20 motherboards. The extensions may or may not function for other lines of
21 motherboards from the same manufacturer.
22 Listed below are general IPMI options, tool specific options, trouble
24 shooting information, workaround information, examples, and known
25 issues. For a general introduction to FreeIPMI please see freeipmi(7).
26
28 The following options are general options for configuring IPMI communi‐
29 cation and executing general tool commands.
30 -D IPMIDRIVER, --driver-type=IPMIDRIVER
32 Specify the driver type to use instead of doing an auto selec‐
33 tion. The currently available outofband drivers are LAN and
34 LAN_2_0, which perform IPMI 1.5 and IPMI 2.0 respectively. The
35 currently available inband drivers are KCS, SSIF, OPENIPMI,
36 SUNBMC, and INTELDCMI.
37 --disable-auto-probe
39 Do not probe in-band IPMI devices for default settings.
40 --driver-address=DRIVER-ADDRESS
42 Specify the in-band driver address to be used instead of the
43 probed value. DRIVER-ADDRESS should be prefixed with "0x" for a
44 hex value and '0' for an octal value.
45 --driver-device=DEVICE
47 Specify the in-band driver device path to be used instead of the
48 probed path.
49 --register-spacing=REGISTER-SPACING
51 Specify the in-band driver register spacing instead of the
52 probed value. Argument is in bytes (i.e. 32bit register spacing
53 = 4)
54 --target-channel-number=CHANNEL-NUMBER
56 Specify the in-band driver target channel number to send IPMI
57 requests to.
58 --target-slave-address=SLAVE-ADDRESS
60 Specify the in-band driver target slave number to send IPMI
61 requests to.
62 -h IPMIHOST1,IPMIHOST2,..., --hostname=IPMIHOST1[:PORT],IPMI‐
64 HOST2[:PORT],...
65 Specify the remote host(s) to communicate with. Multiple host‐
66 names may be separated by comma or may be specified in a range
67 format; see HOSTRANGED SUPPORT below. An optional port can be
68 specified with each host, which may be useful in port forwarding
69 or similar situations.
70 -u USERNAME, --username=USERNAME
72 Specify the username to use when authenticating with the remote
73 host. If not specified, a null (i.e. anonymous) username is
74 assumed. The required user privilege will depend on the oem com‐
75 mands executed.
76 -p PASSWORD, --password=PASSWORD
78 Specify the password to use when authenticationg with the remote
79 host. If not specified, a null password is assumed. Maximum
80 password length is 16 for IPMI 1.5 and 20 for IPMI 2.0.
81 -P, --password-prompt
83 Prompt for password to avoid possibility of listing it in
84 process lists.
85 -k K_G, --k-g=K_G
87 Specify the K_g BMC key to use when authenticating with the
88 remote host for IPMI 2.0. If not specified, a null key is
89 assumed. To input the key in hexadecimal form, prefix the string
90 with '0x'. E.g., the key 'abc' can be entered with the either
91 the string 'abc' or the string '0x616263'
92 -K, --k-g-prompt
94 Prompt for k-g to avoid possibility of listing it in process
95 lists.
96 --session-timeout=MILLISECONDS
98 Specify the session timeout in milliseconds. Defaults to 20000
99 milliseconds (20 seconds) if not specified.
100 --retransmission-timeout=MILLISECONDS
102 Specify the packet retransmission timeout in milliseconds.
103 Defaults to 1000 milliseconds (1 second) if not specified. The
104 retransmission timeout cannot be larger than the session time‐
105 out.
106 -a AUTHENTICATION-TYPE, --authentication-type=AUTHENTICATION-TYPE
108 Specify the IPMI 1.5 authentication type to use. The currently
109 available authentication types are NONE, STRAIGHT_PASSWORD_KEY,
110 MD2, and MD5. Defaults to MD5 if not specified.
111 -I CIPHER-SUITE-ID, --cipher-suite-id=CIPHER-SUITE-ID
113 Specify the IPMI 2.0 cipher suite ID to use. The Cipher Suite ID
114 identifies a set of authentication, integrity, and confidential‐
115 ity algorithms to use for IPMI 2.0 communication. The authenti‐
116 cation algorithm identifies the algorithm to use for session
117 setup, the integrity algorithm identifies the algorithm to use
118 for session packet signatures, and the confidentiality algorithm
119 identifies the algorithm to use for payload encryption. Defaults
120 to cipher suite ID 3 if not specified. The following cipher
121 suite ids are currently supported:
122 0 - Authentication Algorithm = None; Integrity Algorithm = None;
124 Confidentiality Algorithm = None
125 1 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
127 None; Confidentiality Algorithm = None
128 2 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
130 HMAC-SHA1-96; Confidentiality Algorithm = None
131 3 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
133 HMAC-SHA1-96; Confidentiality Algorithm = AES-CBC-128
134 6 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
136 None; Confidentiality Algorithm = None
137 7 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
139 HMAC-MD5-128; Confidentiality Algorithm = None
140 8 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
142 HMAC-MD5-128; Confidentiality Algorithm = AES-CBC-128
143 11 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
145 MD5-128; Confidentiality Algorithm = None
146 12 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
148 MD5-128; Confidentiality Algorithm = AES-CBC-128
149 15 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
151 = None; Confidentiality Algorithm = None
152 16 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
154 = HMAC_SHA256_128; Confidentiality Algorithm = None
155 17 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
157 = HMAC_SHA256_128; Confidentiality Algorithm = AES-CBC-128
158 -l PRIVILEGE-LEVEL, --privilege-level=PRIVILEGE-LEVEL
160 Specify the privilege level to be used. The currently available
161 privilege levels are USER, OPERATOR, and ADMIN. Defaults to
162 ADMIN if not specified.
163 --config-file=FILE
165 Specify an alternate configuration file.
166 -W WORKAROUNDS, --workaround-flags=WORKAROUNDS
168 Specify workarounds to vendor compliance issues. Multiple work‐
169 arounds can be specified separated by commas. A special command
170 line flag of "none", will indicate no workarounds (may be useful
171 for overriding configured defaults). See WORKAROUNDS below for a
172 list of available workarounds.
173 --debug
175 Turn on debugging.
176 -?, --help
178 Output a help list and exit.
179 --usage
181 Output a usage message and exit.
182 -V, --version
184 Output the program version and exit.
185
187 This tool requires access to the sensor data repository (SDR) cache for
188 general operation. By default, SDR data will be downloaded and cached
189 on the local machine. The following options apply to the SDR cache.
190 -f, --flush-cache
192 Flush a cached version of the sensor data repository (SDR)
193 cache. The SDR is typically cached for faster subsequent access.
194 However, it may need to be flushed and re-generated if the SDR
195 has been updated on a system.
196 -Q, --quiet-cache
198 Do not output information about cache creation/deletion. May be
199 useful in scripting.
200 --sdr-cache-recreate
202 If the SDR cache is out of date or invalid, automatically recre‐
203 ate the sensor data repository (SDR) cache. This option may be
204 useful for scripting purposes.
205 --sdr-cache-file=FILE
207 Specify a specific sensor data repository (SDR) cache file to be
208 stored or read from. If this option is used when multiple hosts
209 are specified, the same SDR cache file will be used for all
210 hosts.
211 --sdr-cache-directory=DIRECTORY
213 Specify an alternate directory for sensor data repository (SDR)
214 caches to be stored or read from. Defaults to the home directory
215 if not specified.
216
218 By IPMI definition, all IPMI times and timestamps are stored in local‐
219 time. However, in many situations, the timestamps will not be stored in
220 localtime. Whether or not a system truly stored the timestamps in
221 localtime varies on many factors, such as the vendor, BIOS, and operat‐
222 ing system. The following options will allow the user to adjust the
223 interpretation of the stored timestamps and how they should be output.
224 --utc-to-localtime
226 Assume all times are reported in UTC time and convert the time
227 to localtime before being output.
228 --localtime-to-utc
230 Convert all localtime timestamps to UTC before being output.
231 --utc-offset=SECONDS
233 Specify a specific UTC offset in seconds to be added to time‐
234 stamps. Value can range from -86400 to 86400 seconds. Defaults
235 to 0.
236
238 The following options manipulate hostranged output. See HOSTRANGED SUP‐
239 PORT below for additional information on hostranges.
240 -B, --buffer-output
242 Buffer hostranged output. For each node, buffer standard output
243 until the node has completed its IPMI operation. When specifying
244 this option, data may appear to output slower to the user since
245 the the entire IPMI operation must complete before any data can
246 be output. See HOSTRANGED SUPPORT below for additional informa‐
247 tion.
248 -C, --consolidate-output
250 Consolidate hostranged output. The complete standard output from
251 every node specified will be consolidated so that nodes with
252 identical output are not output twice. A header will list those
253 nodes with the consolidated output. When this option is speci‐
254 fied, no output can be seen until the IPMI operations to all
255 nodes has completed. If the user breaks out of the program
256 early, all currently consolidated output will be dumped. See
257 HOSTRANGED SUPPORT below for additional information.
258 -F NUM, --fanout=NUM
260 Specify multiple host fanout. A "sliding window" (or fanout)
261 algorithm is used for parallel IPMI communication so that slower
262 nodes or timed out nodes will not impede parallel communication.
263 The maximum number of threads available at the same time is lim‐
264 ited by the fanout. The default is 64.
265 -E, --eliminate
267 Eliminate hosts determined as undetected by ipmidetect. This
268 attempts to remove the common issue of hostranged execution tim‐
269 ing out due to several nodes being removed from service in a
270 large cluster. The ipmidetectd daemon must be running on the
271 node executing the command.
272 --always-prefix
274 Always prefix output, even if only one host is specified or com‐
275 municating in-band. This option is primarily useful for script‐
276 ing purposes. Option will be ignored if specified with the -C
277 option.
278
280 The following options are specific to Ipmi-oem.
281 -L, --list
283 List supported OEM IDs and Commands.
284 -v, --verbose
286 Output verbose information. Additional output will depend on
287 specific OEM ID and OEM COMMANDS specified.
288
290 The currently supported OEM IDs and COMMANDs are listed below. The spe‐
291 cial OEM ID of list may be passed into the list all supported OEM IDs
292 and Commands. The special OEM command list may be passed to any OEM ID
293 to list commands supported by that OEM ID.
294 Dell
296 get-system-info KEY
298 This OEM command can retrieve the motherboard system
299 information. Valid keys are guid, asset-tag, ser‐
300 vice-tag, chassis-service-tag, chassis-related-ser‐
301 vice-tag, board-revision, platform-model-name,
302 blade-slot-info, system-revision, idrac-info,
303 idrac-ipv4-url, idrac-gui-webserver-control, cmc-info,
304 cmc-ipv4-url, cmc-ipv6-info, cmc-ipv6-url, mac-addresses.
305 Command confirmed to work on Dell Poweredge 2900, 2950,
306 R610, R710, R720, M600, M610, M610X, M910, and R905. How‐
307 ever, individual system information options may not be
308 readable or available on every system.
309 get-nic-selection
311 This OEM command will determine the current NIC selection
312 for IPMI as dedicated, shared, shared w/ failover to
313 NIC2, or shared w/ failover to all. Dedicated indicates
314 IPMI is only available on an expansion card, shared indi‐
315 cates IPMI is available on NIC1, shared w/ failover to
316 NIC2 indicates IPMI is available on NIC1 w/ failover to
317 NIC2 on NIC1's failure, and shared w/ failover to all
318 indicates IPMI is available on NIC1 w/ failover to all
319 other NICs in the event of NIC failure. Command confirmed
320 to work on Dell Poweredge 2900, 2950, R610, R710, and
321 R905.
322 set-nic-section dedi‐
324 cated|shared|shared_failover_nic2|shared_failover_all
325 This OEM command will set the current NIC selection to
326 dedicated, shared, shared_failover_nic2, or
327 shared_failover_all. (See get-nic-selection above for
328 description on inputs.) On older Poweredge systems,
329 shared_failover_nic2 may have been documented as just
330 failover. Command confirmed to work on Dell Poweredge
331 2900, 2950, R610, R710, and R905.
332 get-nic-selection-failover
334 This OEM command will determine the current NIC selection
335 for IPMI and the failover NIC. Command confirmed to work
336 on Dell Poweredge R720 (Dell 12G Poweredge systems).
337 set-nic-section-failover dedicated|lom1|lom2|lom3|lom4
339 none|lom1|lom2|lom3|lom4|all
340 This OEM command will set the current NIC selection for
341 IPMI and the failover NIC. The first option sets the IPMI
342 NIC and the second option the failover NIC. Command con‐
343 firmed to work on Dell Poweredge R720 (Dell 12G Poweredge
344 systems).
345 get-active-lom-status [v1|v2]
347 This OEM command will get the current NIC being used for
348 out of band management and possibly additional informa‐
349 tion. Users may specify if version 1 or version 2 of this
350 extension should be executed. If no version is specified,
351 version 1 is exectued. Version 1 of this command con‐
352 firmed to work on Dell Poweredge R610 and R710 (Dell 11G
353 Poweredge systems). Version 2 of this command confirmed
354 to work on Dell Poweredge R720 (Dell 12G Poweredge sys‐
355 tems).
356 get-ssh-config
358 This OEM command will get the current SSH configuration
359 on the IPMI card. Command confirmed to work on Dell Pow‐
360 eredge R610 and R710 (Dell 11G Poweredge systems).
361 set-ssh-config KEY=VALUE ...
363 This OEM command will set the current SSH configuration
364 on the IPMI card. The possible keys and values are
365 ssh=enable|disable, idletimeout=seconds, and portnum‐
366 ber=num. Multiple key=value pairs may be specified. If no
367 key=value pairs are specified, available pairs are out‐
368 put. Some fields may be read-only on specific Poweredge
369 systems. Command confirmed to work on Dell Poweredge R610
370 and R710 (Dell 11G Poweredge systems).
371 get-telnet-config
373 This OEM command will get the current telnet configura‐
374 tion on the IPMI card. Command confirmed to work on Dell
375 Poweredge R610 and R710 (Dell 11G Poweredge systems).
376 set-telnet-config KEY=VALUE ...
378 This OEM command will set the current Telnet configura‐
379 tion on the IPMI card. The possible keys and values are
380 telnet=enable|disable, sessiontimeout=seconds, portnum‐
381 ber=num, and 7fls=enable|disable. Multiple key=value
382 pairs may be specified. If no key=value pairs are speci‐
383 fied, available pairs are output. Some fields may be
384 read-only on specific Poweredge systems. Command con‐
385 firmed to work on Dell Poweredge R610 and R710 (Dell 11G
386 Poweredge systems).
387 get-web-server-config
389 This OEM command will get the current web server configu‐
390 ration on the IPMI card. Command confirmed to work on
391 Dell Poweredge R610 and R710 (Dell 11G Poweredge sys‐
392 tems).
393 set-web-server-config KEY=VALUE ...
395 This OEM command will set the current Web Server configu‐
396 ration on the IPMI card. The possible keys and values are
397 webserver=enable|disable, sessiontimeout=seconds, http‐
398 portnumber=num, and httpsportnumber=num. Multiple
399 key=value pairs may be specified. If no key=value pairs
400 are specified, available pairs are output. Some fields
401 may be read-only on specific Poweredge systems. Command
402 confirmed to work on Dell Poweredge R610 and R710 (Dell
403 11G Poweredge systems).
404 get-active-directory-config
406 This OEM command will get the current active directory
407 configuration on the IPMI card. Command confirmed to work
408 on Dell Poweredge R610 and R710 (Dell 11G Poweredge sys‐
409 tems).
410 set-active-directory-config
412 This OEM command will set the current Web Server configu‐
413 ration on the IPMI card. The possible keys and values are
414 activedirectory=enable|disable, timeout=seconds,
415 type=extended|standard, sso=enable|disable, and certifi‐
416 catevalidation=enable|disable. If no key=value pairs are
417 specified, available pairs are output. Some fields may be
418 read-only on specific Poweredge systems. Command con‐
419 firmed to work on Dell Poweredge R610 and R710 (Dell 11G
420 Poweredge systems).
421 reset-to-defaults
423 This OEM command will reset the BMC configuration back to
424 default values. The command will spin until the reset is
425 confirmed to be complete. Command confirmed to work on
426 Dell Poweredge R610 and R710 (Dell 11G Poweredge sys‐
427 tems).
428 get-power-consumption-data
430 This OEM command can retrieve power consumption data.
431 Command confirmed to work on Dell Poweredge R610, R710,
432 R905, M610, M610x, and M910.
433 reset-power-consumption-data cumulative|peak
435 This OEM command can reset the cumulative or peak power
436 consumption data (viewed via get-power-consumption-data).
437 Command confirmed to work on Dell Poweredge R610, R710,
438 R905, M610, M610x, and M910.
439 power-supply-info
441 This OEM command can read and output power supply ratings
442 and other information. This OEM command requires access
443 to the SDR. Command confirmed to work on Dell Poweredge
444 R610, R710, and M610.
445 get-instantaneous-power-consumption-data power_supply_instance
447 This OEM command can read instantaneous power consumption
448 data. If a power supply instance number is specified,
449 only data for that instance will be gathered. Otherwise,
450 collective power consumption will be gathered. Command
451 confirmed to work on Dell Poweredge R610, R710, M610,
452 M610x, and M910.
453 get-power-head-room
455 This OEM command can read power head room. Command con‐
456 firmed to work on Dell Poweredge R610 and R710 (Dell 11G
457 Poweredge systems).
458 get-power-consumption-statistics average|max|min
460 This OEM command can read average, max, or min power con‐
461 sumption history. Command confirmed to work on Dell Pow‐
462 eredge R610, R710, M610, M610x, and M910.
463 get-power-capacity
465 This OEM command can read the current power capacity.
466 Command confirmed to work on Dell Poweredge R610, R710,
467 M610, M610x, and M910.
468 set-power-capacity power-capacity
470 This OEM command can write the current power capacity
471 (specified in Watts). Command confirmed to work on Dell
472 Poweredge R610 and R710 (Dell 11G Poweredge systems).
473 get-power-capacity-status
475 This OEM command can determine if the current power
476 capacity is enabled or disabled. Command confirmed to
477 work on Dell Poweredge R610, R710, M610, M610x, and M910.
478 set-power-capacity-status enable|disable
480 This OEM command can configure the current power capacity
481 to be enabled or disabled. Command confirmed to work on
482 Dell Poweredge R610 and R710 (Dell 11G Poweredge sys‐
483 tems).
484 get-chassis-identify-status
486 This OEM command will retrieve the current chassis iden‐
487 tify (i.e. LED) status. Command confirmed to work on Dell
488 Poweredge 2900, 2950, R610, R710, R905, M600, M610,
489 M610x, and M910.
490 power-monitoring-over-interval interval system‐
492 power|cpu1|cpu2|cpu3|cpu4|memory1|memory2|memory3|mem‐
493 ory4|drives|fans|pciecards|gpucables
494 This OEM command will retrieve power consumption informa‐
495 tion from a specified subsystem for a specified interval
496 time. If the interval is between 30 and 900s, the aver‐
497 age, minimum, and maximum power value can also be
498 retrieved. If the interval is between 5 and 30 seconds,
499 only the average power consumption can be returned. See
500 power-monitoring-interval-range below to determine legal
501 intervals for each subsystem. Command confirmed to work
502 on Dell Poweredge R720 (Dell 12G Poweredge systems).
503 power-monitoring-interval-range system‐
505 power|cpu1|cpu2|cpu3|cpu4|memory1|memory2|memory3|mem‐
506 ory4|drives|fans|pciecards|gpucables
507 This OEM command will retrieve the monitoring intervals
508 for a specified subsystem. Command confirmed to work on
509 Dell Poweredge R720 (Dell 12G Poweredge systems).
510 get-last-post-code
512 This OEM command will retrieve the last POST code and
513 error string for it. Command confirmed to work on Dell
514 Poweredge R720.
515 slot-power-toggle slot-number
517 This OEM command will perform a power toggle on a PCIe
518 slot. The PCIe slot number can range from 1 to 16. Com‐
519 mand confirmed to work on Dell Poweredge C410x.
520 slot-power-control platform-model on|off|status slot-number
522 This OEM command will perform a power control action on a
523 PCIe slot. This OEM extension is tied very closely to a
524 platform, so a supported platform must be specified. The
525 currently supported platform-model options are C410x. The
526 on action powers on a slot, off powers off a slot, and
527 status returns if the current power is on or off. If the
528 current power status is on, an on action does nothing.
529 Similarly, if the current power status is off, an off
530 action does nothing. The on, off, and status slot power
531 actions are not native and are emulated through a combi‐
532 nation of a power toggle (using slot-power-toggle above)
533 and the reading of PCIe slot watt sensors. The PCIe slot
534 number can range from 1 to 16. Command confirmed to work
535 on Dell Poweredge C410x.
536 get-port-map
538 This OEM command will retrieve the current iPASS mapping
539 to PCIe controllers/slots. Command confirmed to work on
540 Dell Poweredge C410x.
541 set-port-map jumper|bmc ipass-mapping 1:2|1:4|1:8
543 This OEM command will set an iPass mapping to PCIe con‐
544 trollers/slots. jumper or bmc must be specified to indi‐
545 cate if iPass mappings will be controlled via jumpers on
546 the system or via a BMC/IPMI. In order for reconfigura‐
547 tion to be done via ipmi-oem, the user must select bmc.
548 The ipass-mapping determines which iPass ports will be
549 mapped. 1:2, 1:4, and 1:8 determine the mapping that
550 should be set. See details below for specific platforms.
551 Command confirmed to work on Dell Poweredge C410x. For
552 the Dell Poweredge C410x, the ipass-mapping ranges from 1
553 to 4. 1 refers to iPass 1 and 5, 2 to 2 and 6, 3 to 3 and
554 7, and 4 to 4 and 8. For the platform C410x, PCIe slots
555 1, 2, 3, 4, 13, 14, 15, and 16 are attached to iPass 1,
556 2, 3, and 4. PCIe slots 5, 6, 7, 8, 9, 10, 11, and 12 are
557 attached to iPass 5, 6, 7, and 8. For example, if 1:2 is
558 set on mapping-number 1, PCIe slots 1 and 15 will be
559 assigned to iPass 1 and slots 2 and 16 will be assigned
560 to iPass 5. if 1:4 is chosen, PCIe slots 1, 2, 15, and 16
561 will be assigned to iPass 1 and iPass 5 will not be used.
562 Fujitsu
564 get-power-on-source
566 This OEM command will return the reason for the most
567 recent Power On. Command confirmed to work on Fujitsu
568 RX100 S5. .TP .B get-power-off-source This OEM command
569 will return the reason for the most recent Power Off.
570 Command confirmed to work on Fujitsu RX100 S5.
571 command will return the connection and/or status of remote stor‐
573 age.
574 connection_number currently supports a range of 0-1. Command
575 confirmed to work on Fujitsu RX100 S5. .TP .B get-system-status
576 This OEM command will return the current system status. Command
577 confirmed to work on Fujitsu RX100 S5. .TP .B get-eeprom-ver‐
578 sion-info eeprom_number This OEM command will return the current
579 version info for various hardware elements, including firmware,
580 SDR, and boot revision. eeprom_number currently supports a range
581 of 0-1. Command confirmed to work on Fujitsu RX100 S5.
582 get-identify-led
584 This OEM command will get the current identify LED status. Com‐
585 mand confirmed to work on Fujitsu RX100 S5.
586 set-identify-led on|off
588 This OEM command will set the current identify LED status. Com‐
589 mand confirmed to work on Fujitsu RX100 S5.
590 get-error-led
592 This OEM command will get the current error LED status. Command
593 confirmed to work on Fujitsu RX100 S5.
594 get-sel-entry-long-text sel_record_id
596 This OEM command will retrieve the Fujitsu specific string
597 interpretation of a SEL record. This command may be useful for
598 interpreting Fujitsu OEM hex codes found in the SEL. A specific
599 SEL record ID must be specified. Please see ipmi-sel(8), for
600 retrieving SEL records. Command confirmed to work on Fujitsu
601 RX100 S5.
602 GIGABYTE
604 This OEM command will determine the current NIC mode as dedi‐
606 cated,
607 shared, or failover. Dedicated indicates IPMI is only available
608 on the dedicated management port. Shared indicates IPMI is also
609 available on one of the primary ethernet ports. Failover indi‐
610 cates IPMI is dedicated but can failover to another if the pri‐
611 mary port fails. Command confirmed to work on GIGABYTE
612 MD90-FS0-ZB.
613 set-nic-mode dedicated|shared|failover
615 This OEM command will set the current NIC mode to dedicated,
616 shared, or failover. (See get-nic-mode above for description on
617 dedicated vs. shared vs failover modes.) Command confirmed to
618 work on GIGABYTE MD90-FS0-ZB.
619 IBM
621 get-led
623 This OEM command will get the current LED status. This
624 OEM command requires access to the SDR. Command confirmed
625 to work on IBM x3755.
626 Intel
628 get-smtp-config [channel-number]
630 This OEM command will get the current SMTP configuration
631 on the IPMI card. By default, configuration for every LAN
632 channel will be output. If a channel-number is speci‐
633 fied, only that specific channel number's configuration
634 will be output. Command confirmed to work on Intel
635 S5500WB (Penguin Computing Relion 700) and Intel S2600JF
636 (Appro 512X).
637 set-smtp-config [channel-number] KEY=VALUE...
639 This OEM command will set the current SMTP configuration
640 on the IPMI card. By default, configuration will be done
641 for all LAN channels. If a channel-number is specified,
642 only that specific channel number's configuration will be
643 configured. The possible keys and values are
644 smtp=enable|disable, smtpserveraddress=ipaddress, smt‐
645 pusername=string, userpassword=string, emailad‐
646 dress=string, subject=string, messagecontent=string,
647 senderemailaddress=string, and smtphostname=string. Mul‐
648 tiple key=value pairs may be specified. If no key=value
649 pairs are specified, available pairs are output. Command
650 confirmed to work on Intel S5500WB (Penguin Computing
651 Relion 700) and Intel S2600JF (Appro 512X).
652 get-power-restore-delay
654 This OEM command will retrieve the power on delay. The
655 power on delay is a delay that occurs whenever the BMC
656 turns on the system according to the Power Restore Policy
657 setting. It does not take effect otherwise (i.e. power
658 button or Chassis Control). Command confirmed to work on
659 Intel S2600JF (Appro 512X).
660 set-power-restore-delay seconds
662 This OEM command will set the power on delay. (See
663 get-power-restore-delay above for description on power
664 restore delay). Command confirmed to work on Intel
665 S2600JF (Appro 512X).
666 get-bmc-services
668 This OEM command will get the current status of BMC ser‐
669 vices such as ssh, http, rmcp, and kvm. Command confirmed
670 to work on Intel S2600WT2.
671 set-bmc-services enable|disable ssh|http|rmcp|kvm
673 This OEM command will enable or disable BMC services
674 besides IPMI. Note that http refers to both http and
675 https. Command confirmed to work on Intel S2600WT2.
676 restore-configuration
678 This OEM command will restore BMC configuration values
679 back to default values. The command will spin until the
680 restore is confirmed to be complete. Command configured
681 to work on Intel S5500WB (Penguin Computing Relion 700)
682 and Intel S2600JF (Appro 512X). After running this com‐
683 mand, the BMC must be reset to return it to functioning
684 status. This may be accomplished by executing a cold-
685 reset with .B bmc-device(8).
686 IntelNM (Intel Node Manager)
688 The following OEM commands operate on Intel chipsets with Node Manager
690 support. They all require access to the SDR. They may work on multiple
691 vendors motherboards.
692 get-node-manager-statistics mode=globalpower|globaltemp|glob‐
694 althrottling|globalvolumetricairflow|globaltempairflow|glob‐
695 alchassispower|policypower|policytrigger|policythrottling|hos‐
696 tunhandledrequests|hostresponsetime|cputhrottling|memorythrot‐
697 tling|hostcommfailure [domainid=platform|cpu|memory|highpowerio]
698 [policyid=num]
699 This OEM command will output Intel Node Manager statis‐
700 tics. A mode indicating statistics to output must be
701 specified. The user may optionally specify a domainid or
702 policyid, although certain mode options may require it.
703 domainid defaults to platform. Command confirmed to work
704 on Intel S5500WB (Penguin Computing Relion 700), Inventec
705 5441/5442 (Dell Xanadu II/III), Quanta S99Q (Dell
706 FS12-TY), Quanta QSSC-S4R (Appro GB812X-CN), Supermicro
707 X9DRi-F, Intel S2600JF (Appro 512X).
708 reset-node-manager-statistics [mode=global|policy|hostunhandle‐
710 drequests|hostresponsetime|cputhrottling|memorythrottling|host‐
711 commfailure]
712 [domainid=platform|cpu|memory|highpowerio] [policyid=num]
713 This OEM command will reset Intel Node Manager statis‐
714 tics. The mode will indicate the statistics to be reset.
715 The user may optionally specify a domainid or policyid.
716 domainid defaults to platform. If a mode is not speci‐
717 fied, it will default to global or policy, depending on
718 whether or not a policyid is specified. Command confirmed
719 to work on Intel S5500WB (Penguin Computing Relion 700),
720 Inventec 5441/5442 (Dell Xanadu II/III), Quanta S99Q
721 (Dell FS12-TY), Quanta QSSC-S4R (Appro GB812X-CN), Super‐
722 micro X9DRi-F, Intel S2600JF (Appro 512X).
723 get-node-manager-capabilities [domainid=platform|cpu|mem‐
725 ory|highpowerio] [policytrigger=none|inlettemperaturelimitpoli‐
726 cytrigger|missingpowerreadingtimeout|timeafterplatformresettrig‐
727 ger|boottimepolicy] [policytype=powercontrol] [policypowerdo‐
728 main=primary|secondary]
729 This OEM command will output the current capabilities of
730 the Intel Node manager. The user may optionally specify a
731 domainid, policytrigger, policytype, or policypowerdo‐
732 main. Note that policypowerdomain is only applicabale to
733 domain id platform. If any particular option is not spec‐
734 ified, all permutations of the remaining options will be
735 used in an attempt to output all capabilities of the sys‐
736 tem. If the verbose option is set, additional error mes‐
737 sages will be output as valid policies are being searched
738 for. Command confirmed to work on Intel S2600JF (Appro
739 512X).
740 node-manager-policy-control <enable|disable> [domainid=plat‐
742 form|cpu|memory|highpowerio] [policyid=num]
743 This OEM command will enable or disable the current
744 global, domain, or policies used by the Intel Node Man‐
745 ager. If no domainid is specified, then the Node Manager
746 will be enabled or globally disabled. If a domainid is
747 specified, only that domain will be enabled or disabled.
748 If both a domainid and policyid are specified, only that
749 specific policy within the domain will be specified. This
750 OEM command will be required to enable or disable poli‐
751 cies before many of the commands below can be used for
752 configuration or use. Command confirmed to work on Intel
753 S2600JF (Appro 512X).
754 get-node-manager-policy [domainid=platform|cpu|memory|highpowe‐
756 rio] [policyid=num]
757 This OEM command will get the current node manager pol‐
758 icy. If no domainid is specified, all policies for all
759 domain IDs and policy Ids will be attempted to be output.
760 If a domainid is specified but a policyid is not, all
761 policies within a domain will be attempted to be output.
762 If the verbose option is set, additional error messages
763 will be output as valid policies are being searched for.
764 Command confirmed to work on Intel S2600JF (Appro 512X).
765 set-node-manager-policy domainid=platform|cpu|memory|highpowerio
767 policyid=num policytrigger=none|inlettemperaturelimitpolicytrig‐
768 ger|missingpowerreadingtimeout|timeafterplatformresettrig‐
769 ger|boottimepolicy policytargetlimit=num [platformbooting‐
770 mode=performance|power] correctiontimelimit=ms statisticsreport‐
771 ingperiod=seconds policystorage=persistent|volatile [policytrig‐
772 gerlimit=num] [policystate=enable|disable] [policyexceptionac‐
773 tion=alert|shutdown] [aggressivepowercorrection=automatic|notag‐
774 gressive|aggressive] [policypowerdomain=primary|secondary]
775 This OEM command will add or modify an indicated policy
776 ID from the domain ID. Most of the fields above are
777 required, although they can be listed in any order. By
778 default any created/modified policy will be enabled, how‐
779 ever this can be overridden by policystate. policyexcep‐
780 tionaction may be specified multiple times to configure
781 multiple actions or can be skipped to configure no
782 actions. When the policytrigger is configured as none,
783 the trigger that will lead to exception actions is the
784 value specified by the policytargetlimit. When the poli‐
785 cytrigger is inlettemperaturelimitpolicytrigger, missing‐
786 powerreadingtimeout, or timeafterplatformresettrigger,
787 the tigger that will lead to exception actions is the
788 value specified by policytriggerlimit. When the fIpoli‐
789 cytrigger is boottimepolicy, a power profile will simply
790 be maintained by the value specified by policytar‐
791 getlimit. aggressivepowercorrection defaults to auto‐
792 matic. It can only be set to notaggressive or aggressive
793 if the domainid is platform or cpu. policystorage deter‐
794 mines if the policy being configured can survive across
795 resets of the machine. The units of the policytargetlimit
796 depends on the policytrigger selected. If the poli‐
797 cytrigger is none, inlettemperaturelimitpolicytrigger, or
798 timeafterplatformresettrigger, the units will be in
799 Watts. If the policytrigger is missingpowerreadingtime‐
800 out, the units will be in percent, where 100 means maxi‐
801 mum throttling. If the policytrigger is boottimepolicy,
802 the units is number of CPUs. In addition, platformboot‐
803 ingmode must be set to performance or power to indicate
804 optimization mode. policytriggerlimit is sometimes
805 required, given the input to policytrigger. The units of
806 the policytriggerlimit will depend on the policytrigger
807 selected. If the policytrigger is inlettemperaturelimit‐
808 policytrigger, the units of policytriggerlimit will be in
809 Celsius. If the policytrigger is missingpowerreadingtime‐
810 out or timeafterplatformresettrigger, the units will be
811 in seconds. If the policytrigger is none or boottimepol‐
812 icy, the policytriggerlimit is ignored internally by the
813 Intel Node Manager and need not be specified.. Typically
814 configuring it to 0 is more than sufficient. The correc‐
815 tiontimelimit specifies the time the Node Manager must
816 take corrective actions to bring back the system within
817 limits before taking the actions specified in policyex‐
818 ceptionaction. statisticsreportingperiod is the number of
819 seconds that measured power will be averaged for report‐
820 ing. Please see get-node-manager-policy to determine
821 proper ranges for policytargetlimit, correctiontimelimit,
822 policytriggerlimit, and statisticsreportingperiod. If
823 domainid is configured as platform, user may optionally
824 set policypowerdomain to primary or secondary. Otherwise
825 policypowerdomain will be ignored. Command confirmed to
826 work on Intel S2600JF (Appro 512X).
827 remove-node-manager-policy domainid=platform|cpu|memory|highpow‐
829 erio policyid=num
830 This OEM command will remove the indicated policy ID from
831 the domain ID. Both the domainid and policyid are
832 required. Command confirmed to work on Intel S2600JF
833 (Appro 512X).
834 get-node-manager-policy-alert-thresholds [domainid=plat‐
836 form|cpu|memory|highpowerio] [policyid=num]
837 This OEM command will get the current alert thresholds.
838 If no domainid is specified, all alert thresholds for
839 domain IDs and policy Ids will be attempted to be output.
840 If a domainid is specified but a policyid is not, all
841 alert thresholds within a domain will be attempted to be
842 output. The units of the thresholds will depend on the
843 configuration of the current policy. If the verbose
844 option is set, additional error messages will be output
845 as valid policies are being searched for. Command con‐
846 firmed to work on Intel S2600JF (Appro 512X).
847 set-node-manager-policy-alert-thresholds domainid=plat‐
849 form|cpu|memory|highpowerio policyid=num [threshold1=num]
850 [threshold2=num] [threshold3=num]
851 This OEM command will set the alert thresholds for a
852 given domain ID and policy ID. Up to three thresholds can
853 be specified, The units of the thresholds will depend on
854 the configuration of the current policy. Command con‐
855 firmed to work on Intel S2600JF (Appro 512X).
856 get-node-manager-policy-suspend-periods [domainid=plat‐
858 form|cpu|memory|highpowerio] [policyid=num]
859 This OEM command will get the current policy suspend
860 periods. Suspend periods will temporarily disable Intel
861 Node Manager policies at configured times. If no domainid
862 is specified, all suspend periods for domain IDs and pol‐
863 icy Ids will be attempted to be output. If a domainid is
864 specified but a policyid is not, all suspend periods
865 within a domain will be attempted to be output. If the
866 verbose option is set, additional error messages will be
867 output as valid policies are being searched for. Suspend
868 start and stop times are output in 24 hour format. Com‐
869 mand confirmed to work on Intel S2600JF (Appro 512X).
870 set-node-manager-policy-suspend-periods domainid=plat‐
872 form|cpu|memory|highpowerio policyid=num suspendperiod‐
873 start1=time suspendperiodstop1=time suspendperiodrepeat1=mon‐
874 day|tuesday|wednesday|thursday|friday|saturday|sunday ...
875 This OEM command will set the policy suspend periods for
876 a policy. Suspend periods will temporarily disable Intel
877 Node Manager policies at configured times. Up to 5 sus‐
878 pend periods can be specified by suspendperiodstartX,
879 suspendperiodstopX, suspendperiodrepeatX. suspendperiod‐
880 start and suspendperiodstop specify the start and stop
881 time since midnight for a suspend period. The time should
882 be specified in 24 hour format (i.e. 02:00 or 13:40).
883 Note that suspend periods are configured in multiples of
884 6 minutes, therefore the stored configuration may be
885 rounded to a slightly alternate configuration. suspend‐
886 periodrepeat indicates the days in which the suspend
887 period shall be enabled. The option can be specified mul‐
888 tiple times to configure multiple times. Command con‐
889 firmed to work on Intel S2600JF (Appro 512X).
890 set-node-manager-power-draw-range domainid=platform|cpu|mem‐
892 ory|highpowerio minpowerdrawrange=watts maxpowerdrawrange=watts
893 This OEM command will set the power draw range for a
894 given domain ID. After this configuration, any policies
895 within the domain ID that are outside of this range will
896 be disabled as needed. The current power draw range can
897 be read via the get-node-manager-capabilities above. Com‐
898 mand confirmed to work on Intel S2600JF (Appro 512X).
899 get-node-manager-alert-destination
901 This OEM command will get the current alert destination
902 information. Some of the configuration information out‐
903 put by this command will need to be correlated to BMC
904 device channel and PEF configuration. BMC device channel
905 information can be viewed via .B bmc-info(8). PEF config‐
906 uration can be viewed via ipmi-config(8). Command con‐
907 firmed to work on Intel S2600JF (Appro 512X).
908 set-node-manager-alert-destination [channelnumber=num] [slavead‐
910 dress=address] [destinationselector=num] [alertstringselec‐
911 tor=num] [sendalertstring=yes|no] [register=yes|no]
912 This OEM command will set the current alert receiver. By
913 default, this command will attempt to register an alert
914 (identical to register=yes). When registering an alert
915 receiver the channelnumber, alertstringselector, and
916 sendalertstring options must be specified. The slavead‐
917 dress or destinationselector must also be specified,
918 depending on the channel number specified. If regis‐
919 ter=no, most of these options are not required. Appro‐
920 priate channel number input can be determined via bmc-
921 info(8). Destination selector and alert string selector
922 information can be determined via ipmi-config(8). Com‐
923 mand confirmed to work on Intel S2600JF (Appro 512X).
924 get-turbo-synchronization-ratio activecoresconfig=num|all [cpu‐
926 socket=num|all]
927 This OEM command will get the current Turbo Synchroniza‐
928 tion Ratio. If cpusocket is not set to a specific cpu
929 socket, all sockets will return maximum settings.
930 set-turbo-synchronization-ratio turboratiolimit=num|default
932 [cpusocket=num|all] [activecoresconfig=num|all],
933 This OEM command will set the Turbo Synchronization
934 Ratio. If cpusocket is not set to a specific cpu socket,
935 it assumed to be applied to all cores. If activecore is
936 not set, it is assumed to be for all cores.
937 get-node-manager-version
939 This OEM command will output the current Intel Node Man‐
940 ager version information. Command confirmed to work on
941 Intel S5500WB (Penguin Computing Relion 700), Inventec
942 5441/5442 (Dell Xanadu II/III), Quanta S99Q (Dell
943 FS12-TY), Quanta QSSC-S4R (Appro GB812X-CN), Intel
944 S2600JF (Appro 512X).
945 Inventec
947 get-nic-mode
949 This OEM command will determine the current NIC mode as
950 dedicated or shared. Dedicated indicates IPMI is only
951 available on the dedicated management port. Shared indi‐
952 cates IPMI is also available on one of the primary ether‐
953 net ports. Command confirmed to work on Inventec
954 5441/5442 (Dell Xanadu II/III).
955 set-nic-mode dedicated|shared
957 This OEM command will set the current NIC mode to dedi‐
958 cated or shared. (See get-nic-mode above for description
959 on dedicated vs. shared mode.) This OEM command may
960 internally reset the BMC, making the BMC unusable for
961 awhile. Command confirmed to work on Inventec 5441/5442
962 (Dell Xanadu II/III).
963 get-mac-address
965 This command will retrieve the BMC MAC address. This is
966 actually not an OEM command, but rather the normal IPMI
967 MAC address command (identical to what is used in the
968 ipmi-config(8) tool). This command is placed here for
969 convenience.
970 set-mac-address dedicated|shared MACADDR
972 This OEM command will set the dedicated or shared BMC MAC
973 address. (See get-nic-mode above for description on ded‐
974 icated vs. shared mode.) The BMC MAC address cannot be
975 set through the normal IPMI MAC address command (what is
976 used in the ipmi-config(8) tool). The MACADDR should be
977 specified in XX:XX:XX:XX:XX:XX form. A shared BMC MAC
978 address may conflict with normal communication ethernet
979 communication on the primary ethernet port. Users may
980 wish to configuration an alternate MAC address instead.
981 After configuration of the MAC address, the BMC must be
982 reset. This may be accomplished by executing a cold-reset
983 with bmc-device(8). Command confirmed to work on Inven‐
984 tec 5441/5442 (Dell Xanadu II/III).
985 get-bmc-services
987 This OEM command will display the currently enabled BMC
988 services. Command confirmed to work on Inventec
989 5441/5442 (Dell Xanadu II/III).
990 set-bmc-services enable|disable all|kvm|http|ssh
992 This OEM command will enable or disable other BMC ser‐
993 vices besides IPMI. all can be specified to enable/dis‐
994 able all services, kvm specifies KVM and Virtual Storage,
995 http specifies HTTP and HTTPS, and ssh specifies both SSH
996 and Telnet. Command confirmed to work on Inventec
997 5441/5442 (Dell Xanadu II/III).
998 get-authentication-config
1000 This OEM command will display additional OEM authentica‐
1001 tion settings. (See set-authentication-config below for
1002 description on outputs.) Command confirmed to work on
1003 Inventec 5441/5442 (Dell Xanadu II/III).
1004 set-authentication-config KEY=VALUE ...
1006 This OEM command will set additional OEM authentication
1007 settings on the IPMI card. The possible keys and values
1008 are maxauthenticationfailures=count, lockoutwindow=sec‐
1009 onds, lockouttime=seconds, and httpsportnumber=num. max‐
1010 authenticationfailures specifies the maximum number of
1011 allowed authentication failures. lockoutwindow specifies
1012 the window of time the authentication failure count can
1013 be reached in to disable a user. lockouttime specifies
1014 the time period a user is disabled if the authentication
1015 failure count is reached. Setting 0 to any of the set‐
1016 tings will disable the lockout feature. Each time any of
1017 these settings is modified, the authentication failure
1018 count of each enabled user is reset to 0. Multiple
1019 key=value pairs may be specified. If no key=value pairs
1020 are specified, available pairs are output. Command con‐
1021 firmed to work on Inventec 5441/5442 (Dell Xanadu
1022 II/III).
1023 get-account-status
1025 This OEM command will output the current account status
1026 of users on the BMC. This command is particularly usefor
1027 for determinining which users in the system may have been
1028 locked out via authentication failures configured via
1029 set-authentication-config. Command confirmed to work on
1030 Inventec 5441/5442 (Dell Xanadu II/III).
1031 get-dns-config
1033 This OEM command will display additional OEM DNS set‐
1034 tings. (See set-dns-config below for description on out‐
1035 puts.) Command confirmed to work on Inventec 5441/5442
1036 (Dell Xanadu II/III).
1037 set-dns-config KEY=VALUE ...
1039 This OEM command will set additional OEM DNS settings on
1040 the IPMI card. The possible keys and values are dnsd‐
1041 hcp=enable|disable, dnsserver1=ipaddress,
1042 dnsserver2=ipaddress, dnsregisterbmc=enable|disable, dns‐
1043 bmchostname=string, dnsdomainnamedhcp=enable|disable, and
1044 dnsdomainname=string. dnsdhcp specifies if the DNS server
1045 IP addresses should be assigned from the DHCP server.
1046 dnsserver1 and dnsserver2 specify the IP addess for
1047 server 1 and 2 respectively. These fields are read only
1048 if dnsdhcp and DHCP are enabled. dnsregisterbmc specifies
1049 if the BMC host name is registered via the DNS server.
1050 dnsbmchostname specifies the BMC host name. This field is
1051 read only if dnsregisterbmc is enabled. dnsdomainnamedhcp
1052 specifies if the DNS domainname should be assigned from
1053 the DHCP server. dnsdomainname specifies the DNS domain
1054 name string. This field is read only if dnsdomainnamedhcp
1055 is enabled. Multiple key=value pairs may be specified. If
1056 no key=value pairs are specified, available pairs are
1057 output. Command confirmed to work on Inventec 5441/5442
1058 (Dell Xanadu II/III).
1059 get-web-server-config
1061 This OEM command will get the current web server configu‐
1062 ration on the IPMI card. Command confirmed to work on
1063 Inventec 5441/5442 (Dell Xanadu II/III).
1064 set-web-server-config KEY=VALUE ...
1066 This OEM command will set the current web server configu‐
1067 ration on the IPMI card. The possible keys and values are
1068 webserver=enable|disable, webservertimeout=seconds, http‐
1069 portnumber=num, and httpsportnumber=num. Multiple
1070 key=value pairs may be specified. If no key=value pairs
1071 are specified, available pairs are output. Command con‐
1072 firmed to work on Inventec 5441/5442 (Dell Xanadu
1073 II/III).
1074 get-power-management-config
1076 This OEM command will get the current power management
1077 configuration on the IPMI card. Command confirmed to work
1078 on Inventec 5441/5442 (Dell Xanadu II/III).
1079 set-power-management-config KEY=VALUE ...
1081 This OEM command will set the current power management
1082 configuration on the IPMI card. The possible keys and
1083 values are dpnmpowermanagement=enable|disable, powerstag‐
1084 geringacrecovery=immediate|auto|user, powerondelay=sec‐
1085 onds, and maxpowerondelay=seconds. dpnmpowermanagement
1086 enables or diables DPNM, Dynamic Power Node Management.
1087 For powerstaggeringacrecovery, immediate specifies no
1088 delay, auto generates a delay time between the minimum
1089 and maximum configured, and user uses the user defined
1090 time defined by powerondelay. powerondelay must be within
1091 the minimum and maximum power on delay times. Multiple
1092 key=value pairs may be specified. If no key=value pairs
1093 are specified, available pairs are output. Command con‐
1094 firmed to work on Inventec 5441/5442 (Dell Xanadu
1095 II/III).
1096 get-sol-idle-timeout
1098 This OEM command will get the SOL idle timeout. Command
1099 confirmed to work on Inventec 5441/5442 (Dell Xanadu
1100 II/III).
1101 set-sol-idle-timeout idle-timeout
1103 This OEM command will set the SOL idle timeout. The
1104 idle-timeout is one-based, max of 65535, in 1 minute
1105 increments (e.g. 1 = 1 minute), 0 or "none" will config‐
1106 ure no timeout. Command confirmed to work on Inventec
1107 5441/5442 (Dell Xanadu II/III).
1108 get-telnet-ssh-redirect-status
1110 This OEM command will get the telnet/SSH redirect status.
1111 Command confirmed to work on Inventec 5442 (Dell Xanadu
1112 III).
1113 set-telnet-ssh-redirect-status enable|disable
1115 This OEM command will enable or disable telnet/SSH redi‐
1116 rect status. Command confirmed to work on Inventec 5442
1117 (Dell Xanadu III).
1118 get-board-id
1120 This OEM command can get the board ID. Command confirmed
1121 to work on Inventec 5441/5442 (Dell Xanadu II/III).
1122 set-board-id ID
1124 This OEM command can set the board ID. Command confirmed
1125 to work on Inventec 5441/5442 (Dell Xanadu II/III).
1126 get-fcb-version
1128 This OEM command can get the fan control board (FCB) ver‐
1129 sion number. Command confirmed to work on Inventec
1130 5441/5442 (Dell Xanadu II/III).
1131 set-fcb-version majorversion minorversion
1133 This OEM command can set the fan control board (FCB) ver‐
1134 sion number. The majorversion and minorversion must be
1135 specified in hex. Command confirmed to work on Inventec
1136 5441/5442 (Dell Xanadu II/III).
1137 get-sol-inactivity-timeout
1139 This OEM command will retrieve the SOL inactivity time‐
1140 out. Command confirmed to work on Inventec 5441/5442
1141 (Dell Xanadu II/III).
1142 set-sol-inactivity-timeout inactivity-timeout
1144 This OEM command will set the SOL inactivity timeout. The
1145 inactivity-timeout is one-based, max of 65535, in 1
1146 minute increments (e.g. 1 = 1 minute), 0 or "none" will
1147 configure no timeout. Command confirmed to work on
1148 Inventec 5441/5442 (Dell Xanadu II/III).
1149 restore-to-defaults all|user|lan|sol|serial|pef
1151 This OEM command will restore certain BMC configuration
1152 sections back to default values. The command will spin
1153 until the reset is confirmed to be complete. Command con‐
1154 firmed to work on Inventec 5442 (Dell Xanadu III). After
1155 running this command, the BMC must be reset to return it
1156 to functioning status. This may be accomplished by exe‐
1157 cuting a cold-reset with bmc-device(8).
1158 read-eeprom at24c256n
1160 This OEM command will read the specified eeprom. Command
1161 confirmed to work on Inventec 5441 (Dell Xanadu II) for
1162 at24c256.
1163 clear-eeprom at24c256n
1165 This OEM command will clear the specified eeprom, over‐
1166 writing all bytes with 0xFF. If the verbose option is
1167 set, progress percent will be output as the clearing is
1168 being done. Command confirmed to work on Inventec 5441
1169 (Dell Xanadu II) for at24c256.
1170 Quanta
1172 get-nic-mode
1174 This OEM command will determine the current NIC mode as
1175 dedicated or shared. Dedicated indicates IPMI is only
1176 available on the dedicated management port. Shared indi‐
1177 cates IPMI is also available on one of the primary ether‐
1178 net ports. Command confirmed to work on Quanta S99Q (Dell
1179 FS12-TY).
1180 set-nic-mode dedicated|shared
1182 This OEM command will set the current NIC mode to dedi‐
1183 cated or shared. (See get-nic-mode above for description
1184 on dedicated vs. shared mode.) This OEM command may
1185 internally reset the BMC, making the BMC unusable for
1186 awhile. Command confirmed to work on Quanta S99Q (Dell
1187 FS12-TY).
1188 get-bmc-services
1190 This OEM command will display the currently enabled BMC
1191 services. Command confirmed to work on Quanta S99Q (Dell
1192 FS12-TY).
1193 set-bmc-services enable|disable all|kvm|http|ssh
1195 This OEM command will enable or disable other BMC ser‐
1196 vices besides IPMI. all can be specified to enable/dis‐
1197 able all services, kvm specifies KVM and Virtual Storage,
1198 http specifies HTTP and HTTPS, and ssh specifies both SSH
1199 and Telnet. Command confirmed to work on Quanta S99Q
1200 (Dell FS12-TY).
1201 get-account-status
1203 This OEM command will output the current account status
1204 of users on the BMC. This command is particularly usefor
1205 for determinining which users in the system may have been
1206 locked out via authentication failures. Command confirmed
1207 to work on Quanta S99Q (Dell FS12-TY).
1208 get-dns-config
1210 This OEM command will display additional OEM DNS set‐
1211 tings. (See set-dns-config below for description on out‐
1212 puts.) Command confirmed to work on Quanta S99Q (Dell
1213 FS12-TY).
1214 set-dns-config KEY=VALUE ...
1216 This OEM command will set additional OEM DNS settings on
1217 the IPMI card. The possible keys and values are dnsd‐
1218 hcp=enable|disable, dnsserver1=ipaddress,
1219 dnsserver2=ipaddress, dnsregisterbmc=enable|disable, dns‐
1220 bmchostname=string, dnsdomainnamedhcp=enable|disable, and
1221 dnsdomainname=string. dnsdhcp specifies if the DNS server
1222 IP addresses should be assigned from the DHCP server.
1223 dnsserver1 and dnsserver2 specify the IP addess for
1224 server 1 and 2 respectively. These fields are read only
1225 if dnsdhcp and DHCP are enabled. dnsregisterbmc specifies
1226 if the BMC host name is registered via the DNS server.
1227 dnsbmchostname specifies the BMC host name. This field is
1228 read only if dnsregisterbmc is enabled. dnsdomainnamedhcp
1229 specifies if the DNS domainname should be assigned from
1230 the DHCP server. dnsdomainname specifies the DNS domain
1231 name string. This field is read only if dnsdomainnamedhcp
1232 is enabled. Multiple key=value pairs may be specified. If
1233 no key=value pairs are specified, available pairs are
1234 output. Command confirmed to work on Quanta S99Q (Dell
1235 FS12-TY).
1236 get-web-server-config
1238 This OEM command will get the current web server configu‐
1239 ration on the IPMI card. Command confirmed to work on
1240 Quanta S99Q (Dell FS12-TY).
1241 set-web-server-config KEY=VALUE...
1243 This OEM command will set the current web server configu‐
1244 ration on the IPMI card. The possible keys and values are
1245 webserver=enable|disable, webservertimeout=seconds, http‐
1246 portnumber=num, and httpsportnumber=num. Multiple
1247 key=value pairs may be specified. If no key=value pairs
1248 are specified, available pairs are output. Command con‐
1249 firmed to work on Quanta S99Q (Dell FS12-TY).
1250 get-power-management-config
1252 This OEM command will get the current power management
1253 configuration on the IPMI card. Command confirmed to work
1254 on Quanta S99Q (Dell FS12-TY).
1255 set-power-management-config KEY=VALUE ...
1257 This OEM command will set the current power management
1258 configuration on the IPMI card. The possible keys and
1259 values are dpnmpowermanagement=enable|disable, powerstag‐
1260 geringacrecovery=immediate|auto|user, powerondelay=sec‐
1261 onds, and maxpowerondelay=seconds. dpnmpowermanagement
1262 enables or diables DPNM, Dynamic Power Node Management.
1263 For powerstaggeringacrecovery, immediate specifies no
1264 delay, auto generates a delay time between the minimum
1265 and maximum configured, and user uses the user defined
1266 time defined by powerondelay. powerondelay must be within
1267 the minimum and maximum power on delay times. Multiple
1268 key=value pairs may be specified. If no key=value pairs
1269 are specified, available pairs are output. Command con‐
1270 firmed to work on Quanta S99Q (Dell FS12-TY).
1271 get-sol-idle-timeout
1273 This OEM command will get the SOL idle timeout. Command
1274 confirmed to work on Quanta S99Q (Dell FS12-TY).
1275 set-sol-idle-timeout idle-timeout
1277 This OEM command will set the SOL idle timeout. The
1278 idle-timeout is one-based, max of 65535, in 1 minute
1279 increments (e.g. 1 = 1 minute), 0 or "none" will config‐
1280 ure no timeout. Command confirmed to work on Quanta S99Q
1281 (Dell FS12-TY).
1282 get-telnet-ssh-redirect-status
1284 This OEM command will get the telnet/SSH redirect status.
1285 Command confirmed to work on Quanta S99Q (Dell FS12-TY).
1286 set-telnet-ssh-redirect-status enable|disable
1288 This OEM command will enable or disable telnet/SSH redi‐
1289 rect status. Command confirmed to work on Quanta S99Q
1290 (Dell FS12-TY).
1291 reset-to-defaults all|user|lan|sol|serial|pef
1293 This OEM command will reset certain BMC configuration
1294 sections back to default values. The command will spin
1295 until the reset is confirmed to be complete. Command con‐
1296 firmed to work on Quanta S99Q (Dell FS12-TY). After run‐
1297 ning this command, the BMC must be reset to return it to
1298 functioning status. This may be accomplished by executing
1299 a cold-reset with bmc-device(8).
1300 get-processor-information [processor-index]
1302 This OEM command will determine system processor informa‐
1303 tion. By default, information about each processor will
1304 be output. If a processor-index is specified, only that
1305 specific processor will be output. Command confirmed to
1306 work on Quanta S99Q (Dell FS12-TY).
1307 read-mac-address s99q dedicated|shared
1309 This command will read the currently configured dedicated
1310 or shared MAC address for a specified motherboard. It
1311 will read the MAC address directly from the BMC eeprom.
1312 Command confirmed to work on Quanta S99Q (Dell FS12-TY)
1313 for s99q.
1314 write-mac-address s99q dedicated|shared MACADDR
1316 This OEM command will set the dedicated or shared BMC MAC
1317 address for a specified motherboard. It will be written
1318 directly to the BMC eeprom. (See get-nic-mode above for
1319 description on dedicated vs. shared mode.) The BMC MAC
1320 address cannot be set through the normal IPMI MAC address
1321 command (what is used in the ipmi-config(8) tool). The
1322 MACADDR should be specified in XX:XX:XX:XX:XX:XX form. A
1323 shared BMC MAC address may conflict with normal communi‐
1324 cation ethernet communication on the primary ethernet
1325 port. Users may wish to configuration an alternate MAC
1326 address instead. After configuration of the MAC address,
1327 the BMC must be reset. This may be accomplished by exe‐
1328 cuting a cold-reset with bmc-device(8). Command con‐
1329 firmed to work on Quanta S99Q (Dell FS12-TY) for s99q.
1330 Sun
1332 get-led
1334 This OEM command will output current LED mode. off indi‐
1335 cates the LED is steady off, on indicates the LED is
1336 steady on, standby indicates the LED blinks at a 100ms
1337 on, 2900ms off rate, slow indicates the LED is blinking
1338 at 1Hz, and fast indicates the LED is blinking at 4Hz. If
1339 the verbose option is set, sensor names will be output
1340 with their entity ID and instance when appropriate. (Sim‐
1341 ilar to the --entity-sensor-names option in ipmi-sen‐
1342 sors.) This OEM command requires access to the SDR. Com‐
1343 mand confirmed to work on Sun Fire 4140 with ILOM.
1344 set-led record_id off|on|standby|slow|fast
1346 This OEM command will configure LED modes. (See get-led
1347 above for description on LED modes.) This OEM command
1348 requires access to the SDR. Command confirmed to work on
1349 Sun Fire 4140 with ILOM.
1350 Supermicro
1352 extra-firmware-info
1354 This OEM command will output additional firmware version
1355 information. Command confirmed to work on Supermicro
1356 H8QME.
1357 reset-intrusion
1359 This OEM command will reset the motherboard intrusion
1360 flag after it has been triggered. For example, in ipmi-
1361 sensors or ipmi-sel, you may notice a 'General Chassis
1362 Intrusion' if the motherboard chassis is not open, but
1363 was opened in the past. Command confirmed to work on
1364 Supermicro H8QME.
1365 get-bmc-services-status
1367 This OEM command will determine if non-IPMI services
1368 (e.g. ssh, http, https, vnc, etc.) are currently enabled
1369 or disabled on the BMC. Command confirmed to work on
1370 Supermicro X8DTG.
1371 set-bmc-services-status enable|disable
1373 This OEM command will enable or disable all non-IPMI ser‐
1374 vices on the BMC. This command can be used to enable or
1375 disable non-IPMI services such as ssh, http, https, and
1376 vnc. Command confirmed to work on Supermicro X8DTG.
1377 get-power-supply-status ps_num
1379 This OEM command will get the status of a regular power
1380 supply. Presently, it can get the status of power sup‐
1381 plies 1 through 3. Command confirmed to work on Supermi‐
1382 cro X8DTU, Supermicro X8STi, and Supermicro X9DRW.
1383 get-power-supply-status2 ps_num
1385 This OEM command will get the status of a regular power
1386 supply. Presently, it can get the status of power sup‐
1387 plies 1 and 2. Command confirmed to work on Supermicro
1388 X10DRU-i+.
1389 get-pmbus-power-supply-status ps_num
1391 This OEM command will get the status of a PMBus based
1392 power supply. Presently, it can get the status of power
1393 supplies 1 through 3. Command confirmed to work on
1394 Supermicro X8DTU, Supermicro X8STi, and Supermicro X9DRW.
1395 Wistron
1397 get-system-info KEY
1399 This OEM command can retrieve the motherboard system
1400 information. Valid keys are asset-tag, service-tag,
1401 product-name. Command confirmed to work on Wistron / Dell
1402 Poweredge C6220.
1403 get-nic-mode
1405 This OEM command will determine the current NIC mode as
1406 dedicated or shared. Dedicated indicates IPMI is only
1407 available on the dedicated management port. Shared indi‐
1408 cates IPMI is also available on one of the primary ether‐
1409 net ports. Command confirmed to work on Wistron / Dell
1410 Poweredge C6220.
1411 set-nic-mode dedicated|shared
1413 This OEM command will set the current NIC mode to dedi‐
1414 cated or shared. (See get-nic-mode above for description
1415 on dedicated vs. shared mode.) After running this com‐
1416 mand, the BMC may need to be reset to finalize the con‐
1417 figuration. This may be accomplished by executing a cold-
1418 reset with bmc-device(8). Command confirmed to work on
1419 Wistron / Dell Poweredge C6220.
1420 get-shared-nic-selection
1422 This OEM command will determine the current NIC IPMI is
1423 shared with if the mode is shared. (See get-nic-mode
1424 above for description on dedicated vs. shared mode.) Com‐
1425 mand confirmed to work on Wistron / Dell Poweredge C6220.
1426 set-shared-nic-selection nic1|nic2|nic3|nic4|clear
1428 This OEM command will set the current NIC sharing selec‐
1429 tion. If the current NIC mode is dedicated it is advis‐
1430 able to clear this setting with the clear option. Command
1431 confirmed to work on Wistron / Dell Poweredge C6220.
1432 get-bmc-services
1434 This OEM command will display the currently enabled BMC
1435 services. Command confirmed to work on Wistron / Dell
1436 Poweredge C6220.
1437 set-bmc-services enable|disable all|kvm|http|ssh|snmp|telnet
1439 This OEM command will enable or disable other BMC ser‐
1440 vices besides IPMI. all can be specified to enable/dis‐
1441 able all services, kvm specifies KVM and Virtual Storage,
1442 http specifies HTTP and HTTPS. Command confirmed to work
1443 on Wistron / Dell Poweredge C6220.
1444 get-account-status
1446 This OEM command will output the current account status
1447 of users on the BMC. This command is particularly usefor
1448 for determinining which users in the system may have been
1449 locked out via authentication failures. Command confirmed
1450 to work on Wistron / Dell Poweredge C6220.
1451 get-dns-config
1453 This OEM command will display additional OEM DNS set‐
1454 tings. (See set-dns-config below for description on out‐
1455 puts.) Command confirmed to work on Wistron / Dell Pow‐
1456 eredge C6220.
1457 set-dns-config KEY=VALUE ...
1459 This OEM command will set additional OEM DNS settings on
1460 the IPMI card. The possible keys and values are dnsd‐
1461 hcp=enable|disable, dnsserver1=ipaddress,
1462 dnsserver2=ipaddress, dnsregisterbmc=enable|disable, dns‐
1463 bmchostname=string, dnsdomainnamedhcp=enable|disable,
1464 dnsdomainname=string, and dnsregistrationdelay=seconds.
1465 dnsdhcp specifies if the DNS server IP addresses should
1466 be assigned from the DHCP server. dnsserver1 and
1467 dnsserver2 specify the IP addess for server 1 and 2
1468 respectively. These fields are read only if dnsdhcp and
1469 DHCP are enabled. dnsregisterbmc specifies if the BMC
1470 host name is registered via the DNS server. dnsbmchost‐
1471 name specifies the BMC host name. This field is read only
1472 if dnsregisterbmc is enabled. dnsdomainnamedhcp specifies
1473 if the DNS domainname should be assigned from the DHCP
1474 server. dnsdomainname specifies the DNS domain name
1475 string. This field is read only if dnsdomainnamedhcp is
1476 enabled. dnsregistrationdelay specifies the delay the BMC
1477 should take after the IPMI process is up and running.
1478 Multiple key=value pairs may be specified. If no
1479 key=value pairs are specifed, available pairs are output.
1480 Command confirmed to work on Wistron / Dell Poweredge
1481 C6220.
1482 get-web-server-config
1484 This OEM command will get the current web server configu‐
1485 ration on the IPMI card. Command confirmed to work on
1486 Wistron / Dell Poweredge C6220.
1487 set-web-server-config KEY=VALUE...
1489 This OEM command will set the current web server configu‐
1490 ration on the IPMI card. The possible keys and values are
1491 webserver=enable|disable, webservertimeout=seconds, http‐
1492 portnumber=num, and httpsportnumber=num. Multiple
1493 key=value pairs may be specified. If no key=value pairs
1494 are specifed, available pairs are output. Command con‐
1495 firmed to work on Wistron / Dell Poweredge C6220.
1496 get-power-management-config
1498 This OEM command will get the current power management
1499 configuration on the IPMI card. Command confirmed to work
1500 on Wistron / Dell Poweredge C6220.
1501 set-power-management-config KEY=VALUE ...
1503 This OEM command will set the current power management
1504 configuration on the IPMI card. The possible keys and
1505 values are powerstaggeringacrecovery=immediate|auto|user,
1506 powerondelay=seconds, and maxpowerondelay=seconds. For
1507 powerstaggeringacrecovery, immediate specifies no delay,
1508 auto generates a delay time between the minimum and maxi‐
1509 mum configured, and user uses the user defined time
1510 defined by powerondelay. powerondelay must be within the
1511 minimum and maximum power on delay times. Multiple
1512 key=value pairs may be specified. If no key=value pairs
1513 are specifed, available pairs are output. Command con‐
1514 firmed to work on Wistron / Dell Poweredge C6220.
1515 get-ipv6-settings
1517 This OEM command will get the current IPv6 settings on
1518 the IPMI card. Command confirmed to work on Wistron /
1519 Dell Poweredge C6220.
1520 set-ipv6-settings KEY=VALUE ...
1522 This OEM command will set the current IPv6 settings on
1523 the IPMI card. The possible keys and values are
1524 ipv6=enable|disable, ipv6address=ipaddress, ipv6gate‐
1525 wayaddress=ipaddress, ipv6prefixlength=length, ipv6auto‐
1526 config=enable|disable, ipv6autodns=enable|disable,
1527 ipv6dnsserver1=ipaddress, and ipv6dnsserver2=ipaddress.
1528 If no key=value pairs are specifed, available pairs are
1529 output. Some fields may be read-only on specific Pow‐
1530 eredge systems. Command confirmed to work on Wistron /
1531 Dell Poweredge C6220.
1532 get-ipv6-trap-settings
1534 This OEM command will get the current IPv6 SNMP trap set‐
1535 tings on the IPMI card. Command confirmed to work on
1536 Wistron / Dell Poweredge C6220.
1537 set-ipv6-trap-settings index KEY=VALUE ...
1539 This OEM command will set the current IPv6 SNMP trap set‐
1540 tings on the IPMI card. The index indicates the index
1541 position for the configuration. It is followed by a set
1542 of configuration keys and values. The possible keys and
1543 values are destinationtype=pet|oem1|oem2, alertacktime‐
1544 out=seconds, retries=count, and ipv6snmptrapaddress=ipad‐
1545 dress. If no key=value pairs are specifed, available
1546 pairs are output. Some fields may be read-only on spe‐
1547 cific Poweredge systems. Command confirmed to work on
1548 Wistron / Dell Poweredge C6220.
1549 get-sol-idle-timeout
1551 This OEM command will get the SOL idle timeout. Command
1552 confirmed to work on Wistron / Dell Poweredge C6220.
1553 set-sol-idle-timeout idle-timeout
1555 This OEM command will set the SOL idle timeout. The
1556 idle-timeout is one-based, max of 65535, in 1 minute
1557 increments (e.g. 1 = 1 minute), 0 or "none" will config‐
1558 ure no timeout. Command confirmed to work on Wistron /
1559 Dell Poweredge C6220.
1560 get-telnet-redirect-function
1562 This OEM command will get the telnet redirect function.
1563 Command confirmed to work on Wistron / Dell Poweredge
1564 C6220.
1565 set-telnet-redirect-function disable|solenable|smashenable
1567 This OEM command will enable or disable telnet redirect
1568 function. Command confirmed to work on Wistron / Dell
1569 Poweredge C6220.
1570 get-dhcp-retry
1572 This OEM command will retrieve DHCP retry information.
1573 Wistron / Dell Poweredge C6220.
1574 set-dhcp-retry retry-count retry-interval retry-timeout
1576 This OEM command will set DHCP retry information. The
1577 retry-count is one-based, max of 254, 0 or "none" will
1578 configure no retries, 255 or "indefinite" will configure
1579 constant retries. The retry-interval is one-based, in 10
1580 second increments (e.g. 1 = 10 seconds). The retry-time‐
1581 out is one-based, in 1 minute increments (e.g. 1 = 1
1582 minute). After running this command, the BMC may need to
1583 be reset to finalize the configuration. This may be
1584 accomplished by executing a cold-reset with bmc-
1585 device(8). Command confirmed to work on Wistron / Dell
1586 Poweredge C6220.
1587 get-link-status-change-control
1589 This OEM command will get the current link status change
1590 control. If it reports "Link Down Resilience Enabled",
1591 BMC firmware will do nothing upon detecting Link Status
1592 Change until the DHCP lease is expired. If it reports
1593 "DHCP Re-Discovery Enabled", BMC firmware will perform
1594 DHCP Discovery upon detecting link status going down than
1595 back up. Command confirmed to work on Wistron / Dell Pow‐
1596 eredge C6220..
1597 set-link-status-change-control link_resilience|dhcp_rediscovery
1599 This OEM command will set the current NIC link status
1600 change control setting. (See set-link-status-change-con‐
1601 trol above for description of arguments). After running
1602 this command, the BMC may need to be reset to finalize
1603 the configuration. This may be accomplished by executing
1604 a cold-reset with bmc-device(8). Command confirmed to
1605 work on Wistron / Dell Poweredge C6220.
1606 set-password-policy <enable|disable>
1608 This OEM command will set the current password policy
1609 enforcement. If password policy is enabled, BMC passwords
1610 must meet the following requirements: Not contain the
1611 user's name, be 8-14 characters long, and contain three
1612 of the following four, an English uppercase character (A-
1613 Z), an English lowercase character (a-z), a digit (0-9),
1614 a special character (!, $, #, %, etc.). Command confirmed
1615 to work on Wistron / Dell Poweredge C6220.
1616 read-proprietary-string
1618 This OEM command will read the proprietary string stored
1619 in the FRU. The proprietary string is a string the user
1620 may set for any management purpose. It can also be read
1621 via ipmi-fru. Command confirmed to work on Wistron /
1622 Dell Poweredge C6220.
1623 set-proprietary-string <string>
1625 This OEM command will write the proprietary string stored
1626 in the FRU. The maximum length string is 80 characters.
1627 Command confirmed to work on Wistron / Dell Poweredge
1628 C6220.
1629 clear-proprietary-string
1631 This OEM command will clear the proprietary string stored
1632 in the FRU. Command confirmed to work on Wistron / Dell
1633 Poweredge C6220.
1634
1636 Multiple hosts can be input either as an explicit comma separated lists
1637 of hosts or a range of hostnames in the general form: prefix[n-m,l-
1638 k,...], where n < m and l < k, etc. The later form should not be con‐
1639 fused with regular expression character classes (also denoted by []).
1640 For example, foo[19] does not represent foo1 or foo9, but rather repre‐
1641 sents a degenerate range: foo19.
1642 This range syntax is meant only as a convenience on clusters with a
1644 prefixNN naming convention and specification of ranges should not be
1645 considered necessary -- the list foo1,foo9 could be specified as such,
1646 or by the range foo[1,9].
1647 Some examples of range usage follow:
1649 foo[01-05] instead of foo01,foo02,foo03,foo04,foo05
1650 foo[7,9-10] instead of foo7,foo9,foo10
1651 foo[0-3] instead of foo0,foo1,foo2,foo3
1652 As a reminder to the reader, some shells will interpret brackets ([ and
1654 ]) for pattern matching. Depending on your shell, it may be necessary
1655 to enclose ranged lists within quotes.
1656 When multiple hosts are specified by the user, a thread will be exe‐
1658 cuted for each host in parallel up to the configured fanout (which can
1659 be adjusted via the -F option). This will allow communication to large
1660 numbers of nodes far more quickly than if done in serial.
1661 By default, standard output from each node specified will be output
1663 with the hostname prepended to each line. Although this output is read‐
1664 able in many situations, it may be difficult to read in other situa‐
1665 tions. For example, output from multiple nodes may be mixed together.
1666 The -B and -C options can be used to change this default.
1667 In-band IPMI Communication will be used when the host "localhost" is
1669 specified. This allows the user to add the localhost into the hos‐
1670 tranged output.
1671
1673 Most often, IPMI problems are due to configuration problems.
1674 IPMI over LAN problems involve a misconfiguration of the remote
1676 machine's BMC. Double check to make sure the following are configured
1677 properly in the remote machine's BMC: IP address, MAC address, subnet
1678 mask, username, user enablement, user privilege, password, LAN privi‐
1679 lege, LAN enablement, and allowed authentication type(s). For IPMI 2.0
1680 connections, double check to make sure the cipher suite privilege(s)
1681 and K_g key are configured properly. The ipmi-config(8) tool can be
1682 used to check and/or change these configuration settings.
1683 Inband IPMI problems are typically caused by improperly configured
1685 drivers or non-standard BMCs.
1686 In addition to the troubleshooting tips below, please see WORKAROUNDS
1688 below to also if there are any vendor specific bugs that have been dis‐
1689 covered and worked around.
1690 Listed below are many of the common issues for error messages. For
1692 additional support, please e-mail the <freeipmi-users@gnu.org> mailing
1693 list.
1694 "username invalid" - The username entered (or a NULL username if none
1696 was entered) is not available on the remote machine. It may also be
1697 possible the remote BMC's username configuration is incorrect.
1698 "password invalid" - The password entered (or a NULL password if none
1700 was entered) is not correct. It may also be possible the password for
1701 the user is not correctly configured on the remote BMC.
1702 "password verification timeout" - Password verification has timed out.
1704 A "password invalid" error (described above) or a generic "session
1705 timeout" (described below) occurred. During this point in the protocol
1706 it cannot be differentiated which occurred.
1707 "k_g invalid" - The K_g key entered (or a NULL K_g key if none was
1709 entered) is not correct. It may also be possible the K_g key is not
1710 correctly configured on the remote BMC.
1711 "privilege level insufficient" - An IPMI command requires a higher user
1713 privilege than the one authenticated with. Please try to authenticate
1714 with a higher privilege. This may require authenticating to a different
1715 user which has a higher maximum privilege.
1716 "privilege level cannot be obtained for this user" - The privilege
1718 level you are attempting to authenticate with is higher than the maxi‐
1719 mum allowed for this user. Please try again with a lower privilege. It
1720 may also be possible the maximum privilege level allowed for a user is
1721 not configured properly on the remote BMC.
1722 "authentication type unavailable for attempted privilege level" - The
1724 authentication type you wish to authenticate with is not available for
1725 this privilege level. Please try again with an alternate authentication
1726 type or alternate privilege level. It may also be possible the avail‐
1727 able authentication types you can authenticate with are not correctly
1728 configured on the remote BMC.
1729 "cipher suite id unavailable" - The cipher suite id you wish to authen‐
1731 ticate with is not available on the remote BMC. Please try again with
1732 an alternate cipher suite id. It may also be possible the available
1733 cipher suite ids are not correctly configured on the remote BMC.
1734 "ipmi 2.0 unavailable" - IPMI 2.0 was not discovered on the remote
1736 machine. Please try to use IPMI 1.5 instead.
1737 "connection timeout" - Initial IPMI communication failed. A number of
1739 potential errors are possible, including an invalid hostname specified,
1740 an IPMI IP address cannot be resolved, IPMI is not enabled on the
1741 remote server, the network connection is bad, etc. Please verify con‐
1742 figuration and connectivity.
1743 "session timeout" - The IPMI session has timed out. Please reconnect.
1745 If this error occurs often, you may wish to increase the retransmission
1746 timeout. Some remote BMCs are considerably slower than others.
1747 "device not found" - The specified device could not be found. Please
1749 check configuration or inputs and try again.
1750 "driver timeout" - Communication with the driver or device has timed
1752 out. Please try again.
1753 "message timeout" - Communication with the driver or device has timed
1755 out. Please try again.
1756 "BMC busy" - The BMC is currently busy. It may be processing informa‐
1758 tion or have too many simultaneous sessions to manage. Please wait and
1759 try again.
1760 "could not find inband device" - An inband device could not be found.
1762 Please check configuration or specify specific device or driver on the
1763 command line.
1764 "driver timeout" - The inband driver has timed out communicating to the
1766 local BMC or service processor. The BMC or service processor may be
1767 busy or (worst case) possibly non-functioning.
1768
1770 With so many different vendors implementing their own IPMI solutions,
1771 different vendors may implement their IPMI protocols incorrectly. The
1772 following describes a number of workarounds currently available to han‐
1773 dle discovered compliance issues. When possible, workarounds have been
1774 implemented so they will be transparent to the user. However, some will
1775 require the user to specify a workaround be used via the -W option.
1776 The hardware listed below may only indicate the hardware that a problem
1778 was discovered on. Newer versions of hardware may fix the problems
1779 indicated below. Similar machines from vendors may or may not exhibit
1780 the same problems. Different vendors may license their firmware from
1781 the same IPMI firmware developer, so it may be worthwhile to try work‐
1782 arounds listed below even if your motherboard is not listed.
1783 If you believe your hardware has an additional compliance issue that
1785 needs a workaround to be implemented, please contact the FreeIPMI main‐
1786 tainers on <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
1787 assumeio - This workaround flag will assume inband interfaces communi‐
1789 cate with system I/O rather than being memory-mapped. This will work
1790 around systems that report invalid base addresses. Those hitting this
1791 issue may see "device not supported" or "could not find inband device"
1792 errors. Issue observed on HP ProLiant DL145 G1.
1793 spinpoll - This workaround flag will inform some inband drivers (most
1795 notably the KCS driver) to spin while polling rather than putting the
1796 process to sleep. This may significantly improve the wall clock running
1797 time of tools because an operating system scheduler's granularity may
1798 be much larger than the time it takes to perform a single IPMI message
1799 transaction. However, by spinning, your system may be performing less
1800 useful work by not contexting out the tool for a more useful task.
1801 authcap - This workaround flag will skip early checks for username
1803 capabilities, authentication capabilities, and K_g support and allow
1804 IPMI authentication to succeed. It works around multiple issues in
1805 which the remote system does not properly report username capabilities,
1806 authentication capabilities, or K_g status. Those hitting this issue
1807 may see "username invalid", "authentication type unavailable for
1808 attempted privilege level", or "k_g invalid" errors. Issue observed on
1809 Asus P5M2/P5MT-R/RS162-E4/RX4, Intel SR1520ML/X38ML, and Sun Fire
1810 2200/4150/4450 with ELOM.
1811 nochecksumcheck - This workaround flag will tell FreeIPMI to not check
1813 the checksums returned from IPMI command responses. It works around
1814 systems that return invalid checksums due to implementation errors, but
1815 the packet is otherwise valid. Users are cautioned on the use of this
1816 option, as it removes validation of packet integrity in a number of
1817 circumstances. However, it is unlikely to be an issue in most situa‐
1818 tions. Those hitting this issue may see "connection timeout", "session
1819 timeout", or "password verification timeout" errors. On IPMI 1.5 con‐
1820 nections, the "noauthcodecheck" workaround may also needed too. Issue
1821 observed on Supermicro X9SCM-iiF, Supermicro X9DRi-F, and Supermicro
1822 X9DRFR.
1823 idzero - This workaround flag will allow empty session IDs to be
1825 accepted by the client. It works around IPMI sessions that report empty
1826 session IDs to the client. Those hitting this issue may see "session
1827 timeout" errors. Issue observed on Tyan S2882 with M3289 BMC.
1828 unexpectedauth - This workaround flag will allow unexpected non-null
1830 authcodes to be checked as though they were expected. It works around
1831 an issue when packets contain non-null authentication data when they
1832 should be null due to disabled per-message authentication. Those hit‐
1833 ting this issue may see "session timeout" errors. Issue observed on
1834 Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware.
1835 forcepermsg - This workaround flag will force per-message authentica‐
1837 tion to be used no matter what is advertised by the remote system. It
1838 works around an issue when per-message authentication is advertised as
1839 disabled on the remote system, but it is actually required for the pro‐
1840 tocol. Those hitting this issue may see "session timeout" errors.
1841 Issue observed on IBM eServer 325.
1842 endianseq - This workaround flag will flip the endian of the session
1844 sequence numbers to allow the session to continue properly. It works
1845 around IPMI 1.5 session sequence numbers that are the wrong endian.
1846 Those hitting this issue may see "session timeout" errors. Issue
1847 observed on some Sun ILOM 1.0/2.0 (depends on service processor
1848 endian).
1849 noauthcodecheck - This workaround flag will tell FreeIPMI to not check
1851 the authentication codes returned from IPMI 1.5 command responses. It
1852 works around systems that return invalid authentication codes due to
1853 hashing or implementation errors. Users are cautioned on the use of
1854 this option, as it removes an authentication check verifying the valid‐
1855 ity of a packet. However, in most organizations, this is unlikely to be
1856 a security issue. Those hitting this issue may see "connection time‐
1857 out", "session timeout", or "password verification timeout" errors.
1858 Issue observed on Xyratex FB-H8-SRAY, Intel Windmill, Quanta Winter‐
1859 fell, and Wiwynn Windmill.
1860 intel20 - This workaround flag will work around several Intel IPMI 2.0
1862 authentication issues. The issues covered include padding of usernames,
1863 and password truncation if the authentication algorithm is HMAC-
1864 MD5-128. Those hitting this issue may see "username invalid", "password
1865 invalid", or "k_g invalid" errors. Issue observed on Intel SE7520AF2
1866 with Intel Server Management Module (Professional Edition).
1867 supermicro20 - This workaround flag will work around several Supermicro
1869 IPMI 2.0 authentication issues on motherboards w/ Peppercon IPMI
1870 firmware. The issues covered include handling invalid length authenti‐
1871 cation codes. Those hitting this issue may see "password invalid"
1872 errors. Issue observed on Supermicro H8QME with SIMSO daughter card.
1873 Confirmed fixed on newerver firmware.
1874 sun20 - This workaround flag will work work around several Sun IPMI 2.0
1876 authentication issues. The issues covered include invalid lengthed hash
1877 keys, improperly hashed keys, and invalid cipher suite records. Those
1878 hitting this issue may see "password invalid" or "bmc error" errors.
1879 Issue observed on Sun Fire 4100/4200/4500 with ILOM. This workaround
1880 automatically includes the "opensesspriv" workaround.
1881 opensesspriv - This workaround flag will slightly alter FreeIPMI's IPMI
1883 2.0 connection protocol to workaround an invalid hashing algorithm used
1884 by the remote system. The privilege level sent during the Open Session
1885 stage of an IPMI 2.0 connection is used for hashing keys instead of the
1886 privilege level sent during the RAKP1 connection stage. Those hitting
1887 this issue may see "password invalid", "k_g invalid", or "bad rmcpplus
1888 status code" errors. Issue observed on Sun Fire 4100/4200/4500 with
1889 ILOM, Inventec 5441/Dell Xanadu II, Supermicro X8DTH, Supermicro X8DTG,
1890 Intel S5500WBV/Penguin Relion 700, Intel S2600JF/Appro 512X, and Quanta
1891 QSSC-S4R/Appro GB812X-CN. This workaround is automatically triggered
1892 with the "sun20" workaround.
1893 integritycheckvalue - This workaround flag will work around an invalid
1895 integrity check value during an IPMI 2.0 session establishment when
1896 using Cipher Suite ID 0. The integrity check value should be 0 length,
1897 however the remote motherboard responds with a non-empty field. Those
1898 hitting this issue may see "k_g invalid" errors. Issue observed on
1899 Supermicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin Relion
1900 700, and Intel S2600JF/Appro 512X.
1901 assumemaxsdrrecordcount - This workaround will inform SDR reading to
1903 stop reading after a known maximum numer of SDR records have been read.
1904 This will work around systems that have mis-implemented SDR reading
1905 functions that. Those hitting this issue may see "SDR record count
1906 invalid" errors. Issue observed on unspecified Inspur motherboard.
1907 No IPMI 1.5 Support - Some motherboards that support IPMI 2.0 have been
1909 found to not support IPMI 1.5. Those hitting this issue may see "ipmi
1910 2.0 unavailable" or "connection timeout" errors. This issue can be
1911 worked around by using IPMI 2.0 instead of IPMI 1.5 by specifying
1912 --driver-type=LAN_2_0. Issue observed on HP Proliant DL 145.
1913
1915 Upon successful execution, exit status is 0. On error, exit status is
1916 1.
1917 If multiple hosts are specified for communication, the exit status is 0
1919 if and only if all targets successfully execute. Otherwise the exit
1920 status is 1.
1921
1923 On older operating systems, if you input your username, password, and
1924 other potentially security relevant information on the command line,
1925 this information may be discovered by other users when using tools like
1926 the ps(1) command or looking in the /proc file system. It is generally
1927 more secure to input password information with options like the -P or
1928 -K options. Configuring security relevant information in the FreeIPMI
1929 configuration file would also be an appropriate way to hide this infor‐
1930 mation.
1931 In order to prevent brute force attacks, some BMCs will temporarily
1933 "lock up" after a number of remote authentication errors. You may need
1934 to wait awhile in order to this temporary "lock up" to pass before you
1935 may authenticate again.
1936
1938 Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
1939
1941 Copyright © 2008-2015 FreeIPMI Core Team
1942 This program is free software; you can redistribute it and/or modify it
1944 under the terms of the GNU General Public License as published by the
1945 Free Software Foundation; either version 3 of the License, or (at your
1946 option) any later version.
1947
1949 freeipmi(7), ipmi-config(8), ipmi-raw(8)
1950 http://www.gnu.org/software/freeipmi/
1952IPMI OEM version 1.5.7 2018-04-11 IPMI-OEM(8)