File: README.rst

package info (click to toggle)
python-ipmi 0.4.2-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 884 kB
  • sloc: python: 9,547; makefile: 2
file content (160 lines) | stat: -rw-r--r-- 5,196 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
Pure Python IPMI Library
========================

|BuildStatus| |PyPiVersion| |Documentation| |PyPiPythonVersions| |Coveralls| |CodeClimate| |Codacy|

Features
--------
* native RMCP interface
* legacy RMCP interface (using ipmitool)
* IPMB interface (using the `Total Phase`_ Aardvark)

Tested Devices
--------------
* Kontron mTCA Carrier Manager
* Kontron CompactPCI boards
* Pigeon Point Shelf Manager
* HPE iLO3/iLO4

Requirements
------------

For IPMB interface a `Total Phase`_ Aardvark is needed.

Installation
------------

Using ``pip``
'''''''''''''

The recommended installation method is using
`pip <http://pip-installer.org>`__::

    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:

.. code:: python

    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:

.. code:: shell

    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:

.. code:: python

    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:

.. code:: shell

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

Compatibility
-------------

Python 2.7 is currently  supported.
Python 3.x support is in beta

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
  <http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html>`_.)
* 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

.. _Total Phase: http://www.totalphase.com
.. _ipmitool: http://sourceforge.net/projects/ipmitool/
.. |BuildStatus| image:: https://travis-ci.org/kontron/python-ipmi.png?branch=master
                 :target: https://travis-ci.org/kontron/python-ipmi
.. |PyPiVersion| image:: https://badge.fury.io/py/python-ipmi.svg
                 :target: http://badge.fury.io/py/python-ipmi
.. |Documentation| image:: https://readthedocs.org/projects/python-ipmi/badge/?version=latest
                   :target: https://python-ipmi.readthedocs.io/en/latest/?badge=latest
                   :alt: Documentation Status
.. |PyPiPythonVersions| image:: https://img.shields.io/pypi/pyversions/python-ipmi.svg
                        :alt: Python versions
                        :target: http://badge.fury.io/py/python-ipmi
.. |CodeClimate| image:: https://codeclimate.com/github/kontron/python-ipmi/badges/gpa.svg
                 :target: http://codeclimate.com/github/kontron/python-ipmi
.. |Coveralls|   image:: https://coveralls.io/repos/github/kontron/python-ipmi/badge.svg?branch=master
                 :target: https://coveralls.io/github/kontron/python-ipmi?branch=master
.. |Codacy|      image:: https://api.codacy.com/project/badge/Grade/bdda77c6596b4e9b8508d95805ba34c5
                 :alt: Codacy Badge
                 :target: https://app.codacy.com/app/hthiery/python-ipmi?utm_source=github.com&utm_medium=referral&utm_content=kontron/python-ipmi&utm_campaign=Badge_Grade_Dashboard