From Fedora Project Wiki
(Undo revision 181276 by Arcress (Talk))
Line 12: Line 12:


= Feature Name <!-- The name of your feature --> =
= Feature Name <!-- The name of your feature --> =
IPMIUTIL


== Summary ==
== Summary ==
<!-- A sentence or two summarizing what this feature is and what it will do.  This information is used for the overall feature summary page for each release. -->
<!-- A sentence or two summarizing what this feature is and what it will do.  This information is used for the overall feature summary page for each release. -->
An easy-to-use fully-featured IPMI server management utility. 


== Owner ==
== Owner ==
<!--This should link to your home wiki page so we know who you are-->
<!--This should link to your home wiki page so we know who you are-->
* Name: <User:FASAcountName | Your name>
* Name: Andy Cress


<!-- Include you email address that you can be reached should people want to contact you about helping with your feature, status is requested, or  technical issues need to be resolved-->
<!-- Include you email address that you can be reached should people want to contact you about helping with your feature, status is requested, or  technical issues need to be resolved-->
* Email: <Your email address>
* Email: arcress@users.sourceforge.net


== Current status ==
== Current status ==
* Targeted release: [Releases/14 | next]
* Targeted release: Releases/14
* Last updated: (DATE)
* Last updated: 11 June 2010
* Percentage of completion: XX%
* Percentage of completion: 95%


<!-- CHANGE THE "FedoraVersion" TEMPLATES ABOVE TO PLAIN NUMBERS WHEN YOU COMPLETE YOUR PAGE. -->
<!-- CHANGE THE "FedoraVersion" TEMPLATES ABOVE TO PLAIN NUMBERS WHEN YOU COMPLETE YOUR PAGE. -->


== Detailed Description ==
== Detailed Description ==
IPMIUTIL performs a series of common IPMI server management functions to allow administrators to perform management functions without a learning curve.  It can gather FRU inventory data, SEL firmware log, sensors, watchdog, power control, health, monitoring, and has an SOL console.  It can write sensor thresholds, FRU asset tags, and supports a full IPMI configuration save/restore.  Ease-of-use examples with IPMIUTIL:  configuring the IPMI LAN requires a single command, and a soft-reboot can be easily performed instead of a hard reboot.  This utility can use various existing IPMI drivers, or run in driverless mode, which is useful for boot media or test environments.  The decoding of IPMI events includes a severity, and any events not recognized at least return the data, rather than just ‘Unknown’.  Features compared to other IPMI packages: http://ipmiutil.sourceforge.net/docs/ipmisw-compare.htm


== Benefit to Fedora ==
This is a new project for Fedora.  Previous IPMI management features in Fedora were oriented bottom-up, providing IPMI features, but requiring previous IPMI knowledge and many commands to accomplish common tasks.  IPMIUTIL detects defaults rather than requiring them as input.  It has an existing following of users who see its benefits over other IPMI projects.
== Scope ==
Upstream Project: http://ipmiutil.sourceforge.net/
List of Bugs upstream: http://sourceforge.net/tracker/?group_id=116222&func=browse
Features compared to other IPMI packages: http://ipmiutil.sourceforge.net/docs/ipmisw-compare.htm
Additonal automated test scripts need to be added (<=5%)
== How To Test ==
Hardware:
This utility should be tested both locally and via IPMI LAN to the target.
There should be more than one vendor's IPMI firmware tested, for example: Intel, SuperMicro, Dell, etc.  It works with both standard servers and bladed ATCA servers. 
Software:
It runs with or without a driver on any IPMI-compliant server.  There is an existing unit test script in the project (unittest.sh) which checks minimal functionality for each area, and a more detailed automated test script is under development (testipmi.sh).  These scripts detect PASS/FAIL and abort if errors are encountered.  The scripts can be modified if desired to add additional tests.
To test remote IPMI LAN capability via testipmi.sh, the target server should first be prepared by installing ipmiutil and doing:
  # ipmiutil lan -e -I <bmc_ip> -u admin -p password
  # service ipmiutil_asy start


== User Experience ==
== User Experience ==
ipmiutil  = the command-line utility to perform various IPMI management functions, see man pages for details.
checksel  = a daily cron script to manage the IPMI SEL, copying records to syslog, and clearing it if full.
ipmi_port = a service to bind RMCP port 623 to prevent portmap from using it
ipmiutil_asy = a service to listen for async bridge requests, like soft-reboot
ipmiutil_wdt = a service to reset the IPMI watchdog every 60 seconds
libipmiutil.a = a library built in the source tree to build custom apps


ipmi_sample  = a sample custom app using libipmiutil.a


== Dependencies ==
== Dependencies ==
    
Does not depend on any external software packages, but will use any of several ipmi drivers, if running locally and the driver is loaded.    


== Contingency Plan ==
== Contingency Plan ==
 
None necessary.


== Documentation ==
== Documentation ==
*  
* UserGuide http://ipmiutil.sourceforge.net/docs/UserGuide
* Feature comparison http://ipmiutil.sourceforge.net/docs/ipmisw-compare.htm
* List of Bugs upstream: http://sourceforge.net/tracker/?group_id=116222&func=browse


