Metadata-Version: 2.4
Name: virtualbmc
Version: 3.4.0
Summary: Create virtual BMCs for controlling virtual instances via IPMI
Author-email: OpenStack <openstack-discuss@lists.openstack.org>
License-Expression: Apache-2.0
Project-URL: Homepage, https://docs.openstack.org/virtualbmc
Project-URL: Repository, https://opendev.org/openstack/virtualbmc
Project-URL: Bugs, https://bugs.launchpad.net/virtualbmc
Classifier: Environment :: OpenStack
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS
Requires-Dist: pbr!=2.1.0,>=2.0.0
Requires-Dist: libvirt-python>=6.0.0
Requires-Dist: pyghmi>=1.2.0
Requires-Dist: cliff!=2.9.0,>=2.8.0
Requires-Dist: pyzmq>=19.0.0
Dynamic: license-file
Dynamic: requires-dist

==========
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

  # Connect to the VM's default serial console
  ipmitool -I lanplus -C 3 -U admin -P password -H 127.0.0.1 sol activate

Serial-over-LAN
~~~~~~~~~~~~~~~

SOL bridges one authenticated IPMI client to the libvirt domain's default
console. It supports activation while powered off and reconnects the stream
after VM power cycles. See ``doc/source/user/sol.rst`` for prerequisites
and limitations.

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
