This project is a fork of https://github.com/openstack/virtualbmc.
Many thanks go to the OpenStack team for creating an awesome piece of software!
A virtual BMC for executing shell scripts using IPMI commands.
pip install shipmi
# 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
From the IPMI - Intelligent Platform Management Interface Specification Second Generation v2.0 Document Revision 1.1 October 1, 2013 https://www.intel.com/content/dam/www/public/us/en/documents/product-briefs/ipmi-second-gen-interface-spec-v2-rev1-1.pdf
The ShIPMI tool is a client-server system where shipmid
server
does all the heavy-lifting (speaks IPMI, calls shell scripts) while shipmi
client is merely a command-line tool sending commands to the server and
rendering responses to the user.
Both tools can make use of an optional configuration file, which is looked for in the following locations (in this order):
SHIPMI_CONFIG
environment variable pointing to a file$HOME/.shipmi/daemon.conf
file/etc/shipmi/daemon.conf
file
If no configuration file has been found, the internal defaults apply.
You should set up your systemd to launch the shipmid
server on system
start up or you can just run shipmid
from command line if you do not need
the tool running persistently on the system. Once the server is up and
running, you can use the shipmi
tool to configure your virtual BMCs as
if they were physical hardware servers.
The shipmi
client can only communicate with shipmid
server if both are running on the same host.
By this moment you should be able to have the ipmitool
managing ShIPMI instances over the network.
First create a provider that provides the shell scripts to execute. Note that you can use pipes or subshells in these scripts. You can also provide a path to an external script to execute. Relative paths are resolved relatively to the folder the provider is located in.
For example to manage Proxmox VMs using the qm
CLI,
create a file /etc/shipmi/providers/proxmox-qm.conf
with the following content:
[BOOT] get=qm config %(name)s | grep 'boot:' | sed -e 's|boot: order=scsi0.*|hd|' -e 's|boot: order=ide2.*|optical|' -e 's|boot: order=net0.*|network|' set=qm set %(name)s --boot order=$(echo %(bootdev)s | sed -e 's|hd|scsi0|' -e 's|optical|ide2|' -e 's|network|net0|') [POWER] status=qm status %(name)s | sed -e 's|status: running|on|' -e 's|status: stopped|off|' on=qm start %(name)s off=qm stop %(name)s shutdown=qm shutdown %(name)s reset=qm reset %(name)s
Use the shipmi
command-line tool to create, delete, list, start and stop virtual BMCs being managed over IPMI.
In order to see all command options supported by the
shipmi
tool do:$ shipmi --help
It's also possible to list the options from a specific command. For example, in order to know what can be provided as part of the
add
command do:$ shipmi add --help
Adding a new virtual BMC called
node-0
:$ shipmi add node-0
Adding a new virtual BMC called
node-1
that will listen for IPMI commands on port6230
:$ shipmi add node-1 --port 6230
Note
Binding a network port number below 1025 is restricted and only users with privilege will be able to start a virtual BMC on those ports.
Starting the virtual BMC called
node-0
:$ shipmi start node-0
Stopping the virtual BMC called
node-0
:$ shipmi stop node-0
Getting the list of virtual BMCs including their provider and IPMI network endpoints they are reachable at:
$ shipmi list +--------+---------+---------+------+------------+ | Name | Status | Address | Port | Provider | +--------+---------+---------+------+------------+ | node-0 | running | :: | 623 | proxmox-qm | | node-1 | running | :: | 6230 | proxmox-qm | +--------+---------+---------+------+------------+
To view configuration information for a specific virtual BMC:
$ shipmi show node-0 +-----------------------+----------------+ | Property | Value | +-----------------------+----------------+ | address | :: | | name | node-0 | | password | *** | | port | 623 | | status | running | | username | admin | | provider | proxmox-qm | +-----------------------+----------------+
Once the virtual BMC has been created and started you can then issue IPMI commands against the address and port of that virtual BMC. For example:
To power on the virtual machine:
$ ipmitool -I lanplus -U admin -P password -H 127.0.0.1 -p 6230 power on
To check its power status:
$ ipmitool -I lanplus -U admin -P password -H 127.0.0.1 -p 6230 power status
To set the boot device to disk:
$ ipmitool -I lanplus -U admin -P password -H 127.0.0.1 -p 6230 chassis bootdev disk
To get the current boot device:
$ ipmitool -I lanplus -U admin -P password -H 127.0.0.1 -p 6230 chassis bootparam get 5