IPMICFG
User’s Guide
Revision 1.14
Supermicro IPMICFG User’s Guide
2
The information in this USER’S GUIDE has been carefully reviewed and is believed to be accurate.
The vendor assumes no responsibility for any inaccuracies that may be contained in this document,
makes no commitment to update or to keep current the information in this manual, or to notify any
person organization of the updates. Please Note: For the most up-to-date version of this manual,
please see our web site at www.supermicro.com.
Super Micro Computer, Inc. (“Supermicro”) reserves the right to make changes to the product
described in this manual at any time and without notice. This product, including software, if any, and
documentation may not, in whole or in part, be copied, photocopied, reproduced, translated or
reduced to any medium or machine without prior written consent.
DISCLAIMER OF WARRANTY ON SOFTWARE AND MATERIALS. You expressly acknowledge and agree
that use of the Software and Materials is at your sole risk. FURTHERMORE, SUPER MICRO
COMPUTER INC. DOES NOT WARRANT OR MAKE ANY REPRESENTATIONS REGARDING THE USE OR
THE RESULTS OF THE USE OF THE SOFTWARE OR MATERIALS IN TERMS OF THEIR CORRECTNESS,
ACCURACY, RELIABILITY, OR OTHERWISE. NO ORAL OR WRITTEN INFORMATION OR ADVICE GIVEN
BY SUPER MICRO COMPUTER INC. OR SUPER MICRO COMPUTER INC. AUTHORIZED REPRESENTATIVE
SHALL CREATE A WARRANTY OR IN ANY WAY INCREASE THE SCOPE OF THIS WARRANTY. SHOULD
THE SOFTWARE AND/OR MATERIALS PROVE DEFECTIVE, YOU (AND NOT SUPER MICRO COMPUTER
INC. OR A SUPER MICRO COMPUTER INC. AUTHORIZED REPRESENTATIVE) ASSUME THE ENTIRE COST
OF ALL NECESSARY SERVICE, REPAIR, OR CORRECTION.
LIMITATION OF LIABILITY. UNDER NO CIRCUMSTANCES INCLUDING NEGLIGENCE, SHALL SUPER
MICRO COMPUTER INC. BE LIABLE FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES
THAT RESULT FROM THE USE OR INABILITY TO USE THE SOFTWARE OR MATERIALS, EVEN IF SUPER
MICRO COMPUTER INC. OR A SUPER MICRO COMPUTER INC. AUTHORIZED REPRESENTATIVE HAS
BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Any disputes arising between manufacturer and customer shall be governed by the laws of Santa
Clara County in the State of California, USA. The State of California, County of Santa Clara shall be
the exclusive venue for the resolution of any such disputes. Super Micro's total liability for all claims
will not exceed the price paid for the hardware product.
Manual Revision: 1.14
Release Date: Feb 24, 2023
Unless you request and receive written permission from Super Micro Computer, Inc., you may not
copy any part of this document.
Information in this document is subject to change without notice. Other products and companies
referred to herein are trademarks or registered trademarks of their respective companies or mark
holders.
Copyright © 2023 by Super Micro Computer, Inc.
All rights reserved.
Printed in the United States of America
Supermicro IPMICFG User’s Guide
3
Document Revision History
Date
Revision
Description
2023/02/24
1.14
1. Added NVMe backplane "Rev" information.
2. Modified the SEL display format.
2022/08/10
1.13
1. Added the "-lani" command to check and configure the BMC
LAN interface.
2. Added the "-linkstatus" command to check the connection
status of the BMC LAN interface.
3. Allowed users to view and modify the information of the
multi-node systems.
4. Added support for FreeBSD 10.4 and later versions.
5. Changed the number system of BMC’s major version from
hexadecimal to decimal.
6. Changed the normal state of the PSU from "ON" to "OK."
2021/11/23
1.12
1. Modified the onscreen messages for the KCS Control privilege
levels: Operator, User, and Callback.
2021/05/28
1.11
1. Added the "Liquid Cooling" and "Smart Speed" fan modes.
2. Modified the display format of firmware version.
3. Removed the function of putting a system in lockdown mode.
4. Added the IPv6 DHCPv6 disabled mode.
5. Supported a NVMe backplane. (Firmware information: 30 02)
6. Added the severity code and event ID fields to the "-sel list"
command.
2020/07/03
1.10
1. Added the "-lockdown" command to put the system in
lockdown mode.
2. Added the "-mel list" command to list maintenance event log.
3. Added the function of listing dynamic IPv6 addresses to the
"-ipv6 list" command.
2020/06/23
1.9
1. Corrected errors in this document.
2020/01/21
1.8
1. Added options to the "-fd" command.
2. Added the "-addrptl" command to set up IP protocol.
3. Added a function to display sets of commands. (This function
is not available on DOS.)
Supermicro IPMICFG User’s Guide
4
Date
Revision
Description
2019/07/01
1.7
1. Added the EFI version of IPMICFG.
2. Added the IPv6 routing functions. (option: -ipv6)
3. Supported the UEFI PXE boot options, including -reset and -
soft commands.
4. Added the mel (Maintenance Event Log) command set.
(option: -mel)
5. Removed the -fru 1m, 1p, 1s, 2m, 2p, 2s, 3s commands.
6. Added the auxiliary firmware revision in "-ver" command.
2018/03/02
1.6
1. Added IPv6 setting functions.
2. Supported BBP2 (BBP + PSU) module.
3. Supported MRC error code for Intel® Xeon® Scalable
Processors with Intel® C620 Series Chipsets.
4. Fixed the known issues.
2017/09/01
1.5
1. Modified the NVME remove commands.
2017/06/20
1.4
1. Added the DCMI commands.
2. Removed the -recoverbiosinfo command.
2016/11/23
1.3
1. Modified description of the -fru DMI feature.
2. Modified description of the -pminfo feature.
3. Updated the “Operation Requirements” chapter.
2016/08/23
1.2
1. Added the Get/Set host name command.
2016/01/05
1.1
1. Added the TAS commands. (DOS was NOT supported)
2. Updated the NVME commands. (DOS was NOT supported)
3. Added the summary command.
2015/06/15
1. 0
Initial document.
Supermicro IPMICFG User’s Guide
5
Contents
1 IPMICFG Overview .......................................................................................................................... 6
1.1 Features ........................................................................................................................ 6
1.2 Operation Requirements .............................................................................................. 7
1.2.1 System Requirements ................................................................................................... 7
1.2.2 Software Requirements ................................................................................................ 8
1.2.3 Installing Additional Drivers .......................................................................................... 8
1.3 Typographical Conventions ........................................................................................... 8
2 Installation and Setup ..................................................................................................................... 9
2.1 Installing IPMICFG ......................................................................................................... 9
3 Basic User Operations ................................................................................................................... 10
3.1 Setting Up IPMI Addresses .......................................................................................... 11
3.1.1 Examples of Command Executions ............................................................................. 12
3.2 IPMI Management Functions ...................................................................................... 18
3.2.1 Examples of Command Executions ............................................................................. 20
3.3 Node Management (NM) 2.0 Functions ..................................................................... 23
3.3.1 Examples of Command Executions ............................................................................. 23
3.4
IPMI User & Configuration Management Functions
...................................................................... 26
3.4.1 Examples of Command Executions ............................................................................. 27
3.5 IPMI Sensor & System Event Management ................................................................ 30
3.5.1 Examples of Command Executions ............................................................................. 30
3.6 FRU Management ....................................................................................................... 32
3.6.1 Examples of Command Executions ............................................................................. 32
3.7 Multi Node Management ........................................................................................... 35
3.7.1 Examples of Command Executions ............................................................................. 35
3.8 TAS Management ........................................................................................................ 37
3.8.1 Examples of Command Executions ............................................................................. 37
3.9 NVME Management .................................................................................................... 38
3.9.1 Examples of Command Executions ............................................................................. 39
3.10 DCMI Management ..................................................................................................... 41
3.10.1 Examples of Command Executions ............................................................................. 41
4 Third Party Software ..................................................................................................................... 43
4.1 IPMI Tool ..................................................................................................................... 43
Contacting Supermicro .......................................................................................................................... 44