ovirt_functions.py

#!/usr/bin/env python
#
# Author: Pablo Iranzo Gomez (Pablo.Iranzo@redhat.com)
#
# Description: Basic common set of functions for usage in other scripts
#
# Requires rhevm-sdk to work
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, version 2 of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.    See the
# GNU General Public License for more details.

import os
import sys
import time
import getpass
import urllib
import glob
from random import choice

try:
    from ovirtsdk.api import API
    from ovirtsdk.xml import params
except ImportError:
    print "requires ovirt-engine-sdk-python rpm"
    sys.exit(1)

# FUNCTIONS
def parseoptions(basename, description, args):
    try:    
        import argparse
    except InportError:
        print "requires python-argparse rpm if < python2.7 installed"
        sys.exit(1)

    p = argparse.ArgumentParser(basename + " [arguments]", description=description)

    p.add_argument("-i", "--isoname", dest="isoname", help="ISO Filename", metavar="isoname", default="redhat.iso")
    p.add_argument("--isodomain", dest="isodomain", help="ISO Domain", metavar="isodomain", default="ISO_DOMAIN")
    p.add_argument("--storagedomain", dest="storagedomain", help="Storage Domain", metavar="storagedomain", default="STORAGE_DOMAIN")

    p.add_argument("-u", "--user", dest="username", help="Username to connect to RHEVM API", metavar="admin@internal", default="admin@internal")
    p.add_argument("-w", "--password", dest="password", help="Password to use with username", metavar="admin", default="redhat")
    p.add_argument("-k", action="store_true", dest="keyring", help="use python keyring for user/password", default=False)
    p.add_argument("-W", action="store_true", dest="askpassword", help="Ask for password", default=False)
    p.add_argument("-s", "--server", dest="server", help="RHEV-M server address/hostname to contact", metavar="server", default="127.0.0.1")
    p.add_argument("-p", "--port", dest="port", help="API port to contact", metavar="443", default="443")
    p.add_argument("-v", "--verbosity", dest="verbosity", help="Show messages while running", metavar='[0-n]', default=0)
    p.add_argument("-c", "--cluster", dest="cluster", help="VM cluster", metavar="cluster", default="Default")
    p.add_argument('-d', "--datacenter", dest="datacenter", help="datacenter to create the vlan at", metavar='datacenter')
    p.add_argument("-n", "--vmname", dest="vmname", help="VM NAME", metavar="vmname", default="Default")
    p.add_argument("-l", "--vlan", dest="vlan", help="VLAN ID", metavar='vlan')
    p.add_argument("-vl", "--vlanname", dest="vlanname", help="VLAN name", metavar='vlanname')
    p.add_argument("--vmip", dest="vmip", help="VM 1st nic IP", metavar="vmip", default="127.0.0.1")
    p.add_argument("--vnictype", dest="vnictype", help="Interface type ov vnic", metavar="vnictype", default="virtio")

    p.add_argument("--vmcpu", dest="vmcpu", help="VM CPU", metavar="vmcpu", default="1")
    p.add_argument("--vmmem", dest="vmmem", help="VM RAM in GB", metavar="vmmem", default="8")
    p.add_argument("--sdtype", dest="sdtype", help="SD type", metavar="sdtype", default="Default")
    p.add_argument("--sdsize", dest="sdsize", help="SD size", metavar="sdsize", default="20")
    p.add_argument("--osver", dest="osver", help="OS version", metavar="osver", default="rhel_6x64")
    p.add_argument("--vmgest", dest="vmgest", help="Management network to use", metavar="vmgest", default="rhevm")
    p.add_argument("--vmserv", dest="vmserv", help="Service Network to use", metavar="vmserv", default="rhevm")

    p.add_argument("--host", dest="host", help="Show messages while running", metavar='host')
    p.add_argument("--storage", dest="storage", help="Show messages while running", metavar='storage')
    p.add_argument("--table", dest="table", help="Input file in CSV format", metavar='table')

    p.add_argument("--templatename", dest="templatename", help="VM template name", metavar="templatename", default="Blank")
    p.add_argument("--templatetype", dest="templatetype", help="VM template type", metavar="templatetype", default="Server")
    p.add_argument("--tagall", dest="tagall", help="Tag all hosts with elas_manage", metavar='0/1', default=0)

    p.add_argument("-a", "--action", dest="action", help="Power action to execute", metavar="action", default="pm-suspend")
    p.add_argument("--ha", dest="ha", help="High Availability enabled", metavar="ha", default="1")
    p.add_argument("--delay", dest="delay", help="Set delay to way until activation after install is sent", metavar='delay', default=900)
    p.add_argument("-q", "--query", action="store_true", dest="query", help="Query the values stored", default=False)
    p.add_argument("-f", "--file", dest="file", help="OVF file to parse", metavar='ovf', default=None)
    p.add_argument("--policy", dest="policy", help="Set destination policy", metavar='policy', default="power_saving")
    p.add_argument("--batch", dest="batch", help="Batch number of hosts to return from maintenance", metavar='[0-n]', default=5)
    p.add_argument("--bond", dest="bond", help="Bond to create under", metavar='bond', default="bond0")

    p.add_argument("--startday", dest="startday", help="Starting day of period", metavar="startday", default="1")
    p.add_argument("--endday", dest="endday", help="Ending day of period, defaults to end of month", metavar="endday")
    p.add_argument("--month", dest="month", help="Month to gather data from", metavar="month")
    p.add_argument("--year", dest="year", help="Year to gather data from", metavar="year")

    p.add_argument("--dbname", dest="dbname", help="RHEV-M database name", metavar="dbname", default="engine")
    p.add_argument("--dbuser", dest="dbuser", help="RHEV-M database user", metavar="dbuser", default="engine")
    p.add_argument("--dbpass", dest="dbpass", help="RHEV-M database password", metavar="dbpass", default="redhat")
    p.add_argument("-D", action="store_true", dest="dbaskpassword", help="Ask for DB password", default=False)

    p.add_argument('-m', "--machine", dest="machine", help="Machine name beggining", metavar="machine", default=None)
    p.add_argument("--reverse", dest="reverse", help="Reverse behaviour with machine name", metavar="reverse", default=0)
    p.add_argument("--release", dest="release", help="Select release to deploy. Like 20130528.0.el6_4", metavar="release", default="latest")





    options = p.parse_args()

    return options