== Release Notes ==
== Release Notes ==
<!-- The Fedora Release Notes inform end-users about what is new in the release.  Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
<!-- The Fedora Release Notes inform end-users about what is new in the release.  Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here.  You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release. -->
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here.  You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release. -->
*  
* Adds ipmiutil package for easy-to-use management on IPMI servers. Includes default detection of various parameters, making the provisioning and IPMI LAN remote connections much easier.  Includes optional services to automate IPMI management.


== Comments and Discussion ==
== Comments and Discussion ==
* See Talk:Features/YourFeatureName
* See Talk:Features/ipmiutil or http://lists.sourceforge.net/lists/listinfo/ipmiutil-developers


[[Category:FeaturePageIncomplete]]
[[Category:FeaturePageIncomplete]]

Revision as of 21:09, 22 June 2010

Comments and Explanations
The page source contains comments providing guidance to fill out each section. They are invisible when viewing this page. To read it, choose the "edit" link.
Copy the source to a new page before making changes! DO NOT EDIT THIS TEMPLATE FOR YOUR FEATURE.
Set a Page Watch
Make sure you click watch on your new page so that you are notified of changes to it by others, including the Feature Wrangler
All sections of this template are required for review by FESCo. If any sections are empty it will not be reviewed



Feature Name

IPMIUTIL

Summary

An easy-to-use fully-featured IPMI server management utility.

Owner

  • Name: Andy Cress
  • Email: arcress@users.sourceforge.net

Current status

  • Targeted release: Releases/14
  • Last updated: 11 June 2010
  • Percentage of completion: 95%


Detailed Description

IPMIUTIL performs a series of common IPMI server management functions to allow administrators to perform management functions without a learning curve. It can gather FRU inventory data, SEL firmware log, sensors, watchdog, power control, health, monitoring, and has an SOL console. It can write sensor thresholds, FRU asset tags, and supports a full IPMI configuration save/restore. Ease-of-use examples with IPMIUTIL: configuring the IPMI LAN requires a single command, and a soft-reboot can be easily performed instead of a hard reboot. This utility can use various existing IPMI drivers, or run in driverless mode, which is useful for boot media or test environments. The decoding of IPMI events includes a severity, and any events not recognized at least return the data, rather than just ‘Unknown’. Features compared to other IPMI packages: http://ipmiutil.sourceforge.net/docs/ipmisw-compare.htm

Benefit to Fedora

This is a new project for Fedora. Previous IPMI management features in Fedora were oriented bottom-up, providing IPMI features, but requiring previous IPMI knowledge and many commands to accomplish common tasks. IPMIUTIL detects defaults rather than requiring them as input. It has an existing following of users who see its benefits over other IPMI projects.

Scope

Upstream Project: http://ipmiutil.sourceforge.net/ List of Bugs upstream: http://sourceforge.net/tracker/?group_id=116222&func=browse Features compared to other IPMI packages: http://ipmiutil.sourceforge.net/docs/ipmisw-compare.htm Additonal automated test scripts need to be added (<=5%)

How To Test

Hardware: This utility should be tested both locally and via IPMI LAN to the target. There should be more than one vendor's IPMI firmware tested, for example: Intel, SuperMicro, Dell, etc. It works with both standard servers and bladed ATCA servers. Software: It runs with or without a driver on any IPMI-compliant server. There is an existing unit test script in the project (unittest.sh) which checks minimal functionality for each area, and a more detailed automated test script is under development (testipmi.sh). These scripts detect PASS/FAIL and abort if errors are encountered. The scripts can be modified if desired to add additional tests. To test remote IPMI LAN capability via testipmi.sh, the target server should first be prepared by installing ipmiutil and doing: 

 # ipmiutil lan -e -I <bmc_ip> -u admin -p password
 # service ipmiutil_asy start

User Experience

ipmiutil = the command-line utility to perform various IPMI management functions, see man pages for details.

checksel = a daily cron script to manage the IPMI SEL, copying records to syslog, and clearing it if full.

ipmi_port = a service to bind RMCP port 623 to prevent portmap from using it

ipmiutil_asy = a service to listen for async bridge requests, like soft-reboot

ipmiutil_wdt = a service to reset the IPMI watchdog every 60 seconds

libipmiutil.a = a library built in the source tree to build custom apps

ipmi_sample = a sample custom app using libipmiutil.a

Dependencies

Does not depend on any external software packages, but will use any of several ipmi drivers, if running locally and the driver is loaded.

Contingency Plan

None necessary.

Documentation

Release Notes

  • Adds ipmiutil package for easy-to-use management on IPMI servers. Includes default detection of various parameters, making the provisioning and IPMI LAN remote connections much easier. Includes optional services to automate IPMI management.

Comments and Discussion

Retrieved from "https://fedoraproject.org/w/index.php?title=Features/EmptyTemplate&oldid=181283"