From aff825c8ab29a3c8dc8f046499acc992dffb2fb0 Mon Sep 17 00:00:00 2001 From: Lucas Alvares Gomes Date: Thu, 11 Feb 2016 15:27:11 +0000 Subject: [PATCH] Initial Commit with code --- .gitignore | 3 + LICENSE | 176 ++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 - README.rst | 27 ++++++++ virtualbmc.py | 152 +++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 358 insertions(+), 2 deletions(-) create mode 100644 .gitignore create mode 100644 LICENSE delete mode 100644 README.md create mode 100644 README.rst create mode 100644 virtualbmc.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8db2ef0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +*.py[co] +.*.swp +*~ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..68c771a --- /dev/null +++ b/LICENSE @@ -0,0 +1,176 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + diff --git a/README.md b/README.md deleted file mode 100644 index 5ec6fe7..0000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# virtualbmc -A virtual BMC for controlling virtual machines with IPMI commands diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..7d80a2a --- /dev/null +++ b/README.rst @@ -0,0 +1,27 @@ +Virtual BMC +=========== + +A virtual BMC for controlling virtual machines with IPMI commands + +Usage +----- + +#. Create a virtual machine + +#. Run the virtual BMC:: + + python ./virtualbmc.py --domain-name + +#. Control it via IPMI:: + + # Power the virtual machine on or off + ipmitool -I lanplus -U admin -P password -H 127.0.0.1 power on|off + + # 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 diff --git a/virtualbmc.py b/virtualbmc.py new file mode 100644 index 0000000..6263719 --- /dev/null +++ b/virtualbmc.py @@ -0,0 +1,152 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import argparse +import sys +import xml.etree.ElementTree as ET + +import libvirt +import pyghmi.ipmi.bmc as bmc + +# Power states +POWEROFF = 0 +POWERON = 1 + +# Boot device maps +GET_BOOT_DEVICES_MAP = { + 'network': 4, + 'hd': 8, + 'cdrom': 0x14, +} + +SET_BOOT_DEVICES_MAP = { + 'network': 'network', + 'hd': 'hd', + 'optical': 'cdrom', +} + + +class VirtualBMC(bmc.Bmc): + def __init__(self, username, password, port, address, + domain_name, libvirt_uri): + super(VirtualBMC, self).__init__({username: password}, + port=port, address=address) + self.domain_name = domain_name + + # Create the connection + self.conn = libvirt.open(libvirt_uri) + if self.conn is None: + print('Failed to open connection to the hypervisor ' + 'using the libvirt URI: "%s"' % libvirt_uri) + sys.exit(1) + + try: + self.domain = self.conn.lookupByName(self.domain_name) + except libvirt.libvirtError: + print('Failed to find the domain "%s"' % self.domain_name) + sys.exit(1) + + def get_boot_device(self): + parsed = ET.fromstring(self.domain.XMLDesc()) + boot_devs = parsed.findall('.//os/boot') + boot_dev = boot_devs[0].attrib['dev'] + return GET_BOOT_DEVICES_MAP.get(boot_dev, 0) + + def set_boot_device(self, bootdevice): + device = SET_BOOT_DEVICES_MAP.get(bootdevice) + if device is None: + print('Uknown boot device: %s' % bootdevice) + return 0xd5 + + parsed = ET.fromstring(self.domain.XMLDesc()) + os = parsed.find('os') + boot_list = os.findall('boot') + + # Clear boot list + for boot_el in boot_list: + os.remove(boot_el) + + boot_el = ET.SubElement(os, 'boot') + boot_el.set('dev', device) + + try: + self.conn.defineXML(ET.tostring(parsed)) + except libvirt.libvirtError as e: + print('Failed setting the boot device to "%s" on the ' + '"%s" domain' % (device, self.domain_name)) + + def get_power_state(self): + try: + if self.domain.isActive(): + return POWERON + except libvirt.libvirtError as e: + print('Error getting the power state of domain "%s". ' + 'Error: %s' % (self.domain_name, e)) + return + + return POWEROFF + + def power_off(self): + try: + self.domain.destroy() + except libvirt.libvirtError as e: + print('Error powering off the domain "%s". Error: %s' % + (self.domain_name, e)) + return + + def power_on(self): + try: + self.domain.create() + except libvirt.libvirtError as e: + print('Error powering on the domain "%s". Error: %s' % + (self.domain_name, e)) + return + + +if __name__ == '__main__': + parser = argparse.ArgumentParser( + prog='Virtual BMC', + description='Virtual BMC for controlling virtual instances', + ) + parser.add_argument('--username', + dest='username', + default='admin', + help='The BMC username; defaults to "admin"') + parser.add_argument('--password', + dest='password', + default='password', + help='The BMC password; defaults to "password"') + parser.add_argument('--port', + dest='port', + type=int, + default=623, + help='Port to listen on; defaults to 623') + parser.add_argument('--address', + dest='address', + default='::', + help='Address to bind to; defaults to ::') + parser.add_argument('--domain-name', + dest='domain_name', + required=True, + help='The name of the virtual machine') + parser.add_argument('--libvirt-uri', + dest='libvirt_uri', + default="qemu:///system", + help='The libvirt URI; defaults to "qemu:///system"') + args = parser.parse_args() + vbmc = VirtualBMC(username=args.username, + password=args.password, + port=args.port, + address=args.address, + domain_name=args.domain_name, + libvirt_uri=args.libvirt_uri) + vbmc.listen()