def getuserpass(options):
    """Checks if it should ask for password interactively, use the keyring or just return the default values or
    commandline values provided by arguments.

    @param options: Options gathered from the script executed by user
    """
    if options.keyring:
        import keyring
        options.username = keyring.get_password('rhevm-utils', 'username')
        options.password = keyring.get_password('rhevm-utils', 'password'),
    elif options.askpassword:
        options.password = getpass.getpass("Enter password: ")
    return options.username, options.password


def check_version(api, major, minor):
    """Checks if required version or higher is installed
    @param api: points to API object to reuse access
    @param major: Major version for available RHEV-H release
    @param minor: Minor  version for available RHEV-H release
    """
    valid = False
    if api.get_product_info().version.major >= major:
        if api.get_product_info().version.minor >= minor:
            valid = True
    return valid


def apilogin(url, username, password, insecure=True, persistent_auth=True, session_timeout=36000):
    """
    @param url: URL for RHEV-M  / Ovirt
    @param username: username to use
    @param password: password for username
    @param insecure: if True, do not validate SSL cert
    @param persistent_auth: Use persistent authentication
    @param session_timeout: Session timeout for non-persistent authentication
    @return:
    """
    api = None

#Grab crt if not present
#if os.path.isfile("rhevm.cer") is False:
#    cafile = urllib.URLopener()
#    cafile.retrieve("http://cloud.suffolk.harris.com/ca.crt", "rhevm.cer")
#
    try:
        api = API(url=url, username=username, password=password, insecure=insecure, persistent_auth=persistent_auth,
                  session_timeout=session_timeout)
    except:
        print("Error while logging in with supplied credentials, please check and try again")
        sys.exit(1)

    return api


def check_tags(api, options):
    """Checks if required tags have been already defined and creates them if missing

    @param api: points to API object to reuse access
    @param options: points to options object to reuse values provided on parent
    """
    if options.verbosity >= 1:
        print("Looking for tags prior to start...")

    tags = "elas_maint elas_manage elas_start elas_upgrade "

    for tag in tags:
        if not api.tags.get(name=tag):
            if options.verbosity >= 2:
                print "Creating tag %s..." % tag
            api.tags.add(params.Tag(name=tag))

    return


def migra(api, options, vm, action=None):
    """Initiates migration action of the vm to specified host or automatically if None
    @param api: points to API object to reuse access
    @param options: points to options object to reuse values provided on parent
    @param action: host to migrate the VM to or use default
    @param vm: vm to work on
    """
    if not action:
        try:
            vm.migrate()
        except:
            if options.verbosity > 4:
                print("Problem migrating auto %s" % vm.name)
    else:
        try:
            vm.migrate(action)
        except:
            if options.verbosity > 4:
                print("Problem migrating fixed %s" % vm.name)

    loop = True
    counter = 0
    while loop:
        if vm.status.state == "up":
            loop = False
        if options.verbosity > 8:
            print("VM migration loop %s" % counter)
        time.sleep(10)
        counter += 1

        if counter > 12:
            loop = False
            if options.verbosity > 8:
                print("Exiting on max loop retries")
    return


def vmused(api, vm):
    """Returns amount of memory used by the VM from Agent if installed or configured if not
    @param api: points to API object to reuse access
    @param vm: vm to work on
    """
    # Get memory usage from agent
    used = vm.statistics.get("memory.used").values.value[0].datum
    if used == 0:
        # If no value received, return installed memory
        used = vm.statistics.get("memory.installed").values.value[0].datum

    return used


def paginate(element, oquery=""):
    """
    Paginates results of .list() for an object to avoid api limitations,
    it is created as generator to improve performance.

    @param element: points to api object for reuse
    @param oquery:  optional query to pass to limit search results
    """

    page = 0
    length = 100
    while length > 0:
        page += 1
        query = "%s page %s" % (oquery, page)
        tanda = element.list(query=query)
        length = len(tanda)
        for elem in tanda:
            yield elem


if __name__ == "__main__":
    print("This file is intended to be used as a library of functions and it's not expected to be executed directly")