0% found this document useful (0 votes)
1K views

Supermicro Utility User Guide IPMICFG

IPMI

Uploaded by

Djaelani Dhian
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
1K views

Supermicro Utility User Guide IPMICFG

IPMI

Uploaded by

Djaelani Dhian
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 21

Supermicro Utility

(IPMICFG)

Users Guide

Supermicro Utility IPMICFG User Guide


Manual Revision: IPMICFG 1.21.0
Document release date: 06/15/2015
Copyright 2015 Super Micro Computer, Inc.
All Rights Reserved.

Legal Notices
This software and documentation is the property of Super Micro Computer, Inc., and supplied only under
a license. Any use or reproduction of this software is not allowed, except as expressly permitted by the
terms of said license.
Information in this document is subject to change without notice.

Trademark Notice
All trademarks and copyrights referred to are the property of their respective owners.

Contact Supermicro
Headquarters
Address:

Super Micro Computer, Inc.


980 Rock Ave.
San Jose, CA 95131 U.S.A.

Tel:

+1 (408) 503-8000

Fax:

+1 (408) 503-8008

Email:

[email protected] (General Information)


[email protected] (Technical Support)

Web Site:

www.supermicro.com

Europe
Address:

Super Micro Computer B.V.


Het Sterrenbeeld 28, 5215 ML
's-Hertogenbosch, The Netherlands

Tel:

+31 (0) 73-6400390

Fax:

+31 (0) 73-6416525

Email:

[email protected] (General Information)


[email protected] (Technical Support)
[email protected] (Customer Support)

Asia-Pacific
Address:

Super Micro Computer, Inc.


4F, No. 232-1, Liancheng Rd.
Chung-Ho Dist., New Taipei City 235
Taiwan, R.O.C.

Tel:

+886-(2) 8226-3990

Fax:

+886-(2) 8226-3991

Web Site:

www.supermicro.com.tw

Technical Support:
Email:

[email protected]

Tel:

+886-(2)-8226-5990

Contents
1. IPMICFG Overview .............................................................................................................. 1
1.1 Features ......................................................................................................................... 1
1.2 Operation Requirements ................................................................................................. 1
1.3 Typographical conventions ............................................................................................. 2
2. Installation and Setup ........................................................................................................... 3
2.1 Installing IPMICFG ......................................................................................................... 3
3. Basic User Operations ......................................................................................................... 4
3.1 Set up IPMI IP Address .................................................................................................. 4
3.2 IPMI Management Functions .......................................................................................... 5
3.3 Node Management (NM) 2.0 Management Functions..................................................... 7
3.4 IPMI User & Configuration Management Functions ........................................................ 9
3.5 IPMI Sensor & System Event Management ...................................................................12
3.6 FRU Management .........................................................................................................14
4. Third Party Software ...........................................................................................................17
4.1 Phymem ........................................................................................................................17
4.2 IPMITool ........................................................................................................................17

Supermicro IPMICFG Users Guide

1. IPMICFG Overview
IPMICFG is a utility for IPMI devices configuration. It is a command line tool providing IPMI
commands and Supermicro proprietary OEM commands.
It is designed for easy to use and no pre-installation required. Use it for basic IPMI configuration
and BMC status reading and monitoring.

1.1 Features

Set up IPMI IP Address

Set up IPMI Configuration

Configure IPMI User Management

Configure IPMI FRU

Manage System Event Log (SEL)

Manage IPMI by node management (NM) protocol

1.2 Operation Requirements


To run basic operations, you must meet the following requirements:
System Requirements:
Environment
Hardware

Operating System

Requirements
Free Disk Space: 200 MB
Available RAM: 64 MB
Baseboard Management Controller (BMC) must
support Intelligent Platform Management Interface
(IPMI) version 2.0 specifications.
- DOS 5.0 or later version
- Microsoft Windows 7 / 8 / 8.1 / Server 2003 32bit
and 64bit / Server 2008 32bit and 64bit / Server 2012
Operating system must be pre-installed Microsoft
Visual C++ 2008 SP1 Redistributable Package.
Download Link: http://www.microsoft.com/enus/download/details.aspx?id=29
- RHEL 5.x or 6.x,/CentOS 5.x or 6.x(x86/x86_64)
1

Supermicro IPMICFG Users Guide

The software you should get in advance:


