rmcp+: initial version

This implementation is base on the work done by Phirince Philip.

Co-Authored-by: Phirince Philip <[email protected]>
Signed-off-by: Heiko Thiery <[email protected]>

Author: hthiery

.github/workflows/test.yml

@@ -9,7 +9,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "pypy3.8", "pypy3.9", "pypy3.10"]
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "pypy3.9", "pypy3.10"]
 
     steps:
       - uses: actions/checkout@v3
@@ -19,7 +19,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Install dependencies
-        run: pip install python-coveralls coverage pytest pytest-cov flake8
+        run: pip install python-coveralls coverage pytest pytest-cov flake8 cryptography
 
         #      - name: Setup and run tests
         #        run: python setup.py test

README.rst

@@ -6,6 +6,7 @@ Pure Python IPMI Library
 Features
 --------
 * native RMCP interface
+* native RMCP+ interface (beta)
 * legacy RMCP interface (using ipmitool as backend)
 * RMCP+ interface (using ipmitool as backend)
 * system (KCS) interface (using ipmitool as backend)

examples/interface_rmcpplus.py

@@ -0,0 +1,57 @@
+#!/usr/bin/env python
+
+import sys
+
+import pyipmi
+import pyipmi.interfaces
+
+host = sys.argv[1]
+user = sys.argv[2]
+password = sys.argv[3]
+
+intf = pyipmi.interfaces.create_interface('rmcp+')
+
+sess = pyipmi.Session()
+sess.set_session_type_rmcp(host, 623)
+sess.set_auth_type_user(user, password)
+target = pyipmi.Target(ipmb_address=0x20)
+
+# (1) The device connection can either be opened and closed
+ipmi = pyipmi.Ipmi(interface=intf, session=sess, target=target)
+ipmi.open()
+device_id = ipmi.get_device_id()
+ipmi.close()
+
+# (2) or the 'with' statement can be used
+with pyipmi.Ipmi(interface=intf, session=sess, target=target) as ipmi:
+    device_id = ipmi.get_device_id()
+
+print('''
+Device ID:          %(device_id)s
+Device Revision:    %(revision)s
+Firmware Revision:  %(fw_revision)s
+IPMI Version:       %(ipmi_version)s
+Manufacturer ID:    %(manufacturer_id)d (0x%(manufacturer_id)04x)
+Product ID:         %(product_id)d (0x%(product_id)04x)
+Device Available:   %(available)d
+Provides SDRs:      %(provides_sdrs)d
+Additional Device Support:
+'''[1:-1] % device_id.__dict__)
+
+functions = (
+        ('SENSOR', 'Sensor Device'),
+        ('SDR_REPOSITORY', 'SDR Repository Device'),
+        ('SEL', 'SEL Device'),
+        ('FRU_INVENTORY', 'FRU Inventory Device'),
+        ('IPMB_EVENT_RECEIVER', 'IPMB Event Receiver'),
+        ('IPMB_EVENT_GENERATOR', 'IPMB Event Generator'),
+        ('BRIDGE', 'Bridge'),
+        ('CHASSIS', 'Chassis Device')
+)
+for n, s in functions:
+    if device_id.supports_function(n):
+        print('  %s' % s)
+
+if device_id.aux is not None:
+    print('Aux Firmware Rev Info:  [%s]' % (
+            ' '.join('0x%02x' % d for d in device_id.aux)))

pyipmi/errors.py

@@ -14,7 +14,8 @@
 # License along with this library; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
 
-from .msgs.constants import COMPLETION_CODE_DESCR, CC_ERR_CMD_SPECIFIC_DESC
+from .msgs.constants import (COMPLETION_CODE_DESCR, CC_ERR_CMD_SPECIFIC_DESC,
+                             MESSAGE_STATUS_CODE_DESCR)
 
 
 class DecodingError(Exception):
@@ -51,6 +52,7 @@ def find_cc_desc(error_cc, cmdid=None, netfn=None, group_extension=None):
                 return cc[1]
         # Then search in command specific completion codes
         if cmdid is not None:
+            print(netfn, cmdid, group_extension)
             command_cc = CC_ERR_CMD_SPECIFIC_DESC.get((netfn, cmdid, group_extension), {})
             descr = command_cc.get(error_cc, "Unknown error description")
             return descr
@@ -99,3 +101,22 @@ def __init__(self, msg=None):
 
     def __str__(self):
         return "{}".format(self.msg)
+
+
+class MessageStatusCodeError(Exception):
+    """IPMI Message Status code not OK."""
+
+    def __init__(self, msc):
+        self.msc = msc
+        self.msc_desc = self.find_msc_desc(msc)
+
+    def __str__(self):
+        return "%s cc=0x%02x desc=%s" \
+            % (self.__class__.__name__, self.msc, self.msc_desc)
+
+    @staticmethod
+    def find_msc_desc(error_msc):
+        for msc in MESSAGE_STATUS_CODE_DESCR:
+            if error_msc == msc[0]:
+                return msc[1]
+        return "Unknown error description"

pyipmi/interfaces/__init__.py

@@ -18,14 +18,15 @@
 from .aardvark import Aardvark
 from .ipmbdev import IpmbDev
 from .mock import Mock
-from .rmcp import Rmcp
+from .rmcp import (Rmcp, RmcpPlus)
 
 INTERFACES = [
     Ipmitool,
     Aardvark,
     IpmbDev,
     Mock,
     Rmcp,
+    RmcpPlus,
 ]