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 is‐
25 sues. 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 re‐
61 quests 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. If specifying an IPv6 address and port,
70 use the format [ADDRESS]:PORT.
71 -u USERNAME, --username=USERNAME
73 Specify the username to use when authenticating with the remote
74 host. If not specified, a null (i.e. anonymous) username is as‐
75 sumed. The required user privilege will depend on the oem com‐
76 mands executed.
77 -p PASSWORD, --password=PASSWORD
79 Specify the password to use when authenticationg with the remote
80 host. If not specified, a null password is assumed. Maximum
81 password length is 16 for IPMI 1.5 and 20 for IPMI 2.0.
82 -P, --password-prompt
84 Prompt for password to avoid possibility of listing it in
85 process lists.
86 -k K_G, --k-g=K_G
88 Specify the K_g BMC key to use when authenticating with the re‐
89 mote host for IPMI 2.0. If not specified, a null key is assumed.
90 To input the key in hexadecimal form, prefix the string with
91 '0x'. E.g., the key 'abc' can be entered with the either the
92 string 'abc' or the string '0x616263'
93 -K, --k-g-prompt
95 Prompt for k-g to avoid possibility of listing it in process
96 lists.
97 --session-timeout=MILLISECONDS
99 Specify the session timeout in milliseconds. Defaults to 20000
100 milliseconds (20 seconds) if not specified.
101 --retransmission-timeout=MILLISECONDS
103 Specify the packet retransmission timeout in milliseconds. De‐
104 faults to 1000 milliseconds (1 second) if not specified. The re‐
105 transmission timeout cannot be larger than the session timeout.
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 AD‐
162 MIN 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 --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 --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 lo‐
221 caltime varies on many factors, such as the vendor, BIOS, and operating
222 system. The following options will allow the user to adjust the inter‐
223 pretation 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) al‐
261 gorithm 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 in‐
299 formation. Valid keys are guid, asset-tag, service-tag,
300 chassis-service-tag, chassis-related-service-tag,
301 board-revision, platform-model-name, blade-slot-info,
302 system-revision, idrac-info, idrac-ipv4-url,
303 idrac-gui-webserver-control, cmc-info, cmc-ipv4-url,
304 cmc-ipv6-info, cmc-ipv6-url, mac-addresses. Command con‐
305 firmed to work on Dell Poweredge 2900, 2950, R610, R710,
306 R720, M600, M610, M610X, M910, and R905. However, indi‐
307 vidual system information options may not be readable or
308 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 in‐
318 dicates 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 de‐
328 scription 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, type=ex‐
415 tended|standard, sso=enable|disable, and certificatevali‐
416 dation=enable|disable. If no key=value pairs are speci‐
417 fied, 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 ca‐
476 pacity is enabled or disabled. Command confirmed to work
477 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 re‐
498 trieved. 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 er‐
513 ror string for it. Command confirmed to work on Dell Pow‐
514 eredge 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 ac‐
530 tion does nothing. The on, off, and status slot power ac‐
531 tions are not native and are emulated through a combina‐
532 tion 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 as‐
559 signed to iPass 1 and slots 2 and 16 will be assigned to
560 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 re‐
567 cent 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 in‐
597 terpretation of a SEL record. This command may be useful for in‐
598 terpreting Fujitsu OEM hex codes found in the SEL. A specific
599 SEL record ID must be specified. Please see ipmi-sel(8), for re‐
600 trieving SEL records. Command confirmed to work on Fujitsu RX100
601 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 get-bmc-services
621 This OEM command will display the enable/disable state of BMC
622 services besides IPMI. Command confirmed to work on GIGABYTE
623 MD90-FS0-ZB.
624 set-bmc-services enable|disable ssh|http|rpcbind|svr‐
626 loc|https|avocenkvm|wbem-http|wbem-https
627 This OEM command will enable or disable BMC services besides
628 IPMI. Command confirmed to work on GIGABYTE MD90-FS0-ZB.
629 IBM
631 get-led
633 This OEM command will get the current LED status. This
634 OEM command requires access to the SDR. Command confirmed
635 to work on IBM x3755.
636 Intel
638 get-smtp-config [channel-number]
640 This OEM command will get the current SMTP configuration
641 on the IPMI card. By default, configuration for every LAN
642 channel will be output. If a channel-number is speci‐
643 fied, only that specific channel number's configuration
644 will be output. Command confirmed to work on Intel
645 S5500WB (Penguin Computing Relion 700) and Intel S2600JF
646 (Appro 512X).
647 set-smtp-config [channel-number] KEY=VALUE...
649 This OEM command will set the current SMTP configuration
650 on the IPMI card. By default, configuration will be done
651 for all LAN channels. If a channel-number is specified,
652 only that specific channel number's configuration will be
653 configured. The possible keys and values are smtp=en‐
654 able|disable, smtpserveraddress=ipaddress, smtpuser‐
655 name=string, userpassword=string, emailaddress=string,
656 subject=string, messagecontent=string, senderemailad‐
657 dress=string, and smtphostname=string. Multiple
658 key=value pairs may be specified. If no key=value pairs
659 are specified, available pairs are output. Command con‐
660 firmed to work on Intel S5500WB (Penguin Computing Relion
661 700) and Intel S2600JF (Appro 512X).
662 get-power-restore-delay
664 This OEM command will retrieve the power on delay. The
665 power on delay is a delay that occurs whenever the BMC
666 turns on the system according to the Power Restore Policy
667 setting. It does not take effect otherwise (i.e. power
668 button or Chassis Control). Command confirmed to work on
669 Intel S2600JF (Appro 512X).
670 set-power-restore-delay seconds
672 This OEM command will set the power on delay. (See
673 get-power-restore-delay above for description on power
674 restore delay). Command confirmed to work on Intel
675 S2600JF (Appro 512X).
676 get-bmc-services
678 This OEM command will get the current status of BMC ser‐
679 vices such as ssh, http, rmcp, and kvm. Command confirmed
680 to work on Intel S2600WT2.
681 set-bmc-services enable|disable ssh|http|rmcp|kvm
683 This OEM command will enable or disable BMC services be‐
684 sides IPMI. Note that http refers to both http and
685 https. Command confirmed to work on Intel S2600WT2.
686 restore-configuration
688 This OEM command will restore BMC configuration values
689 back to default values. The command will spin until the
690 restore is confirmed to be complete. Command configured
691 to work on Intel S5500WB (Penguin Computing Relion 700)
692 and Intel S2600JF (Appro 512X). After running this com‐
693 mand, the BMC must be reset to return it to functioning
694 status. This may be accomplished by executing a cold-re‐
695 set with .B bmc-device(8).
696 IntelNM (Intel Node Manager)
698 The following OEM commands operate on Intel chipsets with Node Manager
700 support. They all require access to the SDR. They may work on multiple
701 vendors motherboards.
702 get-node-manager-statistics mode=globalpower|globaltemp|glob‐
704 althrottling|globalvolumetricairflow|globaltempairflow|glob‐
705 alchassispower|policypower|policytrigger|policythrottling|hos‐
706 tunhandledrequests|hostresponsetime|cputhrottling|memorythrot‐
707 tling|hostcommfailure [domainid=platform|cpu|memory|highpowerio]
708 [policyid=num]
709 This OEM command will output Intel Node Manager statis‐
710 tics. A mode indicating statistics to output must be
711 specified. The user may optionally specify a domainid or
712 policyid, although certain mode options may require it.
713 domainid defaults to platform. Command confirmed to work
714 on Intel S5500WB (Penguin Computing Relion 700), Inventec
715 5441/5442 (Dell Xanadu II/III), Quanta S99Q (Dell
716 FS12-TY), Quanta QSSC-S4R (Appro GB812X-CN), Supermicro
717 X9DRi-F, Intel S2600JF (Appro 512X).
718 reset-node-manager-statistics [mode=global|policy|hostunhandle‐
720 drequests|hostresponsetime|cputhrottling|memorythrottling|host‐
721 commfailure]
722 [domainid=platform|cpu|memory|highpowerio] [policyid=num]
723 This OEM command will reset Intel Node Manager statis‐
724 tics. The mode will indicate the statistics to be reset.
725 The user may optionally specify a domainid or policyid.
726 domainid defaults to platform. If a mode is not speci‐
727 fied, it will default to global or policy, depending on
728 whether or not a policyid is specified. Command confirmed
729 to work on Intel S5500WB (Penguin Computing Relion 700),
730 Inventec 5441/5442 (Dell Xanadu II/III), Quanta S99Q
731 (Dell FS12-TY), Quanta QSSC-S4R (Appro GB812X-CN), Super‐
732 micro X9DRi-F, Intel S2600JF (Appro 512X).
733 get-node-manager-capabilities [domainid=platform|cpu|mem‐
735 ory|highpowerio] [policytrigger=none|inlettemperaturelimitpoli‐
736 cytrigger|missingpowerreadingtimeout|timeafterplatformresettrig‐
737 ger|boottimepolicy] [policytype=powercontrol] [policypowerdo‐
738 main=primary|secondary]
739 This OEM command will output the current capabilities of
740 the Intel Node manager. The user may optionally specify a
741 domainid, policytrigger, policytype, or policypowerdo‐
742 main. Note that policypowerdomain is only applicabale to
743 domain id platform. If any particular option is not spec‐
744 ified, all permutations of the remaining options will be
745 used in an attempt to output all capabilities of the sys‐
746 tem. If the verbose option is set, additional error mes‐
747 sages will be output as valid policies are being searched
748 for. Command confirmed to work on Intel S2600JF (Appro
749 512X).
750 node-manager-policy-control <enable|disable> [domainid=plat‐
752 form|cpu|memory|highpowerio] [policyid=num]
753 This OEM command will enable or disable the current
754 global, domain, or policies used by the Intel Node Man‐
755 ager. If no domainid is specified, then the Node Manager
756 will be enabled or globally disabled. If a domainid is
757 specified, only that domain will be enabled or disabled.
758 If both a domainid and policyid are specified, only that
759 specific policy within the domain will be specified. This
760 OEM command will be required to enable or disable poli‐
761 cies before many of the commands below can be used for
762 configuration or use. Command confirmed to work on Intel
763 S2600JF (Appro 512X).
764 get-node-manager-policy [domainid=platform|cpu|memory|highpowe‐
766 rio] [policyid=num]
767 This OEM command will get the current node manager pol‐
768 icy. If no domainid is specified, all policies for all
769 domain IDs and policy Ids will be attempted to be output.
770 If a domainid is specified but a policyid is not, all
771 policies within a domain will be attempted to be output.
772 If the verbose option is set, additional error messages
773 will be output as valid policies are being searched for.
774 Command confirmed to work on Intel S2600JF (Appro 512X).
775 set-node-manager-policy domainid=platform|cpu|memory|highpowerio
777 policyid=num policytrigger=none|inlettemperaturelimitpolicytrig‐
778 ger|missingpowerreadingtimeout|timeafterplatformresettrig‐
779 ger|boottimepolicy policytargetlimit=num [platformbooting‐
780 mode=performance|power] correctiontimelimit=ms statisticsreport‐
781 ingperiod=seconds policystorage=persistent|volatile [policytrig‐
782 gerlimit=num] [policystate=enable|disable] [policyexceptionac‐
783 tion=alert|shutdown] [aggressivepowercorrection=automatic|notag‐
784 gressive|aggressive] [policypowerdomain=primary|secondary]
785 This OEM command will add or modify an indicated policy
786 ID from the domain ID. Most of the fields above are re‐
787 quired, although they can be listed in any order. By de‐
788 fault any created/modified policy will be enabled, how‐
789 ever this can be overridden by policystate. policyexcep‐
790 tionaction may be specified multiple times to configure
791 multiple actions or can be skipped to configure no ac‐
792 tions. When the policytrigger is configured as none, the
793 trigger that will lead to exception actions is the value
794 specified by the policytargetlimit. When the policytrig‐
795 ger is inlettemperaturelimitpolicytrigger, missingpower‐
796 readingtimeout, or timeafterplatformresettrigger, the
797 trigger that will lead to exception actions is the value
798 specified by policytriggerlimit. When the fIpolicytrig‐
799 ger is boottimepolicy, a power profile will simply be
800 maintained by the value specified by policytargetlimit.
801 aggressivepowercorrection defaults to automatic. It can
802 only be set to notaggressive or aggressive if the do‐
803 mainid is platform or cpu. policystorage determines if
804 the policy being configured can survive across resets of
805 the machine. The units of the policytargetlimit depends
806 on the policytrigger selected. If the policytrigger is
807 none, inlettemperaturelimitpolicytrigger, or timeafter‐
808 platformresettrigger, the units will be in Watts. If the
809 policytrigger is missingpowerreadingtimeout, the units
810 will be in percent, where 100 means maximum throttling.
811 If the policytrigger is boottimepolicy, the units is num‐
812 ber of CPUs. In addition, platformbootingmode must be set
813 to performance or power to indicate optimization mode.
814 policytriggerlimit is sometimes required, given the input
815 to policytrigger. The units of the policytriggerlimit
816 will depend on the policytrigger selected. If the poli‐
817 cytrigger is inlettemperaturelimitpolicytrigger, the
818 units of policytriggerlimit will be in Celsius. If the
819 policytrigger is missingpowerreadingtimeout or timeafter‐
820 platformresettrigger, the units will be in seconds. If
821 the policytrigger is none or boottimepolicy, the poli‐
822 cytriggerlimit is ignored internally by the Intel Node
823 Manager and need not be specified.. Typically configuring
824 it to 0 is more than sufficient. The correctiontimelimit
825 specifies the time the Node Manager must take corrective
826 actions to bring back the system within limits before
827 taking the actions specified in policyexceptionaction.
828 statisticsreportingperiod is the number of seconds that
829 measured power will be averaged for reporting. Please
830 see get-node-manager-policy to determine proper ranges
831 for policytargetlimit, correctiontimelimit, policytrig‐
832 gerlimit, and statisticsreportingperiod. If domainid is
833 configured as platform, user may optionally set policy‐
834 powerdomain to primary or secondary. Otherwise policy‐
835 powerdomain will be ignored. Command confirmed to work
836 on Intel S2600JF (Appro 512X).
837 remove-node-manager-policy domainid=platform|cpu|memory|highpow‐
839 erio policyid=num
840 This OEM command will remove the indicated policy ID from
841 the domain ID. Both the domainid and policyid are re‐
842 quired. Command confirmed to work on Intel S2600JF (Appro
843 512X).
844 get-node-manager-policy-alert-thresholds [domainid=plat‐
846 form|cpu|memory|highpowerio] [policyid=num]
847 This OEM command will get the current alert thresholds.
848 If no domainid is specified, all alert thresholds for do‐
849 main IDs and policy Ids will be attempted to be output.
850 If a domainid is specified but a policyid is not, all
851 alert thresholds within a domain will be attempted to be
852 output. The units of the thresholds will depend on the
853 configuration of the current policy. If the verbose op‐
854 tion is set, additional error messages will be output as
855 valid policies are being searched for. Command confirmed
856 to work on Intel S2600JF (Appro 512X).
857 set-node-manager-policy-alert-thresholds domainid=plat‐
859 form|cpu|memory|highpowerio policyid=num [threshold1=num]
860 [threshold2=num] [threshold3=num]
861 This OEM command will set the alert thresholds for a
862 given domain ID and policy ID. Up to three thresholds can
863 be specified, The units of the thresholds will depend on
864 the configuration of the current policy. Command con‐
865 firmed to work on Intel S2600JF (Appro 512X).
866 get-node-manager-policy-suspend-periods [domainid=plat‐
868 form|cpu|memory|highpowerio] [policyid=num]
869 This OEM command will get the current policy suspend pe‐
870 riods. Suspend periods will temporarily disable Intel
871 Node Manager policies at configured times. If no domainid
872 is specified, all suspend periods for domain IDs and pol‐
873 icy Ids will be attempted to be output. If a domainid is
874 specified but a policyid is not, all suspend periods
875 within a domain will be attempted to be output. If the
876 verbose option is set, additional error messages will be
877 output as valid policies are being searched for. Suspend
878 start and stop times are output in 24 hour format. Com‐
879 mand confirmed to work on Intel S2600JF (Appro 512X).
880 set-node-manager-policy-suspend-periods domainid=plat‐
882 form|cpu|memory|highpowerio policyid=num suspendperiod‐
883 start1=time suspendperiodstop1=time suspendperiodrepeat1=mon‐
884 day|tuesday|wednesday|thursday|friday|saturday|sunday ...
885 This OEM command will set the policy suspend periods for
886 a policy. Suspend periods will temporarily disable Intel
887 Node Manager policies at configured times. Up to 5 sus‐
888 pend periods can be specified by suspendperiodstartX,
889 suspendperiodstopX, suspendperiodrepeatX. suspendperiod‐
890 start and suspendperiodstop specify the start and stop
891 time since midnight for a suspend period. The time should
892 be specified in 24 hour format (i.e. 02:00 or 13:40).
893 Note that suspend periods are configured in multiples of
894 6 minutes, therefore the stored configuration may be
895 rounded to a slightly alternate configuration. suspend‐
896 periodrepeat indicates the days in which the suspend pe‐
897 riod shall be enabled. The option can be specified multi‐
898 ple times to configure multiple times. Command confirmed
899 to work on Intel S2600JF (Appro 512X).
900 set-node-manager-power-draw-range domainid=platform|cpu|mem‐
902 ory|highpowerio minpowerdrawrange=watts maxpowerdrawrange=watts
903 This OEM command will set the power draw range for a
904 given domain ID. After this configuration, any policies
905 within the domain ID that are outside of this range will
906 be disabled as needed. The current power draw range can
907 be read via the get-node-manager-capabilities above. Com‐
908 mand confirmed to work on Intel S2600JF (Appro 512X).
909 get-node-manager-alert-destination
911 This OEM command will get the current alert destination
912 information. Some of the configuration information out‐
913 put by this command will need to be correlated to BMC de‐
914 vice channel and PEF configuration. BMC device channel
915 information can be viewed via .B bmc-info(8). PEF config‐
916 uration can be viewed via ipmi-config(8). Command con‐
917 firmed to work on Intel S2600JF (Appro 512X).
918 set-node-manager-alert-destination [channelnumber=num] [slavead‐
920 dress=address] [destinationselector=num] [alertstringselec‐
921 tor=num] [sendalertstring=yes|no] [register=yes|no]
922 This OEM command will set the current alert receiver. By
923 default, this command will attempt to register an alert
924 (identical to register=yes). When registering an alert
925 receiver the channelnumber, alertstringselector, and
926 sendalertstring options must be specified. The slavead‐
927 dress or destinationselector must also be specified, de‐
928 pending on the channel number specified. If register=no,
929 most of these options are not required. Appropriate
930 channel number input can be determined via bmc-info(8).
931 Destination selector and alert string selector informa‐
932 tion can be determined via ipmi-config(8). Command con‐
933 firmed to work on Intel S2600JF (Appro 512X).
934 get-turbo-synchronization-ratio activecoresconfig=num|all [cpu‐
936 socket=num|all]
937 This OEM command will get the current Turbo Synchroniza‐
938 tion Ratio. If cpusocket is not set to a specific cpu
939 socket, all sockets will return maximum settings.
940 set-turbo-synchronization-ratio turboratiolimit=num|default
942 [cpusocket=num|all] [activecoresconfig=num|all],
943 This OEM command will set the Turbo Synchronization Ra‐
944 tio. If cpusocket is not set to a specific cpu socket, it
945 assumed to be applied to all cores. If activecore is not
946 set, it is assumed to be for all cores.
947 get-node-manager-version
949 This OEM command will output the current Intel Node Man‐
950 ager version information. Command confirmed to work on
951 Intel S5500WB (Penguin Computing Relion 700), Inventec
952 5441/5442 (Dell Xanadu II/III), Quanta S99Q (Dell
953 FS12-TY), Quanta QSSC-S4R (Appro GB812X-CN), Intel
954 S2600JF (Appro 512X).
955 Inventec
957 get-nic-mode
959 This OEM command will determine the current NIC mode as
960 dedicated or shared. Dedicated indicates IPMI is only
961 available on the dedicated management port. Shared indi‐
962 cates IPMI is also available on one of the primary ether‐
963 net ports. Command confirmed to work on Inventec
964 5441/5442 (Dell Xanadu II/III).
965 set-nic-mode dedicated|shared
967 This OEM command will set the current NIC mode to dedi‐
968 cated or shared. (See get-nic-mode above for description
969 on dedicated vs. shared mode.) This OEM command may in‐
970 ternally reset the BMC, making the BMC unusable for
971 awhile. Command confirmed to work on Inventec 5441/5442
972 (Dell Xanadu II/III).
973 get-mac-address
975 This command will retrieve the BMC MAC address. This is
976 actually not an OEM command, but rather the normal IPMI
977 MAC address command (identical to what is used in the
978 ipmi-config(8) tool). This command is placed here for
979 convenience.
980 set-mac-address dedicated|shared MACADDR
982 This OEM command will set the dedicated or shared BMC MAC
983 address. (See get-nic-mode above for description on ded‐
984 icated vs. shared mode.) The BMC MAC address cannot be
985 set through the normal IPMI MAC address command (what is
986 used in the ipmi-config(8) tool). The MACADDR should be
987 specified in XX:XX:XX:XX:XX:XX form. A shared BMC MAC ad‐
988 dress may conflict with normal communication ethernet
989 communication on the primary ethernet port. Users may
990 wish to configuration an alternate MAC address instead.
991 After configuration of the MAC address, the BMC must be
992 reset. This may be accomplished by executing a cold-reset
993 with bmc-device(8). Command confirmed to work on Inven‐
994 tec 5441/5442 (Dell Xanadu II/III).
995 get-bmc-services
997 This OEM command will display the currently enabled BMC
998 services. Command confirmed to work on Inventec
999 5441/5442 (Dell Xanadu II/III).
1000 set-bmc-services enable|disable all|kvm|http|ssh
1002 This OEM command will enable or disable other BMC ser‐
1003 vices besides IPMI. all can be specified to enable/dis‐
1004 able all services, kvm specifies KVM and Virtual Storage,
1005 http specifies HTTP and HTTPS, and ssh specifies both SSH
1006 and Telnet. Command confirmed to work on Inventec
1007 5441/5442 (Dell Xanadu II/III).
1008 get-authentication-config
1010 This OEM command will display additional OEM authentica‐
1011 tion settings. (See set-authentication-config below for
1012 description on outputs.) Command confirmed to work on In‐
1013 ventec 5441/5442 (Dell Xanadu II/III).
1014 set-authentication-config KEY=VALUE ...
1016 This OEM command will set additional OEM authentication
1017 settings on the IPMI card. The possible keys and values
1018 are maxauthenticationfailures=count, lockoutwindow=sec‐
1019 onds, lockouttime=seconds, and httpsportnumber=num. max‐
1020 authenticationfailures specifies the maximum number of
1021 allowed authentication failures. lockoutwindow specifies
1022 the window of time the authentication failure count can
1023 be reached in to disable a user. lockouttime specifies
1024 the time period a user is disabled if the authentication
1025 failure count is reached. Setting 0 to any of the set‐
1026 tings will disable the lockout feature. Each time any of
1027 these settings is modified, the authentication failure
1028 count of each enabled user is reset to 0. Multiple
1029 key=value pairs may be specified. If no key=value pairs
1030 are specified, available pairs are output. Command con‐
1031 firmed to work on Inventec 5441/5442 (Dell Xanadu
1032 II/III).
1033 get-account-status
1035 This OEM command will output the current account status
1036 of users on the BMC. This command is particularly usefor
1037 for determinining which users in the system may have been
1038 locked out via authentication failures configured via
1039 set-authentication-config. Command confirmed to work on
1040 Inventec 5441/5442 (Dell Xanadu II/III).
1041 get-dns-config
1043 This OEM command will display additional OEM DNS set‐
1044 tings. (See set-dns-config below for description on out‐
1045 puts.) Command confirmed to work on Inventec 5441/5442
1046 (Dell Xanadu II/III).
1047 set-dns-config KEY=VALUE ...
1049 This OEM command will set additional OEM DNS settings on
1050 the IPMI card. The possible keys and values are dnsd‐
1051 hcp=enable|disable, dnsserver1=ipaddress,
1052 dnsserver2=ipaddress, dnsregisterbmc=enable|disable, dns‐
1053 bmchostname=string, dnsdomainnamedhcp=enable|disable, and
1054 dnsdomainname=string. dnsdhcp specifies if the DNS server
1055 IP addresses should be assigned from the DHCP server.
1056 dnsserver1 and dnsserver2 specify the IP address for
1057 server 1 and 2 respectively. These fields are read only
1058 if dnsdhcp and DHCP are enabled. dnsregisterbmc specifies
1059 if the BMC host name is registered via the DNS server.
1060 dnsbmchostname specifies the BMC host name. This field is
1061 read only if dnsregisterbmc is enabled. dnsdomainnamedhcp
1062 specifies if the DNS domainname should be assigned from
1063 the DHCP server. dnsdomainname specifies the DNS domain
1064 name string. This field is read only if dnsdomainnamedhcp
1065 is enabled. Multiple key=value pairs may be specified. If
1066 no key=value pairs are specified, available pairs are
1067 output. Command confirmed to work on Inventec 5441/5442
1068 (Dell Xanadu II/III).
1069 get-web-server-config
1071 This OEM command will get the current web server configu‐
1072 ration on the IPMI card. Command confirmed to work on In‐
1073 ventec 5441/5442 (Dell Xanadu II/III).
1074 set-web-server-config KEY=VALUE ...
1076 This OEM command will set the current web server configu‐
1077 ration on the IPMI card. The possible keys and values are
1078 webserver=enable|disable, webservertimeout=seconds, http‐
1079 portnumber=num, and httpsportnumber=num. Multiple
1080 key=value pairs may be specified. If no key=value pairs
1081 are specified, available pairs are output. Command con‐
1082 firmed to work on Inventec 5441/5442 (Dell Xanadu
1083 II/III).
1084 get-power-management-config
1086 This OEM command will get the current power management
1087 configuration on the IPMI card. Command confirmed to work
1088 on Inventec 5441/5442 (Dell Xanadu II/III).
1089 set-power-management-config KEY=VALUE ...
1091 This OEM command will set the current power management
1092 configuration on the IPMI card. The possible keys and
1093 values are dpnmpowermanagement=enable|disable, powerstag‐
1094 geringacrecovery=immediate|auto|user, powerondelay=sec‐
1095 onds, and maxpowerondelay=seconds. dpnmpowermanagement
1096 enables or disables DPNM, Dynamic Power Node Management.
1097 For powerstaggeringacrecovery, immediate specifies no de‐
1098 lay, auto generates a delay time between the minimum and
1099 maximum configured, and user uses the user defined time
1100 defined by powerondelay. powerondelay must be within the
1101 minimum and maximum power on delay times. Multiple
1102 key=value pairs may be specified. If no key=value pairs
1103 are specified, available pairs are output. Command con‐
1104 firmed to work on Inventec 5441/5442 (Dell Xanadu
1105 II/III).
1106 get-sol-idle-timeout
1108 This OEM command will get the SOL idle timeout. Command
1109 confirmed to work on Inventec 5441/5442 (Dell Xanadu
1110 II/III).
1111 set-sol-idle-timeout idle-timeout
1113 This OEM command will set the SOL idle timeout. The
1114 idle-timeout is one-based, max of 65535, in 1 minute in‐
1115 crements (e.g. 1 = 1 minute), 0 or "none" will configure
1116 no timeout. Command confirmed to work on Inventec
1117 5441/5442 (Dell Xanadu II/III).
1118 get-telnet-ssh-redirect-status
1120 This OEM command will get the telnet/SSH redirect status.
1121 Command confirmed to work on Inventec 5442 (Dell Xanadu
1122 III).
1123 set-telnet-ssh-redirect-status enable|disable
1125 This OEM command will enable or disable telnet/SSH redi‐
1126 rect status. Command confirmed to work on Inventec 5442
1127 (Dell Xanadu III).
1128 get-board-id
1130 This OEM command can get the board ID. Command confirmed
1131 to work on Inventec 5441/5442 (Dell Xanadu II/III).
1132 set-board-id ID
1134 This OEM command can set the board ID. Command confirmed
1135 to work on Inventec 5441/5442 (Dell Xanadu II/III).
1136 get-fcb-version
1138 This OEM command can get the fan control board (FCB) ver‐
1139 sion number. Command confirmed to work on Inventec
1140 5441/5442 (Dell Xanadu II/III).
1141 set-fcb-version majorversion minorversion
1143 This OEM command can set the fan control board (FCB) ver‐
1144 sion number. The majorversion and minorversion must be
1145 specified in hex. Command confirmed to work on Inventec
1146 5441/5442 (Dell Xanadu II/III).
1147 get-sol-inactivity-timeout
1149 This OEM command will retrieve the SOL inactivity time‐
1150 out. Command confirmed to work on Inventec 5441/5442
1151 (Dell Xanadu II/III).
1152 set-sol-inactivity-timeout inactivity-timeout
1154 This OEM command will set the SOL inactivity timeout. The
1155 inactivity-timeout is one-based, max of 65535, in 1
1156 minute increments (e.g. 1 = 1 minute), 0 or "none" will
1157 configure no timeout. Command confirmed to work on In‐
1158 ventec 5441/5442 (Dell Xanadu II/III).
1159 restore-to-defaults all|user|lan|sol|serial|pef
1161 This OEM command will restore certain BMC configuration
1162 sections back to default values. The command will spin
1163 until the reset is confirmed to be complete. Command con‐
1164 firmed to work on Inventec 5442 (Dell Xanadu III). After
1165 running this command, the BMC must be reset to return it
1166 to functioning status. This may be accomplished by exe‐
1167 cuting a cold-reset with bmc-device(8).
1168 read-eeprom at24c256n
1170 This OEM command will read the specified eeprom. Command
1171 confirmed to work on Inventec 5441 (Dell Xanadu II) for
1172 at24c256.
1173 clear-eeprom at24c256n
1175 This OEM command will clear the specified eeprom, over‐
1176 writing all bytes with 0xFF. If the verbose option is
1177 set, progress percent will be output as the clearing is
1178 being done. Command confirmed to work on Inventec 5441
1179 (Dell Xanadu II) for at24c256.
1180 Quanta
1182 get-nic-mode
1184 This OEM command will determine the current NIC mode as
1185 dedicated or shared. Dedicated indicates IPMI is only
1186 available on the dedicated management port. Shared indi‐
1187 cates IPMI is also available on one of the primary ether‐
1188 net ports. Command confirmed to work on Quanta S99Q (Dell
1189 FS12-TY).
1190 set-nic-mode dedicated|shared
1192 This OEM command will set the current NIC mode to dedi‐
1193 cated or shared. (See get-nic-mode above for description
1194 on dedicated vs. shared mode.) This OEM command may in‐
1195 ternally reset the BMC, making the BMC unusable for
1196 awhile. Command confirmed to work on Quanta S99Q (Dell
1197 FS12-TY).
1198 get-bmc-services
1200 This OEM command will display the currently enabled BMC
1201 services. Command confirmed to work on Quanta S99Q (Dell
1202 FS12-TY).
1203 set-bmc-services enable|disable all|kvm|http|ssh
1205 This OEM command will enable or disable other BMC ser‐
1206 vices besides IPMI. all can be specified to enable/dis‐
1207 able all services, kvm specifies KVM and Virtual Storage,
1208 http specifies HTTP and HTTPS, and ssh specifies both SSH
1209 and Telnet. Command confirmed to work on Quanta S99Q
1210 (Dell FS12-TY).
1211 get-account-status
1213 This OEM command will output the current account status
1214 of users on the BMC. This command is particularly usefor
1215 for determinining which users in the system may have been
1216 locked out via authentication failures. Command confirmed
1217 to work on Quanta S99Q (Dell FS12-TY).
1218 get-dns-config
1220 This OEM command will display additional OEM DNS set‐
1221 tings. (See set-dns-config below for description on out‐
1222 puts.) Command confirmed to work on Quanta S99Q (Dell
1223 FS12-TY).
1224 set-dns-config KEY=VALUE ...
1226 This OEM command will set additional OEM DNS settings on
1227 the IPMI card. The possible keys and values are dnsd‐
1228 hcp=enable|disable, dnsserver1=ipaddress,
1229 dnsserver2=ipaddress, dnsregisterbmc=enable|disable, dns‐
1230 bmchostname=string, dnsdomainnamedhcp=enable|disable, and
1231 dnsdomainname=string. dnsdhcp specifies if the DNS server
1232 IP addresses should be assigned from the DHCP server.
1233 dnsserver1 and dnsserver2 specify the IP address for
1234 server 1 and 2 respectively. These fields are read only
1235 if dnsdhcp and DHCP are enabled. dnsregisterbmc specifies
1236 if the BMC host name is registered via the DNS server.
1237 dnsbmchostname specifies the BMC host name. This field is
1238 read only if dnsregisterbmc is enabled. dnsdomainnamedhcp
1239 specifies if the DNS domainname should be assigned from
1240 the DHCP server. dnsdomainname specifies the DNS domain
1241 name string. This field is read only if dnsdomainnamedhcp
1242 is enabled. Multiple key=value pairs may be specified. If
1243 no key=value pairs are specified, available pairs are
1244 output. Command confirmed to work on Quanta S99Q (Dell
1245 FS12-TY).
1246 get-web-server-config
1248 This OEM command will get the current web server configu‐
1249 ration on the IPMI card. Command confirmed to work on
1250 Quanta S99Q (Dell FS12-TY).
1251 set-web-server-config KEY=VALUE...
1253 This OEM command will set the current web server configu‐
1254 ration on the IPMI card. The possible keys and values are
1255 webserver=enable|disable, webservertimeout=seconds, http‐
1256 portnumber=num, and httpsportnumber=num. Multiple
1257 key=value pairs may be specified. If no key=value pairs
1258 are specified, available pairs are output. Command con‐
1259 firmed to work on Quanta S99Q (Dell FS12-TY).
1260 get-power-management-config
1262 This OEM command will get the current power management
1263 configuration on the IPMI card. Command confirmed to work
1264 on Quanta S99Q (Dell FS12-TY).
1265 set-power-management-config KEY=VALUE ...
1267 This OEM command will set the current power management
1268 configuration on the IPMI card. The possible keys and
1269 values are dpnmpowermanagement=enable|disable, powerstag‐
1270 geringacrecovery=immediate|auto|user, powerondelay=sec‐
1271 onds, and maxpowerondelay=seconds. dpnmpowermanagement
1272 enables or disables DPNM, Dynamic Power Node Management.
1273 For powerstaggeringacrecovery, immediate specifies no de‐
1274 lay, auto generates a delay time between the minimum and
1275 maximum configured, and user uses the user defined time
1276 defined by powerondelay. powerondelay must be within the
1277 minimum and maximum power on delay times. Multiple
1278 key=value pairs may be specified. If no key=value pairs
1279 are specified, available pairs are output. Command con‐
1280 firmed to work on Quanta S99Q (Dell FS12-TY).
1281 get-sol-idle-timeout
1283 This OEM command will get the SOL idle timeout. Command
1284 confirmed to work on Quanta S99Q (Dell FS12-TY).
1285 set-sol-idle-timeout idle-timeout
1287 This OEM command will set the SOL idle timeout. The
1288 idle-timeout is one-based, max of 65535, in 1 minute in‐
1289 crements (e.g. 1 = 1 minute), 0 or "none" will configure
1290 no timeout. Command confirmed to work on Quanta S99Q
1291 (Dell FS12-TY).
1292 get-telnet-ssh-redirect-status
1294 This OEM command will get the telnet/SSH redirect status.
1295 Command confirmed to work on Quanta S99Q (Dell FS12-TY).
1296 set-telnet-ssh-redirect-status enable|disable
1298 This OEM command will enable or disable telnet/SSH redi‐
1299 rect status. Command confirmed to work on Quanta S99Q
1300 (Dell FS12-TY).
1301 reset-to-defaults all|user|lan|sol|serial|pef
1303 This OEM command will reset certain BMC configuration
1304 sections back to default values. The command will spin
1305 until the reset is confirmed to be complete. Command con‐
1306 firmed to work on Quanta S99Q (Dell FS12-TY). After run‐
1307 ning this command, the BMC must be reset to return it to
1308 functioning status. This may be accomplished by executing
1309 a cold-reset with bmc-device(8).
1310 get-processor-information [processor-index]
1312 This OEM command will determine system processor informa‐
1313 tion. By default, information about each processor will
1314 be output. If a processor-index is specified, only that
1315 specific processor will be output. Command confirmed to
1316 work on Quanta S99Q (Dell FS12-TY).
1317 read-mac-address s99q dedicated|shared
1319 This command will read the currently configured dedicated
1320 or shared MAC address for a specified motherboard. It
1321 will read the MAC address directly from the BMC eeprom.
1322 Command confirmed to work on Quanta S99Q (Dell FS12-TY)
1323 for s99q.
1324 write-mac-address s99q dedicated|shared MACADDR
1326 This OEM command will set the dedicated or shared BMC MAC
1327 address for a specified motherboard. It will be written
1328 directly to the BMC eeprom. (See get-nic-mode above for
1329 description on dedicated vs. shared mode.) The BMC MAC
1330 address cannot be set through the normal IPMI MAC address
1331 command (what is used in the ipmi-config(8) tool). The
1332 MACADDR should be specified in XX:XX:XX:XX:XX:XX form. A
1333 shared BMC MAC address may conflict with normal communi‐
1334 cation ethernet communication on the primary ethernet
1335 port. Users may wish to configuration an alternate MAC
1336 address instead. After configuration of the MAC address,
1337 the BMC must be reset. This may be accomplished by exe‐
1338 cuting a cold-reset with bmc-device(8). Command con‐
1339 firmed to work on Quanta S99Q (Dell FS12-TY) for s99q.
1340 Sun
1342 get-led
1344 This OEM command will output current LED mode. off indi‐
1345 cates the LED is steady off, on indicates the LED is
1346 steady on, standby indicates the LED blinks at a 100ms
1347 on, 2900ms off rate, slow indicates the LED is blinking
1348 at 1Hz, and fast indicates the LED is blinking at 4Hz. If
1349 the verbose option is set, sensor names will be output
1350 with their entity ID and instance when appropriate. (Sim‐
1351 ilar to the --entity-sensor-names option in ipmi-sen‐
1352 sors.) This OEM command requires access to the SDR. Com‐
1353 mand confirmed to work on Sun Fire 4140 with ILOM.
1354 set-led record_id off|on|standby|slow|fast
1356 This OEM command will configure LED modes. (See get-led
1357 above for description on LED modes.) This OEM command re‐
1358 quires access to the SDR. Command confirmed to work on
1359 Sun Fire 4140 with ILOM.
1360 Supermicro
1362 extra-firmware-info
1364 This OEM command will output additional firmware version
1365 information. Command confirmed to work on Supermicro
1366 H8QME.
1367 reset-intrusion
1369 This OEM command will reset the motherboard intrusion
1370 flag after it has been triggered. For example, in ipmi-
1371 sensors or ipmi-sel, you may notice a 'General Chassis
1372 Intrusion' if the motherboard chassis is not open, but
1373 was opened in the past. Command confirmed to work on Su‐
1374 permicro H8QME.
1375 get-bmc-services-status
1377 This OEM command will determine if non-IPMI services
1378 (e.g. ssh, http, https, vnc, etc.) are currently enabled
1379 or disabled on the BMC. Command confirmed to work on Su‐
1380 permicro X8DTG.
1381 set-bmc-services-status enable|disable
1383 This OEM command will enable or disable all non-IPMI ser‐
1384 vices on the BMC. This command can be used to enable or
1385 disable non-IPMI services such as ssh, http, https, and
1386 vnc. Command confirmed to work on Supermicro X8DTG.
1387 get-power-supply-status ps_num
1389 This OEM command will get the status of a regular power
1390 supply. Presently, it can get the status of power sup‐
1391 plies 1 through 3. Command confirmed to work on Supermi‐
1392 cro X8DTU, Supermicro X8STi, and Supermicro X9DRW.
1393 get-power-supply-status2 ps_num
1395 This OEM command will get the status of a regular power
1396 supply. Presently, it can get the status of power sup‐
1397 plies 1 and 2. Command confirmed to work on Supermicro
1398 X10DRU-i+.
1399 get-pmbus-power-supply-status ps_num
1401 This OEM command will get the status of a PMBus based
1402 power supply. Presently, it can get the status of power
1403 supplies 1 through 3. Command confirmed to work on Su‐
1404 permicro X8DTU, Supermicro X8STi, and Supermicro X9DRW.
1405 Wistron
1407 get-system-info KEY
1409 This OEM command can retrieve the motherboard system in‐
1410 formation. Valid keys are asset-tag, service-tag, prod‐
1411 uct-name. Command confirmed to work on Wistron / Dell
1412 Poweredge C6220.
1413 get-nic-mode
1415 This OEM command will determine the current NIC mode as
1416 dedicated or shared. Dedicated indicates IPMI is only
1417 available on the dedicated management port. Shared indi‐
1418 cates IPMI is also available on one of the primary ether‐
1419 net ports. Command confirmed to work on Wistron / Dell
1420 Poweredge C6220.
1421 set-nic-mode dedicated|shared
1423 This OEM command will set the current NIC mode to dedi‐
1424 cated or shared. (See get-nic-mode above for description
1425 on dedicated vs. shared mode.) After running this com‐
1426 mand, the BMC may need to be reset to finalize the con‐
1427 figuration. This may be accomplished by executing a cold-
1428 reset with bmc-device(8). Command confirmed to work on
1429 Wistron / Dell Poweredge C6220.
1430 get-shared-nic-selection
1432 This OEM command will determine the current NIC IPMI is
1433 shared with if the mode is shared. (See get-nic-mode
1434 above for description on dedicated vs. shared mode.) Com‐
1435 mand confirmed to work on Wistron / Dell Poweredge C6220.
1436 set-shared-nic-selection nic1|nic2|nic3|nic4|clear
1438 This OEM command will set the current NIC sharing selec‐
1439 tion. If the current NIC mode is dedicated it is advis‐
1440 able to clear this setting with the clear option. Command
1441 confirmed to work on Wistron / Dell Poweredge C6220.
1442 get-bmc-services
1444 This OEM command will display the currently enabled BMC
1445 services. Command confirmed to work on Wistron / Dell
1446 Poweredge C6220.
1447 set-bmc-services enable|disable all|kvm|http|ssh|snmp|telnet
1449 This OEM command will enable or disable other BMC ser‐
1450 vices besides IPMI. all can be specified to enable/dis‐
1451 able all services, kvm specifies KVM and Virtual Storage,
1452 http specifies HTTP and HTTPS. Command confirmed to work
1453 on Wistron / Dell Poweredge C6220.
1454 get-account-status
1456 This OEM command will output the current account status
1457 of users on the BMC. This command is particularly usefor
1458 for determinining which users in the system may have been
1459 locked out via authentication failures. Command confirmed
1460 to work on Wistron / Dell Poweredge C6220.
1461 get-dns-config
1463 This OEM command will display additional OEM DNS set‐
1464 tings. (See set-dns-config below for description on out‐
1465 puts.) Command confirmed to work on Wistron / Dell Pow‐
1466 eredge C6220.
1467 set-dns-config KEY=VALUE ...
1469 This OEM command will set additional OEM DNS settings on
1470 the IPMI card. The possible keys and values are dnsd‐
1471 hcp=enable|disable, dnsserver1=ipaddress,
1472 dnsserver2=ipaddress, dnsregisterbmc=enable|disable, dns‐
1473 bmchostname=string, dnsdomainnamedhcp=enable|disable,
1474 dnsdomainname=string, and dnsregistrationdelay=seconds.
1475 dnsdhcp specifies if the DNS server IP addresses should
1476 be assigned from the DHCP server. dnsserver1 and
1477 dnsserver2 specify the IP address for server 1 and 2 re‐
1478 spectively. These fields are read only if dnsdhcp and
1479 DHCP are enabled. dnsregisterbmc specifies if the BMC
1480 host name is registered via the DNS server. dnsbmchost‐
1481 name specifies the BMC host name. This field is read only
1482 if dnsregisterbmc is enabled. dnsdomainnamedhcp specifies
1483 if the DNS domainname should be assigned from the DHCP
1484 server. dnsdomainname specifies the DNS domain name
1485 string. This field is read only if dnsdomainnamedhcp is
1486 enabled. dnsregistrationdelay specifies the delay the BMC
1487 should take after the IPMI process is up and running.
1488 Multiple key=value pairs may be specified. If no
1489 key=value pairs are specified, available pairs are out‐
1490 put. Command confirmed to work on Wistron / Dell Pow‐
1491 eredge C6220.
1492 get-web-server-config
1494 This OEM command will get the current web server configu‐
1495 ration on the IPMI card. Command confirmed to work on
1496 Wistron / Dell Poweredge C6220.
1497 set-web-server-config KEY=VALUE...
1499 This OEM command will set the current web server configu‐
1500 ration on the IPMI card. The possible keys and values are
1501 webserver=enable|disable, webservertimeout=seconds, http‐
1502 portnumber=num, and httpsportnumber=num. Multiple
1503 key=value pairs may be specified. If no key=value pairs
1504 are specified, available pairs are output. Command con‐
1505 firmed to work on Wistron / Dell Poweredge C6220.
1506 get-power-management-config
1508 This OEM command will get the current power management
1509 configuration on the IPMI card. Command confirmed to work
1510 on Wistron / Dell Poweredge C6220.
1511 set-power-management-config KEY=VALUE ...
1513 This OEM command will set the current power management
1514 configuration on the IPMI card. The possible keys and
1515 values are powerstaggeringacrecovery=immediate|auto|user,
1516 powerondelay=seconds, and maxpowerondelay=seconds. For
1517 powerstaggeringacrecovery, immediate specifies no delay,
1518 auto generates a delay time between the minimum and maxi‐
1519 mum configured, and user uses the user defined time de‐
1520 fined by powerondelay. powerondelay must be within the
1521 minimum and maximum power on delay times. Multiple
1522 key=value pairs may be specified. If no key=value pairs
1523 are specified, available pairs are output. Command con‐
1524 firmed to work on Wistron / Dell Poweredge C6220.
1525 get-ipv6-settings
1527 This OEM command will get the current IPv6 settings on
1528 the IPMI card. Command confirmed to work on Wistron /
1529 Dell Poweredge C6220.
1530 set-ipv6-settings KEY=VALUE ...
1532 This OEM command will set the current IPv6 settings on
1533 the IPMI card. The possible keys and values are ipv6=en‐
1534 able|disable, ipv6address=ipaddress, ipv6gatewayad‐
1535 dress=ipaddress, ipv6prefixlength=length, ipv6autocon‐
1536 fig=enable|disable, ipv6autodns=enable|disable,
1537 ipv6dnsserver1=ipaddress, and ipv6dnsserver2=ipaddress.
1538 If no key=value pairs are specified, available pairs are
1539 output. Some fields may be read-only on specific Pow‐
1540 eredge systems. Command confirmed to work on Wistron /
1541 Dell Poweredge C6220.
1542 get-ipv6-trap-settings
1544 This OEM command will get the current IPv6 SNMP trap set‐
1545 tings on the IPMI card. Command confirmed to work on
1546 Wistron / Dell Poweredge C6220.
1547 set-ipv6-trap-settings index KEY=VALUE ...
1549 This OEM command will set the current IPv6 SNMP trap set‐
1550 tings on the IPMI card. The index indicates the index po‐
1551 sition for the configuration. It is followed by a set of
1552 configuration keys and values. The possible keys and val‐
1553 ues are destinationtype=pet|oem1|oem2, alertacktime‐
1554 out=seconds, retries=count, and ipv6snmptrapaddress=ipad‐
1555 dress. If no key=value pairs are specified, available
1556 pairs are output. Some fields may be read-only on spe‐
1557 cific Poweredge systems. Command confirmed to work on
1558 Wistron / Dell Poweredge C6220.
1559 get-sol-idle-timeout
1561 This OEM command will get the SOL idle timeout. Command
1562 confirmed to work on Wistron / Dell Poweredge C6220.
1563 set-sol-idle-timeout idle-timeout
1565 This OEM command will set the SOL idle timeout. The
1566 idle-timeout is one-based, max of 65535, in 1 minute in‐
1567 crements (e.g. 1 = 1 minute), 0 or "none" will configure
1568 no timeout. Command confirmed to work on Wistron / Dell
1569 Poweredge C6220.
1570 get-telnet-redirect-function
1572 This OEM command will get the telnet redirect function.
1573 Command confirmed to work on Wistron / Dell Poweredge
1574 C6220.
1575 set-telnet-redirect-function disable|solenable|smashenable
1577 This OEM command will enable or disable telnet redirect
1578 function. Command confirmed to work on Wistron / Dell
1579 Poweredge C6220.
1580 get-dhcp-retry
1582 This OEM command will retrieve DHCP retry information.
1583 Wistron / Dell Poweredge C6220.
1584 set-dhcp-retry retry-count retry-interval retry-timeout
1586 This OEM command will set DHCP retry information. The
1587 retry-count is one-based, max of 254, 0 or "none" will
1588 configure no retries, 255 or "indefinite" will configure
1589 constant retries. The retry-interval is one-based, in 10
1590 second increments (e.g. 1 = 10 seconds). The retry-time‐
1591 out is one-based, in 1 minute increments (e.g. 1 = 1
1592 minute). After running this command, the BMC may need to
1593 be reset to finalize the configuration. This may be ac‐
1594 complished by executing a cold-reset with bmc-device(8).
1595 Command confirmed to work on Wistron / Dell Poweredge
1596 C6220.
1597 get-link-status-change-control
1599 This OEM command will get the current link status change
1600 control. If it reports "Link Down Resilience Enabled",
1601 BMC firmware will do nothing upon detecting Link Status
1602 Change until the DHCP lease is expired. If it reports
1603 "DHCP Re-Discovery Enabled", BMC firmware will perform
1604 DHCP Discovery upon detecting link status going down than
1605 back up. Command confirmed to work on Wistron / Dell Pow‐
1606 eredge C6220..
1607 set-link-status-change-control link_resilience|dhcp_rediscovery
1609 This OEM command will set the current NIC link status
1610 change control setting. (See set-link-status-change-con‐
1611 trol above for description of arguments). After running
1612 this command, the BMC may need to be reset to finalize
1613 the configuration. This may be accomplished by executing
1614 a cold-reset with bmc-device(8). Command confirmed to
1615 work on Wistron / Dell Poweredge C6220.
1616 set-password-policy <enable|disable>
1618 This OEM command will set the current password policy en‐
1619 forcement. If password policy is enabled, BMC passwords
1620 must meet the following requirements: Not contain the
1621 user's name, be 8-14 characters long, and contain three
1622 of the following four, an English uppercase character (A-
1623 Z), an English lowercase character (a-z), a digit (0-9),
1624 a special character (!, $, #, %, etc.). Command confirmed
1625 to work on Wistron / Dell Poweredge C6220.
1626 read-proprietary-string
1628 This OEM command will read the proprietary string stored
1629 in the FRU. The proprietary string is a string the user
1630 may set for any management purpose. It can also be read
1631 via ipmi-fru. Command confirmed to work on Wistron /
1632 Dell Poweredge C6220.
1633 set-proprietary-string <string>
1635 This OEM command will write the proprietary string stored
1636 in the FRU. The maximum length string is 80 characters.
1637 Command confirmed to work on Wistron / Dell Poweredge
1638 C6220.
1639 clear-proprietary-string
1641 This OEM command will clear the proprietary string stored
1642 in the FRU. Command confirmed to work on Wistron / Dell
1643 Poweredge C6220.
1644
1646 Multiple hosts can be input either as an explicit comma separated lists
1647 of hosts or a range of hostnames in the general form: prefix[n-m,l-
1648 k,...], where n < m and l < k, etc. The later form should not be con‐
1649 fused with regular expression character classes (also denoted by []).
1650 For example, foo[19] does not represent foo1 or foo9, but rather repre‐
1651 sents a degenerate range: foo19.
1652 This range syntax is meant only as a convenience on clusters with a
1654 prefixNN naming convention and specification of ranges should not be
1655 considered necessary -- the list foo1,foo9 could be specified as such,
1656 or by the range foo[1,9].
1657 Some examples of range usage follow:
1659 foo[01-05] instead of foo01,foo02,foo03,foo04,foo05
1660 foo[7,9-10] instead of foo7,foo9,foo10
1661 foo[0-3] instead of foo0,foo1,foo2,foo3
1662 As a reminder to the reader, some shells will interpret brackets ([ and
1664 ]) for pattern matching. Depending on your shell, it may be necessary
1665 to enclose ranged lists within quotes.
1666 When multiple hosts are specified by the user, a thread will be exe‐
1668 cuted for each host in parallel up to the configured fanout (which can
1669 be adjusted via the -F option). This will allow communication to large
1670 numbers of nodes far more quickly than if done in serial.
1671 By default, standard output from each node specified will be output
1673 with the hostname prepended to each line. Although this output is read‐
1674 able in many situations, it may be difficult to read in other situa‐
1675 tions. For example, output from multiple nodes may be mixed together.
1676 The -B and -C options can be used to change this default.
1677 In-band IPMI Communication will be used when the host "localhost" is
1679 specified. This allows the user to add the localhost into the hos‐
1680 tranged output.
1681
1683 Most often, IPMI problems are due to configuration problems.
1684 IPMI over LAN problems involve a misconfiguration of the remote ma‐
1686 chine's BMC. Double check to make sure the following are configured
1687 properly in the remote machine's BMC: IP address, MAC address, subnet
1688 mask, username, user enablement, user privilege, password, LAN privi‐
1689 lege, LAN enablement, and allowed authentication type(s). For IPMI 2.0
1690 connections, double check to make sure the cipher suite privilege(s)
1691 and K_g key are configured properly. The ipmi-config(8) tool can be
1692 used to check and/or change these configuration settings.
1693 Inband IPMI problems are typically caused by improperly configured
1695 drivers or non-standard BMCs.
1696 In addition to the troubleshooting tips below, please see WORKAROUNDS
1698 below to also if there are any vendor specific bugs that have been dis‐
1699 covered and worked around.
1700 Listed below are many of the common issues for error messages. For ad‐
1702 ditional support, please e-mail the <freeipmi-users@gnu.org> mailing
1703 list.
1704 "username invalid" - The username entered (or a NULL username if none
1706 was entered) is not available on the remote machine. It may also be
1707 possible the remote BMC's username configuration is incorrect.
1708 "password invalid" - The password entered (or a NULL password if none
1710 was entered) is not correct. It may also be possible the password for
1711 the user is not correctly configured on the remote BMC.
1712 "password verification timeout" - Password verification has timed out.
1714 A "password invalid" error (described above) or a generic "session
1715 timeout" (described below) occurred. During this point in the protocol
1716 it cannot be differentiated which occurred.
1717 "k_g invalid" - The K_g key entered (or a NULL K_g key if none was en‐
1719 tered) is not correct. It may also be possible the K_g key is not cor‐
1720 rectly configured on the remote BMC.
1721 "privilege level insufficient" - An IPMI command requires a higher user
1723 privilege than the one authenticated with. Please try to authenticate
1724 with a higher privilege. This may require authenticating to a different
1725 user which has a higher maximum privilege.
1726 "privilege level cannot be obtained for this user" - The privilege
1728 level you are attempting to authenticate with is higher than the maxi‐
1729 mum allowed for this user. Please try again with a lower privilege. It
1730 may also be possible the maximum privilege level allowed for a user is
1731 not configured properly on the remote BMC.
1732 "authentication type unavailable for attempted privilege level" - The
1734 authentication type you wish to authenticate with is not available for
1735 this privilege level. Please try again with an alternate authentication
1736 type or alternate privilege level. It may also be possible the avail‐
1737 able authentication types you can authenticate with are not correctly
1738 configured on the remote BMC.
1739 "cipher suite id unavailable" - The cipher suite id you wish to authen‐
1741 ticate with is not available on the remote BMC. Please try again with
1742 an alternate cipher suite id. It may also be possible the available ci‐
1743 pher suite ids are not correctly configured on the remote BMC.
1744 "ipmi 2.0 unavailable" - IPMI 2.0 was not discovered on the remote ma‐
1746 chine. Please try to use IPMI 1.5 instead.
1747 "connection timeout" - Initial IPMI communication failed. A number of
1749 potential errors are possible, including an invalid hostname specified,
1750 an IPMI IP address cannot be resolved, IPMI is not enabled on the re‐
1751 mote server, the network connection is bad, etc. Please verify configu‐
1752 ration and connectivity.
1753 "session timeout" - The IPMI session has timed out. Please reconnect.
1755 If this error occurs often, you may wish to increase the retransmission
1756 timeout. Some remote BMCs are considerably slower than others.
1757 "device not found" - The specified device could not be found. Please
1759 check configuration or inputs and try again.
1760 "driver timeout" - Communication with the driver or device has timed
1762 out. Please try again.
1763 "message timeout" - Communication with the driver or device has timed
1765 out. Please try again.
1766 "BMC busy" - The BMC is currently busy. It may be processing informa‐
1768 tion or have too many simultaneous sessions to manage. Please wait and
1769 try again.
1770 "could not find inband device" - An inband device could not be found.
1772 Please check configuration or specify specific device or driver on the
1773 command line.
1774 "driver timeout" - The inband driver has timed out communicating to the
1776 local BMC or service processor. The BMC or service processor may be
1777 busy or (worst case) possibly non-functioning.
1778
1780 With so many different vendors implementing their own IPMI solutions,
1781 different vendors may implement their IPMI protocols incorrectly. The
1782 following describes a number of workarounds currently available to han‐
1783 dle discovered compliance issues. When possible, workarounds have been
1784 implemented so they will be transparent to the user. However, some will
1785 require the user to specify a workaround be used via the -W option.
1786 The hardware listed below may only indicate the hardware that a problem
1788 was discovered on. Newer versions of hardware may fix the problems in‐
1789 dicated below. Similar machines from vendors may or may not exhibit the
1790 same problems. Different vendors may license their firmware from the
1791 same IPMI firmware developer, so it may be worthwhile to try work‐
1792 arounds listed below even if your motherboard is not listed.
1793 If you believe your hardware has an additional compliance issue that
1795 needs a workaround to be implemented, please contact the FreeIPMI main‐
1796 tainers on <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
1797 assumeio - This workaround flag will assume inband interfaces communi‐
1799 cate with system I/O rather than being memory-mapped. This will work
1800 around systems that report invalid base addresses. Those hitting this
1801 issue may see "device not supported" or "could not find inband device"
1802 errors. Issue observed on HP ProLiant DL145 G1.
1803 spinpoll - This workaround flag will inform some inband drivers (most
1805 notably the KCS driver) to spin while polling rather than putting the
1806 process to sleep. This may significantly improve the wall clock running
1807 time of tools because an operating system scheduler's granularity may
1808 be much larger than the time it takes to perform a single IPMI message
1809 transaction. However, by spinning, your system may be performing less
1810 useful work by not contexting out the tool for a more useful task.
1811 authcap - This workaround flag will skip early checks for username ca‐
1813 pabilities, authentication capabilities, and K_g support and allow IPMI
1814 authentication to succeed. It works around multiple issues in which the
1815 remote system does not properly report username capabilities, authenti‐
1816 cation capabilities, or K_g status. Those hitting this issue may see
1817 "username invalid", "authentication type unavailable for attempted
1818 privilege level", or "k_g invalid" errors. Issue observed on Asus
1819 P5M2/P5MT-R/RS162-E4/RX4, Intel SR1520ML/X38ML, and Sun Fire
1820 2200/4150/4450 with ELOM.
1821 nochecksumcheck - This workaround flag will tell FreeIPMI to not check
1823 the checksums returned from IPMI command responses. It works around
1824 systems that return invalid checksums due to implementation errors, but
1825 the packet is otherwise valid. Users are cautioned on the use of this
1826 option, as it removes validation of packet integrity in a number of
1827 circumstances. However, it is unlikely to be an issue in most situa‐
1828 tions. Those hitting this issue may see "connection timeout", "session
1829 timeout", or "password verification timeout" errors. On IPMI 1.5 con‐
1830 nections, the "noauthcodecheck" workaround may also needed too. Issue
1831 observed on Supermicro X9SCM-iiF, Supermicro X9DRi-F, and Supermicro
1832 X9DRFR.
1833 idzero - This workaround flag will allow empty session IDs to be ac‐
1835 cepted by the client. It works around IPMI sessions that report empty
1836 session IDs to the client. Those hitting this issue may see "session
1837 timeout" errors. Issue observed on Tyan S2882 with M3289 BMC.
1838 unexpectedauth - This workaround flag will allow unexpected non-null
1840 authcodes to be checked as though they were expected. It works around
1841 an issue when packets contain non-null authentication data when they
1842 should be null due to disabled per-message authentication. Those hit‐
1843 ting this issue may see "session timeout" errors. Issue observed on
1844 Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware.
1845 forcepermsg - This workaround flag will force per-message authentica‐
1847 tion to be used no matter what is advertised by the remote system. It
1848 works around an issue when per-message authentication is advertised as
1849 disabled on the remote system, but it is actually required for the pro‐
1850 tocol. Those hitting this issue may see "session timeout" errors. Is‐
1851 sue observed on IBM eServer 325.
1852 endianseq - This workaround flag will flip the endian of the session
1854 sequence numbers to allow the session to continue properly. It works
1855 around IPMI 1.5 session sequence numbers that are the wrong endian.
1856 Those hitting this issue may see "session timeout" errors. Issue ob‐
1857 served on some Sun ILOM 1.0/2.0 (depends on service processor endian).
1858 noauthcodecheck - This workaround flag will tell FreeIPMI to not check
1860 the authentication codes returned from IPMI 1.5 command responses. It
1861 works around systems that return invalid authentication codes due to
1862 hashing or implementation errors. Users are cautioned on the use of
1863 this option, as it removes an authentication check verifying the valid‐
1864 ity of a packet. However, in most organizations, this is unlikely to be
1865 a security issue. Those hitting this issue may see "connection time‐
1866 out", "session timeout", or "password verification timeout" errors.
1867 Issue observed on Xyratex FB-H8-SRAY, Intel Windmill, Quanta Winter‐
1868 fell, and Wiwynn Windmill.
1869 intel20 - This workaround flag will work around several Intel IPMI 2.0
1871 authentication issues. The issues covered include padding of usernames,
1872 and password truncation if the authentication algorithm is HMAC-
1873 MD5-128. Those hitting this issue may see "username invalid", "password
1874 invalid", or "k_g invalid" errors. Issue observed on Intel SE7520AF2
1875 with Intel Server Management Module (Professional Edition).
1876 supermicro20 - This workaround flag will work around several Supermicro
1878 IPMI 2.0 authentication issues on motherboards w/ Peppercon IPMI
1879 firmware. The issues covered include handling invalid length authenti‐
1880 cation codes. Those hitting this issue may see "password invalid" er‐
1881 rors. Issue observed on Supermicro H8QME with SIMSO daughter card.
1882 Confirmed fixed on newerver firmware.
1883 sun20 - This workaround flag will work work around several Sun IPMI 2.0
1885 authentication issues. The issues covered include invalid lengthed hash
1886 keys, improperly hashed keys, and invalid cipher suite records. Those
1887 hitting this issue may see "password invalid" or "bmc error" errors.
1888 Issue observed on Sun Fire 4100/4200/4500 with ILOM. This workaround
1889 automatically includes the "opensesspriv" workaround.
1890 opensesspriv - This workaround flag will slightly alter FreeIPMI's IPMI
1892 2.0 connection protocol to workaround an invalid hashing algorithm used
1893 by the remote system. The privilege level sent during the Open Session
1894 stage of an IPMI 2.0 connection is used for hashing keys instead of the
1895 privilege level sent during the RAKP1 connection stage. Those hitting
1896 this issue may see "password invalid", "k_g invalid", or "bad rmcpplus
1897 status code" errors. Issue observed on Sun Fire 4100/4200/4500 with
1898 ILOM, Inventec 5441/Dell Xanadu II, Supermicro X8DTH, Supermicro X8DTG,
1899 Intel S5500WBV/Penguin Relion 700, Intel S2600JF/Appro 512X, Quanta
1900 QSSC-S4R/Appro GB812X-CN, and Dell C5220. This workaround is automati‐
1901 cally triggered with the "sun20" workaround.
1902 integritycheckvalue - This workaround flag will work around an invalid
1904 integrity check value during an IPMI 2.0 session establishment when us‐
1905 ing Cipher Suite ID 0. The integrity check value should be 0 length,
1906 however the remote motherboard responds with a non-empty field. Those
1907 hitting this issue may see "k_g invalid" errors. Issue observed on Su‐
1908 permicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin Relion
1909 700, and Intel S2600JF/Appro 512X.
1910 assumemaxsdrrecordcount - This workaround will inform SDR reading to
1912 stop reading after a known maximum number of SDR records have been
1913 read. This will work around systems that have mis-implemented SDR read‐
1914 ing functions. Those hitting this issue may see "SDR record count in‐
1915 valid" errors. Issue observed on unspecified Inspur motherboard.
1916 No IPMI 1.5 Support - Some motherboards that support IPMI 2.0 have been
1918 found to not support IPMI 1.5. Those hitting this issue may see "ipmi
1919 2.0 unavailable" or "connection timeout" errors. This issue can be
1920 worked around by using IPMI 2.0 instead of IPMI 1.5 by specifying
1921 --driver-type=LAN_2_0. Issue observed on a number of HP and Supermicro
1922 motherboards.
1923
1925 Upon successful execution, exit status is 0. On error, exit status is
1926 1.
1927 If multiple hosts are specified for communication, the exit status is 0
1929 if and only if all targets successfully execute. Otherwise the exit
1930 status is 1.
1931
1933 On older operating systems, if you input your username, password, and
1934 other potentially security relevant information on the command line,
1935 this information may be discovered by other users when using tools like
1936 the ps(1) command or looking in the /proc file system. It is generally
1937 more secure to input password information with options like the -P or
1938 -K options. Configuring security relevant information in the FreeIPMI
1939 configuration file would also be an appropriate way to hide this infor‐
1940 mation.
1941 In order to prevent brute force attacks, some BMCs will temporarily
1943 "lock up" after a number of remote authentication errors. You may need
1944 to wait awhile in order to this temporary "lock up" to pass before you
1945 may authenticate again.
1946
1948 Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
1949
1951 Copyright © 2008-2015 FreeIPMI Core Team
1952 This program is free software; you can redistribute it and/or modify it
1954 under the terms of the GNU General Public License as published by the
1955 Free Software Foundation; either version 3 of the License, or (at your
1956 option) any later version.
1957
1959 freeipmi(7), ipmi-config(8), ipmi-raw(8)
1960 http://www.gnu.org/software/freeipmi/
1962IPMI OEM version 1.6.8 2021-05-20 IPMI-OEM(8)