IPMICFG Release Notes
================================================

Software Release Version: 1.22.0
Release Date: 08/14/2015



Introduction
============
IPMICFG is a command line tool that let user set IPMI command through keyboard controller style (KCS) to the device that support Intelligent Platform Management Interface (IPMI) version 2.0 specifications.



Requirements
============
 - Operating system:
    * Microsoft Dos 5.0 or later version
    * Windows Server 2003, 2008, 2012 (32/64bit)
        - Operating system must be pre-installed Microsoft Visual C++ 2008 SP1 Redistributable Package
        Download Link: http://www.microsoft.com/en-us/download/details.aspx?id=29
      Windows 7/8/8.1/10:
        - Need disabled UAC(User Account Control) or open a command prompt with a run as administrator.
    * Linux Kernel version 2.6.x (ex: RHEL 5.x or 6.x, CentOS 5.x or 6.x)
    * Free Disk Space: 200 MB (Linux, Windows)
    * Available RAM: 64 MB
 - Hardware:
    * Baseboard Management Controller (BMC) must support Intelligent Platform Management Interface (IPMI) version 2.0 specifications.



Installation and Upgrade Instructions
=====================================
For Dos
-------
Execute IPMICFG.exe


For Window
----------
Execute ipmicfg-win.exe


For Linux
---------
If your system has installed OpenIPMI driver, you can enabled Linux IPMI driver:
# /etc/init.d/ipmi start
or
# modprobe ipmi_msghandler
# modprobe ipmi_devintf
# modprobe ipmi_si

Then execute ipmicfg-linux.x86 or ipmicfg-linux.x86_64

if not, you can also execute ipmicfg-linux.x86 or ipmicfg-linux.x86_64


Third Party Software
====================
1. Phymem
	Please refer to	http://www.codeproject.com/Articles/35378/Access-Physical-Memory-Port-and-PCI-Configuration for more information.
2. IPMITool
	Please refer to http://sourceforge.net/projects/ipmitool for more information.


Version History
===============

IPMICFG 1.22.0
=========================
Additions
---------
	1. Update board id.
	2. Update GUID.

Modify
---------
	1. When impicfg failed, error message will store to stderr variable.
	2. When input wrong parameter, ipmicfg will print all the parameters explaination and cancel pause screen mechanism. (Not supported Dos)
	3. When use not root permission account to launch ipmicfg, ipmicfg will show tip message.

Fixes
---------
	1. Fix -sdr hang issue at SuperBlade.


IPMICFG 1.21.0
=========================
Additions
---------
	1. Add BIOS MRC Code for SEL.
	2. Add support power consumption sensor(SDR record type = 0x0b).
	3. Add SDR Type 2 to support PS Status Compact SDR.
	4. Update Fan mode.
	5. Udpate SEL description and board id.

Modify
---------
	1. Modify FatTwin Right side node ID.
	2. Modify TwinPro commands.
	3. Replace KCS driver.
	4. Update length of PWS Module Number from 12 bytes to 13 bytes.

Fixes
---------
	1. Fix memory ECC error description.


Known Issues, Limitations & Restrictions
========================================
1. 'Destination IP address' in the  first entry under alerts subsection is volatile as per the IPMI spec. So, this field will not be saved if restored to factory defaults.

2. Some parameters need IPMI OEM commands support. If not, the execute result will response error message or information. The parameters include:
  -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.
  -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.
  -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.
  -reset <index>                    Reset System and force to boot from device.
  -soft <index>                     Initiate a soft-shutdown for OS and force
                                    to boot from device.
  -recoverbiosinfo                  Get recovery BIOS information.
  -nvme list                        Display the existing NVME SSD list.
  -nvme info <aoc> <slot>           NVME SSD information.
  -nvme locate <aoc> <slot>         Locate NVME SSD.
  -nvme stoplocate <aoc> <slot>     Stop locate NVME SSD.
  -nvme eject <aoc> <slot>          Eject NVME SSD.
  -tp info                          Get MCU Info.
  -tp info <type>                   Get MCU Type Info. (type: 1 - 3)
  -tp nodeid                        Get Node ID.


Technical Support
=================
Web Site:        www.supermicro.com
Headquarters:    support@supermicro.com
European Branch: support@supermicro.nl
Asian Branch:    support@supermicro.com.tw