Program/Script
\DOS\ IPMICFG.exe
\linux\32bit\ipmicfg-linux.x86
\linux\64bit\ipmicfg-linux.x86_64
\win\32bit\ipmicfg-win.exe
\win\64bit\ipmicfg-win.exe
*.dat files

Description
IPMICFG DOS (DOS 5.0)
IPMICFG linux 32bit
IPMICFG linux 64bit version
IPMICFG Windows 32bit
IPMICFG Windows 64bit
database for MB type and SEL event table

Additional driver installation:


Linux:
IPMICFG Linux version will automatically use linux built-in ipmi driver from ipmitool to access
BMC. If there is no ipmi driver loaded, IPMICFG will use its internal API to access BMC.
However, the performance will be slow.
Here is a step to load ipmi driver.
You should be type these command to activate openIPMI driver:
1. # modprobe ipmi_msghandler
2. # modprobe ipmi_devintf
3. # modprobe ipmi_si

1.3 Typographical conventions


This manual uses the following typographical conventions.
Courier-New font size 10 represents command line instructions (CLI) in Linux terminal

mode.
Bold is used for the keyword needed to pay attention.
Italic is used for variable and section name.
enclose the parameters in syntax description.
[shell]# represents the prompt for input in Linux terminal mode.
| A vertical bar separates items in a list.
2

Supermicro IPMICFG Users Guide

2. Installation and Setup


2.1 Installing IPMICFG
Get ipmicfg_x.xx.zip installer. Then unzip it in your environment. You will see the directory list:
./dos:
./linux:
./linux/32bit:
./linux/64bit:
./win:
./win/32bit:
./win/64bit:
DOS:
Execute /DOS/ IPMICFG.exe
Linux:
Execute \linux\32bit\ ipmicfg-linux.x86
OR
Execute \linux\32bit\ ipmicfg-linux.x86_64

Windows:
Execute /win/32bit/ ipmicfg-win.exe
OR
Execute /win/64bit/ ipmicfg-win.exe

Supermicro IPMICFG Users Guide

3. Basic User Operations


Usage:
[ipmicfg_HOME] > IPMICFG <option> [data...]

3.1 Set up IPMI IP Address


Options for Using IPMICFG
-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: ###.###.###.###).
-garp on
Enable the Gratuitous ARP.
-garp off
Disable the Gratuitous ARP.

Example 1:
[ipmicfg_HOME] > IPMICFG.exe -m
IP=192.168.12.34
MAC=00:25:90:AB:CD:EF

Example 2:
[ipmicfg_HOME] > IPMICFG.exe m 192.168.56.78
IP=192.168.56.78

Supermicro IPMICFG Users Guide

Example 3:
[ipmicfg_HOME] > IPMICFG.exe dhcp
DHCP is currently disabled.

Example 4:
[ipmicfg_HOME] > IPMICFG.exe k
Subnet Mask=255.255.255.0

Example 5:
[ipmicfg_HOME] > IPMICFG.exe g
Gateway=192.168.12.254

Example 6:
[ipmicfg_HOME] > IPMICFG.exe garp on
Failed to enable Gratuitous ARP, Completion Code=80h

Gratuitous ARP means Gratuitous ARP request and Gratuitous ARP reply. It is to update ARP
table for MAC Address and IP Address mapping. But it is not supported by default for most
network devices because there is security concern. If customer needs this function, please
make sure the network devices to enable Gratuitous ARP function.

3.2 IPMI Management Functions


Options for Using IPMICFG
-clrint
Clear Chassis Intrusion.
-fd
Reset IPMI to the factory default.
5

Supermicro IPMICFG Users Guide

-fdl
-fde
-ver
-vlan
-vlan on <VLANtag>
-vlan off
-raw
-fan
-fan <mode>

option: -d | Detected IPMI device for BMC reset.


Reset IPMI to the factory default. (Clean LAN).
option: -d | Detected IPMI device for BMC reset.
Reset IPMI to the factory default. (Clean FRU & LAN).
option: -d | Detected IPMI device for BMC reset.
Get Firmware revision.
Get VLAN status.
Enable the VLAN and set the VLAN tag.
If VLANtag is not given it uses previously saved value.
Disable the VLAN.
Send a RAW IPMI request and print response.
Format: NetFn LUN Cmd [Data1 ... DataN]
Get Fan Mode.
Set Fan Mode.

