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