A Pure python IPMI library
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Jarrod Johnson 9958b75cc6 Transform IPMI version number for XCC 2 hours ago
doc/source Update package documentation 1 year ago
playbooks/legacy/tempest-devstack-ironic-pxe_ipmitool-pyghmi-src Replace openstack.org git:// URLs with https:// 11 months ago
pyghmi Transform IPMI version number for XCC 2 hours ago
zuul.d Drop old Python versions 2 months ago
.coveragerc Switch to stestr 1 year ago
.gitignore Add more file patterns for git to ignore 1 year ago
.gitreview OpenDev Migration Patch 10 months ago
.stestr.conf Switch to stestr 1 year ago
CONTRIBUTING.rst Update package documentation 1 year ago
LICENSE Place project under Apache license 2.0 6 years ago
MANIFEST.in Align to OpenStack Build Standards. 6 years ago
README Install scripts as well as library 5 years ago
README.md Fix bullet points in README.md 3 years ago
builddeb Use python3 for pyghmi builds except Wheezy 1 month ago
buildrpm Enable package builds without pbr 1 year ago
lower-constraints.txt Prepare to switch to flake8 2 months ago
makesetup Enable package builds without pbr 1 year ago
python-pyghmi.spec Fix minor .spec issues 1 year ago
python-pyghmi.spec.tmpl Add a spec template for rpm build 4 months ago
requirements.txt Prepare to switch to flake8 2 months ago
setup.cfg Drop old Python versions 2 months ago
setup.py Refactor console scripts into entry points 1 year ago
setup.py.tmpl Add OEM extensibility framework to pyghmi redfish 10 months ago
test-requirements.txt Use flake8 for testing 2 months ago
tox.ini Use flake8 for testing 2 months ago
wheezy.patch Update the Wheezy patch 1 year ago

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