Example 1:
[ipmicfg_HOME] > IPMICFG.exe -fd
Reset to the factory default completed.

Example 2:
[ipmicfg_HOME] > IPMICFG.exe ver
Firmware Version: 01.87

Example 3:
[ipmicfg_HOME] > IPMICFG.exe vlan
VLAN is now disabled.

Example 4:
[ipmicfg_HOME] > IPMICFG.exe -raw NetFN LUN
00 20 20 20 20 20

Example 5:

Supermicro IPMICFG Users Guide


[ipmicfg_HOME] > IPMICFG.exe fan
Current Fan Speed Mode is [ Optimal Mode ]

Parameter for setting:


0:Standard
1:Full
2:Optimal

Example 6:
[ipmicfg_HOME] > IPMICFG.exe fan 0
Done.

3.3 Node Management (NM) 2.0 Management Functions


Options for Using IPMICFG
-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.

Example 1:
[ipmicfg_HOME] > IPMICFG.exe nm nmsdr
Record ID

= A7 08

SDR Version

= 51h

Record Type

= C0h

Record Length

= 0Bh

Supermicro IPMICFG Users Guide


OEM ID

= 57 01 00 h

Record Subtype

= 0Dh

SubType Version

= 01h

Salve Address

= 2Ch

Channel

= 00h

Health Event Sensor Number

= 1Dh

Exception Event Sensor Number

= 1Eh

Operational Capailities Sensor Number

= 1Fh

Alert Threshold Exceeded Sensor Number = 20h

Example 2:
[ipmicfg_HOME] > IPMICFG.exe nm deviceid
Device ID

= 50h

Firmware Version = 2.1.5.95


IPMI Version

= 2.0

Manufacturer ID

= 57 01 00

Product ID Minor Ver = Romley platform


Firmware implemented version = NM Revision 2.0
Image Flag = operational image 1
raw

= 50 01 02 15 02 21 57 01 00 02 0b 02 09 50 01

Example 3:
[ipmicfg_HOME] > IPMICFG.exe nm listimagesinfo
Recovery Image:
Image Type = Recovery image
raw

= 57 01 00 02 01 02 09 55 00

Example 4:
[ipmicfg_HOME] > IPMICFG.exe nm selftest
PSU Monitoring service error. < 80 03 >
PSU[1] is not responding.

Supermicro IPMICFG Users Guide


PSU[2] is not responding.

