/pyghmi

A Pure python IPMI library
  1. Python 100.0%
Python
Find file
Latest commit 2963ecf Dec 7, 2016 @jjohnson42 jjohnson42 Correct offset of a capability bit 
Specification has corrected an internal bit offset,
so our implementation must adapt.

Change-Id: I62cf562cfd80b0bc680f41881bf64e421f503432
Permalink
Failed to load latest commit information.
bin Add support for OEM command for IPv6 address fetch Mar 21, 2016
doc/source Remove unused pngmath Sphinx extension May 10, 2016
pyghmi Correct offset of a capability bit Dec 7, 2016
.gitignore Improve .gitignore Nov 30, 2016
.gitreview Update .gitreview for new namespace Oct 17, 2015
.testr.conf Align to OpenStack Build Standards. Jun 30, 2013
LICENSE Place project under Apache license 2.0 Jun 24, 2013
MANIFEST.in Align to OpenStack Build Standards. Jun 30, 2013
README Install scripts as well as library May 8, 2014
README.md Fix bullet points in README.md Oct 28, 2016
buildrpm Add script to help build rpms Oct 11, 2016
python-pyghmi.spec Add script to help build rpms Oct 11, 2016
requirements.txt Remove libvirt from requirements Jun 3, 2015
setup.cfg Point to more specific page for pyghmi Dec 1, 2015
setup.py Add license parameter to setup.py Dec 1, 2015
test-requirements.txt Update from requirements Sep 13, 2013
tox.ini Remove support for py33/py26 Mar 23, 2016

README.md

pyghmi

Pyghmi is a pure Python (mostly IPMI) server management library.

Building and installing

(These instructions have been tested on CentOS 7)

Clone the repository, generate the RPM and install it:

$ git clone https://github.com/openstack/pyghmi.git
$ cd pyghmi/
$ python setup.py bdist_rpm
$ sudo rpm -ivh dist/pyghmi-*.noarch.rpm

Using

There are a few use examples in the bin folder:

  • fakebmc: simply fakes a BMC that supports a few IPMI commands (useful for testing)
  • pyghmicons: a remote console based on SOL redirection over IPMI
  • pyghmiutil: an IPMI client that supports a few direct uses of pyghmi (also useful for testing and prototyping new features)
  • virshbmc: a BMC emulation wrapper using libvirt

Extending

If you plan on adding support for new features, you'll most likely be interested in adding your methods to pyghmi/ipmi/command.py. See methods such as get_users and set_power for examples of how to use internal mechanisms to implement new features. And please, always document new methods.

Sometimes you may want to implement OEM-specific code. For example, retrieving firmware version information is not a part of standard IPMI, but some servers are known to support it via custom OEM commands. If this is the case, follow these steps:

  • Add your generic retrieval function (stub) to the OEMHandler class in pyghmi/ipmi/oem/generic.py. And please, document its intent, parameters and expected return values.
  • Implement the specific methods that your server supports in subdirectories in the oem folder (consider the lenovo submodule as an example). A OEM folder will contain at least one class inheriting from OEMHandler, and optionally helpers for running and parsing custom OEM commands.
  • Register mapping policies in pyghmi/ipmi/oem/lookup.py so pyghmi knows how to associate a BMC session with the specific OEM code you implemented.

A good way of testing the new feature is using bin/pyghmiutil. Just add an extension for the new feature you just implemented (as a new command) and call it from the command line:

$ IPMIPASSWORD=passw0rd bin/pyghmiutil [BMC IP address] username my_new_feature_command