IPMI configuration for Supermicro servers with ipmicfg

From Thomas-Krenn-Wiki
Jump to navigation Jump to search

This article describes the tool ipmicfg for Supermicro systems. Alternatively, when the server is operated on Linux, the ipmitool (see article Configuring IPMI on Linux using ipmitool) or FreeIPMI can also be used. Older systems could be also interesting for the tools IPnMAC and XGICFG. Information can be found in the article IPMI Configuration for Supermicro Systems

If there are problems with the configuration, it may be because the required modules have not been loaded. Please take the following article into consideration: IPMI Init Script for Debian


Basic configuration

Screenshot ipmicfg.exe on Windows

IPMICFG version 1.02 (Build 120820) provides the following options: 

root@test:~# ./ipmicfg-linux.x86_64.static 

IPMICFG Version 1.14.3 (Build 130725)
Copyright 2013 Super Micro Computer, Inc.
Usage: IPMICFG params (Example: IPMICFG -m 192.168.1.123)
  -m                    Show IP and MAC.
  -m IP                 Set IP (format: ###.###.###.###).
  -a MAC                Set MAC (format: ##:##:##:##:##:##).
  -k                    Show Subnet Mask.
  -k Mask               Set Subnet Mask (format: ###.###.###.###).
  -dhcp                 Get the DHCP status.
  -dhcp on              Enable the DHCP.
  -dhcp off             Disable the DHCP.
  -g                    Show Gateway IP.
  -g IP                 Set Gateway IP (format: ###.###.###.###).
  -r                    BMC cold reset.
                        option: -d | Detected IPMI device for BMC reset.
  -garp on              Enable the Gratuitous ARP.
  -garp off             Disable the Gratuitous ARP.
  -fd                   Reset to the factory default.
                        option: -d | Detected IPMI device for BMC reset.
  -fdl                  Reset to the factory default. (Clean LAN)
                        option: -d | Detected IPMI device for BMC reset.
  -fde                  Reset to the factory default. (Clean FRU & LAN)
                        option: -d | Detected IPMI device for BMC reset.
  -ver                  Get Firmware revision.
  -vlan                 Get VLAN status.
  -vlan on <VLANtag>    Enable the VLAN and set the VLAN tag.
                        If VLANtag is not given it uses previously saved value.
  -vlan off             Disable the VLAN.
  -selftest             Checking and reporting on the basic health of BMC.
  -raw                  Send a RAW IPMI request and print response.
                        Format: NetFn Cmd [Data1 ... DataN]
  -fru info             Show FRU inventory area Info.
  -fru list             Show all FRU values.
  -fru cthelp           Show chassis type code.
  -fru help             Show help of FRU Write.
  -fru <Field>          Show FRU field value.
  -fru <Field> <Value>  Write FRU.
  -fru 1m               Update FRU Product Manufacturer from DMITable.
  -fru 1p               Update FRU Product Prodcut Name from DMITable.
  -fru 1s               Update FRU Product S/N from DMITable.
  -fru 2m               Update FRU Board Manufacturer from DMITable.
  -fru 2p               Update FRU Board Product Name from DMITable.
  -fru 2s               Update FRU Board S/N from DMITable.
  -fru 3s               Update FRU Chassis S/N from DMITable.
  -fru backup <file>    Backup FRU to file <Binary format>.
  -fru restore <file>   Restore FRU from file <Binary format>.
  -fru tbackup <file>   Backup FRU to file <Text format>.
  -fru trestore <file>  Restore FRU from file <Text format>.
  -fru ver <V1> <V2>    Get/Set FRU version. (V1 V2 are BCD format)
  -sel info             Show SEL info.
  -sel list             Show SEL records.
  -sel del              Delete all SEL records.
  -sel raw              Show SEL raw data.
  -sdr                  Show SDR records and reading.
  -sdr del <SDR ID>     Delete SDR record.
  -sdr ver <V1> <V2>    Get/Set SDR version. (V1 V2 are BCD format)
  -nm nmsdr             Display NM SDR.
  -nm seltime           Get SEL time.
  -nm deviceid          Get ME Device ID.
  -nm reset             Reboots ME.
  -nm reset2default     Force ME reset to Default.
  -nm updatemode        Force ME to Update Mode.
  -nm selftest          Get Self Test Results.
  -nm listimagesinfo    List ME Images information.
  -nm oemgetpower       OEM Power command for ME.
  -nm oemgettemp        OEM Temp. command for ME.
  -nm pstate            Get Max allowed CPU P-State.
  -nm tstate            Get Max allowed CPU T-State.
  -nm cpumemtemp        Get CPU/Memory temperature.
  -nm hostcpudata       Get host CPU data.
  -fan                  Get Fan Mode.
  -fan <mode>           Set Fan Mode.
  -pminfo               Power supply PMBus health.
  -psfruinfo            Power supply FRU health.
  -psbbpinfo            Battery backup power status.
  -autodischarge <module> <day>   Set auto discharge by days.
  -discharge <module>   Manually discharge battery.
  -user list            List user privilege information.
  -user help            Show user privilege code.
  -user add <user id> <user name> <password> <privilege>
                        Add user.
  -user del <user id>   Delete user.
  -user level <user id> <privilege>  Update user privilege.
  -user setpwd <user id> <password>  Update user password.
  -conf upload <file> <option>       Upload IPMI configuration form binary file.
                        option: -p | Bypass warning message.
  -conf download <file>              Download IPMI configuration to binary file.
  -conf tupload <file> <option>      Upload IPMI configuration from text file.
                        option: -p | Bypass warning message.
  -conf tdownload <file>             Download IPMI configuration to text file.
  -clrint               Clear chassis intrusion.
root@test:~#

To configure the IPMI module for the first time, it is necessary to state the IP address through which the IPMI module should be accessible. 

ipmicfg -m ###.###.###.###

After that, the IPMI module is available via web interface.

Factory default settings

To set the IPMI module on the default settings, please enter 

ipmicfg -fd

Please note that all settings, including all users, are deleted. Furthermore, the DHCP server is switched on after reset.

Problems with Offset Sensor Readings

Under certain circumstances, some sensor readings may be incorrect or may not be read at all. To solve the issue, the following steps must be performed:

Correcting Faulty IPMI Sensors by Fully Initializing the IPMI Module

Command reference

Display IP and MAC address

ipmicfg -m

Set IP address

ipmicfg -m ###.###.###.###

Set MAC address

ipmicfg -a ##:##:##:##:##:##

Display Subnet mask

ipmicfg -k

Set Subnet mask

ipmicfg -k ###.###.###.###

Switch on DHCP

ipmicfg -dhcp on

Switch off DHCP

ipmicfg -dhcp off

Display Gateway IP address

ipmicfg -g

Set Gateway IP address

ipmicfg -g ###.###.###.###


BMC Cold Reset

ipmicfg -r

Recreate default settings

ipmicfg -fd

Enable the Gratuitous ARP

ipmicfg -garp on

Disable the Gratuitous ARP

ipmicfg -garp off

Download ipmicfg

If the ipmicfg is not yet installed on the system, it can be downloaded via Thomas-Krenn download area. For this, select the specific mainboard.

At Supermicro, it is available here:

Author: Benjamin Bayer

Translator: Alina Ranzinger

Alina has been working at Thomas-Krenn.AG since 2024. After her training as multilingual business assistant, she got her job as assistant of the Product Management and is responsible for the translation of texts and for the organisation of the department.


Related articles

FreeIPMI ipmimonitoring versions
Show article
FreeIPMI version information
Show article
How to activate and configure SNMP in TKMI
Show article