Example 5:
[ipmicfg_HOME] > IPMICFG.exe nm cpumemtemp
CPU#0 = 43(c)
CPU#1 = 44(c)
[CPU#0]CHANNEL#1, DIMM#0(P1_DIMMB1) = 39(c)
[CPU#1]CHANNEL#3, DIMM#0(P2_DIMMH1) = 31(c)

Example 6:
[ipmicfg_HOME] > IPMICFG.exe nm hostcpudata
Host CPU data:
End of POST notification was received
Host CPU discovery data provided with that command is valid
Number of P-States = 10
Number of T-States = 15
Number of installed CPUs/socket = 2
Processor Discovery Data-1 = 19 19 18 18 17 17 17 17
Processor Discovery Data-2 = 00 00 00 00 00 00 00 00

3.4 IPMI User & Configuration Management Functions


Options for Using IPMICFG
-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>
9

Supermicro IPMICFG Users Guide

-conf upload

-conf download
-conf tupload

-conf tdownload

Update user password.


<file> <option>
Upload IPMI configuration from binary file.
option: -p | Bypass warning message.
<file> Download IPMI configuration to binaryfile.
<file> <option>
Upload IPMI configuration from text file.
option: -p | Bypass warning message.
<file> Download IPMI configuration to text file.

Example 1:
[ipmicfg_HOME] > IPMICFG.exe pminfo
[SlaveAddress = 78h] [Module 1]
Item

Value

----

-----

Status

[STATUS OK](00h)

AC Input Voltage

121.5 V

AC Input Current

0.56 A

DC 12V Output Voltage

12.19 V

DC 12V Output Current

3.18 A

Temperature 1

43C/109F

Temperature 2

41C/106F

Fan 1

224 RPM

Fan 2

0 RPM

DC 12V Output Power

42 W

AC Input Power

65 W

PMBus Revision

0x8B22

PWS Serial Number

P441PAC17GW2358

PWS Module Number

PWS-441P-1H

PWS Revision

REV1.0

Example 2:
[ipmicfg_HOME] > IPMICFG.exe psfruinfo
[SlaveAddress = 70h] [Module 1]
Item

Value

10

Supermicro IPMICFG Users Guide


----

-----

Status

On

Temperature

41C/106F

Fan 1

229 RPM

Fan 2

0 RPM

Example 3:
[ipmicfg_HOME] > IPMICFG.exe psbbpinfo
[SlaveAddress = 70h] [Module 1]
Item

Value

----

-----

Manufacturer

SUPERMICRO

Model Name

PWS-206B-1R

Serial Number

TEST1234567890A

Product Version

1.2

Firmware version

1.0

-----

Battery Voltage

16.27 V

Battery Current

0 mA

Battery Pack Temp

30C/86F

Board Temp

N/A

Power Wattage

200W

Cycle Count

-----

Battery Power Status

Normal

Remaining Energy

99%

Discharge Status

None

Discharge Setting

Auto (30 days)

Discharge Remaining Days

30 days

Battery Status

0xC0E0

[FULLY CHARGED]

[DISCHARGING]

[TERMINATE CHARGE]

11

Supermicro IPMICFG Users Guide

Example 4: (With 2 default enabled users, one is hidden in command line.)


[ipmicfg_HOME] > IPMICFG.exe user list
Maximum number of Users

: 10

Count of currently enabled Users : 2


User ID | User Name

| Privilege Level | Enable

------- | -----------

| --------------- | ------

2 | ADMIN

| Administrator

| Yes

Example 5:
[ipmicfg_HOME] > IPMICFG.exe user add 3 ADMINTEST TESTADMIN 4
Done.

Operations for Privilege Level


1
Callback
2
User
3
Operator
4
Administrator

Example 6:
[ipmicfg_HOME] > IPMICFG.exe conf download ipmi.cfg.txt
Download file successfully

Example 7:
[ipmicfg_HOME] > IPMICFG.exe conf upload ipmi.cfg.txt
This function may reboot the IPMI device.
Do you want to proceed?[y/n]: y
Upload file successfully
Please wait for 1 minute to reboot BMC.

3.5 IPMI Sensor & System Event Management


Options for Using IPMICFG
12

Supermicro IPMICFG Users Guide

-sel info
-sel list
-sel del
-sel raw
-sdr [full]
-sdr del <SDR ID>
-sdr ver <V1> <V2>

Show SEL info.


Show SEL records.
Delete all SEL records.
Show SEL raw data.
Show SDR records and reading.
Delete SDR record.
Get/Set SDR version. (V1 V2 are BCD format)

Example 1:
[ipmicfg_HOME] > IPMICFG.exe sel list
1 | 2012/11/11 15:16:12 | Chassis Intru
| Assertion:General Chassis intrusion

Example 2:
[ipmicfg_HOME] > IPMICFG.exe sel raw
SEL(

1) 01 00 02 48 00 00 00 20 00 04 05 51 6F F0 FF FF

Example 3:
[ipmicfg_HOME] > IPMICFG.exe sdr
Status | (#)Sensor

Reading | Low Limit | High Limit

------ | ---------

------- | --------- | ----------

OK | (4) CPU1 Temp

44C/111F |

0C/32F |

86C/187F

OK | (71) CPU2 Temp

44C/111F |

0C/32F |

86C/187F

OK | (138) System Temp

31C/88F |

-5C/23F |

80C/176F

OK | (205) Peripheral Temp

44C/111F |

-5C/23F |

80C/176F

OK | (272) PCH Temp

57C/135F |

-5C/23F |

90C/194F

OK | (339) FAN1

1800 RPM |

600 RPM |

18975 RPM

OK | (406) FAN2

1800 RPM |

600 RPM |

18975 RPM

| (473) FAN3

N/A |

N/A |

N/A

| (540) FAN4

N/A |

N/A |

N/A

| (607) FAN5

N/A |

N/A |

N/A

| (674) FAN6

N/A |

N/A |

N/A

| (741) FAN7

N/A |

N/A |

N/A

13

Supermicro IPMICFG Users Guide


| (808) FAN8

N/A |

N/A |

N/A

OK | (875) VTT

1.05 V |

0.91 V |

1.34 V

OK | (942) CPU1 Vcore

0.89 V |

0.54 V |

1.48 V

OK | (1009) CPU2 Vcore

0.76 V |

0.54 V |

1.48 V

OK | (1076) VDIMM ABCD

1.48 V |

1.20 V |

1.64 V

OK | (1143) VDIMM EFGH

1.50 V |

1.20 V |

1.64 V

OK | (1210) +1.5 V

1.47 V |

1.34 V |

1.64 V

OK | (1277) 3.3V

3.31 V |

2.92 V |

3.64 V

OK | (1344) +3.3VSB

3.31 V |

2.92 V |

3.64 V

OK | (1411) 5V

5.05 V |

4.48 V |

5.50 V

OK | (1478) 12V

12.29 V |

10.81 V |

13.25 V

OK | (1545) VBAT

3.26 V |

2.68 V |

3.31 V

OK | (1612) HDD Status

Fail | (1679) Chassis Intru


OK | (1746) PS1 Status

0.00

2.68

3.31

01 C0 01 00 |

N/A |

N/A

01 C0 01 00 |

N/A |

N/A

3.6 FRU Management


Options for Using IPMICFG
-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)
-fru dmi <$1> <$2>
$1 PRODUCT Manufacturer Name
<$3> <$4> <$5>
$2 PRODUCT Product Name
<$6> <$7> <$8>
$3 PRODUCT Part Number
<$9> <$10> <$11>
$4 PRODUCT Product Version
14

Supermicro IPMICFG Users Guide

<$12> <$13> <$14>

$5 PRODUCT Serial Number


$6 PRODUCT Asset Tag
$7 BOARD mfg/DateTime
$8 BOARD Board Manufacturer
$9 BOARD Product Name
$10 BOARD Part Number
$11 BOARD Serial Number
$12 CHASSIS Type (HEX value, ex:01,02,03 ...)
$13 CHASSIS Part Number
$14 CHASSIS Serial Number

Example 1:
[ipmicfg_HOME] > IPMICFG.exe fru info
FRU size :1024 bytes (Device is accessed by bytes)

Example 2:
[ipmicfg_HOME] > IPMICFG.exe fru help
Available Fields for FRU
Chassis Info Fields:
CT

;Chassis Type

CP

;Chassis Part number

CS

;Chassis Serial number

Board Info Fields:


BDT ;Board Mfg. Date/Time (YYYYMMDDhhmm)
BM

;Board Manufacturer

BPN ;Board Product Name


BS

;Board Serial Name

BP

;Board Part Number

Product Info Fields:


PM

;Product Manufacturer

PN

;Product Name

PPM ;Product Part/Model Number


PV

;Product Version

PS

;Product Serial Number

PAT ;Asset Tag

15

Supermicro IPMICFG Users Guide


Example:
ipmicfg -fru PS

;read product serial number

ipmicfg -fru PS 123456789

;write product serial number

Example 3:
[ipmicfg_HOME] > IPMICFG.exe fru BDT 201211121631
Chassis Type (CT)

= Unknown(02h)

Chassis Part number (CP)

Chassis Serial number (CS)

= 0123456789

Board Mfg. Date/Time(BDT)

= 2012/11/12 16:31:00 (DF 5D 87)

Board Manufacturer (BM)

= Supermicro

Board Product Name (BPN)

= X9DRD-iF

Board Serial number (BS)

= 0123456789

Board Part number (BP)

Product Manufacturer (PM)

= Supermicro

Product Name (PN)

= X9DRD-iF

Product Part/Model number (PPM) =


Product Version (PV)

Product Serial number (PS)

= 0123456789

Product Asset Tag (PAT)

Example 4:
[ipmicfg_HOME] > IPMICFG.exe fru tbackup fru.txt
Backup FRU successfully.

Example 5:
[ipmicfg_HOME] > IPMICFG.exe fru ver 1 1
Done.
FRU version is 01.01

16

Supermicro IPMICFG Users Guide

4. Third Party Software


4.1 Phymem
Please refer to http://www.codeproject.com/Articles/35378/Access-Physical-Memory-Port-andPCI-Configuration for more information.

4.2 IPMITool
Please refer to http://sourceforge.net/projects/ipmitool for more information.

17

You might also like