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