IPMI-OEM(8)
💖 IPMI-OEM(8) — System Commands — ipmi-oem 💖
okay so bestie, this is the manual for ipmi-oem, the IPMI OEM utility, and it's giving “OEM-specific IPMI commands but make it a usable interface” energy. ✨ Manual name? IPMI-OEM(8). System Commands? yes bestie. Main character utility? also yes. 💅
🎀 NAME 🎀
ipmi-oem — IPMI OEM utility. That's the name, that's the vibe, no cap. 🫶
✨ SYNOPSIS ✨
ipmi-oem [OPTION...] <OEMID> <OEMCOMMAND> [OEMOPTION...]🌸 DESCRIPTION 🌸
ipmi-oem is used to execute OEM specific IPMI commands. It is intended to provide a better user interface for OEM specific IPMI commands rather than using ipmi-raw(8). Please see SUPPORTED OEM IDS and COMMANDS below for a list of supported OEM specific IPMI commands. A list of supported OEM specific commands may also be generated using the --list option. 💖
There are no guarantees that the below OEM commands will work on any particular motherboard. OEM extensions may or may not exist on particular hardware revisions and/or firmware revisions of motherboards. The extensions may or may not function for other lines of motherboards from the same manufacturer. fr fr, motherboard lore is complicated. 😭
Listed below are general IPMI options, tool specific options, trouble shooting information, workaround information, examples, and known issues. For a general introduction to FreeIPMI please see freeipmi(7). 🌈
⚙️ GENERAL OPTIONS ⚙️
The following options are general options for configuring IPMI communication and executing general tool commands. Slay, let's go through them one by one. 💅
-D IPMIDRIVER,--driver-type=IPMIDRIVER— Specify the driver type to use instead of doing an auto selection. The currently available outofband drivers areLANandLAN_2_0, which perform IPMI 1.5 and IPMI 2.0 respectively. The currently available inband drivers areKCS,SSIF,OPENIPMI,SUNBMC, andINTELDCMI.--disable-auto-probe— Do not probe in-band IPMI devices for default settings.--driver-address=DRIVER-ADDRESS— Specify the in-band driver address to be used instead of the probed value.DRIVER-ADDRESSshould be prefixed with"0x"for a hex value and'0'for an octal value.--driver-device=DEVICE— Specify the in-band driver device path to be used instead of the probed path.--register-spacing=REGISTER-SPACING— Specify the in-band driver register spacing instead of the probed value. Argument is in bytes (i.e.32bit register spacing = 4).--target-channel-number=CHANNEL-NUMBER— Specify the in-band driver target channel number to send IPMI requests to.--target-slave-address=SLAVE-ADDRESS— Specify the in-band driver target slave number to send IPMI requests to.-h IPMIHOST1,IPMIHOST2,...,,--hostname=IPMIHOST1[:PORT],IPMIHOST2[:PORT],...— Specify the remote host(s) to communicate with. Multiple hostnames may be separated by comma or may be specified in a range format; see HOSTRANGED SUPPORT below. An optional port can be specified with each host, which may be useful in port forwarding or similar situations. If specifying an IPv6 address and port, use the format[ADDRESS]:PORT.-u USERNAME,--username=USERNAME— Specify the username to use when authenticating with the remote host. If not specified, a null (i.e. anonymous) username is assumed. The required user privilege will depend on the oem commands executed.-p PASSWORD,--password=PASSWORD— Specify the password to use when authenticating with the remote host. If not specified, a null password is assumed. Maximum password length is16for IPMI 1.5 and20for IPMI 2.0.-P,--password-prompt— Prompt for password to avoid possibility of listing it in process lists.-k K_G,--k-g=K_G— Specify theK_gBMC key to use when authenticating with the remote host for IPMI 2.0. If not specified, a null key is assumed. To input the key in hexadecimal form, prefix the string with'0x'. E.g., the key'abc'can be entered with the either the string'abc'or the string'0x616263'.-K,--k-g-prompt— Prompt for k-g to avoid possibility of listing it in process lists.--session-timeout=MILLISECONDS— Specify the session timeout in milliseconds. Defaults to20000milliseconds (20seconds) if not specified.--retransmission-timeout=MILLISECONDS— Specify the packet retransmission timeout in milliseconds. Defaults to1000milliseconds (1second) if not specified. The retransmission timeout cannot be larger than the session timeout.-a AUTHENTICATION-TYPE,--authentication-type=AUTHENTICATION-TYPE— Specify the IPMI 1.5 authentication type to use. The currently available authentication types areNONE,STRAIGHT_PASSWORD_KEY,MD2, andMD5. Defaults toMD5if not specified.-I CIPHER-SUITE-ID,--cipher-suite-id=CIPHER-SUITE-ID— Specify the IPMI 2.0 cipher suite ID to use. The Cipher Suite ID identifies a set of authentication, integrity, and confidentiality algorithms to use for IPMI 2.0 communication. The authentication algorithm identifies the algorithm to use for session setup, the integrity algorithm identifies the algorithm to use for session packet signatures, and the confidentiality algorithm identifies the algorithm to use for payload encryption. Defaults to cipher suite ID3if not specified. The following cipher suite ids are currently supported:0— Authentication Algorithm =None; Integrity Algorithm =None; Confidentiality Algorithm =None1— Authentication Algorithm =HMAC-SHA1; Integrity Algorithm =None; Confidentiality Algorithm =None2— Authentication Algorithm =HMAC-SHA1; Integrity Algorithm =HMAC-SHA1-96; Confidentiality Algorithm =None3— Authentication Algorithm =HMAC-SHA1; Integrity Algorithm =HMAC-SHA1-96; Confidentiality Algorithm =AES-CBC-1286— Authentication Algorithm =HMAC-MD5; Integrity Algorithm =None; Confidentiality Algorithm =None7— Authentication Algorithm =HMAC-MD5; Integrity Algorithm =HMAC-MD5-128; Confidentiality Algorithm =None8— Authentication Algorithm =HMAC-MD5; Integrity Algorithm =HMAC-MD5-128; Confidentiality Algorithm =AES-CBC-12811— Authentication Algorithm =HMAC-MD5; Integrity Algorithm =MD5-128; Confidentiality Algorithm =None12— Authentication Algorithm =HMAC-MD5; Integrity Algorithm =MD5-128; Confidentiality Algorithm =AES-CBC-12815— Authentication Algorithm =HMAC-SHA256; Integrity Algorithm =None; Confidentiality Algorithm =None16— Authentication Algorithm =HMAC-SHA256; Integrity Algorithm =HMAC_SHA256_128; Confidentiality Algorithm =None17— Authentication Algorithm =HMAC-SHA256; Integrity Algorithm =HMAC_SHA256_128; Confidentiality Algorithm =AES-CBC-128
-l PRIVILEGE-LEVEL,--privilege-level=PRIVILEGE-LEVEL— Specify the privilege level to be used. The currently available privilege levels areUSER,OPERATOR, andADMIN. Defaults toADMINif not specified.--config-file=FILE— Specify an alternate configuration file.-W WORKAROUNDS,--workaround-flags=WORKAROUNDS— Specify workarounds to vendor compliance issues. Multiple workarounds can be specified separated by commas. A special command line flag of"none", will indicate no workarounds (may be useful for overriding configured defaults). See WORKAROUNDS below for a list of available workarounds.--debug— Turn on debugging.-?,--help— Output a help list and exit.--usage— Output a usage message and exit.-V,--version— Output the program version and exit.
🦋 SDR CACHE OPTIONS 🦋
This tool requires access to the sensor data repository (SDR) cache for general operation. By default, SDR data will be downloaded and cached on the local machine. The following options apply to the SDR cache. Cute cache moment. 🎀
--flush-cache— Flush a cached version of the sensor data repository (SDR) cache. The SDR is typically cached for faster subsequent access. However, it may need to be flushed and re-generated if the SDR has been updated on a system.--quiet-cache— Do not output information about cache creation/deletion. May be useful in scripting.--sdr-cache-recreate— If the SDR cache is out of date or invalid, automatically recreate the sensor data repository (SDR) cache. This option may be useful for scripting purposes.--sdr-cache-file=FILE— Specify a specific sensor data repository (SDR) cache file to be stored or read from. If this option is used when multiple hosts are specified, the same SDR cache file will be used for all hosts.--sdr-cache-directory=DIRECTORY— Specify an alternate directory for sensor data repository (SDR) caches to be stored or read from. Defaults to the home directory if not specified.
⏰ TIME OPTIONS ⏰
By IPMI definition, all IPMI times and timestamps are stored in localtime. However, in many situations, the timestamps will not be stored in localtime. Whether or not a system truly stored the timestamps in localtime varies on many factors, such as the vendor, BIOS, and operating system. The following options will allow the user to adjust the interpretation of the stored timestamps and how they should be output. Timezone drama, honestly iconic. 😭
--utc-to-localtime— Assume all times are reported in UTC time and convert the time to localtime before being output.--localtime-to-utc— Convert all localtime timestamps to UTC before being output.--utc-offset=SECONDS— Specify a specific UTC offset in seconds to be added to timestamps. Value can range from-86400to86400seconds. Defaults to0.
🎀 HOSTRANGED OPTIONS 🎀
okay so these options control how the hostranged output behaves 💅 hit up HOSTRANGED SUPPORT below if you want the full tea on hostranges.
-B,--buffer-output— buffers the hostranged output, bestie. For every node, standard output gets held back until that node finishes its IPMI operation. So yeah, with this on, data might look like it's coming at you slower, because the entire IPMI operation has to wrap up before literally anything gets printed. See HOSTRANGED SUPPORT below for more.-C,--consolidate-output— consolidates the hostranged output ✨ the complete standard output from every node you specified gets merged together so nodes with identical output don't get printed twice, and a header lists which nodes are sharing that consolidated output. Heads up though: with this one, you see nothing until the IPMI operations on all the nodes are done. If you break out of the program early, all the output consolidated so far gets dumped. See HOSTRANGED SUPPORT below.-F NUM,--fanout=NUM— sets the multiple host fanout 🔥 a "sliding window" (aka fanout) algorithm runs the parallel IPMI communication, so slow nodes or timed-out nodes don't block the parallel stuff. The max number of threads going at once is capped by the fanout. Default is64.-E,--eliminate— eliminates hosts thatipmidetectsays are undetected. This is the fix for that super common "hostranged execution timed out" situation where a bunch of nodes got pulled out of service in a big cluster. Theipmidetectddaemon has to be running on the node executing the command.--always-prefix— always prefixes the output, even if there's only one host specified or you're communicating in-band. Mainly the move for scripting. This option gets ignored if you also pass-C.
🌸 IPMI-OEM OPTIONS 🌸
these ones are ipmi-oem's very own:
-L,--list— lists the supported OEM IDs and Commands 👑-v,--verbose— outputs verbose info. What extra you get depends on the specific OEM ID and OEM COMMANDS you specified.
🦋 SUPPORTED OEM IDS AND COMMANDS 🦋
here's every OEM ID and COMMAND we currently support, laid out for you 💖 The special OEM ID list can be passed in to list all the supported OEM IDs and Commands. And the special OEM command list can be passed to any OEM ID to list the commands that OEM ID supports. iykyk ✨
🍓 Dell 🍓
get-system-info KEY
this OEM command pulls the motherboard system information 🫶 valid keys are guid, asset-tag, service-tag, chassis-service-tag, chassis-related-service-tag, board-revision, platform-model-name, blade-slot-info, system-revision, idrac-info, idrac-ipv4-url, idrac-gui-webserver-control, cmc-info, cmc-ipv4-url, cmc-ipv6-info, cmc-ipv6-url, mac-addresses. Command confirmed to work on Dell Poweredge 2900, 2950, R610, R710, R720, M600, M610, M610X, M910, and R905. That said — heads up — individual system information options may not be readable or even available on every system 🙈
get-nic-selection
this one tells you the current NIC selection for IPMI, and it'll be one of dedicated, shared, shared w/ failover to NIC2, or shared w/ failover to all 💅 breaking it down: dedicated means IPMI is only available on an expansion card, shared means IPMI is available on NIC1, shared w/ failover to NIC2 means IPMI is available on NIC1 w/ failover to NIC2 when NIC1 fails, and shared w/ failover to all means IPMI is available on NIC1 w/ failover to all the other NICs if a NIC fails. Command confirmed to work on Dell Poweredge 2900, 2950, R610, R710, and R905.
set-nic-selection
set-nic-selection dedicated|shared|shared_failover_nic2|shared_failover_allsets the current NIC selection to dedicated, shared, shared_failover_nic2, or shared_failover_all — see get-nic-selection above for what those actually mean 😌 On older Poweredge systems, shared_failover_nic2 may have been documented as just failover. Command confirmed to work on Dell Poweredge 2900, 2950, R610, R710, and R905.
get-nic-selection-failover
this OEM command determines the current NIC selection for IPMI and the failover NIC. Command confirmed to work on Dell Poweredge R720 (Dell 12G Poweredge systems) 🔥
set-nic-selection-failover
set-nic-selection-failover dedicated|lom1|lom2|lom3|lom4 none|lom1|lom2|lom3|lom4|allsets the current NIC selection for IPMI and the failover NIC. The first option sets the IPMI NIC and the second option sets the failover NIC. Command confirmed to work on Dell Poweredge R720 (Dell 12G Poweredge systems) ✨
get-active-lom-status [v1|v2]
gets the current NIC being used for out of band management, and possibly some extra info too. You can say whether version 1 or version 2 of this extension should run — if you don't specify, version 1 runs. Version 1 of this command confirmed to work on Dell Poweredge R610 and R710 (Dell 11G Poweredge systems). Version 2 confirmed to work on Dell Poweredge R720 (Dell 12G Poweredge systems) 💜
get-ssh-config
gets the current SSH configuration on the IPMI card. Command confirmed to work on Dell Poweredge R610 and R710 (Dell 11G Poweredge systems) 🎀
set-ssh-config KEY=VALUE ...
sets the current SSH configuration on the IPMI card. The possible keys and values are ssh=enable|disable, idletimeout=seconds, and portnumber=num. You can pass multiple key=value pairs. If you pass no key=value pairs at all, the available pairs get output instead. Some fields may be read-only on specific Poweredge systems. Command confirmed to work on Dell Poweredge R610 and R710 (Dell 11G Poweredge systems).
get-telnet-config
gets the current telnet configuration on the IPMI card. Command confirmed to work on Dell Poweredge R610 and R710 (Dell 11G Poweredge systems) 🌈
set-telnet-config KEY=VALUE ...
sets the current Telnet configuration on the IPMI card. The possible keys and values are telnet=enable|disable, sessiontimeout=seconds, portnumber=num, and 7fls=enable|disable. Multiple key=value pairs may be specified. If no key=value pairs are specified, the available pairs are output. Some fields may be read-only on specific Poweredge systems. Command confirmed to work on Dell Poweredge R610 and R710 (Dell 11G Poweredge systems).
get-web-server-config
gets the current web server configuration on the IPMI card. Command confirmed to work on Dell Poweredge R610 and R710 (Dell 11G Poweredge systems) 🦋
set-web-server-config KEY=VALUE ...
sets the current Web Server configuration on the IPMI card. The possible keys and values are webserver=enable|disable, sessiontimeout=seconds, httpportnumber=num, and httpsportnumber=num. Multiple key=value pairs may be specified. If no key=value pairs are specified, the available pairs are output. Some fields may be read-only on specific Poweredge systems. Command confirmed to work on Dell Poweredge R610 and R710 (Dell 11G Poweredge systems).
get-active-directory-config
gets the current active directory configuration on the IPMI card. Command confirmed to work on Dell Poweredge R610 and R710 (Dell 11G Poweredge systems) 💖
set-active-directory-config
sets the current Web Server configuration on the IPMI card. The possible keys and values are activedirectory=enable|disable, timeout=seconds, type=extended|standard, sso=enable|disable, and certificatevalidation=enable|disable. If no key=value pairs are specified, the available pairs are output. Some fields may be read-only on specific Poweredge systems. Command confirmed to work on Dell Poweredge R610 and R710 (Dell 11G Poweredge systems).
reset-to-defaults
resets the BMC configuration back to default values 🔥 and the command just spins until the reset is confirmed complete — like, it will sit there and wait, no cap. Command confirmed to work on Dell Poweredge R610 and R710 (Dell 11G Poweredge systems).
get-power-consumption-data
pulls the power consumption data ⚡ Command confirmed to work on Dell Poweredge R610, R710, R905, M610, M610x, and M910.
reset-power-consumption-data cumulative|peak
resets the cumulative or peak power consumption data (the stuff you'd view via get-power-consumption-data). Command confirmed to work on Dell Poweredge R610, R710, R905, M610, M610x, and M910 🙌
power-supply-info
reads and outputs power supply ratings and other info. Heads up bestie: this OEM command requires access to the SDR 👀 Command confirmed to work on Dell Poweredge R610, R710, and M610.
okay Dell bestie, here’s the rest of the lineup — every model name stays exactly as written, periodt 💅
get-instantaneous-power-consumption-data power_supply_instance— this OEM command reads instantaneous power consumption data. If a power supply instance number is specified, only data for that instance gets gathered. Otherwise, collective power consumption gets gathered. Command confirmed to work on Dell Poweredge R610, R710, M610, M610x, and M910.get-power-head-room— this OEM command reads power head room. Command confirmed to work on Dell Poweredge R610 and R710 (Dell 11G Poweredge systems).get-power-consumption-statistics average|max|min— this OEM command reads average, max, or min power consumption history. Command confirmed to work on Dell Poweredge R610, R710, M610, M610x, and M910.get-power-capacity— this OEM command reads the current power capacity. Command confirmed to work on Dell Poweredge R610, R710, M610, M610x, and M910.set-power-capacity power-capacity— this OEM command writes the current power capacity (specified in Watts). Command confirmed to work on Dell Poweredge R610 and R710 (Dell 11G Poweredge systems).get-power-capacity-status— this OEM command determines if the current power capacity is enabled or disabled. Command confirmed to work on Dell Poweredge R610, R710, M610, M610x, and M910.set-power-capacity-status enable|disable— this OEM command configures the current power capacity to be enabled or disabled. Command confirmed to work on Dell Poweredge R610 and R710 (Dell 11G Poweredge systems).get-chassis-identify-status— this OEM command retrieves the current chassis identify (i.e. LED) status. Command confirmed to work on Dell Poweredge 2900, 2950, R610, R710, R905, M600, M610, M610x, and M910.power-monitoring-over-interval intervalsystempower|cpu1|cpu2|cpu3|cpu4|memory1|memory2|memory3|memory4|drives|fans|pciecards|gpucables— this OEM command retrieves power consumption information from a specified subsystem for a specified interval time. If the interval is between 30 and 900s, the average, minimum, and maximum power value can also be retrieved. If the interval is between 5 and 30 seconds, only the average power consumption can be returned. Seepower-monitoring-interval-rangebelow to determine legal intervals for each subsystem. Command confirmed to work on Dell Poweredge R720 (Dell 12G Poweredge systems).power-monitoring-interval-rangesystempower|cpu1|cpu2|cpu3|cpu4|memory1|memory2|memory3|memory4|drives|fans|pciecards|gpucables— this OEM command retrieves the monitoring intervals for a specified subsystem. Command confirmed to work on Dell Poweredge R720 (Dell 12G Poweredge systems).get-last-post-code— this OEM command retrieves the last POST code and error string for it. Command confirmed to work on Dell Poweredge R720.slot-power-toggle slot-number— this OEM command performs a power toggle on a PCIe slot. The PCIe slot number can range from 1 to 16. Command confirmed to work on Dell Poweredge C410x.slot-power-control platform-model on|off|status slot-number— this OEM command performs a power control action on a PCIe slot. This OEM extension is tied very closely to a platform, so a supported platform must be specified. The currently supported platform-model options areC410x. Theonaction powers on a slot,offpowers off a slot, andstatusreturns if the current power is on or off. If the current power status is on, anonaction does nothing. Similarly, if the current power status is off, anoffaction does nothing. Theon,off, andstatusslot power actions are not native and are emulated through a combination of a power toggle (usingslot-power-toggleabove) and the reading of PCIe slot watt sensors. The PCIe slot number can range from 1 to 16. Command confirmed to work on Dell Poweredge C410x.get-port-map— this OEM command retrieves the current iPASS mapping to PCIe controllers/slots. Command confirmed to work on Dell Poweredge C410x.set-port-map jumper|bmc ipass-mapping 1:2|1:4|1:8— this OEM command sets an iPass mapping to PCIe controllers/slots.jumperorbmcmust be specified to indicate if iPass mappings will be controlled via jumpers on the system or via a BMC/IPMI. In order for reconfiguration to be done viaipmi-oem, the user must selectbmc. Theipass-mappingdetermines which iPass ports will be mapped.1:2,1:4, and1:8determine the mapping that should be set. See details below for specific platforms. Command confirmed to work on Dell Poweredge C410x. For the Dell Poweredge C410x, theipass-mappingranges from 1 to 4. 1 refers to iPass 1 and 5, 2 to 2 and 6, 3 to 3 and 7, and 4 to 4 and 8. For the platform C410x, PCIe slots 1, 2, 3, 4, 13, 14, 15, and 16 are attached to iPass 1, 2, 3, and 4. PCIe slots 5, 6, 7, 8, 9, 10, 11, and 12 are attached to iPass 5, 6, 7, and 8. For example, if1:2is set on mapping-number 1, PCIe slots 1 and 15 will be assigned to iPass 1 and slots 2 and 16 will be assigned to iPass 5. if1:4is chosen, PCIe slots 1, 2, 15, and 16 will be assigned to iPass 1 and iPass 5 will not be used.
Fujitsu 💜
get-power-on-source— this OEM command returns the reason for the most recent Power On. Command confirmed to work on Fujitsu RX100 S5.get-power-off-source— this OEM command returns the reason for the most recent Power Off. Command confirmed to work on Fujitsu RX100 S5.get-remote-storage-status connection_number— this OEM command returns the connection and/or status of remote storage.connection_numbercurrently supports a range of 0-1. Command confirmed to work on Fujitsu RX100 S5.get-system-status— this OEM command returns the current system status. Command confirmed to work on Fujitsu RX100 S5.get-eeprom-version-info eeprom_number— this OEM command returns the current version info for various hardware elements, including firmware, SDR, and boot revision.eeprom_numbercurrently supports a range of 0-1. Command confirmed to work on Fujitsu RX100 S5.get-identify-led— this OEM command gets the current identify LED status. Command confirmed to work on Fujitsu RX100 S5.set-identify-led on|off— this OEM command sets the current identify LED status. Command confirmed to work on Fujitsu RX100 S5.get-error-led— this OEM command gets the current error LED status. Command confirmed to work on Fujitsu RX100 S5.get-sel-entry-long-text sel_record_id— this OEM command retrieves the Fujitsu specific string interpretation of a SEL record. This command may be useful for interpreting Fujitsu OEM hex codes found in the SEL. A specific SEL record ID must be specified. Please seeipmi-sel(8), for retrieving SEL records. Command confirmed to work on Fujitsu RX100 S5.
GIGABYTE 🦋
get-nic-mode— this OEM command determines the current NIC mode as dedicated, shared, or failover. Dedicated indicates IPMI is only available on the dedicated management port. Shared indicates IPMI is also available on one of the primary ethernet ports. Failover indicates IPMI is dedicated but can failover to another if the primary port fails. Command confirmed to work on GIGABYTE MD90-FS0-ZB.set-nic-mode dedicated|shared|failover— this OEM command sets the current NIC mode to dedicated, shared, or failover. (Seeget-nic-modeabove for description on dedicated vs. shared vs failover modes.) Command confirmed to work on GIGABYTE MD90-FS0-ZB.get-bmc-services— this OEM command displays the enable/disable state of BMC services besides IPMI. Command confirmed to work on GIGABYTE MD90-FS0-ZB.set-bmc-services enable|disablessh|http|rpcbind|svrloc|https|avocentkvm|wbem-http|wbem-https— this OEM command enables or disables BMC services besides IPMI. Command confirmed to work on GIGABYTE MD90-FS0-ZB.
IBM 🎀
get-led— this OEM command gets the current LED status. This OEM command requires access to the SDR. Command confirmed to work on IBM x3755.
Intel ⭐
get-smtp-config [channel-number]— this OEM command gets the current SMTP configuration on the IPMI card. By default, configuration for every LAN channel will be output. If achannel-numberis specified, only that specific channel number's configuration will be output. Command confirmed to work on Intel S5500WB (Penguin Computing Relion 700) and Intel S2600JF (Appro 512X).
set-smtp-config [channel-number] KEY=VALUE…
Bestie this one sets the current SMTP configuration on the IPMI card 💌 By default, the config happens across all LAN channels — all of them, no picking favourites. But if you pass a channel-number, then only that specific channel's configuration gets configured. ✨
The possible keys and values are:
smtp=enable|disablesmtpserveraddress=ipaddresssmtpusername=stringuserpassword=stringemailaddress=stringsubject=stringmessagecontent=stringsenderemailaddress=stringsmtphostname=string
You can specify multiple key=value pairs, stack 'em up 🫶 If you specify no key=value pairs at all, then the available pairs just get output for you. Command confirmed to work on Intel S5500WB (Penguin Computing Relion 700) and Intel S2600JF (Appro 512X). 👑
get-power-restore-delay
This OEM command retrieves the power on delay ⏳ Now, the power on delay is a delay that occurs whenever the BMC turns on the system according to the Power Restore Policy setting. It does not take effect otherwise (i.e. power button or Chassis Control) — so don't go blaming it for everything, it's very much a specific-circumstances girlie. Command confirmed to work on Intel S2600JF (Appro 512X). 💅
set-power-restore-delay seconds
Sets the power on delay 🌸 (See get-power-restore-delay above for the description on power restore delay, iykyk.) Command confirmed to work on Intel S2600JF (Appro 512X).
get-bmc-services
Gets the current status of BMC services such as ssh, http, rmcp, and kvm 🔍 Command confirmed to work on Intel S2600WT2.
set-bmc-services enable|disable ssh|http|rmcp|kvm
This one enables or disables BMC services besides IPMI, main character energy 💅 Note that http refers to both http and https — it's giving two-for-one. Command confirmed to work on Intel S2600WT2.
restore-configuration
Restores BMC configuration values back to default values 🎀 The command will spin until the restore is confirmed to be complete — it's not ghosting you, it's just working. Command configured to work on Intel S5500WB (Penguin Computing Relion 700) and Intel S2600JF (Appro 512X).
⚠️ After running this command, the BMC must be reset to return it to functioning status. This may be accomplished by executing acold-resetwithbmc-device(8). Do not skip this step bestie, fr fr.
IntelNM (Intel Node Manager) 🧚
The following OEM commands operate on Intel chipsets with Node Manager support. They all require access to the SDR — every single one, no cap. They may work on multiple vendors motherboards. 🌈
get-node-manager-statistics
mode=globalpower|globaltemp|globalthrottling|globalvolumetricairflow|globaltempairflow|globalchassispower|policypower|policytrigger|policythrottling|hostunhandledrequests|hostresponsetime|cputhrottling|memorythrottling|hostcommfailure
[domainid=platform|cpu|memory|highpowerio] [policyid=num]Outputs Intel Node Manager statistics 📊 A mode indicating the statistics to output must be specified — non-negotiable. The user may optionally specify a domainid or policyid, although certain mode options may require it. domainid defaults to platform.
Command confirmed to work on Intel S5500WB (Penguin Computing Relion 700), Inventec 5441/5442 (Dell Xanadu II/III), Quanta S99Q (Dell FS12-TY), Quanta QSSC-S4R (Appro GB812X-CN), Supermicro X9DRi-F, Intel S2600JF (Appro 512X). 🔥
reset-node-manager-statistics
[mode=global|policy|hostunhandledrequests|hostresponsetime|cputhrottling|memorythrottling|hostcommfailure]
[domainid=platform|cpu|memory|highpowerio] [policyid=num]Resets Intel Node Manager statistics 🔄 The mode indicates the statistics to be reset. The user may optionally specify a domainid or policyid. domainid defaults to platform. If a mode is not specified, it will default to global or policy — depending on whether or not a policyid is specified.
Command confirmed to work on Intel S5500WB (Penguin Computing Relion 700), Inventec 5441/5442 (Dell Xanadu II/III), Quanta S99Q (Dell FS12-TY), Quanta QSSC-S4R (Appro GB812X-CN), Supermicro X9DRi-F, Intel S2600JF (Appro 512X). ✨
get-node-manager-capabilities
[domainid=platform|cpu|memory|highpowerio]
[policytrigger=none|inlettemperaturelimitpolicytrigger|missingpowerreadingtimeout|timeafterplatformresettrigger|boottimepolicy]
[policytype=powercontrol] [policypowerdomain=primary|secondary]Outputs the current capabilities of the Intel Node Manager 🦋 The user may optionally specify a domainid, policytrigger, policytype, or policypowerdomain. Note that policypowerdomain is only applicabale to domain id platform (yes that's how it's spelled in the source, we stan a typo queen 🙈).
If any particular option is not specified, all permutations of the remaining options will be used in an attempt to output all capabilities of the system — she is thorough. And if the verbose option is set, additional error messages will be output as valid policies are being searched for. 👀
Command confirmed to work on Intel S2600JF (Appro 512X).
node-manager-policy-control <enable|disable>
[domainid=platform|cpu|memory|highpowerio] [policyid=num]Enables or disables the current global, domain, or policies used by the Intel Node Manager 🎛️ If no domainid is specified, then the Node Manager will be enabled or globally disabled. If a domainid is specified, only that domain will be enabled or disabled. If both a domainid and policyid are specified, only that specific policy within the domain will be specified.
This OEM command will be required to enable or disable policies before many of the commands below can be used for configuration or use — so like, do this one first, bestie. 💅 Command confirmed to work on Intel S2600JF (Appro 512X).
get-node-manager-policy
[domainid=platform|cpu|memory|highpowerio] [policyid=num]Gets the current node manager policy 📜 If no domainid is specified, all policies for all domain IDs and policy Ids will be attempted to be output — the whole collection, periodt. If a domainid is specified but a policyid is not, all policies within a domain will be attempted to be output.
If the verbose option is set, additional error messages will be output as valid policies are being searched for. 👑
Command confirmed to work on Intel S2600JF (Appro 512X).
…and the rest of the set-node-manager-policy synopsis lands like this 💅
set-node-manager-policy domainid=platform|cpu|memory|highpowerio
policyid=num
policytrigger=none|inlettemperaturelimitpolicytrigger|missingpowerreadingtimeout|timeafterplatformresettrigger|boottimepolicy
policytargetlimit=num [platformbootingmode=performance|power]
correctiontimelimit=ms statisticsreportingperiod=seconds
policystorage=persistent|volatile [policytriggerlimit=num]
[policystate=enable|disable]
[policyexceptionaction=alert|shutdown]
[aggressivepowercorrection=automatic|notaggressive|aggressive]
[policypowerdomain=primary|secondary]So this OEM command adds or modifies an indicated policy ID from the domain ID, bestie. Most of the fields up there are required, but the cute part is you can list them in any order — no cap, order doesn't matter. By default any created/modified policy is enabled, but you can override that with policystate. 🎀
Now the trigger lore, because this is the part people get wrong. policyexceptionaction can be specified multiple times to configure multiple actions, or you can just skip it entirely to configure no actions. When policytrigger is none, the trigger that leads to exception actions is the value given by policytargetlimit. When policytrigger is inlettemperaturelimitpolicytrigger, missingpowerreadingtimeout, or timeafterplatformresettrigger, the trigger that leads to exception actions is the value given by policytriggerlimit. And when policytrigger is boottimepolicy, a power profile is simply maintained by the value given by policytargetlimit. 🦋
aggressivepowercorrection defaults to automatic. It can only be set to notaggressive or aggressive if domainid is platform or cpu — otherwise no. policystorage determines whether the policy you're configuring can survive across resets of the machine.
The units of policytargetlimit depend on the policytrigger you picked, iykyk:
policytriggerisnone,inlettemperaturelimitpolicytrigger, ortimeafterplatformresettrigger→ units are in Wattspolicytriggerismissingpowerreadingtimeout→ units are in percent, where100means maximum throttlingpolicytriggerisboottimepolicy→ units are the number of CPUs, and on top of thatplatformbootingmodemust be set toperformanceorpowerto indicate the optimization mode
policytriggerlimit is sometimes required, depending on your input to policytrigger, and its units depend on the selected policytrigger too:
inlettemperaturelimitpolicytrigger→ units in Celsiusmissingpowerreadingtimeoutortimeafterplatformresettrigger→ units in secondsnoneorboottimepolicy→policytriggerlimitis ignored internally by the Intel Node Manager and need not be specified. Typically configuring it to0is more than sufficient. 🙈
correctiontimelimit specifies the time the Node Manager must take corrective actions to bring the system back within limits before it takes the actions specified in policyexceptionaction. statisticsreportingperiod is the number of seconds that measured power will be averaged for reporting. And if you want proper ranges for policytargetlimit, correctiontimelimit, policytriggerlimit, and statisticsreportingperiod, go look at get-node-manager-policy — it's giving reference material. 👑
If domainid is configured as platform, you may optionally set policypowerdomain to primary or secondary. Otherwise policypowerdomain is just ignored, gone, not invited. ✨
Command confirmed to work on Intel S2600JF (Appro 512X).
remove-node-manager-policy 💀
remove-node-manager-policy domainid=platform|cpu|memory|highpowerio policyid=numThis OEM command removes the indicated policy ID from the domain ID. Both domainid and policyid are required — no shortcuts, no vibes-only invocation. 🫶
Command confirmed to work on Intel S2600JF (Appro 512X).
get-node-manager-policy-alert-thresholds 🌸
get-node-manager-policy-alert-thresholds [domainid=platform|cpu|memory|highpowerio] [policyid=num]This OEM command gets the current alert thresholds. Feed it no domainid and it'll attempt to output all alert thresholds for domain IDs and policy IDs. Give it a domainid but no policyid and it'll attempt to output all alert thresholds within that domain. The units of the thresholds depend on the configuration of the current policy — so like, whatever that policy is doing, that's the unit.
If the verbose option is set, additional error messages get output as valid policies are being searched for — handy for debugging, lowkey iconic 🔍
Command confirmed to work on Intel S2600JF (Appro 512X).
set-node-manager-policy-alert-thresholds 🎀
set-node-manager-policy-alert-thresholds domainid=platform|cpu|memory|highpowerio policyid=num
[threshold1=num] [threshold2=num] [threshold3=num]This OEM command sets the alert thresholds for a given domain ID and policy ID. Up to three thresholds can be specified — threshold1, threshold2, threshold3 — and the units of the thresholds depend on the configuration of the current policy. Same policy, same units, that's the rule. ⭐
Command confirmed to work on Intel S2600JF (Appro 512X).
get-node-manager-policy-suspend-periods 💜
get-node-manager-policy-suspend-periods [domainid=platform|cpu|memory|highpowerio] [policyid=num]This OEM command gets the current policy suspend periods. Suspend periods temporarily disable Intel Node Manager policies at configured times — like a little nap schedule for your policies, honestly relatable 😴
No domainid? It'll attempt to output all suspend periods for domain IDs and policy IDs. domainid but no policyid? It'll attempt to output all suspend periods within that domain. If the verbose option is set, additional error messages get output as valid policies are being searched for. Suspend start and stop times are output in 24 hour format. 🕐
Command confirmed to work on Intel S2600JF (Appro 512X).
set-node-manager-policy-suspend-periods 🌈
set-node-manager-policy-suspend-periods domainid=platform|cpu|memory|highpowerio policyid=num
suspendperiodstart1=time suspendperiodstop1=time
suspendperiodrepeat1=monday|tuesday|wednesday|thursday|friday|saturday|sunday
...This OEM command sets the policy suspend periods for a policy, and again: suspend periods temporarily disable Intel Node Manager policies at configured times. Up to 5 suspend periods can be specified, via suspendperiodstartX, suspendperiodstopX, and suspendperiodrepeatX. 🧚
suspendperiodstart and suspendperiodstop specify the start and stop time since midnight for a suspend period, and the time should be specified in 24 hour format (i.e. 02:00 or 13:40). Heads up though — suspend periods are configured in multiples of 6 minutes, so the stored configuration may be rounded to a slightly alternate configuration. Not a bug, just math being math. 🍓
suspendperiodrepeat indicates the days on which the suspend period shall be enabled, and the option can be specified multiple times to configure multiple times.
Command confirmed to work on Intel S2600JF (Appro 512X).
set-node-manager-power-draw-range 🔥
set-node-manager-power-draw-range domainid=platform|cpu|memory|highpowerio minpowerdrawrange=watts
maxpowerdrawrange=wattsThis OEM command sets the power draw range for a given domain ID. After this configuration, any policies within the domain ID that are outside of this range get disabled as needed — the range is the vibe check and some policies will simply fail it 💅
The current power draw range can be read via the get-node-manager-capabilities above.
Command confirmed to work on Intel S2600JF (Appro 512X).
get-node-manager-alert-destination 🦋
get-node-manager-alert-destinationThis OEM command gets the current alert destination information. Some of the configuration info this command outputs will need to be correlated to BMC device channel and PEF configuration — so yes, you're gonna cross-reference, it's a whole thing. BMC device channel info can be viewed via bmc-info(8). PEF configuration can be viewed via ipmi-config(8). 🔍
Command confirmed to work on Intel S2600JF (Appro 512X).
set-node-manager-alert-destination 👑
set-node-manager-alert-destination [channelnumber=num]
[slaveaddress=address] [destinationselector=num]
[alertstringselector=num] [sendalertstring=yes|no]
[register=yes|no]This OEM command sets the current alert receiver. By default, it'll attempt to register an alert — identical to register=yes, so that's the default behaviour, periodt.
When you're registering an alert receiver, the channelnumber, alertstringselector, and sendalertstring options must be specified. And the slaveaddress or destinationselector must also be specified, depending on the channel number you gave. If register=no, most of these options are not required — you're off the hook. 🙌
Appropriate channel number input can be determined via bmc-info(8). Destination selector and alert string selector information can be determined via ipmi-config(8).
Command confirmed to work on Intel S2600JF (Appro 512X).
get-turbo-synchronization-ratio ⚡
get-turbo-synchronization-ratio activecoresconfig=num|all
[cpusocket=num|all]This OEM command gets the current Turbo Synchronization Ratio. If cpusocket is not set to a specific cpu socket, all sockets will return maximum settings — so like, if you don't pick a socket, everybody shows up with their best numbers. 🌟
set-turbo-synchronization-ratio turboratiolimit=num|default [cpusocket=num|all] [activecoresconfig=num|all]— okay so this OEM command sets the Turbo Synchronization Ratio 💨. Ifcpusocketisn't pinned to a specific cpu socket, it's assumed to apply to all cores. And ifactivecoresconfigisn't set, it's assumed to be for all cores too. Default everything, basically.get-node-manager-version— this OEM command outputs the current Intel Node Manager version info 📋. Command confirmed to work on Intel S5500WB (Penguin Computing Relion 700), Inventec 5441/5442 (Dell Xanadu II/III), Quanta S99Q (Dell FS12-TY), Quanta QSSC-S4R (Appro GB812X-CN), and Intel S2600JF (Appro 512X). Slay, that's a whole list 💅
🌸 Inventec 🌸
get-nic-mode— this OEM command figures out whether the current NIC mode isdedicatedorshared🕵️♀️.Dedicatedmeans IPMI is only available on the dedicated management port.Sharedmeans IPMI is also available on one of the primary ethernet ports. Command confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III).set-nic-mode dedicated|shared— this OEM command sets the current NIC mode todedicatedorshared(peepget-nic-modeabove for the whole dedicated-vs-shared lore ✨). Heads up bestie: this OEM command may internally reset the BMC, making the BMC unusable for awhile 😭. Command confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III).get-mac-address— this command retrieves the BMC MAC address 🎀. Plot twist: this is actually not an OEM command, it's the normal IPMI MAC address command (identical to what's used in theipmi-config(8)tool). It's just placed here for convenience. iykyk.set-mac-address dedicated|shared MACADDR— this OEM command sets the dedicated or shared BMC MAC address (again, seeget-nic-modeabove for dedicated vs. shared tea ☕). Important: the BMC MAC address cannot be set through the normal IPMI MAC address command (the one used in theipmi-config(8)tool) 🙈.MACADDRshould be inXX:XX:XX:XX:XX:XXform. A shared BMC MAC address may conflict with normal communication ethernet communication on the primary ethernet port — so users may wish to configure an alternate MAC address instead. After configuring the MAC address, the BMC must be reset, which you can do by executing a cold-reset withbmc-device(8)🔄. Command confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III).get-bmc-services— this OEM command displays the currently enabled BMC services 💖. Command confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III).set-bmc-services enable|disable all|kvm|http|ssh— this OEM command enables or disables other BMC services besides IPMI 🎛️.allcan be specified to enable/disable all services,kvmspecifies KVM and Virtual Storage,httpspecifies HTTP and HTTPS, andsshspecifies both SSH and Telnet. Command confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III).get-authentication-config— this OEM command displays additional OEM authentication settings 🔐 (seeset-authentication-configbelow for what the outputs mean). Command confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III).set-authentication-config KEY=VALUE ...— this OEM command sets additional OEM authentication settings on the IPMI card 🛡️. The possible keys and values aremaxauthenticationfailures=count,lockoutwindow=seconds,lockouttime=seconds, andhttpsportnumber=num.maxauthenticationfailuresspecifies the maximum number of allowed authentication failures.lockoutwindowspecifies the window of time the authentication failure count can be reached in to disable a user.lockouttimespecifies the time period a user is disabled if the authentication failure count is reached. Setting0to any of the settings will disable the lockout feature. Each time any of these settings is modified, the authentication failure count of each enabled user is reset to 0 👀. Multiplekey=valuepairs may be specified. If nokey=valuepairs are specified, available pairs are output. Command confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III).get-account-status— this OEM command outputs the current account status of users on the BMC 👥. It's particularly useful for determining which users in the system may have been locked out via authentication failures configured throughset-authentication-config. Command confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III).get-dns-config— this OEM command displays additional OEM DNS settings 🌐 (seeset-dns-configbelow for what the outputs mean). Command confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III).set-dns-config KEY=VALUE ...— this OEM command sets additional OEM DNS settings on the IPMI card 💻. The possible keys and values arednsdhcp=enable|disable,dnsserver1=ipaddress,dnsserver2=ipaddress,dnsregisterbmc=enable|disable,dnsbmchostname=string,dnsdomainnamedhcp=enable|disable, anddnsdomainname=string.dnsdhcpspecifies if the DNS server IP addresses should be assigned from the DHCP server.dnsserver1anddnsserver2specify the IP address for server 1 and 2 respectively — these fields are read only ifdnsdhcpand DHCP are enabled.dnsregisterbmcspecifies if the BMC host name is registered via the DNS server.dnsbmchostnamespecifies the BMC host name, and this field is read only ifdnsregisterbmcis enabled.dnsdomainnamedhcpspecifies if the DNS domainname should be assigned from the DHCP server.dnsdomainnamespecifies the DNS domain name string, and this field is read only ifdnsdomainnamedhcpis enabled. Multiplekey=valuepairs may be specified. If nokey=valuepairs are specified, available pairs are output. Command confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III).get-web-server-config— this OEM command gets the current web server configuration on the IPMI card 🖥️. Command confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III).set-web-server-config KEY=VALUE ...— this OEM command sets the current web server configuration on the IPMI card ✨. The possible keys and values arewebserver=enable|disable,webservertimeout=seconds,httpportnumber=num, andhttpsportnumber=num. Multiplekey=valuepairs may be specified. If nokey=valuepairs are specified, available pairs are output. Command confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III).get-power-management-config— this OEM command gets the current power management configuration on the IPMI card ⚡. Command confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III).set-power-management-config KEY=VALUE ...— this OEM command sets the current power management configuration on the IPMI card 🔌. The possible keys and values aredpnmpowermanagement=enable|disable,powerstaggeringacrecovery=immediate|auto|user,powerondelay=seconds, andmaxpowerondelay=seconds.dpnmpowermanagementenables or disables DPNM, Dynamic Power Node Management. Forpowerstaggeringacrecovery,immediatespecifies no delay,autogenerates a delay time between the minimum and maximum configured, anduseruses the user defined time defined bypowerondelay.powerondelaymust be within the minimum and maximum power on delay times ⏳. Multiplekey=valuepairs may be specified. If nokey=valuepairs are specified, available pairs are output. Command confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III).get-sol-idle-timeout— this OEM command gets the SOL idle timeout ⌛. Command confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III).set-sol-idle-timeout idle-timeout— this OEM command sets the SOL idle timeout ⏰. Theidle-timeoutis one-based, max of65535, in 1 minute increments (e.g.1= 1 minute), and0or"none"will configure no timeout. Command confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III).get-telnet-ssh-redirect-status— this OEM command gets the telnet/SSH redirect status 📡. Command confirmed to work on Inventec 5442 (Dell Xanadu III).set-telnet-ssh-redirect-status enable|disable— this OEM command enables or disables telnet/SSH redirect status 🔀. Command confirmed to work on Inventec 5442 (Dell Xanadu III).get-board-id— this OEM command can get the board ID 🪪. Command confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III).set-board-id ID— this OEM command can set the board ID 🏷️. Command confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III).get-fcb-version— this OEM command can get the fan control board (FCB) version number 🌬️. Command confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III).
set-fcb-version majorversion minorversion 🎛️
Okay so this OEM command sets the fan control board (FCB) version number. The majorversion and minorversion must be specified in hex, bestie — no decimal shenanigans allowed. Command confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III). ✨
get-sol-inactivity-timeout ⏳
This OEM command retrieves the SOL inactivity timeout. That's the whole assignment, periodt. Command confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III). 💖
set-sol-inactivity-timeout inactivity-timeout 🕰️
This OEM command sets the SOL inactivity timeout. The inactivity-timeout is one-based, max of 65535, in 1 minute increments (e.g. 1 = 1 minute), and 0 or "none" will configure no timeout. Command confirmed to work on Inventec 5441/5442 (Dell Xanadu II/III). 🫶
restore-to-defaults all|user|lan|sol|serial|pef 🔄
This OEM command restores certain BMC configuration sections back to default values. The command will spin until the reset is confirmed to be complete. Command confirmed to work on Inventec 5442 (Dell Xanadu III). After running this command, the BMC must be reset to return it to functioning status. This may be accomplished by executing a cold-reset with bmc-device(8).
Heads up: the BMC reset is not optional, bestie. Run the cold-reset or it's giving "functioning status: missing." 😭
read-eeprom at24c256n 📖
This OEM command reads the specified eeprom. Command confirmed to work on Inventec 5441 (Dell Xanadu II) for at24c256. 🍓
clear-eeprom at24c256n 🧽
This OEM command clears the specified eeprom, overwriting all bytes with 0xFF. If the verbose option is set, progress percent will be output as the clearing is being done. Command confirmed to work on Inventec 5441 (Dell Xanadu II) for at24c256. 💀
🌸 Quanta 🌸
get-nic-mode 🖧
This OEM command determines the current NIC mode as dedicated or shared. dedicated indicates IPMI is only available on the dedicated management port. shared indicates IPMI is also available on one of the primary ethernet ports. Command confirmed to work on Quanta S99Q (Dell FS12-TY). This is your NIC mode vibe check, iykyk. ✨
set-nic-mode dedicated|shared 🔧
This OEM command sets the current NIC mode to dedicated or shared. (See get-nic-mode above for the description on dedicated vs. shared mode.) This OEM command may internally reset the BMC, making the BMC unusable for awhile. Command confirmed to work on Quanta S99Q (Dell FS12-TY).
Not me warning you: the BMC can go MIA for a bit after this. Plan accordingly. 😭
get-bmc-services 📋
This OEM command displays the currently enabled BMC services. Command confirmed to work on Quanta S99Q (Dell FS12-TY). 💅
set-bmc-services enable|disable all|kvm|http|ssh 🎚️
This OEM command enables or disables other BMC services besides IPMI. all can be specified to enable/disable all services, kvm specifies KVM and Virtual Storage, http specifies HTTP and HTTPS, and ssh specifies both SSH and Telnet. Command confirmed to work on Quanta S99Q (Dell FS12-TY). Slay. 🔥
get-account-status 👤
This OEM command outputs the current account status of users on the BMC. This command is particularly useful for determining which users in the system may have been locked out via authentication failures. Command confirmed to work on Quanta S99Q (Dell FS12-TY). 🕵️
get-dns-config 🌐
This OEM command displays additional OEM DNS settings. (See set-dns-config below for description on outputs.) Command confirmed to work on Quanta S99Q (Dell FS12-TY). 💜
set-dns-config KEY=VALUE ... 🛠️
This OEM command sets additional OEM DNS settings on the IPMI card. The possible keys and values are:
dnsdhcp=enable|disable— specifies if the DNS server IP addresses should be assigned from the DHCP server.dnsserver1=ipaddress— specifies the IP address for server 1.dnsserver2=ipaddress— specifies the IP address for server 2.dnsregisterbmc=enable|disable— specifies if the BMC host name is registered via the DNS server.dnsbmchostname=string— specifies the BMC host name. This field is read only ifdnsregisterbmcis enabled.dnsdomainnamedhcp=enable|disable— specifies if the DNS domainname should be assigned from the DHCP server.dnsdomainname=string— specifies the DNS domain name string. This field is read only ifdnsdomainnamedhcpis enabled.
Both dnsserver1 and dnsserver2 fields are read only if dnsdhcp and DHCP are enabled.
Multiple key=value pairs may be specified. If no key=value pairs are specified, available pairs are output. Command confirmed to work on Quanta S99Q (Dell FS12-TY). 🌈
get-web-server-config 🕸️
This OEM command gets the current web server configuration on the IPMI card. Command confirmed to work on Quanta S99Q (Dell FS12-TY). 🎀
set-web-server-config KEY=VALUE... 🛠️
This OEM command sets the current web server configuration on the IPMI card. The possible keys and values are:
webserver=enable|disablewebservertimeout=secondshttpportnumber=numhttpsportnumber=num
Multiple key=value pairs may be specified. If no key=value pairs are specified, available pairs are output. Command confirmed to work on Quanta S99Q (Dell FS12-TY). 💖
get-power-management-config ⚡
This OEM command gets the current power management configuration on the IPMI card. Command confirmed to work on Quanta S99Q (Dell FS12-TY). 🔌
set-power-management-config KEY=VALUE ... 🛠️
This OEM command sets the current power management configuration on the IPMI card. The possible keys and values are:
dpnmpowermanagement=enable|disable— enables or disables DPNM, Dynamic Power Node Management.powerstaggeringacrecovery=immediate|auto|user—immediatespecifies no delay,autogenerates a delay time between the minimum and maximum configured, anduseruses the user defined time defined bypowerondelay.powerondelay=seconds— must be within the minimum and maximum power on delay times.maxpowerondelay=seconds
Multiple key=value pairs may be specified. If no key=value pairs are specified, available pairs are output. Command confirmed to work on Quanta S99Q (Dell FS12-TY). 👑
get-sol-idle-timeout ⏳
This OEM command gets the SOL idle timeout. Command confirmed to work on Quanta S99Q (Dell FS12-TY). 💜
set-sol-idle-timeout idle-timeout 🕰️
This OEM command sets the SOL idle timeout. The idle-timeout is one-based, max of 65535, in 1 minute increments (e.g. 1 = 1 minute), and 0 or "none" will configure no timeout. Command confirmed to work on Quanta S99Q (Dell FS12-TY). 🫶
get-telnet-ssh-redirect-status 📡
This OEM command gets the telnet/SSH redirect status. Command confirmed to work on Quanta S99Q (Dell FS12-TY). 🌸
set-telnet-ssh-redirect-status enable|disable 🎚️
This OEM command enables or disables telnet/SSH redirect status. Command confirmed to work on Quanta S99Q (Dell FS12-TY). ✨
reset-to-defaults all|user|lan|sol|serial|pef 🔄
This OEM command resets certain BMC configuration sections back to default values. The command will spin until the reset is confirmed to be complete. Command confirmed to work on Quanta S99Q (Dell FS12-TY). After running this command, the BMC must be reset to return it to functioning status. This may be accomplished by executing a cold-reset with bmc-device(8).
Again: reset the BMC after this, or it's giving "why am I like this." 😭
get-processor-information [processor-index] 🧠
This OEM command determines system processor information. By default, information about each processor will be output. If a processor-index is specified, only that specific processor will be output. Command confirmed to work on Quanta S99Q (Dell FS12-TY). 💅
read-mac-address s99q dedicated|shared 📟
This command reads the currently configured dedicated or shared MAC address for a specified motherboard. It will read the MAC address directly from the BMC eeprom. Command confirmed to work on Quanta S99Q (Dell FS12-TY) for s99q. 🦋
write-mac-address s99q dedicated|shared MACADDR ✍️
This OEM command sets the dedicated or shared BMC MAC address for a specified motherboard. It will be written directly to the BMC eeprom. (See get-nic-mode above for description on dedicated vs. shared mode.) The BMC MAC address cannot be set through the normal IPMI MAC address command (what is used in the ipmi-config(8) tool). The MACADDR should be specified in XX:XX:XX:XX:XX:XX form. A shared BMC MAC address may conflict with normal ethernet communication on the primary ethernet port. Users may wish to configure an alternate MAC address instead. After configuration of the MAC address, the BMC must be reset. This may be accomplished by executing a cold-reset with bmc-device(8). Command confirmed to work on Quanta S99Q (Dell FS12-TY) for s99q.
Big warning energy, fr fr: shared MAC can clash with the primary ethernet port, and the BMC needs a reset after you write this. Not a "set it and forget it" moment, bestie. 😭
☀️ Sun ☀️
get-led— this OEM command spills the tea on your current LED mode.offmeans the LED is steady off,onmeans it's steady on,standbymeans it blinks at a 100ms on, 2900ms off rate,slowmeans it's blinking at 1Hz, andfastmeans it's blinking at 4Hz. If theverboseoption is set, sensor names will be output with their entity ID and instance when appropriate. (Similar to the--entity-sensor-namesoption in ipmi-sensors.) Heads up bestie — this OEM command requires access to the SDR. Command confirmed to work on Sun Fire 4140 with ILOM. ✨set-led record_id off|on|standby|slow|fast— this OEM command configures LED modes. (Seeget-ledabove for the whole description on LED modes, no need to make me repeat myself 💅) This OEM command requires access to the SDR. Command confirmed to work on Sun Fire 4140 with ILOM.
🌸 Supermicro 🌸
extra-firmware-info— this OEM command outputs additional firmware version information. Command confirmed to work on Supermicro H8QME. 🎀reset-intrusion— this OEM command resets the motherboard intrusion flag after it has been triggered. Like, for example, inipmi-sensorsoripmi-selyou may notice a'General Chassis Intrusion'if the motherboard chassis is not open, but was opened in the past. Been there tbh. Command confirmed to work on Supermicro H8QME.get-bmc-services-status— this OEM command determines if non-IPMI services (e.g.ssh,http,https,vnc, etc.) are currently enabled or disabled on the BMC. Command confirmed to work on Supermicro X8DTG. 🦋set-bmc-services-status enable|disable— this OEM command enables or disables all non-IPMI services on the BMC. It can be used to enable or disable non-IPMI services such asssh,http,https, andvnc. Command confirmed to work on Supermicro X8DTG.get-power-supply-status ps_num— this OEM command gets the status of a regular power supply. Presently, it can get the status of power supplies 1 through 3. Command confirmed to work on Supermicro X8DTU, Supermicro X8STi, and Supermicro X9DRW. ⚡get-power-supply-status2 ps_num— this OEM command gets the status of a regular power supply. Presently, it can get the status of power supplies 1 and 2. Command confirmed to work on Supermicro X10DRU-i+.get-pmbus-power-supply-status ps_num— this OEM command gets the status of a PMBus based power supply. Presently, it can get the status of power supplies 1 through 3. Command confirmed to work on Supermicro X8DTU, Supermicro X8STi, Supermicro X9DRW, and Supermicro X9DRD. 🔥
🌈 Wistron 🌈
get-system-info KEY— this OEM command can retrieve the motherboard system information. Valid keys areasset-tag,service-tag,product-name. Command confirmed to work on Wistron / Dell Poweredge C6220. 👑get-nic-mode— this OEM command determines the current NIC mode asdedicatedorshared.Dedicatedindicates IPMI is only available on the dedicated management port.Sharedindicates IPMI is also available on one of the primary ethernet ports. Command confirmed to work on Wistron / Dell Poweredge C6220. 🧚set-nic-mode dedicated|shared— this OEM command sets the current NIC mode todedicatedorshared. (Seeget-nic-modeabove for the description on dedicated vs. shared mode.) After running this command, the BMC may need to be reset to finalize the configuration. This may be accomplished by executing acold-resetwithbmc-device(8). Command confirmed to work on Wistron / Dell Poweredge C6220.
Not me reminding you — that reset step is fr fr part of the process, don't skip it and then act surprised. 💀
get-shared-nic-selection— this OEM command determines the current NIC IPMI is shared with, if the mode isshared. (Seeget-nic-modeabove for the description on dedicated vs. shared mode.) Command confirmed to work on Wistron / Dell Poweredge C6220.set-shared-nic-selection nic1|nic2|nic3|nic4|clear— this OEM command sets the current NIC sharing selection. If the current NIC mode isdedicatedit is advisable to clear this setting with theclearoption. Command confirmed to work on Wistron / Dell Poweredge C6220. 🫶get-bmc-services— this OEM command displays the currently enabled BMC services. Command confirmed to work on Wistron / Dell Poweredge C6220.set-bmc-services enable|disable all|kvm|http|ssh|snmp|telnet— this OEM command enables or disables other BMC services besides IPMI.allcan be specified to enable/disable all services,kvmspecifies KVM and Virtual Storage,httpspecifies HTTP and HTTPS. Command confirmed to work on Wistron / Dell Poweredge C6220. 💜get-account-status— this OEM command outputs the current account status of users on the BMC. This command is particularly useful for determining which users in the system may have been locked out via authentication failures. (iykyk 😭) Command confirmed to work on Wistron / Dell Poweredge C6220.get-dns-config— this OEM command displays additional OEM DNS settings. (Seeset-dns-configbelow for the description on outputs.) Command confirmed to work on Wistron / Dell Poweredge C6220.set-dns-config KEY=VALUE ...— this OEM command sets additional OEM DNS settings on the IPMI card. The possible keys and values are:dnsdhcp=enable|disablednsserver1=ipaddressdnsserver2=ipaddressdnsregisterbmc=enable|disablednsbmchostname=stringdnsdomainnamedhcp=enable|disablednsdomainname=stringdnsregistrationdelay=seconds
So like, dnsdhcp specifies if the DNS server IP addresses should be assigned from the DHCP server. dnsserver1 and dnsserver2 specify the IP address for server 1 and 2 respectively. These fields are read only if dnsdhcp and DHCP are enabled. dnsregisterbmc specifies if the BMC host name is registered via the DNS server. dnsbmchostname specifies the BMC host name. This field is read only if dnsregisterbmc is enabled. dnsdomainnamedhcp specifies if the DNS domainname should be assigned from the DHCP server. dnsdomainname specifies the DNS domain name string. This field is read only if dnsdomainnamedhcp is enabled. dnsregistrationdelay specifies the delay the BMC should take after the IPMI process is up and running. Multiple key=value pairs may be specified. If no key=value pairs are specified, available pairs are output. Command confirmed to work on Wistron / Dell Poweredge C6220. ✨
get-web-server-config— this OEM command gets the current web server configuration on the IPMI card. Command confirmed to work on Wistron / Dell Poweredge C6220.set-web-server-config KEY=VALUE...— this OEM command sets the current web server configuration on the IPMI card. The possible keys and values arewebserver=enable|disable,webservertimeout=seconds,httpportnumber=num, andhttpsportnumber=num. Multiplekey=valuepairs may be specified. If nokey=valuepairs are specified, available pairs are output. Command confirmed to work on Wistron / Dell Poweredge C6220. 🍓get-power-management-config— this OEM command gets the current power management configuration on the IPMI card. Command confirmed to work on Wistron / Dell Poweredge C6220.set-power-management-config KEY=VALUE ...— this OEM command sets the current power management configuration on the IPMI card. The possible keys and values arepowerstaggeringacrecovery=immediate|auto|user,powerondelay=seconds, andmaxpowerondelay=seconds. Forpowerstaggeringacrecovery,immediatespecifies no delay,autogenerates a delay time between the minimum and maximum configured, anduseruses the user defined time defined bypowerondelay.powerondelaymust be within the minimum and maximum power on delay times. Multiplekey=valuepairs may be specified. If nokey=valuepairs are specified, available pairs are output. Command confirmed to work on Wistron / Dell Poweredge C6220. ⭐get-ipv6-settings— this OEM command gets the current IPv6 settings on the IPMI card. Command confirmed to work on Wistron / Dell Poweredge C6220. 🦋set-ipv6-settings KEY=VALUE ...— this OEM command sets the current IPv6 settings on the IPMI card. The possible keys and values areipv6=enable|disable,ipv6address=ipaddress,ipv6gatewayipaddress=ipaddress,ipv6prefixlength=length,ipv6autoconfig=enable|disable,ipv6autodns=enable|disable,ipv6dnsserver1=ipaddress, andipv6dnsserver2=ipaddress. If nokey=valuepairs are specified, available pairs are output. Some fields may be read-only on specific Poweredge systems. Command confirmed to work on Wistron / Dell Poweredge C6220. 💖get-ipv6-trap-settings— this OEM command gets the current IPv6 SNMP trap settings on the IPMI card. Command confirmed to work on Wistron / Dell Poweredge C6220.set-ipv6-trap-settings index KEY=VALUE ...— sets the current IPv6 SNMP trap settings on the IPMI card, bestie 💅. The index is literally the index position for the configuration, and then you follow it up with a little set of configuration keys and values. The possible keys and values aredestinationtype=pet|oem1|oem2,alertacktimeout=seconds,retries=count, andipv6snmptrapaddress=ipaddress. And here's the cute part — if you specify nokey=valuepairs at all, the available pairs get output for you ✨. Heads up though: some fields may be read-only on specific Poweredge systems 🙈. Command confirmed to work on Wistron / Dell Poweredge C6220.get-sol-idle-timeout— gets the SOL idle timeout, periodt. Command confirmed to work on Wistron / Dell Poweredge C6220 💖.set-sol-idle-timeout idle-timeout— sets the SOL idle timeout. The idle-timeout is one-based, max of 65535, in 1 minute increments (e.g.1= 1 minute), and0or"none"will configure no timeout. Command confirmed to work on Wistron / Dell Poweredge C6220 🌸.get-telnet-redirect-function— gets the telnet redirect function, no cap. Command confirmed to work on Wistron / Dell Poweredge C6220.set-telnet-redirect-function disable|solenable|smashenable— enables or disables the telnet redirect function, slay. Command confirmed to work on Wistron / Dell Poweredge C6220 🦋.get-dhcp-retry— retrieves the DHCP retry information 👑. Wistron / Dell Poweredge C6220.set-dhcp-retry retry-count retry-interval retry-timeout— sets the DHCP retry information. Let's break it down because there's a lot going on here 🫶:- retry-count is one-based, max of 254;
0or"none"will configure no retries, and255or"indefinite"will configure constant retries. - retry-interval is one-based, in 10 second increments (e.g.
1= 10 seconds). - retry-timeout is one-based, in 1 minute increments (e.g.
1= 1 minute).
- retry-count is one-based, max of 254;
After running this command, the BMC may need to be reset to finalize the configuration 😭. This may be accomplished by executing a cold-reset with bmc-device(8).
Command confirmed to work on Wistron / Dell Poweredge C6220.
get-link-status-change-control— gets the current link status change control 🌈. So if it reports"Link Down Resilience Enabled", the BMC firmware will do nothing upon detecting a Link Status Change until the DHCP lease is expired. If it reports"DHCP Re-Discovery Enabled", the BMC firmware will perform DHCP Discovery upon detecting the link status going down then back up. Command confirmed to work on Wistron / Dell Poweredge C6220 💜.set-link-status-change-control link_resilience|dhcp_rediscovery— sets the current NIC link status change control setting 🔥. (Seeset-link-status-change-controlabove for the description of the arguments.)
After running this command, the BMC may need to be reset to finalize the configuration. This may be accomplished by executing a cold-reset with bmc-device(8) ⭐.
Command confirmed to work on Wistron / Dell Poweredge C6220.
set-password-policy <enable|disable>— sets the current password policy enforcement 🔐. If the password policy is enabled, BMC passwords must meet the following requirements:- Not contain the user's name
- Be 8-14 characters long
- Contain three of the following four: an English uppercase character (
A-Z), an English lowercase character (a-z), a digit (0-9), a special character (!,$,#,%, etc.)
Command confirmed to work on Wistron / Dell Poweredge C6220.
read-proprietary-string— reads the proprietary string stored in the FRU 🎀. The proprietary string is a string the user may set for any management purpose, which is honestly such main character energy. It can also be read viaipmi-fru. Command confirmed to work on Wistron / Dell Poweredge C6220.write-proprietary-string <string>— writes the proprietary string stored in the FRU ✍️. The maximum length string is 80 characters. Command confirmed to work on Wistron / Dell Poweredge C6220.clear-proprietary-string— clears the proprietary string stored in the FRU 🧹. Command confirmed to work on Wistron / Dell Poweredge C6220.
🌈 HOSTRANGED SUPPORT 🌈
OK so multiple hosts can be input either as an explicit comma separated list of hosts, or as a range of hostnames in the general form prefix[n-m,l-k,...], where n < m and l < k, etc. Lowkey important: the latter form should not be confused with regular expression character classes (which are also denoted by [] 🙈). For example, foo[19] does not represent foo1 or foo9 — it represents a degenerate range: foo19.
This range syntax is meant only as a convenience on clusters with a prefixNN naming convention, and specification of ranges should not be considered necessary — the list foo1,foo9 could be specified as such, or by the range foo[1,9] 💅.
Some examples of range usage follow:
foo[01-05] instead of foo01,foo02,foo03,foo04,foo05
foo[7,9-10] instead of foo7,foo9,foo10
foo[0-3] instead of foo0,foo1,foo2,foo3As a reminder to the reader (that's you, bestie 🫶), some shells will interpret brackets ([ and ]) for pattern matching. Depending on your shell, it may be necessary to enclose ranged lists within quotes ⚠️.
When multiple hosts are specified by the user, a thread will be executed for each host in parallel up to the configured fanout (which can be adjusted via the -F option). This will allow communication to large numbers of nodes far more quickly than if done in serial — iconic behaviour honestly ⚡.
By default, standard output from each node specified will be output with the hostname prepended to each line. Although this output is readable in many situations, it may be difficult to read in other situations 😭 — for example, output from multiple nodes may be mixed together. The -B and -C options can be used to change this default.
In-band IPMI Communication will be used when the host "localhost" is specified. This allows the user to add the localhost into the hostranged output 💖.
🌸 GENERAL TROUBLESHOOTING 🌸
Okay bestie, listen — most of the time when IPMI is acting up, it's literally just a config problem. That's it. That's the whole vibe. 💅
🦋 when it's IPMI over LAN
If you're doing IPMI over LAN and things are broken, it's almost always the remote machine's BMC being misconfigured. So double check these are all set up correctly in the remote machine's BMC, bestie:
- IP address
- MAC address
- subnet mask
- username
- user enablement
- user privilege
- password
- LAN privilege
- LAN enablement
- allowed authentication type(s)
And for IPMI 2.0 connections specifically, double check that the cipher suite privilege(s) and the K_g key are configured properly too. 💖
The good news? The ipmi-config(8) tool exists and you can use it to check and/or change all these configuration settings. Slay. ✨
🧚 when it's inband
Inband IPMI problems are typically caused by improperly configured drivers or non-standard BMCs. No cap, that's usually the culprit.
Also, in addition to the troubleshooting tips below, please see WORKAROUNDS below to check if there are any vendor specific bugs that have been discovered and worked around. 👑
⭐ the error message cheat sheet ⭐
Listed below are many of the common issues for error messages. For additional support, please e-mail the freeipmi-users@gnu.org mailing list. 🫶
"username invalid"— The username entered (or a NULL username if none was entered) is not available on the remote machine. It may also be possible the remote BMC's username configuration is incorrect."password invalid"— The password entered (or a NULL password if none was entered) is not correct. It may also be possible the password for the user is not correctly configured on the remote BMC."password verification timeout"— Password verification has timed out. A"password invalid"error (described above) or a generic"session timeout"(described below) occurred. During this point in the protocol it cannot be differentiated which occurred. 😭"k_g invalid"— The K_g key entered (or a NULL K_g key if none was entered) is not correct. It may also be possible the K_g key is not correctly configured on the remote BMC."privilege level insufficient"— An IPMI command requires a higher user privilege than the one authenticated with. Please try to authenticate with a higher privilege. This may require authenticating to a different user which has a higher maximum privilege."privilege level cannot be obtained for this user"— The privilege level you are attempting to authenticate with is higher than the maximum allowed for this user. Please try again with a lower privilege. It may also be possible the maximum privilege level allowed for a user is not configured properly on the remote BMC."authentication type unavailable for attempted privilege level"— The authentication type you wish to authenticate with is not available for this privilege level. Please try again with an alternate authentication type or alternate privilege level. It may also be possible the available authentication types you can authenticate with are not correctly configured on the remote BMC."cipher suite id unavailable"— The cipher suite id you wish to authenticate with is not available on the remote BMC. Please try again with an alternate cipher suite id. It may also be possible the available cipher suite ids are not correctly configured on the remote BMC."ipmi 2.0 unavailable"— IPMI 2.0 was not discovered on the remote machine. Please try to use IPMI 1.5 instead. 🦋"connection timeout"— Initial IPMI communication failed. A number of potential errors are possible, including an invalid hostname specified, an IPMI IP address cannot be resolved, IPMI is not enabled on the remote server, the network connection is bad, etc. Please verify configuration and connectivity."session timeout"— The IPMI session has timed out. Please reconnect. If this error occurs often, you may wish to increase the retransmission timeout. Some remote BMCs are considerably slower than others. 💀"device not found"— The specified device could not be found. Please check configuration or inputs and try again."driver timeout"— Communication with the driver or device has timed out. Please try again."message timeout"— Communication with the driver or device has timed out. Please try again."BMC busy"— The BMC is currently busy. It may be processing information or have too many simultaneous sessions to manage. Please wait and try again."could not find inband device"— An inband device could not be found. Please check configuration or specify specific device or driver on the command line."driver timeout"— The inband driver has timed out communicating to the local BMC or service processor. The BMC or service processor may be busy or (worst case) possibly non-functioning. 🙈
Not a typo, babe — "driver timeout" really does show up twice with two different meanings. Read the description to know which one you got, iykyk. 💜
the whole "your board is quirky" situation — okay so real talk, every vendor out there is out here writing their own IPMI implementation, and some of them are just... not it. Different vendors may implement their IPMI protocols incorrectly, bestie. So here's the rundown of every workaround we currently have on deck for when we catch a compliance issue in the wild. When possible, workarounds have been implemented so they'll be transparent to you (iconic, no notes), but some will require you to specify a workaround be used via the -W option. 💅
The hardware listed below may only indicate the hardware that a problem was discovered on — newer versions of hardware may have already fixed the problems indicated below. Similar machines from vendors may or may not exhibit the same problems. And here's the tea: different vendors may license their firmware from the same IPMI firmware developer, so it may genuinely be worthwhile to try the workarounds listed below even if your motherboard isn't listed. Periodt.
If you believe your hardware has an additional compliance issue that needs a workaround to be implemented, please contact the FreeIPMI maintainers on <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>. 🫶
assumeio— this workaround flag will assume inband interfaces communicate with system I/O rather than being memory-mapped. It works around systems that report invalid base addresses. Those hitting this issue may seedevice not supportedorcould not find inband deviceerrors. Issue observed on HP ProLiant DL145 G1. 🔍spinpoll— this workaround flag will inform some inband drivers (most notably the KCS driver) to spin while polling rather than putting the process to sleep. This may significantly improve the wall clock running time of tools because an operating system scheduler's granularity may be much larger than the time it takes to perform a single IPMI message transaction. But — and this is the tradeoff, bestie — by spinning, your system may be performing less useful work by not contexting out the tool for a more useful task. 😬authcap— this workaround flag will skip early checks for username capabilities, authentication capabilities, andK_gsupport and allow IPMI authentication to succeed. It works around multiple issues in which the remote system does not properly report username capabilities, authentication capabilities, orK_gstatus. Those hitting this issue may seeusername invalid,authentication type unavailable for attempted privilege level, ork_g invaliderrors. Issue observed on Asus P5M2/P5MT-R/RS162-E4/RX4, Intel SR1520ML/X38ML, and Sun Fire 2200/4150/4450 with ELOM. ✨nochecksumcheck— this workaround flag will tell FreeIPMI to not check the checksums returned from IPMI command responses. It works around systems that return invalid checksums due to implementation errors, but the packet is otherwise valid. Users are cautioned on the use of this option, as it removes validation of packet integrity in a number of circumstances. However, it is unlikely to be an issue in most situations. Those hitting this issue may seeconnection timeout,session timeout, orpassword verification timeouterrors. On IPMI 1.5 connections, thenoauthcodecheckworkaround may also be needed too. Issue observed on Supermicro X9SCM-iiF, Supermicro X9DRi-F, and Supermicro X9DRFR. ⚠️idzero— this workaround flag will allow empty session IDs to be accepted by the client. It works around IPMI sessions that report empty session IDs to the client. Those hitting this issue may seesession timeouterrors. Issue observed on Tyan S2882 with M3289 BMC.unexpectedauth— this workaround flag will allow unexpected non-null authcodes to be checked as though they were expected. It works around an issue when packets contain non-null authentication data when they should be null due to disabled per-message authentication. Those hitting this issue may seesession timeouterrors. Issue observed on Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware. 🎀forcepermsg— this workaround flag will force per-message authentication to be used no matter what is advertised by the remote system. It works around an issue when per-message authentication is advertised as disabled on the remote system, but it is actually required for the protocol. Those hitting this issue may seesession timeouterrors. Issue observed on IBM eServer 325.endianseq— this workaround flag will flip the endian of the session sequence numbers to allow the session to continue properly. It works around IPMI 1.5 session sequence numbers that are the wrong endian. Those hitting this issue may seesession timeouterrors. Issue observed on some Sun ILOM 1.0/2.0 (depends on service processor endian).noauthcodecheck— this workaround flag will tell FreeIPMI to not check the authentication codes returned from IPMI 1.5 command responses. It works around systems that return invalid authentication codes due to hashing or implementation errors. Users are cautioned on the use of this option, as it removes an authentication check verifying the validity of a packet. However, in most organizations, this is unlikely to be a security issue. Those hitting this issue may seeconnection timeout,session timeout, orpassword verification timeouterrors. Issue observed on Xyratex FB-H8-SRAY, Intel Windmill, Quanta Winterfell, and Wiwynn Windmill. 🔥intel20— this workaround flag will work around several Intel IPMI 2.0 authentication issues. The issues covered include padding of usernames, and password truncation if the authentication algorithm is HMAC-MD5-128. Those hitting this issue may seeusername invalid,password invalid, ork_g invaliderrors. Issue observed on Intel SE7520AF2 with Intel Server Management Module (Professional Edition).supermicro20— this workaround flag will work around several Supermicro IPMI 2.0 authentication issues on motherboards w/ Peppercon IPMI firmware. The issues covered include handling invalid length authentication codes. Those hitting this issue may seepassword invaliderrors. Issue observed on Supermicro H8QME with SIMSO daughter card. Confirmed fixed on newerver firmware. 🦋sun20— this workaround flag will work work around several Sun IPMI 2.0 authentication issues. The issues covered include invalid lengthed hash keys, improperly hashed keys, and invalid cipher suite records. Those hitting this issue may seepassword invalidorbmc errorerrors. Issue observed on Sun Fire 4100/4200/4500 with ILOM. This workaround automatically includes theopensessprivworkaround. ☀️opensesspriv— this workaround flag will slightly alter FreeIPMI's IPMI 2.0 connection protocol to workaround an invalid hashing algorithm used by the remote system. The privilege level sent during the Open Session stage of an IPMI 2.0 connection is used for hashing keys instead of the privilege level sent during the RAKP1 connection stage. Those hitting this issue may seepassword invalid,k_g invalid,bad rmcpplus status code, orprivilege level cannot be obtained for this usererrors. Issue observed on Sun Fire 4100/4200/4500 with ILOM, Inventec 5441/Dell Xanadu II, Supermicro X8DTH, Supermicro X8DTG, Intel S5500WBV/Penguin Relion 700, Intel S2600JF/Appro 512X, Quanta QSSC-S4R/Appro GB812X-CN, Dell C5220, and the OpenIPMI software BMC. This workaround is automatically triggered with thesun20workaround. 💜integritycheckvalue— this workaround flag will work around an invalid integrity check value during an IPMI 2.0 session establishment when using Cipher Suite ID 0. The integrity check value should be 0 length, however the remote motherboard responds with a non-empty field. Those hitting this issue may seek_g invaliderrors. Issue observed on Supermicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin Relion 700, and Intel S2600JF/Appro 512X.assumemaxsdrrecordcount— this workaround will inform SDR reading to stop reading after a known maximum number of SDR records have been read. This will work around systems that have miss-implemented SDR reading functions. Those hitting this issue may seeSDR record count invaliderrors. Issue observed on unspecified Inspur motherboard. 🙈- No IPMI 1.5 Support — some motherboards that support IPMI 2.0 have been found to not support IPMI 1.5. Those hitting this issue may see
ipmi 2.0 unavailableorconnection timeouterrors. This issue can be worked around by using IPMI 2.0 instead of IPMI 1.5 by specifying--driver-type=LAN_2_0. Issue observed on a number of HP and Supermicro motherboards.
🌈 DIAGNOSTICS 🌈
Upon successful execution, exit status is 0. On error, exit status is 1.
If multiple hosts are specified for communication, the exit status is 0 if and only if all targets successfully execute. Otherwise the exit status is 1. fr fr, all of them or it's a no from us.
💀 KNOWN ISSUES 💀
On older operating systems, if you input your username, password, and other potentially security relevant information on the command line, this information may be discovered by other users when using tools like the ps(1) command or looking in the /proc file system. It is generally more secure to input password information with options like the -P or -K options. Configuring security relevant information in the FreeIPMI configuration file would also be an appropriate way to hide this information. 🔐
In order to prevent brute force attacks, some BMCs will temporarily "lock up" after a number of remote authentication errors. You may need to wait awhile in order to this temporary "lock up" to pass before you may authenticate again. (yes, it's giving "please try again later" energy 😭)
🐛 REPORTING BUGS 🐛
Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
👑 COPYRIGHT 👑
Copyright © 2008-2015 FreeIPMI Core Team
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
🦋 SEE ALSO 🦋
freeipmi(7), ipmi-config(8), ipmi-raw(8)
http://www.gnu.org/software/freeipmi/
and that's the whole page, bestie — we did it 🎉💖
This was IPMI OEM version 1.6.20, dated 2026-10-05 — go forth and configure, you absolute main character. slay ✨🎀
📦 where this page comes from
- arch rolling: freeipmi 1.6.20-1 · GPL-3.0-or-later
- centos-stream 10: freeipmi 1.6.20-1.el10 · GPL-3.0-or-later
- centos-stream 9: freeipmi 1.6.20-1.el9 · GPLv3+
- centos-stream 9: freeipmi 1.6.20-1.el9 · GPLv3+
- 💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms