2
0
mirror of https://opendev.org/x/pyghmi synced 2025-01-14 11:48:33 +00:00
Jarrod Johnson 758507764a Normalize spaces in values and candidates
There are some uefi configuration options that have a confusing yet
specific number of spaces in the setting.  Improve the experience by
normalizing all whitespace to single space in the candidate and
the value to select the correct one that will make it to the system.

Change-Id: I6b3e162fbaff342077bb16ebcdf492a84dd67529
2018-04-20 17:11:18 -04:00
2017-11-19 10:44:12 -05:00
2017-01-05 15:52:14 +00:00
2015-10-17 22:36:04 +00:00
2018-01-22 18:59:43 +00:00
2014-05-08 14:06:01 -04:00
2016-10-28 13:57:44 +01:00
2017-01-05 15:52:14 +00:00
2015-12-01 14:30:01 -05:00
2017-11-19 10:44:12 -05:00
2017-09-13 16:12:52 -04:00

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
Description
No description provided
Readme Apache-2.0 13 MiB
Languages
Python 99.9%
Shell 0.1%