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 tigger 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 This OEM command will determine the current NIC mode as dedi‐
960 cated or
961 shared. Dedicated indicates IPMI is only available on the dedi‐
962 cated management port. Shared indicates IPMI is also available
963 on one of the primary ethernet ports. Command confirmed to work
964 on Inventec 5441/5442 (Dell Xanadu II/III).
965 set-nic-mode dedicated|shared
967 This OEM command will set the current NIC mode to dedicated or
968 shared. (See get-nic-mode above for description on dedicated
969 vs. shared mode.) This OEM command may internally reset the BMC,
970 making the BMC unusable for awhile. Command confirmed to work on
971 Inventec 5441/5442 (Dell Xanadu II/III).
972 get-mac-address
974 This command will retrieve the BMC MAC address. This is actually
975 not an OEM command, but rather the normal IPMI MAC address com‐
976 mand (identical to what is used in the ipmi-config(8) tool).
977 This command is placed here for convenience.
978 set-mac-address dedicated|shared MACADDR
980 This OEM command will set the dedicated or shared BMC MAC
981 address. (See get-nic-mode above for description on dedicated
982 vs. shared mode.) The BMC MAC address cannot be set through the
983 normal IPMI MAC address command (what is used in the ipmi-con‐
984 fig(8) tool). The MACADDR should be specified in
985 XX:XX:XX:XX:XX:XX form. A shared BMC MAC address may conflict
986 with normal communication ethernet communication on the primary
987 ethernet port. Users may wish to configuration an alternate MAC
988 address instead. After configuration of the MAC address, the BMC
989 must be reset. This may be accomplished by executing a cold-
990 reset with bmc-device(8). Command confirmed to work on Inventec
991 5441/5442 (Dell Xanadu II/III).
992 get-bmc-services
994 This OEM command will display the currently enabled BMC ser‐
995 vices. Command confirmed to work on Inventec 5441/5442 (Dell
996 Xanadu II/III).
997 set-bmc-services enable|disable all|kvm|http|ssh
999 This OEM command will enable or disable other BMC services
1000 besides IPMI. all can be specified to enable/disable all ser‐
1001 vices, kvm specifies KVM and Virtual Storage, http specifies
1002 HTTP and HTTPS, and ssh specifies both SSH and Telnet. Command
1003 confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III).
1004 get-authentication-config
1006 This OEM command will display additional OEM authentication set‐
1007 tings. (See set-authentication-config below for description on
1008 outputs.) Command confirmed to work on Inventec 5441/5442 (Dell
1009 Xanadu II/III).
1010 set-authentication-config KEY=VALUE ...
1012 This OEM command will set additional OEM authentication settings
1013 on the IPMI card. The possible keys and values are maxauthenti‐
1014 cationfailures=count, lockoutwindow=seconds, lockouttime=sec‐
1015 onds, and httpsportnumber=num. maxauthenticationfailures speci‐
1016 fies the maximum number of allowed authentication failures.
1017 lockoutwindow specifies the window of time the authentication
1018 failure count can be reached in to disable a user. lockouttime
1019 specifies the time period a user is disabled if the authentica‐
1020 tion failure count is reached. Setting 0 to any of the settings
1021 will disable the lockout feature. Each time any of these set‐
1022 tings is modified, the authentication failure count of each
1023 enabled user is reset to 0. Multiple key=value pairs may be
1024 specified. If no key=value pairs are specified, available pairs
1025 are output. Command confirmed to work on Inventec 5441/5442
1026 (Dell Xanadu II/III).
1027 get-account-status
1029 This OEM command will output the current account status of users
1030 on the BMC. This command is particularly usefor for determinin‐
1031 ing which users in the system may have been locked out via
1032 authentication failures configured via set-authentication-con‐
1033 fig. Command confirmed to work on Inventec 5441/5442 (Dell
1034 Xanadu II/III).
1035 get-dns-config
1037 This OEM command will display additional OEM DNS settings. (See
1038 set-dns-config below for description on outputs.) Command con‐
1039 firmed to work on Inventec 5441/5442 (Dell Xanadu II/III).
1040 set-dns-config KEY=VALUE ...
1042 This OEM command will set additional OEM DNS settings on the
1043 IPMI card. The possible keys and values are dnsdhcp=enable|dis‐
1044 able, dnsserver1=ipaddress, dnsserver2=ipaddress, dnsregis‐
1045 terbmc=enable|disable, dnsbmchostname=string, dnsdomainnamed‐
1046 hcp=enable|disable, and dnsdomainname=string. dnsdhcp specifies
1047 if the DNS server IP addresses should be assigned from the DHCP
1048 server. dnsserver1 and dnsserver2 specify the IP addess for
1049 server 1 and 2 respectively. These fields are read only if dnsd‐
1050 hcp and DHCP are enabled. dnsregisterbmc specifies if the BMC
1051 host name is registered via the DNS server. dnsbmchostname spec‐
1052 ifies the BMC host name. This field is read only if dnsregis‐
1053 terbmc is enabled. dnsdomainnamedhcp specifies if the DNS
1054 domainname should be assigned from the DHCP server. dnsdomain‐
1055 name specifies the DNS domain name string. This field is read
1056 only if dnsdomainnamedhcp is enabled. Multiple key=value pairs
1057 may be specified. If no key=value pairs are specified, available
1058 pairs are output. Command confirmed to work on Inventec
1059 5441/5442 (Dell Xanadu II/III).
1060 get-web-server-config
1062 This OEM command will get the current web server configuration
1063 on the IPMI card. Command confirmed to work on Inventec
1064 5441/5442 (Dell Xanadu II/III).
1065 set-web-server-config KEY=VALUE ...
1067 This OEM command will set the current web server configuration
1068 on the IPMI card. The possible keys and values are web‐
1069 server=enable|disable, webservertimeout=seconds, httpportnum‐
1070 ber=num, and httpsportnumber=num. Multiple key=value pairs may
1071 be specified. If no key=value pairs are specified, available
1072 pairs are output. Command confirmed to work on Inventec
1073 5441/5442 (Dell Xanadu II/III).
1074 get-power-management-config
1076 This OEM command will get the current power management configu‐
1077 ration on the IPMI card. Command confirmed to work on Inventec
1078 5441/5442 (Dell Xanadu II/III).
1079 set-power-management-config KEY=VALUE ...
1081 This OEM command will set the current power management configu‐
1082 ration on the IPMI card. The possible keys and values are dpnm‐
1083 powermanagement=enable|disable, powerstaggeringacrecovery=imme‐
1084 diate|auto|user, powerondelay=seconds, and maxpowerondelay=sec‐
1085 onds. dpnmpowermanagement enables or diables DPNM, Dynamic
1086 Power Node Management. For powerstaggeringacrecovery, immediate
1087 specifies no delay, auto generates a delay time between the min‐
1088 imum and maximum configured, and user uses the user defined time
1089 defined by powerondelay. powerondelay must be within the minimum
1090 and maximum power on delay times. Multiple key=value pairs may
1091 be specified. If no key=value pairs are specified, available
1092 pairs are output. Command confirmed to work on Inventec
1093 5441/5442 (Dell Xanadu II/III).
1094 get-sol-idle-timeout
1096 This OEM command will get the SOL idle timeout. Command con‐
1097 firmed to work on Inventec 5441/5442 (Dell Xanadu II/III).
1098 set-sol-idle-timeout idle-timeout
1100 This OEM command will set the SOL idle timeout. The idle-timeout
1101 is one-based, max of 65535, in 1 minute increments (e.g. 1 = 1
1102 minute), 0 or "none" will configure no timeout. Command con‐
1103 firmed to work on Inventec 5441/5442 (Dell Xanadu II/III).
1104 get-telnet-ssh-redirect-status
1106 This OEM command will get the telnet/SSH redirect status. Com‐
1107 mand confirmed to work on Inventec 5442 (Dell Xanadu III).
1108 set-telnet-ssh-redirect-status enable|disable
1110 This OEM command will enable or disable telnet/SSH redirect sta‐
1111 tus. Command confirmed to work on Inventec 5442 (Dell Xanadu
1112 III).
1113 get-board-id
1115 This OEM command can get the board ID. Command confirmed to work
1116 on Inventec 5441/5442 (Dell Xanadu II/III).
1117 set-board-id ID
1119 This OEM command can set the board ID. Command confirmed to work
1120 on Inventec 5441/5442 (Dell Xanadu II/III).
1121 get-fcb-version
1123 This OEM command can get the fan control board (FCB) version
1124 number. Command confirmed to work on Inventec 5441/5442 (Dell
1125 Xanadu II/III).
1126 set-fcb-version majorversion minorversion
1128 This OEM command can set the fan control board (FCB) version
1129 number. The majorversion and minorversion must be specified in
1130 hex. Command confirmed to work on Inventec 5441/5442 (Dell
1131 Xanadu II/III).
1132 get-sol-inactivity-timeout
1134 This OEM command will retrieve the SOL inactivity timeout. Com‐
1135 mand confirmed to work on Inventec 5441/5442 (Dell Xanadu
1136 II/III).
1137 set-sol-inactivity-timeout inactivity-timeout
1139 This OEM command will set the SOL inactivity timeout. The inac‐
1140 tivity-timeout is one-based, max of 65535, in 1 minute incre‐
1141 ments (e.g. 1 = 1 minute), 0 or "none" will configure no time‐
1142 out. Command confirmed to work on Inventec 5441/5442 (Dell
1143 Xanadu II/III).
1144 restore-to-defaults all|user|lan|sol|serial|pef
1146 This OEM command will restore certain BMC configuration sections
1147 back to default values. The command will spin until the reset is
1148 confirmed to be complete. Command confirmed to work on Inventec
1149 5442 (Dell Xanadu III). After running this command, the BMC must
1150 be reset to return it to functioning status. This may be accom‐
1151 plished by executing a cold-reset with bmc-device(8).
1152 read-eeprom at24c256n
1154 This OEM command will read the specified eeprom. Command con‐
1155 firmed to work on Inventec 5441 (Dell Xanadu II) for at24c256.
1156 clear-eeprom at24c256n
1158 This OEM command will clear the specified eeprom, overwriting
1159 all bytes with 0xFF. If the verbose option is set, progress per‐
1160 cent will be output as the clearing is being done. Command con‐
1161 firmed to work on Inventec 5441 (Dell Xanadu II) for at24c256.
1162 Quanta
1164 get-nic-mode
1166 This OEM command will determine the current NIC mode as
1167 dedicated or shared. Dedicated indicates IPMI is only
1168 available on the dedicated management port. Shared indi‐
1169 cates IPMI is also available on one of the primary ether‐
1170 net ports. Command confirmed to work on Quanta S99Q (Dell
1171 FS12-TY).
1172 set-nic-mode dedicated|shared
1174 This OEM command will set the current NIC mode to dedi‐
1175 cated or shared. (See get-nic-mode above for description
1176 on dedicated vs. shared mode.) This OEM command may
1177 internally reset the BMC, making the BMC unusable for
1178 awhile. Command confirmed to work on Quanta S99Q (Dell
1179 FS12-TY).
1180 get-bmc-services
1182 This OEM command will display the currently enabled BMC
1183 services. Command confirmed to work on Quanta S99Q (Dell
1184 FS12-TY).
1185 set-bmc-services enable|disable all|kvm|http|ssh
1187 This OEM command will enable or disable other BMC ser‐
1188 vices besides IPMI. all can be specified to enable/dis‐
1189 able all services, kvm specifies KVM and Virtual Storage,
1190 http specifies HTTP and HTTPS, and ssh specifies both SSH
1191 and Telnet. Command confirmed to work on Quanta S99Q
1192 (Dell FS12-TY).
1193 get-account-status
1195 This OEM command will output the current account status
1196 of users on the BMC. This command is particularly usefor
1197 for determinining which users in the system may have been
1198 locked out via authentication failures. Command confirmed
1199 to work on Quanta S99Q (Dell FS12-TY).
1200 get-dns-config
1202 This OEM command will display additional OEM DNS set‐
1203 tings. (See set-dns-config below for description on out‐
1204 puts.) Command confirmed to work on Quanta S99Q (Dell
1205 FS12-TY).
1206 set-dns-config KEY=VALUE ...
1208 This OEM command will set additional OEM DNS settings on
1209 the IPMI card. The possible keys and values are dnsd‐
1210 hcp=enable|disable, dnsserver1=ipaddress,
1211 dnsserver2=ipaddress, dnsregisterbmc=enable|disable, dns‐
1212 bmchostname=string, dnsdomainnamedhcp=enable|disable, and
1213 dnsdomainname=string. dnsdhcp specifies if the DNS server
1214 IP addresses should be assigned from the DHCP server.
1215 dnsserver1 and dnsserver2 specify the IP addess for
1216 server 1 and 2 respectively. These fields are read only
1217 if dnsdhcp and DHCP are enabled. dnsregisterbmc specifies
1218 if the BMC host name is registered via the DNS server.
1219 dnsbmchostname specifies the BMC host name. This field is
1220 read only if dnsregisterbmc is enabled. dnsdomainnamedhcp
1221 specifies if the DNS domainname should be assigned from
1222 the DHCP server. dnsdomainname specifies the DNS domain
1223 name string. This field is read only if dnsdomainnamedhcp
1224 is enabled. Multiple key=value pairs may be specified. If
1225 no key=value pairs are specified, available pairs are
1226 output. Command confirmed to work on Quanta S99Q (Dell
1227 FS12-TY).
1228 get-web-server-config
1230 This OEM command will get the current web server configu‐
1231 ration on the IPMI card. Command confirmed to work on
1232 Quanta S99Q (Dell FS12-TY).
1233 set-web-server-config KEY=VALUE...
1235 This OEM command will set the current web server configu‐
1236 ration on the IPMI card. The possible keys and values are
1237 webserver=enable|disable, webservertimeout=seconds, http‐
1238 portnumber=num, and httpsportnumber=num. Multiple
1239 key=value pairs may be specified. If no key=value pairs
1240 are specified, available pairs are output. Command con‐
1241 firmed to work on Quanta S99Q (Dell FS12-TY).
1242 get-power-management-config
1244 This OEM command will get the current power management
1245 configuration on the IPMI card. Command confirmed to work
1246 on Quanta S99Q (Dell FS12-TY).
1247 set-power-management-config KEY=VALUE ...
1249 This OEM command will set the current power management
1250 configuration on the IPMI card. The possible keys and
1251 values are dpnmpowermanagement=enable|disable, powerstag‐
1252 geringacrecovery=immediate|auto|user, powerondelay=sec‐
1253 onds, and maxpowerondelay=seconds. dpnmpowermanagement
1254 enables or diables DPNM, Dynamic Power Node Management.
1255 For powerstaggeringacrecovery, immediate specifies no
1256 delay, auto generates a delay time between the minimum
1257 and maximum configured, and user uses the user defined
1258 time defined by powerondelay. powerondelay must be within
1259 the minimum and maximum power on delay times. Multiple
1260 key=value pairs may be specified. If no key=value pairs
1261 are specified, available pairs are output. Command con‐
1262 firmed to work on Quanta S99Q (Dell FS12-TY).
1263 get-sol-idle-timeout
1265 This OEM command will get the SOL idle timeout. Command
1266 confirmed to work on Quanta S99Q (Dell FS12-TY).
1267 set-sol-idle-timeout idle-timeout
1269 This OEM command will set the SOL idle timeout. The
1270 idle-timeout is one-based, max of 65535, in 1 minute
1271 increments (e.g. 1 = 1 minute), 0 or "none" will config‐
1272 ure no timeout. Command confirmed to work on Quanta S99Q
1273 (Dell FS12-TY).
1274 get-telnet-ssh-redirect-status
1276 This OEM command will get the telnet/SSH redirect status.
1277 Command confirmed to work on Quanta S99Q (Dell FS12-TY).
1278 set-telnet-ssh-redirect-status enable|disable
1280 This OEM command will enable or disable telnet/SSH redi‐
1281 rect status. Command confirmed to work on Quanta S99Q
1282 (Dell FS12-TY).
1283 reset-to-defaults all|user|lan|sol|serial|pef
1285 This OEM command will reset certain BMC configuration
1286 sections back to default values. The command will spin
1287 until the reset is confirmed to be complete. Command con‐
1288 firmed to work on Quanta S99Q (Dell FS12-TY). After run‐
1289 ning this command, the BMC must be reset to return it to
1290 functioning status. This may be accomplished by executing
1291 a cold-reset with bmc-device(8).
1292 get-processor-information [processor-index]
1294 This OEM command will determine system processor informa‐
1295 tion. By default, information about each processor will
1296 be output. If a processor-index is specified, only that
1297 specific processor will be output. Command confirmed to
1298 work on Quanta S99Q (Dell FS12-TY).
1299 read-mac-address s99q dedicated|shared
1301 This command will read the currently configured dedicated
1302 or shared MAC address for a specified motherboard. It
1303 will read the MAC address directly from the BMC eeprom.
1304 Command confirmed to work on Quanta S99Q (Dell FS12-TY)
1305 for s99q.
1306 write-mac-address s99q dedicated|shared MACADDR
1308 This OEM command will set the dedicated or shared BMC MAC
1309 address for a specified motherboard. It will be written
1310 directly to the BMC eeprom. (See get-nic-mode above for
1311 description on dedicated vs. shared mode.) The BMC MAC
1312 address cannot be set through the normal IPMI MAC address
1313 command (what is used in the ipmi-config(8) tool). The
1314 MACADDR should be specified in XX:XX:XX:XX:XX:XX form. A
1315 shared BMC MAC address may conflict with normal communi‐
1316 cation ethernet communication on the primary ethernet
1317 port. Users may wish to configuration an alternate MAC
1318 address instead. After configuration of the MAC address,
1319 the BMC must be reset. This may be accomplished by exe‐
1320 cuting a cold-reset with bmc-device(8). Command con‐
1321 firmed to work on Quanta S99Q (Dell FS12-TY) for s99q.
1322 Sun
1324 get-led
1326 This OEM command will output current LED mode. off indi‐
1327 cates the LED is steady off, on indicates the LED is
1328 steady on, standby indicates the LED blinks at a 100ms
1329 on, 2900ms off rate, slow indicates the LED is blinking
1330 at 1Hz, and fast indicates the LED is blinking at 4Hz. If
1331 the verbose option is set, sensor names will be output
1332 with their entity ID and instance when appropriate. (Sim‐
1333 ilar to the --entity-sensor-names option in ipmi-sen‐
1334 sors.) This OEM command requires access to the SDR. Com‐
1335 mand confirmed to work on Sun Fire 4140 with ILOM.
1336 set-led record_id off|on|standby|slow|fast
1338 This OEM command will configure LED modes. (See get-led
1339 above for description on LED modes.) This OEM command
1340 requires access to the SDR. Command confirmed to work on
1341 Sun Fire 4140 with ILOM.
1342 Supermicro
1344 extra-firmware-info
1346 This OEM command will output additional firmware version
1347 information. Command confirmed to work on Supermicro
1348 H8QME.
1349 reset-intrusion
1351 This OEM command will reset the motherboard intrusion
1352 flag after it has been triggered. For example, in ipmi-
1353 sensors or ipmi-sel, you may notice a 'General Chassis
1354 Intrusion' if the motherboard chassis is not open, but
1355 was opened in the past. Command confirmed to work on
1356 Supermicro H8QME.
1357 get-bmc-services-status
1359 This OEM command will determine if non-IPMI services
1360 (e.g. ssh, http, https, vnc, etc.) are currently enabled
1361 or disabled on the BMC. Command confirmed to work on
1362 Supermicro X8DTG.
1363 set-bmc-services-status enable|disable
1365 This OEM command will enable or disable all non-IPMI ser‐
1366 vices on the BMC. This command can be used to enable or
1367 disable non-IPMI services such as ssh, http, https, and
1368 vnc. Command confirmed to work on Supermicro X8DTG.
1369 get-power-supply-status ps_num
1371 This OEM command will get the status of a regular power
1372 supply. Presently, it can get the status of power sup‐
1373 plies 1 through 3. Command confirmed to work on Supermi‐
1374 cro X8DTU, Supermicro X8STi, and Supermicro X9DRW.
1375 get-power-supply-status2 ps_num
1377 This OEM command will get the status of a regular power
1378 supply. Presently, it can get the status of power sup‐
1379 plies 1 and 2. Command confirmed to work on Supermicro
1380 X10DRU-i+.
1381 get-pmbus-power-supply-status ps_num
1383 This OEM command will get the status of a PMBus based
1384 power supply. Presently, it can get the status of power
1385 supplies 1 through 3. Command confirmed to work on
1386 Supermicro X8DTU, Supermicro X8STi, and Supermicro X9DRW.
1387 Wistron
1389 get-system-info KEY
1391 This OEM command can retrieve the motherboard system
1392 information. Valid keys are asset-tag, service-tag,
1393 product-name. Command confirmed to work on Wistron / Dell
1394 Poweredge C6220.
1395 get-nic-mode
1397 This OEM command will determine the current NIC mode as
1398 dedicated or shared. Dedicated indicates IPMI is only
1399 available on the dedicated management port. Shared indi‐
1400 cates IPMI is also available on one of the primary ether‐
1401 net ports. Command confirmed to work on Wistron / Dell
1402 Poweredge C6220.
1403 set-nic-mode dedicated|shared
1405 This OEM command will set the current NIC mode to dedi‐
1406 cated or shared. (See get-nic-mode above for description
1407 on dedicated vs. shared mode.) After running this com‐
1408 mand, the BMC may need to be reset to finalize the con‐
1409 figuration. This may be accomplished by executing a cold-
1410 reset with bmc-device(8). Command confirmed to work on
1411 Wistron / Dell Poweredge C6220.
1412 get-shared-nic-selection
1414 This OEM command will determine the current NIC IPMI is
1415 shared with if the mode is shared. (See get-nic-mode
1416 above for description on dedicated vs. shared mode.) Com‐
1417 mand confirmed to work on Wistron / Dell Poweredge C6220.
1418 set-shared-nic-selection nic1|nic2|nic3|nic4|clear
1420 This OEM command will set the current NIC sharing selec‐
1421 tion. If the current NIC mode is dedicated it is advis‐
1422 able to clear this setting with the clear option. Command
1423 confirmed to work on Wistron / Dell Poweredge C6220.
1424 get-bmc-services
1426 This OEM command will display the currently enabled BMC
1427 services. Command confirmed to work on Wistron / Dell
1428 Poweredge C6220.
1429 set-bmc-services enable|disable all|kvm|http|ssh|snmp|telnet
1431 This OEM command will enable or disable other BMC ser‐
1432 vices besides IPMI. all can be specified to enable/dis‐
1433 able all services, kvm specifies KVM and Virtual Storage,
1434 http specifies HTTP and HTTPS. Command confirmed to work
1435 on Wistron / Dell Poweredge C6220.
1436 get-account-status
1438 This OEM command will output the current account status
1439 of users on the BMC. This command is particularly usefor
1440 for determinining which users in the system may have been
1441 locked out via authentication failures. Command confirmed
1442 to work on Wistron / Dell Poweredge C6220.
1443 get-dns-config
1445 This OEM command will display additional OEM DNS set‐
1446 tings. (See set-dns-config below for description on out‐
1447 puts.) Command confirmed to work on Wistron / Dell Pow‐
1448 eredge C6220.
1449 set-dns-config KEY=VALUE ...
1451 This OEM command will set additional OEM DNS settings on
1452 the IPMI card. The possible keys and values are dnsd‐
1453 hcp=enable|disable, dnsserver1=ipaddress,
1454 dnsserver2=ipaddress, dnsregisterbmc=enable|disable, dns‐
1455 bmchostname=string, dnsdomainnamedhcp=enable|disable,
1456 dnsdomainname=string, and dnsregistrationdelay=seconds.
1457 dnsdhcp specifies if the DNS server IP addresses should
1458 be assigned from the DHCP server. dnsserver1 and
1459 dnsserver2 specify the IP addess for server 1 and 2
1460 respectively. These fields are read only if dnsdhcp and
1461 DHCP are enabled. dnsregisterbmc specifies if the BMC
1462 host name is registered via the DNS server. dnsbmchost‐
1463 name specifies the BMC host name. This field is read only
1464 if dnsregisterbmc is enabled. dnsdomainnamedhcp specifies
1465 if the DNS domainname should be assigned from the DHCP
1466 server. dnsdomainname specifies the DNS domain name
1467 string. This field is read only if dnsdomainnamedhcp is
1468 enabled. dnsregistrationdelay specifies the delay the BMC
1469 should take after the IPMI process is up and running.
1470 Multiple key=value pairs may be specified. If no
1471 key=value pairs are specifed, available pairs are output.
1472 Command confirmed to work on Wistron / Dell Poweredge
1473 C6220.
1474 get-web-server-config
1476 This OEM command will get the current web server configu‐
1477 ration on the IPMI card. Command confirmed to work on
1478 Wistron / Dell Poweredge C6220.
1479 set-web-server-config KEY=VALUE...
1481 This OEM command will set the current web server configu‐
1482 ration on the IPMI card. The possible keys and values are
1483 webserver=enable|disable, webservertimeout=seconds, http‐
1484 portnumber=num, and httpsportnumber=num. Multiple
1485 key=value pairs may be specified. If no key=value pairs
1486 are specifed, available pairs are output. Command con‐
1487 firmed to work on Wistron / Dell Poweredge C6220.
1488 get-power-management-config
1490 This OEM command will get the current power management
1491 configuration on the IPMI card. Command confirmed to work
1492 on Wistron / Dell Poweredge C6220.
1493 set-power-management-config KEY=VALUE ...
1495 This OEM command will set the current power management
1496 configuration on the IPMI card. The possible keys and
1497 values are powerstaggeringacrecovery=immediate|auto|user,
1498 powerondelay=seconds, and maxpowerondelay=seconds. For
1499 powerstaggeringacrecovery, immediate specifies no delay,
1500 auto generates a delay time between the minimum and maxi‐
1501 mum configured, and user uses the user defined time
1502 defined by powerondelay. powerondelay must be within the
1503 minimum and maximum power on delay times. Multiple
1504 key=value pairs may be specified. If no key=value pairs
1505 are specifed, available pairs are output. Command con‐
1506 firmed to work on Wistron / Dell Poweredge C6220.
1507 get-ipv6-settings
1509 This OEM command will get the current IPv6 settings on
1510 the IPMI card. Command confirmed to work on Wistron /
1511 Dell Poweredge C6220.
1512 set-ipv6-settings KEY=VALUE ...
1514 This OEM command will set the current IPv6 settings on
1515 the IPMI card. The possible keys and values are
1516 ipv6=enable|disable, ipv6address=ipaddress, ipv6gate‐
1517 wayaddress=ipaddress, ipv6prefixlength=length, ipv6auto‐
1518 config=enable|disable, ipv6autodns=enable|disable,
1519 ipv6dnsserver1=ipaddress, and ipv6dnsserver2=ipaddress.
1520 If no key=value pairs are specifed, available pairs are
1521 output. Some fields may be read-only on specific Pow‐
1522 eredge systems. Command confirmed to work on Wistron /
1523 Dell Poweredge C6220.
1524 get-ipv6-trap-settings
1526 This OEM command will get the current IPv6 SNMP trap set‐
1527 tings on the IPMI card. Command confirmed to work on
1528 Wistron / Dell Poweredge C6220.
1529 set-ipv6-trap-settings index KEY=VALUE ...
1531 This OEM command will set the current IPv6 SNMP trap set‐
1532 tings on the IPMI card. The index indicates the index
1533 position for the configuration. It is followed by a set
1534 of configuration keys and values. The possible keys and
1535 values are destinationtype=pet|oem1|oem2, alertacktime‐
1536 out=seconds, retries=count, and ipv6snmptrapaddress=ipad‐
1537 dress. If no key=value pairs are specifed, available
1538 pairs are output. Some fields may be read-only on spe‐
1539 cific Poweredge systems. Command confirmed to work on
1540 Wistron / Dell Poweredge C6220.
1541 get-sol-idle-timeout
1543 This OEM command will get the SOL idle timeout. Command
1544 confirmed to work on Wistron / Dell Poweredge C6220.
1545 set-sol-idle-timeout idle-timeout
1547 This OEM command will set the SOL idle timeout. The
1548 idle-timeout is one-based, max of 65535, in 1 minute
1549 increments (e.g. 1 = 1 minute), 0 or "none" will config‐
1550 ure no timeout. Command confirmed to work on Wistron /
1551 Dell Poweredge C6220.
1552 get-telnet-redirect-function
1554 This OEM command will get the telnet redirect function.
1555 Command confirmed to work on Wistron / Dell Poweredge
1556 C6220.
1557 set-telnet-redirect-function disable|solenable|smashenable
1559 This OEM command will enable or disable telnet redirect
1560 function. Command confirmed to work on Wistron / Dell
1561 Poweredge C6220.
1562 get-dhcp-retry
1564 This OEM command will retrieve DHCP retry information.
1565 Wistron / Dell Poweredge C6220.
1566 set-dhcp-retry retry-count retry-interval retry-timeout
1568 This OEM command will set DHCP retry information. The
1569 retry-count is one-based, max of 254, 0 or "none" will
1570 configure no retries, 255 or "indefinite" will configure
1571 constant retries. The retry-interval is one-based, in 10
1572 second increments (e.g. 1 = 10 seconds). The retry-time‐
1573 out is one-based, in 1 minute increments (e.g. 1 = 1
1574 minute). After running this command, the BMC may need to
1575 be reset to finalize the configuration. This may be
1576 accomplished by executing a cold-reset with bmc-
1577 device(8). Command confirmed to work on Wistron / Dell
1578 Poweredge C6220.
1579 get-link-status-change-control
1581 This OEM command will get the current link status change
1582 control. If it reports "Link Down Resilience Enabled",
1583 BMC firmware will do nothing upon detecting Link Status
1584 Change until the DHCP lease is expired. If it reports
1585 "DHCP Re-Discovery Enabled", BMC firmware will perform
1586 DHCP Discovery upon detecting link status going down than
1587 back up. Command confirmed to work on Wistron / Dell Pow‐
1588 eredge C6220..
1589 set-link-status-change-control link_resilience|dhcp_rediscovery
1591 This OEM command will set the current NIC link status
1592 change control setting. (See set-link-status-change-con‐
1593 trol above for description of arguments). After running
1594 this command, the BMC may need to be reset to finalize
1595 the configuration. This may be accomplished by executing
1596 a cold-reset with bmc-device(8). Command confirmed to
1597 work on Wistron / Dell Poweredge C6220.
1598 set-password-policy <enable|disable>
1600 This OEM command will set the current password policy
1601 enforcement. If password policy is enabled, BMC passwords
1602 must meet the following requirements: Not contain the
1603 user's name, be 8-14 characters long, and contain three
1604 of the following four, an English uppercase character (A-
1605 Z), an English lowercase character (a-z), a digit (0-9),
1606 a special character (!, $, #, %, etc.). Command confirmed
1607 to work on Wistron / Dell Poweredge C6220.
1608 read-proprietary-string
1610 This OEM command will read the proprietary string stored
1611 in the FRU. The proprietary string is a string the user
1612 may set for any management purpose. It can also be read
1613 via ipmi-fru. Command confirmed to work on Wistron /
1614 Dell Poweredge C6220.
1615 set-proprietary-string <string>
1617 This OEM command will write the proprietary string stored
1618 in the FRU. The maximum length string is 80 characters.
1619 Command confirmed to work on Wistron / Dell Poweredge
1620 C6220.
1621 clear-proprietary-string
1623 This OEM command will clear the proprietary string stored
1624 in the FRU. Command confirmed to work on Wistron / Dell
1625 Poweredge C6220.
1626
1628 Multiple hosts can be input either as an explicit comma separated lists
1629 of hosts or a range of hostnames in the general form: prefix[n-m,l-
1630 k,...], where n < m and l < k, etc. The later form should not be con‐
1631 fused with regular expression character classes (also denoted by []).
1632 For example, foo[19] does not represent foo1 or foo9, but rather repre‐
1633 sents a degenerate range: foo19.
1634 This range syntax is meant only as a convenience on clusters with a
1636 prefixNN naming convention and specification of ranges should not be
1637 considered necessary -- the list foo1,foo9 could be specified as such,
1638 or by the range foo[1,9].
1639 Some examples of range usage follow:
1641 foo[01-05] instead of foo01,foo02,foo03,foo04,foo05
1642 foo[7,9-10] instead of foo7,foo9,foo10
1643 foo[0-3] instead of foo0,foo1,foo2,foo3
1644 As a reminder to the reader, some shells will interpret brackets ([ and
1646 ]) for pattern matching. Depending on your shell, it may be necessary
1647 to enclose ranged lists within quotes.
1648 When multiple hosts are specified by the user, a thread will be exe‐
1650 cuted for each host in parallel up to the configured fanout (which can
1651 be adjusted via the -F option). This will allow communication to large
1652 numbers of nodes far more quickly than if done in serial.
1653 By default, standard output from each node specified will be output
1655 with the hostname prepended to each line. Although this output is read‐
1656 able in many situations, it may be difficult to read in other situa‐
1657 tions. For example, output from multiple nodes may be mixed together.
1658 The -B and -C options can be used to change this default.
1659 In-band IPMI Communication will be used when the host "localhost" is
1661 specified. This allows the user to add the localhost into the hos‐
1662 tranged output.
1663
1665 Most often, IPMI problems are due to configuration problems.
1666 IPMI over LAN problems involve a misconfiguration of the remote
1668 machine's BMC. Double check to make sure the following are configured
1669 properly in the remote machine's BMC: IP address, MAC address, subnet
1670 mask, username, user enablement, user privilege, password, LAN privi‐
1671 lege, LAN enablement, and allowed authentication type(s). For IPMI 2.0
1672 connections, double check to make sure the cipher suite privilege(s)
1673 and K_g key are configured properly. The ipmi-config(8) tool can be
1674 used to check and/or change these configuration settings.
1675 Inband IPMI problems are typically caused by improperly configured
1677 drivers or non-standard BMCs.
1678 In addition to the troubleshooting tips below, please see WORKAROUNDS
1680 below to also if there are any vendor specific bugs that have been dis‐
1681 covered and worked around.
1682 Listed below are many of the common issues for error messages. For
1684 additional support, please e-mail the <freeipmi-users@gnu.org> mailing
1685 list.
1686 "username invalid" - The username entered (or a NULL username if none
1688 was entered) is not available on the remote machine. It may also be
1689 possible the remote BMC's username configuration is incorrect.
1690 "password invalid" - The password entered (or a NULL password if none
1692 was entered) is not correct. It may also be possible the password for
1693 the user is not correctly configured on the remote BMC.
1694 "password verification timeout" - Password verification has timed out.
1696 A "password invalid" error (described above) or a generic "session
1697 timeout" (described below) occurred. During this point in the protocol
1698 it cannot be differentiated which occurred.
1699 "k_g invalid" - The K_g key entered (or a NULL K_g key if none was
1701 entered) is not correct. It may also be possible the K_g key is not
1702 correctly configured on the remote BMC.
1703 "privilege level insufficient" - An IPMI command requires a higher user
1705 privilege than the one authenticated with. Please try to authenticate
1706 with a higher privilege. This may require authenticating to a different
1707 user which has a higher maximum privilege.
1708 "privilege level cannot be obtained for this user" - The privilege
1710 level you are attempting to authenticate with is higher than the maxi‐
1711 mum allowed for this user. Please try again with a lower privilege. It
1712 may also be possible the maximum privilege level allowed for a user is
1713 not configured properly on the remote BMC.
1714 "authentication type unavailable for attempted privilege level" - The
1716 authentication type you wish to authenticate with is not available for
1717 this privilege level. Please try again with an alternate authentication
1718 type or alternate privilege level. It may also be possible the avail‐
1719 able authentication types you can authenticate with are not correctly
1720 configured on the remote BMC.
1721 "cipher suite id unavailable" - The cipher suite id you wish to authen‐
1723 ticate with is not available on the remote BMC. Please try again with
1724 an alternate cipher suite id. It may also be possible the available
1725 cipher suite ids are not correctly configured on the remote BMC.
1726 "ipmi 2.0 unavailable" - IPMI 2.0 was not discovered on the remote
1728 machine. Please try to use IPMI 1.5 instead.
1729 "connection timeout" - Initial IPMI communication failed. A number of
1731 potential errors are possible, including an invalid hostname specified,
1732 an IPMI IP address cannot be resolved, IPMI is not enabled on the
1733 remote server, the network connection is bad, etc. Please verify con‐
1734 figuration and connectivity.
1735 "session timeout" - The IPMI session has timed out. Please reconnect.
1737 If this error occurs often, you may wish to increase the retransmission
1738 timeout. Some remote BMCs are considerably slower than others.
1739 "device not found" - The specified device could not be found. Please
1741 check configuration or inputs and try again.
1742 "driver timeout" - Communication with the driver or device has timed
1744 out. Please try again.
1745 "message timeout" - Communication with the driver or device has timed
1747 out. Please try again.
1748 "BMC busy" - The BMC is currently busy. It may be processing informa‐
1750 tion or have too many simultaneous sessions to manage. Please wait and
1751 try again.
1752 "could not find inband device" - An inband device could not be found.
1754 Please check configuration or specify specific device or driver on the
1755 command line.
1756 "driver timeout" - The inband driver has timed out communicating to the
1758 local BMC or service processor. The BMC or service processor may be
1759 busy or (worst case) possibly non-functioning.
1760
1762 With so many different vendors implementing their own IPMI solutions,
1763 different vendors may implement their IPMI protocols incorrectly. The
1764 following describes a number of workarounds currently available to han‐
1765 dle discovered compliance issues. When possible, workarounds have been
1766 implemented so they will be transparent to the user. However, some will
1767 require the user to specify a workaround be used via the -W option.
1768 The hardware listed below may only indicate the hardware that a problem
1770 was discovered on. Newer versions of hardware may fix the problems
1771 indicated below. Similar machines from vendors may or may not exhibit
1772 the same problems. Different vendors may license their firmware from
1773 the same IPMI firmware developer, so it may be worthwhile to try work‐
1774 arounds listed below even if your motherboard is not listed.
1775 If you believe your hardware has an additional compliance issue that
1777 needs a workaround to be implemented, please contact the FreeIPMI main‐
1778 tainers on <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
1779 assumeio - This workaround flag will assume inband interfaces communi‐
1781 cate with system I/O rather than being memory-mapped. This will work
1782 around systems that report invalid base addresses. Those hitting this
1783 issue may see "device not supported" or "could not find inband device"
1784 errors. Issue observed on HP ProLiant DL145 G1.
1785 spinpoll - This workaround flag will inform some inband drivers (most
1787 notably the KCS driver) to spin while polling rather than putting the
1788 process to sleep. This may significantly improve the wall clock running
1789 time of tools because an operating system scheduler's granularity may
1790 be much larger than the time it takes to perform a single IPMI message
1791 transaction. However, by spinning, your system may be performing less
1792 useful work by not contexting out the tool for a more useful task.
1793 authcap - This workaround flag will skip early checks for username
1795 capabilities, authentication capabilities, and K_g support and allow
1796 IPMI authentication to succeed. It works around multiple issues in
1797 which the remote system does not properly report username capabilities,
1798 authentication capabilities, or K_g status. Those hitting this issue
1799 may see "username invalid", "authentication type unavailable for
1800 attempted privilege level", or "k_g invalid" errors. Issue observed on
1801 Asus P5M2/P5MT-R/RS162-E4/RX4, Intel SR1520ML/X38ML, and Sun Fire
1802 2200/4150/4450 with ELOM.
1803 nochecksumcheck - This workaround flag will tell FreeIPMI to not check
1805 the checksums returned from IPMI command responses. It works around
1806 systems that return invalid checksums due to implementation errors, but
1807 the packet is otherwise valid. Users are cautioned on the use of this
1808 option, as it removes validation of packet integrity in a number of
1809 circumstances. However, it is unlikely to be an issue in most situa‐
1810 tions. Those hitting this issue may see "connection timeout", "session
1811 timeout", or "password verification timeout" errors. On IPMI 1.5 con‐
1812 nections, the "noauthcodecheck" workaround may also needed too. Issue
1813 observed on Supermicro X9SCM-iiF, Supermicro X9DRi-F, and Supermicro
1814 X9DRFR.
1815 idzero - This workaround flag will allow empty session IDs to be
1817 accepted by the client. It works around IPMI sessions that report empty
1818 session IDs to the client. Those hitting this issue may see "session
1819 timeout" errors. Issue observed on Tyan S2882 with M3289 BMC.
1820 unexpectedauth - This workaround flag will allow unexpected non-null
1822 authcodes to be checked as though they were expected. It works around
1823 an issue when packets contain non-null authentication data when they
1824 should be null due to disabled per-message authentication. Those hit‐
1825 ting this issue may see "session timeout" errors. Issue observed on
1826 Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware.
1827 forcepermsg - This workaround flag will force per-message authentica‐
1829 tion to be used no matter what is advertised by the remote system. It
1830 works around an issue when per-message authentication is advertised as
1831 disabled on the remote system, but it is actually required for the pro‐
1832 tocol. Those hitting this issue may see "session timeout" errors.
1833 Issue observed on IBM eServer 325.
1834 endianseq - This workaround flag will flip the endian of the session
1836 sequence numbers to allow the session to continue properly. It works
1837 around IPMI 1.5 session sequence numbers that are the wrong endian.
1838 Those hitting this issue may see "session timeout" errors. Issue
1839 observed on some Sun ILOM 1.0/2.0 (depends on service processor
1840 endian).
1841 noauthcodecheck - This workaround flag will tell FreeIPMI to not check
1843 the authentication codes returned from IPMI 1.5 command responses. It
1844 works around systems that return invalid authentication codes due to
1845 hashing or implementation errors. Users are cautioned on the use of
1846 this option, as it removes an authentication check verifying the valid‐
1847 ity of a packet. However, in most organizations, this is unlikely to be
1848 a security issue. Those hitting this issue may see "connection time‐
1849 out", "session timeout", or "password verification timeout" errors.
1850 Issue observed on Xyratex FB-H8-SRAY, Intel Windmill, Quanta Winter‐
1851 fell, and Wiwynn Windmill.
1852 intel20 - This workaround flag will work around several Intel IPMI 2.0
1854 authentication issues. The issues covered include padding of usernames,
1855 and password truncation if the authentication algorithm is HMAC-
1856 MD5-128. Those hitting this issue may see "username invalid", "password
1857 invalid", or "k_g invalid" errors. Issue observed on Intel SE7520AF2
1858 with Intel Server Management Module (Professional Edition).
1859 supermicro20 - This workaround flag will work around several Supermicro
1861 IPMI 2.0 authentication issues on motherboards w/ Peppercon IPMI
1862 firmware. The issues covered include handling invalid length authenti‐
1863 cation codes. Those hitting this issue may see "password invalid"
1864 errors. Issue observed on Supermicro H8QME with SIMSO daughter card.
1865 Confirmed fixed on newerver firmware.
1866 sun20 - This workaround flag will work work around several Sun IPMI 2.0
1868 authentication issues. The issues covered include invalid lengthed hash
1869 keys, improperly hashed keys, and invalid cipher suite records. Those
1870 hitting this issue may see "password invalid" or "bmc error" errors.
1871 Issue observed on Sun Fire 4100/4200/4500 with ILOM. This workaround
1872 automatically includes the "opensesspriv" workaround.
1873 opensesspriv - This workaround flag will slightly alter FreeIPMI's IPMI
1875 2.0 connection protocol to workaround an invalid hashing algorithm used
1876 by the remote system. The privilege level sent during the Open Session
1877 stage of an IPMI 2.0 connection is used for hashing keys instead of the
1878 privilege level sent during the RAKP1 connection stage. Those hitting
1879 this issue may see "password invalid", "k_g invalid", or "bad rmcpplus
1880 status code" errors. Issue observed on Sun Fire 4100/4200/4500 with
1881 ILOM, Inventec 5441/Dell Xanadu II, Supermicro X8DTH, Supermicro X8DTG,
1882 Intel S5500WBV/Penguin Relion 700, Intel S2600JF/Appro 512X, and Quanta
1883 QSSC-S4R/Appro GB812X-CN. This workaround is automatically triggered
1884 with the "sun20" workaround.
1885 integritycheckvalue - This workaround flag will work around an invalid
1887 integrity check value during an IPMI 2.0 session establishment when
1888 using Cipher Suite ID 0. The integrity check value should be 0 length,
1889 however the remote motherboard responds with a non-empty field. Those
1890 hitting this issue may see "k_g invalid" errors. Issue observed on
1891 Supermicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin Relion
1892 700, and Intel S2600JF/Appro 512X.
1893 assumemaxsdrrecordcount - This workaround will inform SDR reading to
1895 stop reading after a known maximum numer of SDR records have been read.
1896 This will work around systems that have mis-implemented SDR reading
1897 functions that. Those hitting this issue may see "SDR record count
1898 invalid" errors. Issue observed on unspecified Inspur motherboard.
1899 No IPMI 1.5 Support - Some motherboards that support IPMI 2.0 have been
1901 found to not support IPMI 1.5. Those hitting this issue may see "ipmi
1902 2.0 unavailable" or "connection timeout" errors. This issue can be
1903 worked around by using IPMI 2.0 instead of IPMI 1.5 by specifying
1904 --driver-type=LAN_2_0. Issue observed on HP Proliant DL 145.
1905
1907 Upon successful execution, exit status is 0. On error, exit status is
1908 1.
1909 If multiple hosts are specified for communication, the exit status is 0
1911 if and only if all targets successfully execute. Otherwise the exit
1912 status is 1.
1913
1915 On older operating systems, if you input your username, password, and
1916 other potentially security relevant information on the command line,
1917 this information may be discovered by other users when using tools like
1918 the ps(1) command or looking in the /proc file system. It is generally
1919 more secure to input password information with options like the -P or
1920 -K options. Configuring security relevant information in the FreeIPMI
1921 configuration file would also be an appropriate way to hide this infor‐
1922 mation.
1923 In order to prevent brute force attacks, some BMCs will temporarily
1925 "lock up" after a number of remote authentication errors. You may need
1926 to wait awhile in order to this temporary "lock up" to pass before you
1927 may authenticate again.
1928
1930 Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
1931
1933 Copyright © 2008-2015 FreeIPMI Core Team
1934 This program is free software; you can redistribute it and/or modify it
1936 under the terms of the GNU General Public License as published by the
1937 Free Software Foundation; either version 3 of the License, or (at your
1938 option) any later version.
1939
1941 freeipmi(7), ipmi-config(8), ipmi-raw(8)
1942 http://www.gnu.org/software/freeipmi/
1944IPMI OEM version 1.6.2 2018-05-03 IPMI-OEM(8)