Features/ipmiutil

From FedoraProject

< Features(Difference between revisions)
Jump to: navigation, search
m (Feature Name)
(Current status)
 
(12 intermediate revisions by 2 users not shown)
Line 4: Line 4:
 
<!-- The actual name of your feature page should look something like: Features/YourFeatureName.  This keeps all features in the same namespace -->
 
<!-- The actual name of your feature page should look something like: Features/YourFeatureName.  This keeps all features in the same namespace -->
  
= Feature Name <!-- The name of your feature --> =
+
= ipmiutil =
ipmiutil  
+
  
 
== Summary ==
 
== Summary ==
Line 13: Line 12:
 
== 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: Andy Cress
+
* Name: [[User:Arcress | 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-->
Line 19: Line 18:
  
 
== Current status ==
 
== Current status ==
* Targeted release: Releases/14
+
* Targeted release: [[Releases/14| Fedora 14]]
* Last updated: 11 June 2010
+
* Last updated: 2010-07-23
* Percentage of completion: 95%
+
* Percentage of completion: 100%
 
+
* Last Koji build: 186017  ipmiutil-2.6.8-1.fc14  arcress  2010-07-22 16:07:43 complete
<!-- CHANGE THE "FedoraVersion" TEMPLATES ABOVE TO PLAIN NUMBERS WHEN YOU COMPLETE YOUR PAGE. -->
+
  (http://koji.fedoraproject.org/koji/buildinfo?buildID=186017)
  
 
== Detailed Description ==
 
== Detailed Description ==
Line 36: Line 35:
 
* List of Bugs upstream: http://sourceforge.net/tracker/?group_id=116222&func=browse
 
* 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
 
* Features compared to other IPMI packages: http://ipmiutil.sourceforge.net/docs/ipmisw-compare.htm
* Additonal automated test scripts need to be added (<=5%)
+
* Additonal automated test scripts need to be added: Completed with testipmi.sh in ipmiutil-2.6.8 cvs submission 07-22-10
  
 
== How To Test ==
 
== How To Test ==
Line 45: Line 44:
  
 
Software:
 
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.
+
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 for each test case.  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:
 
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
 
   # ipmiutil lan -e -I <bmc_ip> -u admin -p password
Line 52: Line 51:
 
== User Experience ==
 
== User Experience ==
 
ipmiutil  = the command-line utility to perform various IPMI management functions, see man pages for details.
 
ipmiutil  = the command-line utility to perform various IPMI management functions, see man pages for details.
 +
 +
ievents  = a standalone utility to interpret IPMI or PET events, especially useful at the enterprise management station for IPMI PET SNMP trap interpretation.
  
 
checksel  = a daily cron script to manage the IPMI SEL, copying records to syslog, and clearing it if full.
 
checksel  = a daily cron script to manage the IPMI SEL, copying records to syslog, and clearing it if full.
Line 60: Line 61:
  
 
ipmiutil_wdt = a service to reset the IPMI watchdog every 60 seconds
 
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
 
ipmi_sample  = a sample custom app using libipmiutil.a
Line 77: Line 76:
  
 
== 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 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.
 
* 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/ipmiutil  
+
* See [[Talk:Features/ipmiutil]]
 
* or http://lists.sourceforge.net/lists/listinfo/ipmiutil-developers
 
* or http://lists.sourceforge.net/lists/listinfo/ipmiutil-developers
  
[[Category:FeatureReadyForWrangler]]
+
[[Category:FeatureAcceptedF14]]
 
<!-- When your feature page is completed and ready for review -->
 
<!-- When your feature page is completed and ready for review -->
 
<!-- remove Category:FeaturePageIncomplete and change it to Category:FeatureReadyForWrangler -->
 
<!-- remove Category:FeaturePageIncomplete and change it to Category:FeatureReadyForWrangler -->
 
<!-- After review, the feature wrangler will move your page to Category:FeatureReadyForFesco... if it still needs more work it will move back to Category:FeaturePageIncomplete-->
 
<!-- After review, the feature wrangler will move your page to Category:FeatureReadyForFesco... if it still needs more work it will move back to Category:FeaturePageIncomplete-->
 
<!-- A pretty picture of the page category usage is at: https://fedoraproject.org/wiki/Features/Policy/Process -->
 
<!-- A pretty picture of the page category usage is at: https://fedoraproject.org/wiki/Features/Policy/Process -->

Latest revision as of 13:56, 9 August 2010


Contents

[edit] ipmiutil

[edit] Summary

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

[edit] Owner

  • Email: arcress at users.sourceforge.net

[edit] Current status

  • Targeted release: Fedora 14
  • Last updated: 2010-07-23
  • Percentage of completion: 100%
  • Last Koji build: 186017 ipmiutil-2.6.8-1.fc14 arcress 2010-07-22 16:07:43 complete
 (http://koji.fedoraproject.org/koji/buildinfo?buildID=186017)

[edit] 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

[edit] 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.

[edit] Scope

[edit] 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 for each test case. 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

[edit] User Experience

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

ievents = a standalone utility to interpret IPMI or PET events, especially useful at the enterprise management station for IPMI PET SNMP trap interpretation.

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

ipmi_sample = a sample custom app using libipmiutil.a

[edit] 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.

[edit] Contingency Plan

None necessary.

[edit] Documentation

[edit] 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.

[edit] Comments and Discussion