A virtual BMC for controlling virtual machines using IPMI commands. Mirror of code maintained at opendev.org.
Find a file
2024-10-31 18:14:23 +00:00
doc Drop unnecessary 'x' bit from doc config file 2024-10-24 20:54:05 +09:00
releasenotes Remove Python 3.8 support 2024-10-24 20:44:23 +09:00
virtualbmc [codespell] Fixing Spelling Mistakes 2024-01-26 05:18:16 +00:00
zuul.d [codespell] Adding CI target for Tox Codespell 2024-02-12 20:55:49 +00:00
.coveragerc Switch to using stestr 2018-06-20 09:23:50 -04:00
.gitignore Merge "Switch to using stestr" 2018-07-18 20:21:39 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:45:25 +00:00
.stestr.conf Switch to using stestr 2018-06-20 09:23:50 -04:00
bindep.txt Fixes for tox 4.0 2022-12-28 15:18:14 +01:00
CONTRIBUTING.rst Bugs are now in Launchpad, update docs to reflect 2023-05-18 07:12:30 -07:00
HACKING.rst Update the documentation link for doc migration 2017-07-25 14:06:06 +08:00
LICENSE Initial Commit with code 2016-02-11 15:55:51 +00:00
README.rst Bugs are now in Launchpad, update docs to reflect 2023-05-18 07:12:30 -07:00
requirements.txt Fix lower-constraints for ubuntu focal 2020-09-11 15:21:32 -05:00
setup.cfg Remove Python 3.8 support 2024-10-24 20:44:23 +09:00
setup.py Cleanup py27 support 2020-04-05 20:21:05 +02:00
test-requirements.txt Update to match latest development cycle 2024-06-24 10:30:01 +02:00
tox.ini Update to match latest development cycle 2024-06-24 10:30:01 +02:00

==========
VirtualBMC
==========

Team and repository tags
------------------------

.. image:: https://governance.openstack.org/tc/badges/virtualbmc.svg
    :target: https://governance.openstack.org/tc/reference/tags/index.html

Overview
--------

A virtual BMC for controlling virtual machines using IPMI commands.

This software is intended for CI and development use only. Please do not run
VirtualBMC in a production environment for any reason.

Installation
~~~~~~~~~~~~

.. code-block:: bash

  pip install virtualbmc


Supported IPMI commands
~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: bash

  # Power the virtual machine on, off, graceful off, NMI and reset
  ipmitool -I lanplus -U admin -P password -H 127.0.0.1 power on|off|soft|diag|reset

  # Check the power status
  ipmitool -I lanplus -U admin -P password -H 127.0.0.1 power status

  # Set the boot device to network, hd or cdrom
  ipmitool -I lanplus -U admin -P password -H 127.0.0.1 chassis bootdev pxe|disk|cdrom

  # Get the current boot device
  ipmitool -I lanplus -U admin -P password -H 127.0.0.1 chassis bootparam get 5

Project resources
~~~~~~~~~~~~~~~~~

* Documentation: https://docs.openstack.org/virtualbmc/latest
* Source: https://opendev.org/openstack/virtualbmc
* Bugs: https://bugs.launchpad.net/virtualbmc
* Release Notes: https://docs.openstack.org/releasenotes/virtualbmc/

For information on how to contribute to VirtualBMC, see
https://docs.openstack.org/virtualbmc/latest/contributor