Skip to main content

Pure python IPMI library

Project description

BuildStatus PyPiVersion Documentation Status Python versions Coveralls CodeClimate Codacy Badge

Features

  • native RMCP interface

  • legacy RMCP interface (using ipmitool)

  • IPMB interface using the Total Phase Aardvark

  • IPMB interface using ipmb-dev driver on Linux

Tested Devices

  • Kontron mTCA Carrier Manager

  • Kontron CompactPCI boards

  • Pigeon Point Shelf Manager

  • HPE iLO3/iLO4

  • N.A.T. NAT-MCH

  • DESY MMC STAMP & related AMCs (DAMC-FMC2ZUP, DAMC-FMC1Z7IO)

Requirements

For IPMB interface a Total Phase Aardvark is needed. Another option is to use ipmb-dev driver on Linux with an I2C bus, driver of which supports slave mode: https://www.kernel.org/doc/html/latest/driver-api/ipmb.html

Installation

Using pip

The recommended installation method is using pip:

pip install python-ipmi

Manual installation

Download the source distribution package for the library. Extract the the package to a temporary location and install:

python setup.py install

Documentation

You can find the most up to date documentation at: http://python-ipmi.rtfd.org

Example

Below is an example that shows how to setup the interface and the connection using the ipmitool as backend with both network and serial interfaces.

Example with lan interface:

import pyipmi
import pyipmi.interfaces

# Supported interface_types for ipmitool are: 'lan' , 'lanplus', and 'serial-terminal'
interface = pyipmi.interfaces.create_interface('ipmitool', interface_type='lan')

connection = pyipmi.create_connection(interface)

connection.target = pyipmi.Target(0x82)
connection.target.set_routing([(0x81,0x20,0),(0x20,0x82,7)])

connection.session.set_session_type_rmcp('10.0.0.1', port=623)
connection.session.set_auth_type_user('admin', 'admin')
connection.session.establish()

connection.get_device_id()

ipmitool command:

ipmitool -I lan -H 10.0.0.1 -p 623 -U "admin" -P "admin" -t 0x82 -b 0 -l 0 raw 0x06 0x01

Example with serial interface:

import pyipmi
import pyipmi.interfaces

interface = pyipmi.interfaces.create_interface('ipmitool', interface_type='serial-terminal')

connection = pyipmi.create_connection(interface)

connection.target = pyipmi.Target(0xb2)

# set_session_type_serial(port, baudrate)
connection.session.set_session_type_serial('/dev/tty2', 115200)
connection.session.establish()

connection.get_device_id()

ipmitool command:

ipmitool -I serial-terminal -D /dev/tty2:115200 -t 0xb2 -l 0 raw 0x06 0x01

Compatibility

Both Python 2.7 and Python 3.x are currently supported.

Contributing

Contributions are always welcome. You may send patches directly (eg. git send-email), do a github pull request or just file an issue.

  • respect the coding style (eg. PEP8),

  • provide well-formed commit message (see this blog post.)

  • add a Signed-off-by line (eg. git commit -s)

License

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-ipmi-0.5.2.tar.gz (91.2 kB view details)

Uploaded Source

Built Distribution

python_ipmi-0.5.2-py3-none-any.whl (135.3 kB view details)

Uploaded Python 3

File details

Details for the file python-ipmi-0.5.2.tar.gz.

File metadata

  • Download URL: python-ipmi-0.5.2.tar.gz
  • Upload date:
  • Size: 91.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for python-ipmi-0.5.2.tar.gz
Algorithm Hash digest
SHA256 19d98fec23c31eadb769518d6c9d5e115a068446218a4fdebf2b6c98ce2ca742
MD5 474bbdd0b508a55321348a1754ee4717
BLAKE2b-256 a4bd1a66f3c8dc3ea581cc397c3a3d187acf1f5d6a9ef604665b2cd62bb32b73

See more details on using hashes here.

File details

Details for the file python_ipmi-0.5.2-py3-none-any.whl.

File metadata

  • Download URL: python_ipmi-0.5.2-py3-none-any.whl
  • Upload date:
  • Size: 135.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for python_ipmi-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4cd9cc311ccf535a101657c4e238459905baa90e2d6b34b95276b7c42d9710ea
MD5 778bf22256d806e3b82e397a734ca061
BLAKE2b-256 3f232fa7250c37bbf704521e7d26324f143a20ef61c95ad7e85b8112498d827c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page