virtualbmc/README.rst
Jay Faulkner e6fa558879 Bugs are now in Launchpad, update docs to reflect
Update docs to reflect bugs being in LP now.

Change-Id: Ibe43fe463af1d7a3998acaa8b6c985b068249f91
2023-05-18 07:12:30 -07:00

55 lines
1.4 KiB
ReStructuredText

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