X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=vimconn_vmware.py;h=7836eff63658b02c08f50461d969414860632cce;hb=ed1be4b1591c258748261f21947dc388c28c6fd9;hp=20db81e9f60e4b3dd2877bb12b7ad339d63eb120;hpb=325fa1c2b18ecb0765f3733994e694ee5c42339b;p=osm%2FRO.git diff --git a/vimconn_vmware.py b/vimconn_vmware.py index 20db81e9..7836eff6 100644 --- a/vimconn_vmware.py +++ b/vimconn_vmware.py @@ -21,16 +21,21 @@ # contact with: nfvlabs@tid.es ## -''' +""" vimconn_vmware implementation an Abstract class in order to interact with VMware vCloud Director. mbayramov@vmware.com -''' +""" +from progressbar import Percentage, Bar, ETA, FileTransferSpeed, ProgressBar + +import vimconn import os +import traceback +import itertools import requests +from xml.etree import ElementTree as XmlElementTree -from xml.etree import ElementTree as ET - +import yaml from pyvcloud import Http from pyvcloud.vcloudair import VCA from pyvcloud.schema.vcd.v1_5.schemas.vcloud import sessionType, organizationType, \ @@ -38,6 +43,11 @@ from pyvcloud.schema.vcd.v1_5.schemas.vcloud import sessionType, organizationTyp networkType, vcloudType, taskType, diskType, vmsType, vdcTemplateListType, mediaType from xml.sax.saxutils import escape +from pyvcloud.schema.vcd.v1_5.schemas.admin.vCloudEntities import TaskType +from pyvcloud.schema.vcd.v1_5.schemas.vcloud.taskType import TaskType as GenericTask +from pyvcloud.schema.vcd.v1_5.schemas.vcloud.vAppType import TaskType as VappTask +from pyvcloud.schema.vcd.v1_5.schemas.admin.vCloudEntities import TasksInProgressType + import logging import json import vimconn @@ -45,303 +55,597 @@ import time import uuid import httplib +# global variable for vcd connector type +STANDALONE = 'standalone' + +# global variable for number of retry +DELETE_INSTANCE_RETRY = 3 + +VCAVERSION = '5.9' + +__author__ = "Mustafa Bayramov" +__date__ = "$26-Aug-2016 11:09:29$" +__version__ = '0.1' + +# -1: "Could not be created", +# 0: "Unresolved", +# 1: "Resolved", +# 2: "Deployed", +# 3: "Suspended", +# 4: "Powered on", +# 5: "Waiting for user input", +# 6: "Unknown state", +# 7: "Unrecognized state", +# 8: "Powered off", +# 9: "Inconsistent state", +# 10: "Children do not all have the same status", +# 11: "Upload initiated, OVF descriptor pending", +# 12: "Upload initiated, copying contents", +# 13: "Upload initiated , disk contents pending", +# 14: "Upload has been quarantined", +# 15: "Upload quarantine period has expired" + +# mapping vCD status to MANO +vcdStatusCode2manoFormat = {4: 'ACTIVE', + 7: 'PAUSED', + 3: 'SUSPENDED', + 8: 'INACTIVE', + 12: 'BUILD', + -1: 'ERROR', + 14: 'DELETED'} -__author__="Mustafa Bayramov" -__date__ ="$26-Aug-2016 11:09:29$" - +# +netStatus2manoFormat = {'ACTIVE': 'ACTIVE', 'PAUSED': 'PAUSED', 'INACTIVE': 'INACTIVE', 'BUILD': 'BUILD', + 'ERROR': 'ERROR', 'DELETED': 'DELETED' + } -#Error variables -HTTP_Bad_Request = 400 -HTTP_Unauthorized = 401 -HTTP_Not_Found = 404 -HTTP_Method_Not_Allowed = 405 -HTTP_Request_Timeout = 408 -HTTP_Conflict = 409 -HTTP_Not_Implemented = 501 -HTTP_Service_Unavailable = 503 -HTTP_Internal_Server_Error = 500 +# dict used to store flavor in memory +flavorlist = {} -class vimconnException(Exception): - '''Common and base class Exception for all vimconnector exceptions''' - def __init__(self, message, http_code=HTTP_Bad_Request): - Exception.__init__(self, message) - self.http_code = http_code -class vimconnConnectionException(vimconnException): - '''Connectivity error with the VIM''' - def __init__(self, message, http_code=HTTP_Service_Unavailable): - vimconnException.__init__(self, message, http_code) +class vimconnector(vimconn.vimconnector): + def __init__(self, uuid=None, name=None, tenant_id=None, tenant_name=None, + url=None, url_admin=None, user=None, passwd=None, log_level=None, config={}): + """ + Constructor create vmware connector to vCloud director. -class vimconnUnexpectedResponse(vimconnException): - '''Get an wrong response from VIM''' - def __init__(self, message, http_code=HTTP_Service_Unavailable): - vimconnException.__init__(self, message, http_code) + By default construct doesn't validate connection state. So client can create object with None arguments. + If client specified username , password and host and VDC name. Connector initialize other missing attributes. -class vimconnAuthException(vimconnException): - '''Invalid credentials or authorization to perform this action over the VIM''' - def __init__(self, message, http_code=HTTP_Unauthorized): - vimconnException.__init__(self, message, http_code) + a) It initialize organization UUID + b) Initialize tenant_id/vdc ID. (This information derived from tenant name) -class vimconnNotFoundException(vimconnException): - '''The item is not found at VIM''' - def __init__(self, message, http_code=HTTP_Not_Found): - vimconnException.__init__(self, message, http_code) + Args: + uuid - is organization uuid. + name - is organization name that must be presented in vCloud director. + tenant_id - is VDC uuid it must be presented in vCloud director + tenant_name - is VDC name. + url - is hostname or ip address of vCloud director + url_admin - same as above. + user - is user that administrator for organization. Caller must make sure that + username has right privileges. -class vimconnConflictException(vimconnException): - '''There is a conflict, e.g. more item found than one''' - def __init__(self, message, http_code=HTTP_Conflict): - vimconnException.__init__(self, message, http_code) + password - is password for a user. -class vimconnNotImplemented(vimconnException): - '''The method is not implemented by the connected''' - def __init__(self, message, http_code=HTTP_Not_Implemented): - vimconnException.__init__(self, message, http_code) + VMware connector also requires PVDC administrative privileges and separate account. + This variables must be passed via config argument dict contains keys + dict['admin_username'] + dict['admin_password'] -flavorlist = {} + Returns: + Nothing. + """ -class vimconnector(): - '''Vmware VIM Connector base class - ''' - def __init__(self, uuid, name, tenant_id, tenant_name, url, url_admin=None, user=None, passwd=None, log_level="ERROR", config={}): - self.id = uuid - self.name = name - self.url = url + vimconn.vimconnector.__init__(self, uuid, name, tenant_id, tenant_name, url, + url_admin, user, passwd, log_level, config) + self.id = uuid + self.name = name + self.org_name = name + self.url = url self.url_admin = url_admin self.tenant_id = tenant_id self.tenant_name = tenant_name - self.user = user - self.passwd = passwd - self.config = config - self.logger = logging.getLogger('mano.vim.vmware') + self.user = user + self.passwd = passwd + self.config = config + self.admin_password = None + self.admin_user = None - formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') - ch = logging.StreamHandler() - ch.setLevel(log_level) - ch.setFormatter(formatter) - self.logger.addHandler(ch) - self.logger.setLevel( getattr(logging, log_level)) + self.logger = logging.getLogger('openmano.vim.vmware') + self.logger.setLevel(10) -# self.logger = logging.getLogger('mano.vim.vmware') + if log_level: + self.logger.setLevel(getattr(logging, log_level)) + + try: + self.admin_user = config['admin_username'] + self.admin_password = config['admin_password'] + except KeyError: + raise vimconn.vimconnException(message="Error admin username or admin password is empty.") - self.logger.debug("Vmware tenant from VIM filter: '%s'", user) - self.logger.debug("Vmware tenant from VIM filter: '%s'", passwd) + self.org_uuid = None + self.vca = None if not url: - raise TypeError, 'url param can not be NoneType' + raise vimconn.vimconnException('url param can not be NoneType') - if not self.url_admin: #try to use normal url + if not self.url_admin: # try to use normal url self.url_admin = self.url - self.vcaversion = '5.6' - - print "Calling constructor with following paramters" - print " UUID: {} ".format(uuid) - print " name: {} ".format(name) - print " tenant_id: {} ".format(tenant_id) - print " tenant_name: {} ".format(tenant_name) - print " url: {} ".format(url) - print " url_admin: {} ".format(url_admin) - print " user: {} ".format(user) - print " passwd: {} ".format(passwd) - print " debug: {} ".format(log_level) - - def __getitem__(self,index): - if index=='tenant_id': + logging.debug("Calling constructor with following paramters") + logging.debug("UUID: {} name: {} tenant_id: {} tenant name {}".format(self.id, self.name, + self.tenant_id, self.tenant_name)) + logging.debug("vcd url {} vcd username: {} vcd password: {}".format(self.url, self.user, self.passwd)) + logging.debug("vcd admin username {} vcd admin passowrd {}".format(self.admin_user, self.admin_password)) + + # initialize organization + if self.user is not None and self.passwd is not None and self.url: + self.init_organization() + + def __getitem__(self, index): + if index == 'tenant_id': return self.tenant_id - if index=='tenant_name': + if index == 'tenant_name': return self.tenant_name - elif index=='id': + elif index == 'id': return self.id - elif index=='name': + elif index == 'name': return self.name - elif index=='user': + elif index == 'org_name': + return self.org_name + elif index == 'org_uuid': + return self.org_uuid + elif index == 'user': return self.user - elif index=='passwd': + elif index == 'passwd': return self.passwd - elif index=='url': + elif index == 'url': return self.url - elif index=='url_admin': + elif index == 'url_admin': return self.url_admin - elif index=="config": + elif index == "config": return self.config else: - raise KeyError("Invalid key '%s'" %str(index)) + raise KeyError("Invalid key '%s'" % str(index)) - def __setitem__(self,index, value): - if index=='tenant_id': + def __setitem__(self, index, value): + if index == 'tenant_id': self.tenant_id = value - if index=='tenant_name': + if index == 'tenant_name': self.tenant_name = value - elif index=='id': + elif index == 'id': self.id = value - elif index=='name': + # we use name = org #TODO later refactor + elif index == 'name': self.name = value - elif index=='user': + self.org = value + elif index == 'org_name': + self.org_name = value + self.name = value + elif index == 'org_uuid': + self.org_name = value + elif index == 'user': self.user = value - elif index=='passwd': + elif index == 'passwd': self.passwd = value - elif index=='url': + elif index == 'url': self.url = value - elif index=='url_admin': + elif index == 'url_admin': self.url_admin = value else: - raise KeyError("Invalid key '%s'" %str(index)) + raise KeyError("Invalid key '%s'" % str(index)) - def connect(self): + def connect_as_admin(self): + """ Method connect as pvdc admin user to vCloud director. + There are certain action that can be done only by provider vdc admin user. + Organization creation / provider network creation etc. - service_type = 'standalone' - version = '5.6' + Returns: + The return vca object that letter can be used to connect to vcloud direct as admin for provider vdc + """ - self.logger.debug("Logging in to a VCA '%s'", self.name) + self.logger.debug("Logging in to a vca {} as admin.".format(self.name)) - vca = VCA(host=self.url, username=self.user, service_type=service_type, version=version, verify=False, log=True) - result = vca.login(password=self.passwd, org=self.name) + vca_admin = VCA(host=self.url, + username=self.admin_user, + service_type=STANDALONE, + version=VCAVERSION, + verify=False, + log=False) + result = vca_admin.login(password=self.admin_password, org='System') if not result: - raise KeyError("Can't connect to a vCloud director.") - result = vca.login(token=vca.token, org=self.name, org_url=vca.vcloud_session.org_url) + raise vimconn.vimconnConnectionException( + "Can't connect to a vCloud director as: {}".format(self.admin_user)) + result = vca_admin.login(token=vca_admin.token, org='System', org_url=vca_admin.vcloud_session.org_url) if result is True: - self.logger.debug("Successfully logged to a VCA '%s'", self.name) + self.logger.info( + "Successfully logged to a vcloud direct org: {} as user: {}".format('System', self.admin_user)) + + return vca_admin + + def connect(self): + """ Method connect as normal user to vCloud director. - # vca = VCA(host='172.16.254.206', username=self.user, service_type='standalone', version='5.6', verify=False, log=True) - # vca.login(password=self.passwd, org=self.name) - # vca.login(token=vca.token, org=self.name, org_url=vca.vcloud_session.org_url) + Returns: + The return vca object that letter can be used to connect to vCloud director as admin for VDC + """ - # if not result: - # result = vca.login(token=vca.token, org=self.name, org_url=vca.vcloud_session.org_url) - # if not result: - # raise KeyError("Can't connect to a vcloud director") - # else: - # print "Logged to VCA via existing token" - # else: - # print "Logged to VCA" + try: + self.logger.debug("Logging in to a vca {} as {} to datacenter {}.".format(self.name, self.user, self.name)) + vca = VCA(host=self.url, + username=self.user, + service_type=STANDALONE, + version=VCAVERSION, + verify=False, + log=False) + + result = vca.login(password=self.passwd, org=self.name) + if not result: + raise vimconn.vimconnConnectionException("Can't connect to a vCloud director as: {}".format(self.user)) + result = vca.login(token=vca.token, org=self.name, org_url=vca.vcloud_session.org_url) + if result is True: + self.logger.info( + "Successfully logged to a vcloud direct org: {} as user: {}".format(self.name, self.user)) + + except: + raise vimconn.vimconnConnectionException("Can't connect to a vCloud director as: {}".format(self.user)) return vca + def init_organization(self): + """ Method initialize organization UUID and VDC parameters. + + At bare minimum client must provide organization name that present in vCloud director and VDC. - def new_tenant(self,tenant_name,tenant_description): - '''Adds a new tenant to VIM with this name and description, - returns the tenant identifier''' - raise vimconnNotImplemented( "Should have implemented this" ) + The VDC - UUID ( tenant_id) will be initialized at the run time if client didn't call constructor. + The Org - UUID will be initialized at the run time if data center present in vCloud director. + + Returns: + The return vca object that letter can be used to connect to vcloud direct as admin + """ + try: + if self.org_uuid is None: + org_dict = self.get_org_list() + for org in org_dict: + # we set org UUID at the init phase but we can do it only when we have valid credential. + if org_dict[org] == self.org_name: + self.org_uuid = org + self.logger.debug("Setting organization UUID {}".format(self.org_uuid)) + break + + else: + raise vimconn.vimconnException("Vcloud director organization {} not found".format(self.org_name)) + + # if well good we require for org details + org_details_dict = self.get_org(org_uuid=self.org_uuid) + + # we have two case if we want to initialize VDC ID or VDC name at run time + # tenant_name provided but no tenant id + if self.tenant_id is None and self.tenant_name is not None and 'vdcs' in org_details_dict: + vdcs_dict = org_details_dict['vdcs'] + for vdc in vdcs_dict: + if vdcs_dict[vdc] == self.tenant_name: + self.tenant_id = vdc + self.logger.debug("Setting vdc uuid {} for organization UUID {}".format(self.tenant_id, + self.name)) + break + else: + raise vimconn.vimconnException("Tenant name indicated but not present in vcloud director.") + # case two we have tenant_id but we don't have tenant name so we find and set it. + if self.tenant_id is not None and self.tenant_name is None and 'vdcs' in org_details_dict: + vdcs_dict = org_details_dict['vdcs'] + for vdc in vdcs_dict: + if vdc == self.tenant_id: + self.tenant_name = vdcs_dict[vdc] + self.logger.debug("Setting vdc uuid {} for organization UUID {}".format(self.tenant_id, + self.name)) + break + else: + raise vimconn.vimconnException("Tenant id indicated but not present in vcloud director") + self.logger.debug("Setting organization uuid {}".format(self.org_uuid)) + except: + self.logger.debug("Failed initialize organization UUID for org {}".format(self.org_name)) + self.logger.debug(traceback.format_exc()) + self.org_uuid = None + + def new_tenant(self, tenant_name=None, tenant_description=None): + """ Method adds a new tenant to VIM with this name. + This action requires access to create VDC action in vCloud director. + + Args: + tenant_name is tenant_name to be created. + tenant_description not used for this call + + Return: + returns the tenant identifier in UUID format. + If action is failed method will throw vimconn.vimconnException method + """ + vdc_task = self.create_vdc(vdc_name=tenant_name) + if vdc_task is not None: + vdc_uuid, value = vdc_task.popitem() + self.logger.info("Crated new vdc {} and uuid: {}".format(tenant_name, vdc_uuid)) + return vdc_uuid + else: + raise vimconn.vimconnException("Failed create tenant {}".format(tenant_name)) - def delete_tenant(self,tenant_id,): - '''Delete a tenant from VIM''' - '''Returns the tenant identifier''' - raise vimconnNotImplemented( "Should have implemented this" ) + def delete_tenant(self, tenant_id=None): + """Delete a tenant from VIM""" + 'Returns the tenant identifier' + raise vimconn.vimconnNotImplemented("Should have implemented this") def get_tenant_list(self, filter_dict={}): - '''Obtain tenants of VIM + """Obtain tenants of VIM filter_dict can contain the following keys: name: filter by tenant name id: filter by tenant uuid/id - Returns the tenant list of dictionaries: + Returns the tenant list of dictionaries: [{'name':', 'id':', ...}, ...] - ''' - raise vimconnNotImplemented( "Should have implemented this" ) - def new_network(self,net_name, net_type, ip_profile=None, shared=False): - '''Adds a tenant network to VIM + """ + org_dict = self.get_org(self.org_uuid) + vdcs_dict = org_dict['vdcs'] + + vdclist = [] + try: + for k in vdcs_dict: + entry = {'name': vdcs_dict[k], 'id': k} + # if caller didn't specify dictionary we return all tenants. + if filter_dict is not None and filter_dict: + filtered_entry = entry.copy() + filtered_dict = set(entry.keys()) - set(filter_dict) + for unwanted_key in filtered_dict: del entry[unwanted_key] + if filter_dict == entry: + vdclist.append(filtered_entry) + else: + vdclist.append(entry) + except: + self.logger.debug("Error in get_tenant_list()") + self.logger.debug(traceback.format_exc()) + raise vimconn.vimconnException("Incorrect state. {}") + + return vdclist + + def new_network(self, net_name, net_type, ip_profile=None, shared=False): + """Adds a tenant network to VIM net_name is the name net_type can be 'bridge','data'.'ptp'. TODO: this need to be revised - ip_profile is a dict containing the IP parameters of the network + ip_profile is a dict containing the IP parameters of the network shared is a boolean - Returns the network identifier''' + Returns the network identifier""" + + self.logger.debug( + "new_network tenant {} net_type {} ip_profile {} shared {}".format(net_name, net_type, ip_profile, shared)) + + isshared = 'false' + if shared: + isshared = 'true' + + network_uuid = self.create_network(network_name=net_name, isshared=isshared) + if network_uuid is not None: + return network_uuid + else: + raise vimconn.vimconnUnexpectedResponse("Failed create a new network {}".format(net_name)) - self.logger.debug("Vmware tenant from VIM filter: '%s'", net_name) - self.logger.debug("Vmware tenant from VIM filter: '%s'", net_type) - self.logger.debug("Vmware tenant from VIM filter: '%s'", ip_profile) - self.logger.debug("Vmware tenant from VIM filter: '%s'", shared) + def get_vcd_network_list(self): + """ Method available organization for a logged in tenant - raise vimconnNotImplemented( "Should have implemented this" ) + Returns: + The return vca object that letter can be used to connect to vcloud direct as admin + """ + + self.logger.debug("get_vcd_network_list(): retrieving network list for vcd") + vca = self.connect() + if not vca: + raise vimconn.vimconnConnectionException("self.connect() is failed.") + + vdc = vca.get_vdc(self.tenant_name) + vdc_uuid = vdc.get_id().split(":")[3] + networks = vca.get_networks(vdc.get_name()) + network_list = [] + try: + for network in networks: + filter_dict = {} + netid = network.get_id().split(":") + if len(netid) != 4: + continue + + filter_dict["name"] = network.get_name() + filter_dict["id"] = netid[3] + filter_dict["shared"] = network.get_IsShared() + filter_dict["tenant_id"] = vdc_uuid + if network.get_status() == 1: + filter_dict["admin_state_up"] = True + else: + filter_dict["admin_state_up"] = False + filter_dict["status"] = "ACTIVE" + filter_dict["type"] = "bridge" + network_list.append(filter_dict) + self.logger.debug("get_vcd_network_list adding entry {}".format(filter_dict)) + except: + self.logger.debug("Error in get_vcd_network_list") + self.logger.debug(traceback.format_exc()) + pass + + self.logger.debug("get_vcd_network_list returning {}".format(network_list)) + return network_list def get_network_list(self, filter_dict={}): - '''Obtain tenant networks of VIM + """Obtain tenant networks of VIM Filter_dict can be: - name: network name - id: network uuid - shared: boolean - tenant_id: tenant + name: network name OR/AND + id: network uuid OR/AND + shared: boolean OR/AND + tenant_id: tenant OR/AND admin_state_up: boolean status: 'ACTIVE' + + [{key : value , key : value}] + Returns the network list of dictionaries: [{}, ...] List can be empty - ''' + """ vca = self.connect() if not vca: raise vimconn.vimconnConnectionException("self.connect() is failed") vdc = vca.get_vdc(self.tenant_name) - vdcid = vdc.get_id().split(":") + vdcid = vdc.get_id().split(":")[3] networks = vca.get_networks(vdc.get_name()) network_list = [] - for network in networks: - filter_dict = {} - netid = network.get_id().split(":") - self.logger.debug ("Adding {} to a list".format(netid[3])) - self.logger.debug ("VDC ID {} to a list".format(vdcid[3])) - self.logger.debug ("Network {} to a list".format(network.get_name())) - - filter_dict["name"] = network.get_name() - filter_dict["id"] = netid[3] - filter_dict["shared"] = network.get_IsShared() - filter_dict["tenant_id"] = vdcid[3] - if network.get_status() == 1: - filter_dict["admin_state_up"] = True - else: - filter_dict["admin_state_up"] = False - filter_dict["status"] = "ACTIVE" - filter_dict["type"] = "bridge" - network_list.append(filter_dict) + + try: + for network in networks: + filter_entry = {} + net_uuid = network.get_id().split(":") + if len(net_uuid) != 4: + continue + else: + net_uuid = net_uuid[3] + # create dict entry + self.logger.debug("Adding {} to a list vcd id {} network {}".format(net_uuid, + vdcid, + network.get_name())) + filter_entry["name"] = network.get_name() + filter_entry["id"] = net_uuid + filter_entry["shared"] = network.get_IsShared() + filter_entry["tenant_id"] = vdcid + if network.get_status() == 1: + filter_entry["admin_state_up"] = True + else: + filter_entry["admin_state_up"] = False + filter_entry["status"] = "ACTIVE" + filter_entry["type"] = "bridge" + filtered_entry = filter_entry.copy() + + if filter_dict is not None and filter_dict: + # we remove all the key : value we don't care and match only + # respected field + filtered_dict = set(filter_entry.keys()) - set(filter_dict) + for unwanted_key in filtered_dict: del filter_entry[unwanted_key] + if filter_dict == filter_entry: + network_list.append(filtered_entry) + else: + network_list.append(filtered_entry) + except: + self.logger.debug("Error in get_vcd_network_list") + self.logger.debug(traceback.format_exc()) self.logger.debug("Returning {}".format(network_list)) return network_list def get_network(self, net_id): - '''Obtain network details of net_id VIM network' - Return a dict with the fields at filter_dict (see get_network_list) plus some VIM specific>}, ...]''' - raise vimconnNotImplemented( "Should have implemented this" ) + """Method obtains network details of net_id VIM network + Return a dict with the fields at filter_dict (see get_network_list) plus some VIM specific>}, ...]""" + + vca = self.connect() + if not vca: + raise vimconn.vimconnConnectionException("self.connect() is failed") + + vdc = vca.get_vdc(self.tenant_name) + vdc_id = vdc.get_id().split(":")[3] + + networks = vca.get_networks(vdc.get_name()) + filter_dict = {} + + try: + for network in networks: + vdc_network_id = network.get_id().split(":") + if len(vdc_network_id) == 4 and vdc_network_id[3] == net_id: + filter_dict["name"] = network.get_name() + filter_dict["id"] = vdc_network_id[3] + filter_dict["shared"] = network.get_IsShared() + filter_dict["tenant_id"] = vdc_id + if network.get_status() == 1: + filter_dict["admin_state_up"] = True + else: + filter_dict["admin_state_up"] = False + filter_dict["status"] = "ACTIVE" + filter_dict["type"] = "bridge" + self.logger.debug("Returning {}".format(filter_dict)) + return filter_dict + except: + self.logger.debug("Error in get_network") + self.logger.debug(traceback.format_exc()) + + return filter_dict def delete_network(self, net_id): - '''Deletes a tenant network from VIM, provide the network id. - Returns the network identifier or raise an exception''' - raise vimconnNotImplemented( "Should have implemented this" ) + """ + Method Deletes a tenant network from VIM, provide the network id. + + Returns the network identifier or raise an exception + """ + + vca = self.connect() + if not vca: + raise vimconn.vimconnConnectionException("self.connect() for tenant {} is failed.".format(self.tenant_name)) + + vcd_network = self.get_vcd_network(network_uuid=net_id) + if vcd_network is not None and vcd_network: + if self.delete_network_action(network_uuid=net_id): + return net_id + else: + raise vimconn.vimconnNotFoundException("Network {} not found".format(net_id)) def refresh_nets_status(self, net_list): - '''Get the status of the networks + """Get the status of the networks Params: the list of network identifiers Returns a dictionary with: net_id: #VIM id of this network status: #Mandatory. Text with one of: # DELETED (not found at vim) - # VIM_ERROR (Cannot connect to VIM, VIM response error, ...) + # VIM_ERROR (Cannot connect to VIM, VIM response error, ...) # OTHER (Vim reported other status not understood) # ERROR (VIM indicates an ERROR status) - # ACTIVE, INACTIVE, DOWN (admin down), + # ACTIVE, INACTIVE, DOWN (admin down), # BUILD (on building process) # - error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR + error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR vim_info: #Text with plain information obtained from vim (yaml.safe_dump) - ''' - raise vimconnNotImplemented( "Should have implemented this" ) - - def get_flavor(self, flavor_id): - '''Obtain flavor details from the VIM - Returns the flavor dict details {'id':<>, 'name':<>, other vim specific } #TODO to concrete - ''' - - print " get_flavor contains {}".format(flavor_id) + """ vca = self.connect() if not vca: - raise vimconn.vimconnConnectionException("self.connect() is failed.") + raise vimconn.vimconnConnectionException("self.connect() is failed") + + dict_entry = {} + try: + for net in net_list: + errormsg = '' + vcd_network = self.get_vcd_network(network_uuid=net) + if vcd_network is not None and vcd_network: + if vcd_network['status'] == 1: + status = 'ACTIVE' + else: + status = 'DOWN' + else: + status = 'DELETED' + errormsg = 'Network not found.' + + dict_entry[net] = {'status': status, 'error_msg': errormsg, + 'vm_info': yaml.safe_dump(vcd_network)} + except: + self.logger.debug("Error in refresh_nets_status") + self.logger.debug(traceback.format_exc()) + + return dict_entry + + def get_flavor(self, flavor_id): + """Obtain flavor details from the VIM + Returns the flavor dict details {'id':<>, 'name':<>, other vim specific } #TODO to concrete + """ + if flavor_id not in flavorlist: + raise vimconn.vimconnNotFoundException("Flavor not found.") + return flavorlist[flavor_id] def new_flavor(self, flavor_data): - '''Adds a tenant flavor to VIM + """Adds a tenant flavor to VIM flavor_data contains a dictionary with information, keys: name: flavor name ram: memory (cloud type) in MBytes @@ -354,80 +658,101 @@ class vimconnector(): - name: interface name dedicated: yes|no|yes:sriov; for PT, SRIOV or only one SRIOV for the physical NIC bandwidth: X Gbps; requested guarantee bandwidth - vpci: requested virtual PCI address + vpci: requested virtual PCI address disk: disk size is_public: - - - - #TODO to concrete - Returns the flavor identifier''' - flavor_uuid = uuid.uuid4() - flavorlist[flavor_uuid] = flavor_data - print " new_flavor contains {}".format(flavor_data) - print " flavor list contains {}".format(flavorlist) - return flavor_uuid + #TODO to concrete + Returns the flavor identifier""" + + # generate a new uuid put to internal dict and return it. + flavor_id = uuid.uuid4() + flavorlist[str(flavor_id)] = flavor_data + + return str(flavor_id) def delete_flavor(self, flavor_id): - '''Deletes a tenant flavor from VIM identify by its id - Returns the used id or raise an exception''' - raise vimconnNotImplemented( "Should have implemented this" ) + """Deletes a tenant flavor from VIM identify by its id + + Returns the used id or raise an exception + """ + if flavor_id not in flavorlist: + raise vimconn.vimconnNotFoundException("Flavor not found.") + + flavorlist.pop(flavor_id, None) + return flavor_id - def new_image(self,image_dict): - ''' + def new_image(self, image_dict): + """ Adds a tenant image to VIM Returns: 200, image-id if the image is created <0, message if there is an error - ''' - - print " ################################################################### " - print " new_image contains {}".format(image_dict) - print " ################################################################### " + """ + return self.get_image_id_from_path(image_dict['location']) def delete_image(self, image_id): - '''Deletes a tenant image from VIM''' - '''Returns the HTTP response code and a message indicating details of the success or fail''' + """ - print " ################################################################### " - print " delete_image contains {}".format(image_id) - print " ################################################################### " + :param image_id: + :return: + """ - raise vimconnNotImplemented( "Should have implemented this" ) + raise vimconn.vimconnNotImplemented("Should have implemented this") def catalog_exists(self, catalog_name, catalogs): + """ + + :param catalog_name: + :param catalogs: + :return: + """ for catalog in catalogs: if catalog.name == catalog_name: return True return False - def create_vimcatalog(self, vca, catalog_name): - """Create Catalog entry in VIM""" - task = vca.create_catalog(catalog_name, catalog_name) - result = vca.block_until_completed(task) - if not result: + def create_vimcatalog(self, vca=None, catalog_name=None): + """ Create new catalog entry in vCloud director. + + Args + vca: vCloud director. + catalog_name catalog that client wish to create. Note no validation done for a name. + Client must make sure that provide valid string representation. + + Return (bool) True if catalog created. + + """ + try: + task = vca.create_catalog(catalog_name, catalog_name) + result = vca.block_until_completed(task) + if not result: + return False + catalogs = vca.get_catalogs() + except: return False - catalogs = vca.get_catalogs() return self.catalog_exists(catalog_name, catalogs) - - def upload_ovf(self, vca, catalog_name, item_name, media_file_name, description='', display_progress=False, - chunk_bytes=128 * 1024): + # noinspection PyIncorrectDocstring + def upload_ovf(self, vca=None, catalog_name=None, image_name=None, media_file_name=None, + description='', progress=False, chunk_bytes=128 * 1024): """ Uploads a OVF file to a vCloud catalog + :param chunk_bytes: + :param progress: + :param description: + :param image_name: + :param vca: :param catalog_name: (str): The name of the catalog to upload the media. - :param item_name: (str): The name of the media file in the catalog. :param media_file_name: (str): The name of the local media file to upload. :return: (bool) True if the media file was successfully uploaded, false otherwise. """ os.path.isfile(media_file_name) statinfo = os.stat(media_file_name) - statinfo.st_size # find a catalog entry where we upload OVF. # create vApp Template and check the status if vCD able to read OVF it will respond with appropirate @@ -441,12 +766,12 @@ class vimconnector(): assert len(link) == 1 data = """ %s vApp Template - """ % (escape(item_name), escape(description)) + """ % (escape(image_name), escape(description)) headers = vca.vcloud_session.get_vcloud_headers() headers['Content-Type'] = 'application/vnd.vmware.vcloud.uploadVAppTemplateParams+xml' response = Http.post(link[0].get_href(), headers=headers, data=data, verify=vca.verify, logger=self.logger) if response.status_code == requests.codes.created: - catalogItem = ET.fromstring(response.content) + catalogItem = XmlElementTree.fromstring(response.content) entity = [child for child in catalogItem if child.get("type") == "application/vnd.vmware.vcloud.vAppTemplate+xml"][0] href = entity.get('href') @@ -456,59 +781,89 @@ class vimconnector(): if response.status_code == requests.codes.ok: media = mediaType.parseString(response.content, True) - link = filter(lambda link: link.get_rel() == 'upload:default', media.get_Files().get_File()[0].get_Link())[0] + link = filter(lambda link: link.get_rel() == 'upload:default', + media.get_Files().get_File()[0].get_Link())[0] headers = vca.vcloud_session.get_vcloud_headers() headers['Content-Type'] = 'Content-Type text/xml' - response = Http.put(link.get_href(), data=open(media_file_name, 'rb'), headers=headers, verify=vca.verify,logger=self.logger) + response = Http.put(link.get_href(), + data=open(media_file_name, 'rb'), + headers=headers, + verify=vca.verify, logger=self.logger) if response.status_code != requests.codes.ok: - self.logger.debug("Failed create vApp template for catalog name {} and image {}".format(catalog_name, media_file_name)) + self.logger.debug( + "Failed create vApp template for catalog name {} and image {}".format(catalog_name, + media_file_name)) return False + # TODO fix this with aync block time.sleep(5) self.logger.debug("Failed create vApp template for catalog name {} and image {}". format(catalog_name, media_file_name)) # uploading VMDK file - # check status of OVF upload - response = Http.get(template, headers=vca.vcloud_session.get_vcloud_headers(), verify=vca.verify, logger=self.logger) + # check status of OVF upload and upload remaining files. + response = Http.get(template, + headers=vca.vcloud_session.get_vcloud_headers(), + verify=vca.verify, + logger=self.logger) + if response.status_code == requests.codes.ok: media = mediaType.parseString(response.content, True) - link = filter(lambda link: link.get_rel() == 'upload:default', media.get_Files().get_File()[0].get_Link())[0] - - # The OVF file and VMDK must be in a same directory - head, tail = os.path.split(media_file_name) - filevmdk = head + '/' + os.path.basename(link.get_href()) - - os.path.isfile(filevmdk) - statinfo = os.stat(filevmdk) - - # TODO debug output remove it - #print media.get_Files().get_File()[0].get_Link()[0].get_href() - #print media.get_Files().get_File()[1].get_Link()[0].get_href() - #print link.get_href() - - # in case first element is pointer to OVF. - hrefvmdk = link.get_href().replace("descriptor.ovf","Cirros-disk1.vmdk") - - f = open(filevmdk, 'rb') - bytes_transferred = 0 - while bytes_transferred < statinfo.st_size: - my_bytes = f.read(chunk_bytes) - if len(my_bytes) <= chunk_bytes: - headers = vca.vcloud_session.get_vcloud_headers() - headers['Content-Range'] = 'bytes %s-%s/%s' % (bytes_transferred, len(my_bytes) - 1, statinfo.st_size) - headers['Content-Length'] = str(len(my_bytes)) - response = Http.put(hrefvmdk, headers=headers, data=my_bytes, verify=vca.verify,logger=None) - if response.status_code == requests.codes.ok: - bytes_transferred += len(my_bytes) - self.logger.debug('transferred %s of %s bytes' % (str(bytes_transferred), - str(statinfo.st_size))) - else: - self.logger.debug('file upload failed with error: [%s] %s' % (response.status_code, - response.content)) + number_of_files = len(media.get_Files().get_File()) + for index in xrange(0, number_of_files): + links_list = filter(lambda link: link.get_rel() == 'upload:default', + media.get_Files().get_File()[index].get_Link()) + for link in links_list: + # we skip ovf since it already uploaded. + if 'ovf' in link.get_href(): + continue + # The OVF file and VMDK must be in a same directory + head, tail = os.path.split(media_file_name) + file_vmdk = head + '/' + link.get_href().split("/")[-1] + if not os.path.isfile(file_vmdk): + return False + statinfo = os.stat(file_vmdk) + if statinfo.st_size == 0: return False - f.close() + hrefvmdk = link.get_href() + + if progress: + print("Uploading file: {}".format(file_vmdk)) + if progress: + widgets = ['Uploading file: ', Percentage(), ' ', Bar(), ' ', ETA(), ' ', + FileTransferSpeed()] + progress_bar = ProgressBar(widgets=widgets, maxval=statinfo.st_size).start() + + bytes_transferred = 0 + f = open(file_vmdk, 'rb') + while bytes_transferred < statinfo.st_size: + my_bytes = f.read(chunk_bytes) + if len(my_bytes) <= chunk_bytes: + headers = vca.vcloud_session.get_vcloud_headers() + headers['Content-Range'] = 'bytes %s-%s/%s' % ( + bytes_transferred, len(my_bytes) - 1, statinfo.st_size) + headers['Content-Length'] = str(len(my_bytes)) + response = Http.put(hrefvmdk, + headers=headers, + data=my_bytes, + verify=vca.verify, + logger=None) + + if response.status_code == requests.codes.ok: + bytes_transferred += len(my_bytes) + if progress: + progress_bar.update(bytes_transferred) + else: + self.logger.debug( + 'file upload failed with error: [%s] %s' % (response.status_code, + response.content)) + + f.close() + return False + f.close() + if progress: + progress_bar.finish() return True else: self.logger.debug("Failed retrieve vApp template for catalog name {} for OVF {}". @@ -518,103 +873,217 @@ class vimconnector(): self.logger.debug("Failed retrieve catalog name {} for OVF file {}".format(catalog_name, media_file_name)) return False - def upload_vimimage(self,vca, catalog_name, media_name, medial_file_name): + def upload_vimimage(self, vca=None, catalog_name=None, media_name=None, medial_file_name=None, progress=False): """Upload media file""" - return self.upload_ovf(vca, catalog_name, media_name.split(".")[0], medial_file_name, medial_file_name, True) + # TODO add named parameters for readability + + return self.upload_ovf(vca=vca, catalog_name=catalog_name, image_name=media_name.split(".")[0], + media_file_name=medial_file_name, description='medial_file_name', progress=progress) + + def validate_uuid4(self, uuid_string=None): + """ Method validate correct format of UUID. + + Return: true if string represent valid uuid + """ + try: + val = uuid.UUID(uuid_string, version=4) + except ValueError: + return False + return True + + def get_catalogid(self, catalog_name=None, catalogs=None): + """ Method check catalog and return catalog ID in UUID format. + + Args + catalog_name: catalog name as string + catalogs: list of catalogs. + + Return: catalogs uuid + """ - def get_catalogid(self, catalog_name, catalogs): for catalog in catalogs: if catalog.name == catalog_name: - print catalog.name catalog_id = catalog.get_id().split(":") return catalog_id[3] return None - def get_catalogbyid(self, catalog_id, catalogs): + def get_catalogbyid(self, catalog_uuid=None, catalogs=None): + """ Method check catalog and return catalog name lookup done by catalog UUID. + + Args + catalog_name: catalog name as string + catalogs: list of catalogs. + + Return: catalogs name or None + """ + + if not self.validate_uuid4(uuid_string=catalog_uuid): + return None + for catalog in catalogs: - catalogid = catalog.get_id().split(":")[3] - if catalogid == catalog_id: + catalog_id = catalog.get_id().split(":")[3] + if catalog_id == catalog_uuid: return catalog.name return None - def get_image_id_from_path(self, path): - '''Get the image id from image path in the VIM database''' - '''Returns: - 0,"Image not found" if there are no images with that path - 1,image-id if there is one image with that path - <0,message if there was an error (Image not found, error contacting VIM, more than 1 image with that path, etc.) - ''' + def get_image_id_from_path(self, path=None, progress=False): + """ Method upload OVF image to vCloud director. + + Each OVF image represented as single catalog entry in vcloud director. + The method check for existing catalog entry. The check done by file name without file extension. + + if given catalog name already present method will respond with existing catalog uuid otherwise + it will create new catalog entry and upload OVF file to newly created catalog. + + If method can't create catalog entry or upload a file it will throw exception. + + Method accept boolean flag progress that will output progress bar. It useful method + for standalone upload use case. In case to test large file upload. + + Args + path: - valid path to OVF file. + progress - boolean progress bar show progress bar. + Return: if image uploaded correct method will provide image catalog UUID. + """ vca = self.connect() if not vca: - raise vimconn.vimconnConnectionException("self.connect() is failed") + raise vimconn.vimconnConnectionException("self.connect() is failed.") + + if path is None: + raise vimconn.vimconnException("Image path can't be None.") - self.logger.debug("get_image_id_from_path path {}".format(path)) + if not os.path.isfile(path): + raise vimconn.vimconnException("Can't read file. File not found.") + + if not os.access(path, os.R_OK): + raise vimconn.vimconnException("Can't read file. Check file permission to read.") + + self.logger.debug("get_image_id_from_path() client requesting {} ".format(path)) dirpath, filename = os.path.split(path) flname, file_extension = os.path.splitext(path) if file_extension != '.ovf': - self.logger.debug("Wrong file extension {}".format(file_extension)) - return -1, "Wrong container. vCloud director supports only OVF." + self.logger.debug("Wrong file extension {} connector support only OVF container.".format(file_extension)) + raise vimconn.vimconnException("Wrong container. vCloud director supports only OVF.") catalog_name = os.path.splitext(filename)[0] - self.logger.debug("File name {} Catalog Name {} file path {}".format(filename, catalog_name, path)) - self.logger.debug("Catalog name {}".format(catalog_name)) catalogs = vca.get_catalogs() if len(catalogs) == 0: - self.logger.info("Creating new catalog entry {} in vcloud director".format(catalog_name)) + self.logger.info("Creating a new catalog entry {} in vcloud director".format(catalog_name)) result = self.create_vimcatalog(vca, catalog_name) if not result: - return -1, "Failed create new catalog {} ".format(catalog_name) - result = self.upload_vimimage(vca, catalog_name, filename, path) + raise vimconn.vimconnException("Failed create new catalog {} ".format(catalog_name)) + result = self.upload_vimimage(vca=vca, catalog_name=catalog_name, + media_name=filename, medial_file_name=path, progress=progress) if not result: - return -1, "Failed create vApp template for catalog {} ".format(catalog_name) + raise vimconn.vimconnException("Failed create vApp template for catalog {} ".format(catalog_name)) return self.get_catalogid(catalog_name, vca.get_catalogs()) else: for catalog in catalogs: # search for existing catalog if we find same name we return ID # TODO optimize this if catalog.name == catalog_name: - self.logger.debug("Found existing catalog entry for {} catalog id {}".format(catalog_name, self.get_catalogid(catalog_name, catalogs))) + self.logger.debug("Found existing catalog entry for {} catalog id {}".format(catalog_name, + self.get_catalogid( + catalog_name, + catalogs))) return self.get_catalogid(catalog_name, vca.get_catalogs()) - # if we didn't find existing catalog we create a new one. + # if we didn't find existing catalog we create a new one and upload image. self.logger.debug("Creating new catalog entry".format(catalog_name)) result = self.create_vimcatalog(vca, catalog_name) if not result: - return -1, "Failed create new catalog {} ".format(catalog_name) - result = self.upload_vimimage(vca, catalog_name, filename, path) + raise vimconn.vimconnException("Failed create new catalog {} ".format(catalog_name)) + + result = self.upload_vimimage(vca=vca, catalog_name=catalog_name, + media_name=filename, medial_file_name=path, progress=progress) if not result: - return -1, "Failed create vApp template for catalog {} ".format(catalog_name) + raise vimconn.vimconnException("Failed create vApp template for catalog {} ".format(catalog_name)) return self.get_catalogid(catalog_name, vca.get_catalogs()) - def get_vappid(self, vdc, vapp_name): - """ Take vdc object and vApp name and returns vapp uuid or None - """ - #UUID has following format https://host/api/vApp/vapp-30da58a3-e7c7-4d09-8f68-d4c8201169cf + def get_vappid(self, vdc=None, vapp_name=None): + """ Method takes vdc object and vApp name and returns vapp uuid or None + + Args: + vdc: The VDC object. + vapp_name: is application vappp name identifier + Returns: + The return vApp name otherwise None + """ + if vdc is None or vapp_name is None: + return None + # UUID has following format https://host/api/vApp/vapp-30da58a3-e7c7-4d09-8f68-d4c8201169cf try: refs = filter(lambda ref: ref.name == vapp_name and ref.type_ == 'application/vnd.vmware.vcloud.vApp+xml', - vdc.ResourceEntities.ResourceEntity) - + vdc.ResourceEntities.ResourceEntity) if len(refs) == 1: return refs[0].href.split("vapp")[1][1:] - except: - return None + except Exception as e: + self.logger.exception(e) + return False return None - def get_vappbyid(self, vdc, vapp_id): - refs = filter(lambda ref: ref.type_ == 'application/vnd.vmware.vcloud.vApp+xml', - vdc.ResourceEntities.ResourceEntity) - for ref in refs: - print ref.href + def check_vapp(self, vdc=None, vapp_uuid=None): + """ Method Method returns True or False if vapp deployed in vCloud director + + Args: + vca: Connector to VCA + vdc: The VDC object. + vappid: vappid is application identifier + + Returns: + The return True if vApp deployed + :param vdc: + :param vapp_uuid: + """ + try: + refs = filter(lambda ref: + ref.type_ == 'application/vnd.vmware.vcloud.vApp+xml', + vdc.ResourceEntities.ResourceEntity) + for ref in refs: + vappid = ref.href.split("vapp")[1][1:] + # find vapp with respected vapp uuid + if vappid == vapp_uuid: + return True + except Exception as e: + self.logger.exception(e) + return False + return False - if len(refs) == 1: - return refs[0].href.split("vapp")[1][1:] + def get_namebyvappid(self, vca=None, vdc=None, vapp_uuid=None): + """Method returns vApp name from vCD and lookup done by vapp_id. - def new_vminstance(self,name,description,start,image_id,flavor_id,net_list,cloud_config=None): + Args: + vca: Connector to VCA + vdc: The VDC object. + vapp_uuid: vappid is application identifier + + Returns: + The return vApp name otherwise None + """ + + try: + refs = filter(lambda ref: ref.type_ == 'application/vnd.vmware.vcloud.vApp+xml', + vdc.ResourceEntities.ResourceEntity) + for ref in refs: + # we care only about UUID the rest doesn't matter + vappid = ref.href.split("vapp")[1][1:] + if vappid == vapp_uuid: + response = Http.get(ref.href, headers=vca.vcloud_session.get_vcloud_headers(), verify=vca.verify, + logger=self.logger) + tree = XmlElementTree.fromstring(response.content) + return tree.attrib['name'] + except Exception as e: + self.logger.exception(e) + return None + return None + + def new_vminstance(self, name=None, description="", start=False, image_id=None, flavor_id=None, net_list={}, + cloud_config=None): """Adds a VM instance to VIM Params: start: indicates if VM must start or boot in pause mode. Ignored @@ -644,71 +1113,273 @@ class vimconnector(): if not vca: raise vimconn.vimconnConnectionException("self.connect() is failed.") - # TODO following attribute need be featched from flavor / OVF file must contain same data. - # task = self.vca.create_vapp(vdc_name, vapp_name, template, catalog, - # vm_name=vm_name, - # vm_cpus=cpu, - # vm_memory=memory) - # + #new vm name = vmname + tenant_id + uuid + new_vm_name = [name, '-', str(uuid.uuid4())] + full_name = ''.join(new_vm_name) + + # if vm already deployed we return existing uuid + # vapp_uuid = self.get_vappid(vca.get_vdc(self.tenant_name), name) + # if vapp_uuid is not None: + # return vapp_uuid + # we check for presence of VDC, Catalog entry and Flavor. + vdc = vca.get_vdc(self.tenant_name) + if vdc is None: + raise vimconn.vimconnNotFoundException( + "new_vminstance(): Failed create vApp {}: (Failed retrieve VDC information)".format(name)) catalogs = vca.get_catalogs() - #image upload creates template name as catalog name space Template. - templateName = self.get_catalogbyid(image_id, catalogs) + ' Template' - task = vca.create_vapp(self.tenant_name, name, templateName, self.get_catalogbyid(image_id,catalogs), vm_name=name) - if task is False: - return -1, " Failed deploy vApp {}".format(name) - - result = vca.block_until_completed(task) - if result: - vappID = self.get_vappid(vca.get_vdc(self.tenant_name), name) - if vappID is None: - return -1, " Failed featch UUID for vApp {}".format(name) + if catalogs is None: + raise vimconn.vimconnNotFoundException( + "new_vminstance(): Failed create vApp {}: ""(Failed retrieve catalog information)".format(name)) + + vm_cpus = None + vm_memory = None + if flavor_id is not None: + flavor = flavorlist[flavor_id] + if flavor is None: + raise vimconn.vimconnNotFoundException( + "new_vminstance(): Failed create vApp {}: (Failed retrieve flavor information)".format(name)) else: - return vappID - - return -1, " Failed create vApp {}".format(name) - - def get_vminstance(self,vm_id): - '''Returns the VM instance information from VIM''' - + try: + vm_cpus = flavor['vcpus'] + vm_memory = flavor['ram'] + except KeyError: + raise vimconn.vimconnException("Corrupted flavor. {}".format(flavor_id)) + + # image upload creates template name as catalog name space Template. + templateName = self.get_catalogbyid(catalog_uuid=image_id, catalogs=catalogs) + ' Template' + power_on = 'false' + if start: + power_on = 'true' + + # client must provide at least one entry in net_list if not we report error + primary_net_name = None + if net_list is not None and len(net_list) > 0: + primary_net = net_list[0] + if primary_net is None: + raise vimconn.vimconnUnexpectedResponse("new_vminstance(): Failed network list is empty.".format(name)) + else: + try: + primary_net_id = primary_net['net_id'] + primary_net_name = self.get_network_name_by_id(primary_net_id) + network_mode = primary_net['use'] + except KeyError: + raise vimconn.vimconnException("Corrupted flavor. {}".format(primary_net)) + + # use: 'data', 'bridge', 'mgmt' + # create vApp. Set vcpu and ram based on flavor id. + vapptask = vca.create_vapp(self.tenant_name, full_name, templateName, + self.get_catalogbyid(image_id, catalogs), + network_name=primary_net_name, # can be None if net_list None + network_mode='bridged', + vm_name=full_name, + vm_cpus=vm_cpus, # can be None if flavor is None + vm_memory=vm_memory) # can be None if flavor is None + + if vapptask is None or vapptask is False: + raise vimconn.vimconnUnexpectedResponse("new_vminstance(): failed deploy vApp {}".format(full_name)) + if type(vapptask) is VappTask: + vca.block_until_completed(vapptask) + + # we should have now vapp in undeployed state. + vapp = vca.get_vapp(vca.get_vdc(self.tenant_name), full_name) + if vapp is None: + raise vimconn.vimconnUnexpectedResponse( + "new_vminstance(): Failed failed retrieve vApp {} after we deployed".format(full_name)) + + # add first NIC + try: + nicIndex = 0 + for net in net_list: + # openmano uses network id in UUID format. + # vCloud Director need a name so we do reverse operation from provided UUID we lookup a name + interface_net_id = net['net_id'] + interface_net_name = self.get_network_name_by_id(interface_net_id) + interface_network_mode = net['use'] + + if primary_net_name is not None: + nets = filter(lambda n: n.name == interface_net_name, vca.get_networks(self.tenant_name)) + if len(nets) == 1: + task = vapp.connect_to_network(nets[0].name, nets[0].href) + if type(task) is GenericTask: + vca.block_until_completed(task) + # connect network to VM + # TODO figure out mapping between openmano representation to vCloud director. + # one idea use first nic as management DHCP all remaining in bridge mode + task = vapp.connect_vms(nets[0].name, connection_index=nicIndex, + connections_primary_index=nicIndex, + ip_allocation_mode='DHCP') + if type(task) is GenericTask: + vca.block_until_completed(task) + nicIndex += 1 + except KeyError: + # it might be a case if specific mandatory entry in dict is empty + self.logger.debug("Key error {}".format(KeyError.message)) + raise vimconn.vimconnUnexpectedResponse("new_vminstance(): Failed create new vm instance {}".format(name)) + + # deploy and power on vm + task = vapp.poweron() + if type(task) is TaskType: + vca.block_until_completed(task) + deploytask = vapp.deploy(powerOn='True') + if type(task) is TaskType: + vca.block_until_completed(deploytask) + + # check if vApp deployed and if that the case return vApp UUID otherwise -1 + vapp_uuid = self.get_vappid(vca.get_vdc(self.tenant_name), full_name) + if vapp_uuid is not None: + return vapp_uuid + else: + raise vimconn.vimconnUnexpectedResponse("new_vminstance(): Failed create new vm instance {}".format(name)) + + ## + ## + ## based on current discussion + ## + ## + ## server: + # created: '2016-09-08T11:51:58' + # description: simple-instance.linux1.1 + # flavor: ddc6776e-75a9-11e6-ad5f-0800273e724c + # hostId: e836c036-74e7-11e6-b249-0800273e724c + # image: dde30fe6-75a9-11e6-ad5f-0800273e724c + # status: ACTIVE + # error_msg: + # interfaces: … + # + def get_vminstance(self, vim_vm_uuid=None): + """Returns the VM instance information from VIM""" + + self.logger.debug("Client requesting vm instance {} ".format(vim_vm_uuid)) vca = self.connect() if not vca: raise vimconn.vimconnConnectionException("self.connect() is failed.") + vdc = vca.get_vdc(self.tenant_name) + if vdc is None: + raise vimconn.vimconnConnectionException( + "Failed to get a reference of VDC for a tenant {}".format(self.tenant_name)) - raise vimconnNotImplemented( "Should have implemented this" ) + vm_info_dict = self.get_vapp_details_rest(vapp_uuid=vim_vm_uuid) + if not vm_info_dict: + self.logger.debug("get_vminstance(): Failed to get vApp name by UUID {}".format(vim_vm_uuid)) + raise vimconn.vimconnNotFoundException("Failed to get vApp name by UUID {}".format(vim_vm_uuid)) - def delete_vminstance(self, vm_id): - '''Removes a VM instance from VIM''' - '''Returns the instance identifier''' + status_key = vm_info_dict['status'] + error = '' + try: + vm_dict = {'created': vm_info_dict['created'], + 'description': vm_info_dict['name'], + 'status': vcdStatusCode2manoFormat[int(status_key)], + 'hostId': vm_info_dict['vmuuid'], + 'error_msg': error, + 'vim_info': yaml.safe_dump(vm_info_dict), 'interfaces': []} + + if 'interfaces' in vm_info_dict: + vm_dict['interfaces'] = vm_info_dict['interfaces'] + else: + vm_dict['interfaces'] = [] + except KeyError: + vm_dict = {'created': '', + 'description': '', + 'status': vcdStatusCode2manoFormat[int(-1)], + 'hostId': vm_info_dict['vmuuid'], + 'error_msg': "Inconsistency state", + 'vim_info': yaml.safe_dump(vm_info_dict), 'interfaces': []} + + return vm_dict - print " ###### {} ".format(vm_id) + def delete_vminstance(self, vm__vim_uuid): + """Method poweroff and remove VM instance from vcloud director network. + Args: + vm__vim_uuid: VM UUID + + Returns: + Returns the instance identifier + """ + + self.logger.debug("Client requesting delete vm instance {} ".format(vm__vim_uuid)) vca = self.connect() if not vca: raise vimconn.vimconnConnectionException("self.connect() is failed.") - thevdc = vca.get_vdc(self.tenant_name) - self.get_vappid(vca.get_vdc(self.tenant_name), name) + vdc = vca.get_vdc(self.tenant_name) + if vdc is None: + self.logger.debug("delete_vminstance(): Failed to get a reference of VDC for a tenant {}".format( + self.tenant_name)) + raise vimconn.vimconnException( + "delete_vminstance(): Failed to get a reference of VDC for a tenant {}".format(self.tenant_name)) + try: + vapp_name = self.get_namebyvappid(vca, vdc, vm__vim_uuid) + if vapp_name is None: + self.logger.debug("delete_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid)) + return -1, "delete_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid) + else: + self.logger.info("Deleting vApp {} and UUID {}".format(vapp_name, vm__vim_uuid)) + + # Delete vApp and wait for status change if task executed and vApp is None. + # We successfully delete vApp from vCloud + vapp = vca.get_vapp(vca.get_vdc(self.tenant_name), vapp_name) + # poweroff vapp / undeploy and delete + power_off_task = vapp.poweroff() + if type(power_off_task) is GenericTask: + vca.block_until_completed(power_off_task) + else: + if not power_off_task: + self.logger.debug("delete_vminstance(): Failed power off VM uuid {} ".format(vm__vim_uuid)) + + # refresh status + if vapp.me.deployed: + undeploy_task = vapp.undeploy() + if type(undeploy_task) is GenericTask: + retry = 0 + while retry <= DELETE_INSTANCE_RETRY: + result = vca.block_until_completed(undeploy_task) + if result: + break + retry += 1 + else: + return -1 + + # delete vapp + vapp = vca.get_vapp(vca.get_vdc(self.tenant_name), vapp_name) + if vapp is not None: + delete_task = vapp.delete() + retry = 0 + while retry <= DELETE_INSTANCE_RETRY: + task = vapp.delete() + if type(task) is GenericTask: + vca.block_until_completed(delete_task) + if not delete_task: + self.logger.debug("delete_vminstance(): Failed delete uuid {} ".format(vm__vim_uuid)) + retry += 1 + except: + self.logger.debug(traceback.format_exc()) + raise vimconn.vimconnException("delete_vminstance(): Failed delete vm instance {}".format(vm__vim_uuid)) + if vca.get_vapp(vca.get_vdc(self.tenant_name), vapp_name) is None: + return vm__vim_uuid + else: + raise vimconn.vimconnException("delete_vminstance(): Failed delete vm instance {}".format(vm__vim_uuid)) def refresh_vms_status(self, vm_list): - '''Get the status of the virtual machines and their interfaces/ports + """Get the status of the virtual machines and their interfaces/ports Params: the list of VM identifiers Returns a dictionary with: vm_id: #VIM id of this Virtual Machine status: #Mandatory. Text with one of: # DELETED (not found at vim) - # VIM_ERROR (Cannot connect to VIM, VIM response error, ...) + # VIM_ERROR (Cannot connect to VIM, VIM response error, ...) # OTHER (Vim reported other status not understood) # ERROR (VIM indicates an ERROR status) - # ACTIVE, PAUSED, SUSPENDED, INACTIVE (not running), + # ACTIVE, PAUSED, SUSPENDED, INACTIVE (not running), # CREATING (on building process), ERROR # ACTIVE:NoMgmtIP (Active but any of its interface has an IP address # - error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR + error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR vim_info: #Text with plain information obtained from vim (yaml.safe_dump) interfaces: - vim_info: #Text with plain information obtained from vim (yaml.safe_dump) @@ -716,74 +1387,1043 @@ class vimconnector(): vim_net_id: #network id where this interface is connected vim_interface_id: #interface/port VIM id ip_address: #null, or text with IPv4, IPv6 address - ''' - raise vimconnNotImplemented( "Should have implemented this" ) + """ - def action_vminstance(self, vm_id, action_dict): - '''Send and action over a VM instance from VIM - Returns the vm_id if the action was successfully sent to the VIM''' - raise vimconnNotImplemented( "Should have implemented this" ) + self.logger.debug("Client requesting refresh vm status for {} ".format(vm_list)) + vca = self.connect() + if not vca: + raise vimconn.vimconnConnectionException("self.connect() is failed.") + + vdc = vca.get_vdc(self.tenant_name) + if vdc is None: + raise vimconn.vimconnException("Failed to get a reference of VDC for a tenant {}".format(self.tenant_name)) + + vms_dict = {} + for vmuuid in vm_list: + vmname = self.get_namebyvappid(vca, vdc, vmuuid) + if vmname is not None: + + the_vapp = vca.get_vapp(vdc, vmname) + vm_info = the_vapp.get_vms_details() + vm_status = vm_info[0]['status'] + + vm_dict = {'status': vcdStatusCode2manoFormat[the_vapp.me.get_status()], + 'error_msg': vcdStatusCode2manoFormat[the_vapp.me.get_status()], + 'vim_info': yaml.safe_dump(the_vapp.get_vms_details()), 'interfaces': []} + + # get networks + try: + vm_app_networks = the_vapp.get_vms_network_info() + for vapp_network in vm_app_networks: + for vm_network in vapp_network: + if vm_network['name'] == vmname: + interface = {"mac_address": vm_network['mac'], + "vim_net_id": self.get_network_name_by_id(vm_network['network_name']), + "vim_interface_id": vm_network['network_name'], + 'ip_address': vm_network['ip']} + # interface['vim_info'] = yaml.safe_dump(vm_network) + vm_dict["interfaces"].append(interface) + # add a vm to vm dict + vms_dict.setdefault(vmuuid, vm_dict) + except KeyError: + self.logger.debug("Error in respond {}".format(KeyError.message)) + self.logger.debug(traceback.format_exc()) + + return vms_dict + + def action_vminstance(self, vm__vim_uuid=None, action_dict=None): + """Send and action over a VM instance from VIM + Returns the vm_id if the action was successfully sent to the VIM""" + + self.logger.debug("Received action for vm {} and action dict {}".format(vm__vim_uuid, action_dict)) + if vm__vim_uuid is None or action_dict is None: + raise vimconn.vimconnException("Invalid request. VM id or action is None.") - def get_vminstance_console(self,vm_id, console_type="vnc"): - ''' + vca = self.connect() + if not vca: + raise vimconn.vimconnConnectionException("self.connect() is failed.") + + vdc = vca.get_vdc(self.tenant_name) + if vdc is None: + return -1, "Failed to get a reference of VDC for a tenant {}".format(self.tenant_name) + + vapp_name = self.get_namebyvappid(vca, vdc, vm__vim_uuid) + if vapp_name is None: + self.logger.debug("action_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid)) + raise vimconn.vimconnException("Failed to get vm by given {} vm uuid".format(vm__vim_uuid)) + else: + self.logger.info("Action_vminstance vApp {} and UUID {}".format(vapp_name, vm__vim_uuid)) + + try: + the_vapp = vca.get_vapp(vdc, vapp_name) + # TODO fix all status + if "start" in action_dict: + if action_dict["start"] == "rebuild": + the_vapp.deploy(powerOn=True) + else: + vm_info = the_vapp.get_vms_details() + vm_status = vm_info[0]['status'] + if vm_status == "Suspended": + the_vapp.poweron() + elif vm_status.status == "Powered off": + the_vapp.poweron() + elif "pause" in action_dict: + pass + ## server.pause() + elif "resume" in action_dict: + pass + ## server.resume() + elif "shutoff" in action_dict or "shutdown" in action_dict: + the_vapp.shutdown() + elif "forceOff" in action_dict: + the_vapp.reset() + elif "terminate" in action_dict: + the_vapp.delete() + # elif "createImage" in action_dict: + # server.create_image() + else: + pass + except: + pass + + def get_vminstance_console(self, vm_id, console_type="vnc"): + """ Get a console for the virtual machine Params: vm_id: uuid of the VM console_type, can be: - "novnc" (by default), "xvpvnc" for VNC types, + "novnc" (by default), "xvpvnc" for VNC types, "rdp-html5" for RDP types, "spice-html5" for SPICE types Returns dict with the console parameters: protocol: ssh, ftp, http, https, ... - server: usually ip address - port: the http, ssh, ... port - suffix: extra text, e.g. the http path and query string - ''' - raise vimconnNotImplemented( "Should have implemented this" ) + server: usually ip address + port: the http, ssh, ... port + suffix: extra text, e.g. the http path and query string + """ + raise vimconn.vimconnNotImplemented("Should have implemented this") -#NOT USED METHODS in current version + # NOT USED METHODS in current version def host_vim2gui(self, host, server_dict): - '''Transform host dictionary from VIM format to GUI format, + """Transform host dictionary from VIM format to GUI format, and append to the server_dict - ''' - raise vimconnNotImplemented( "Should have implemented this" ) + """ + raise vimconn.vimconnNotImplemented("Should have implemented this") def get_hosts_info(self): - '''Get the information of deployed hosts - Returns the hosts content''' - raise vimconnNotImplemented( "Should have implemented this" ) + """Get the information of deployed hosts + Returns the hosts content""" + raise vimconn.vimconnNotImplemented("Should have implemented this") def get_hosts(self, vim_tenant): - '''Get the hosts and deployed instances - Returns the hosts content''' - raise vimconnNotImplemented( "Should have implemented this" ) + """Get the hosts and deployed instances + Returns the hosts content""" + raise vimconn.vimconnNotImplemented("Should have implemented this") def get_processor_rankings(self): - '''Get the processor rankings in the VIM database''' - raise vimconnNotImplemented( "Should have implemented this" ) + """Get the processor rankings in the VIM database""" + raise vimconn.vimconnNotImplemented("Should have implemented this") def new_host(self, host_data): - '''Adds a new host to VIM''' + """Adds a new host to VIM""" '''Returns status code of the VIM response''' - raise vimconnNotImplemented( "Should have implemented this" ) + raise vimconn.vimconnNotImplemented("Should have implemented this") def new_external_port(self, port_data): - '''Adds a external port to VIM''' + """Adds a external port to VIM""" '''Returns the port identifier''' - raise vimconnNotImplemented( "Should have implemented this" ) + raise vimconn.vimconnNotImplemented("Should have implemented this") - def new_external_network(self,net_name,net_type): - '''Adds a external network to VIM (shared)''' + def new_external_network(self, net_name, net_type): + """Adds a external network to VIM (shared)""" '''Returns the network identifier''' - raise vimconnNotImplemented( "Should have implemented this" ) + raise vimconn.vimconnNotImplemented("Should have implemented this") def connect_port_network(self, port_id, network_id, admin=False): - '''Connects a external port to a network''' + """Connects a external port to a network""" '''Returns status code of the VIM response''' - raise vimconnNotImplemented( "Should have implemented this" ) + raise vimconn.vimconnNotImplemented("Should have implemented this") def new_vminstancefromJSON(self, vm_data): - '''Adds a VM instance to VIM''' + """Adds a VM instance to VIM""" '''Returns the instance identifier''' - raise vimconnNotImplemented( "Should have implemented this" ) + raise vimconn.vimconnNotImplemented("Should have implemented this") + + def get_network_name_by_id(self, network_name=None): + """Method gets vcloud director network named based on supplied uuid. + + Args: + network_name: network_id + + Returns: + The return network name. + """ + + vca = self.connect() + if not vca: + raise vimconn.vimconnConnectionException("self.connect() is failed") + + if network_name is None: + return None + + try: + org_network_dict = self.get_org(self.org_uuid)['networks'] + for net_uuid in org_network_dict: + if org_network_dict[net_uuid] == network_name: + return net_uuid + except: + self.logger.debug("Exception in get_network_name_by_id") + self.logger.debug(traceback.format_exc()) + + return None + + def list_org_action(self): + """ + Method leverages vCloud director and query for available organization for particular user + + Args: + vca - is active VCA connection. + vdc_name - is a vdc name that will be used to query vms action + + Returns: + The return XML respond + """ + + vca = self.connect() + if not vca: + raise vimconn.vimconnConnectionException("self.connect() is failed") + + url_list = [vca.host, '/api/org'] + vm_list_rest_call = ''.join(url_list) + + if not (not vca.vcloud_session or not vca.vcloud_session.organization): + response = Http.get(url=vm_list_rest_call, + headers=vca.vcloud_session.get_vcloud_headers(), + verify=vca.verify, + logger=vca.logger) + if response.status_code == requests.codes.ok: + return response.content + + return None + + def get_org_action(self, org_uuid=None): + """ + Method leverages vCloud director and retrieve available object fdr organization. + + Args: + vca - is active VCA connection. + vdc_name - is a vdc name that will be used to query vms action + + Returns: + The return XML respond + """ + + vca = self.connect() + if not vca: + raise vimconn.vimconnConnectionException("self.connect() is failed") + + if org_uuid is None: + return None + + url_list = [vca.host, '/api/org/', org_uuid] + vm_list_rest_call = ''.join(url_list) + + if not (not vca.vcloud_session or not vca.vcloud_session.organization): + response = Http.get(url=vm_list_rest_call, + headers=vca.vcloud_session.get_vcloud_headers(), + verify=vca.verify, + logger=vca.logger) + if response.status_code == requests.codes.ok: + return response.content + + return None + + def get_org(self, org_uuid=None): + """ + Method retrieves available organization in vCloud Director + + Args: + org_uuid - is a organization uuid. + + Returns: + The return dictionary with following key + "network" - for network list under the org + "catalogs" - for network list under the org + "vdcs" - for vdc list under org + """ + + org_dict = {} + vca = self.connect() + if not vca: + raise vimconn.vimconnConnectionException("self.connect() is failed") + + if org_uuid is None: + return org_dict + + content = self.get_org_action(org_uuid=org_uuid) + try: + vdc_list = {} + network_list = {} + catalog_list = {} + vm_list_xmlroot = XmlElementTree.fromstring(content) + for child in vm_list_xmlroot: + if child.attrib['type'] == 'application/vnd.vmware.vcloud.vdc+xml': + vdc_list[child.attrib['href'].split("/")[-1:][0]] = child.attrib['name'] + org_dict['vdcs'] = vdc_list + if child.attrib['type'] == 'application/vnd.vmware.vcloud.orgNetwork+xml': + network_list[child.attrib['href'].split("/")[-1:][0]] = child.attrib['name'] + org_dict['networks'] = network_list + if child.attrib['type'] == 'application/vnd.vmware.vcloud.catalog+xml': + catalog_list[child.attrib['href'].split("/")[-1:][0]] = child.attrib['name'] + org_dict['catalogs'] = catalog_list + except: + pass + + return org_dict + + def get_org_list(self): + """ + Method retrieves available organization in vCloud Director + + Args: + vca - is active VCA connection. + + Returns: + The return dictionary and key for each entry VDC UUID + """ + + org_dict = {} + vca = self.connect() + if not vca: + raise vimconn.vimconnConnectionException("self.connect() is failed") + + content = self.list_org_action() + try: + vm_list_xmlroot = XmlElementTree.fromstring(content) + for vm_xml in vm_list_xmlroot: + if vm_xml.tag.split("}")[1] == 'Org': + org_uuid = vm_xml.attrib['href'].split('/')[-1:] + org_dict[org_uuid[0]] = vm_xml.attrib['name'] + except: + pass + + return org_dict + + def vms_view_action(self, vdc_name=None): + """ Method leverages vCloud director vms query call + + Args: + vca - is active VCA connection. + vdc_name - is a vdc name that will be used to query vms action + + Returns: + The return XML respond + """ + vca = self.connect() + if vdc_name is None: + return None + + url_list = [vca.host, '/api/vms/query'] + vm_list_rest_call = ''.join(url_list) + + if not (not vca.vcloud_session or not vca.vcloud_session.organization): + refs = filter(lambda ref: ref.name == vdc_name and ref.type_ == 'application/vnd.vmware.vcloud.vdc+xml', + vca.vcloud_session.organization.Link) + if len(refs) == 1: + response = Http.get(url=vm_list_rest_call, + headers=vca.vcloud_session.get_vcloud_headers(), + verify=vca.verify, + logger=vca.logger) + if response.status_code == requests.codes.ok: + return response.content + + return None + + def get_vapp_list(self, vdc_name=None): + """ + Method retrieves vApp list deployed vCloud director and returns a dictionary + contains a list of all vapp deployed for queried VDC. + The key for a dictionary is vApp UUID + + + Args: + vca - is active VCA connection. + vdc_name - is a vdc name that will be used to query vms action + + Returns: + The return dictionary and key for each entry vapp UUID + """ + + vapp_dict = {} + if vdc_name is None: + return vapp_dict + + content = self.vms_view_action(vdc_name=vdc_name) + try: + vm_list_xmlroot = XmlElementTree.fromstring(content) + for vm_xml in vm_list_xmlroot: + if vm_xml.tag.split("}")[1] == 'VMRecord': + if vm_xml.attrib['isVAppTemplate'] == 'true': + rawuuid = vm_xml.attrib['container'].split('/')[-1:] + if 'vappTemplate-' in rawuuid[0]: + # vm in format vappTemplate-e63d40e7-4ff5-4c6d-851f-96c1e4da86a5 we remove + # vm and use raw UUID as key + vapp_dict[rawuuid[0][13:]] = vm_xml.attrib + except: + pass + + return vapp_dict + + def get_vm_list(self, vdc_name=None): + """ + Method retrieves VM's list deployed vCloud director. It returns a dictionary + contains a list of all VM's deployed for queried VDC. + The key for a dictionary is VM UUID + + + Args: + vca - is active VCA connection. + vdc_name - is a vdc name that will be used to query vms action + + Returns: + The return dictionary and key for each entry vapp UUID + """ + vm_dict = {} + + if vdc_name is None: + return vm_dict + + content = self.vms_view_action(vdc_name=vdc_name) + try: + vm_list_xmlroot = XmlElementTree.fromstring(content) + for vm_xml in vm_list_xmlroot: + if vm_xml.tag.split("}")[1] == 'VMRecord': + if vm_xml.attrib['isVAppTemplate'] == 'false': + rawuuid = vm_xml.attrib['href'].split('/')[-1:] + if 'vm-' in rawuuid[0]: + # vm in format vm-e63d40e7-4ff5-4c6d-851f-96c1e4da86a5 we remove + # vm and use raw UUID as key + vm_dict[rawuuid[0][3:]] = vm_xml.attrib + except: + pass + + return vm_dict + + def get_vapp(self, vdc_name=None, vapp_name=None, isuuid=False): + """ + Method retrieves VM deployed vCloud director. It returns VM attribute as dictionary + contains a list of all VM's deployed for queried VDC. + The key for a dictionary is VM UUID + + + Args: + vca - is active VCA connection. + vdc_name - is a vdc name that will be used to query vms action + + Returns: + The return dictionary and key for each entry vapp UUID + """ + vm_dict = {} + vca = self.connect() + if not vca: + raise vimconn.vimconnConnectionException("self.connect() is failed") + + if vdc_name is None: + return vm_dict + + content = self.vms_view_action(vdc_name=vdc_name) + try: + vm_list_xmlroot = XmlElementTree.fromstring(content) + for vm_xml in vm_list_xmlroot: + if vm_xml.tag.split("}")[1] == 'VMRecord' and vm_xml.attrib['isVAppTemplate'] == 'false': + # lookup done by UUID + if isuuid: + if vapp_name in vm_xml.attrib['container']: + rawuuid = vm_xml.attrib['href'].split('/')[-1:] + if 'vm-' in rawuuid[0]: + vm_dict[rawuuid[0][3:]] = vm_xml.attrib + break + # lookup done by Name + else: + if vapp_name in vm_xml.attrib['name']: + rawuuid = vm_xml.attrib['href'].split('/')[-1:] + if 'vm-' in rawuuid[0]: + vm_dict[rawuuid[0][3:]] = vm_xml.attrib + break + except: + pass + + return vm_dict + + def get_network_action(self, network_uuid=None): + """ + Method leverages vCloud director and query network based on network uuid + + Args: + vca - is active VCA connection. + network_uuid - is a network uuid + + Returns: + The return XML respond + """ + + vca = self.connect() + if not vca: + raise vimconn.vimconnConnectionException("self.connect() is failed") + + if network_uuid is None: + return None + + url_list = [vca.host, '/api/network/', network_uuid] + vm_list_rest_call = ''.join(url_list) + + if not (not vca.vcloud_session or not vca.vcloud_session.organization): + response = Http.get(url=vm_list_rest_call, + headers=vca.vcloud_session.get_vcloud_headers(), + verify=vca.verify, + logger=vca.logger) + if response.status_code == requests.codes.ok: + return response.content + + return None + + def get_vcd_network(self, network_uuid=None): + """ + Method retrieves available network from vCloud Director + + Args: + network_uuid - is VCD network UUID + + Each element serialized as key : value pair + + Following keys available for access. network_configuration['Gateway'} + + + + true + 172.16.252.100 + 255.255.255.0 + 172.16.254.201 + 172.16.254.202 + vmwarelab.edu + true + + + 172.16.252.1 + 172.16.252.99 + + + + + bridged + + Returns: + The return dictionary and key for each entry vapp UUID + """ + + network_configuration = {} + if network_uuid is None: + return network_uuid + + content = self.get_network_action(network_uuid=network_uuid) + try: + vm_list_xmlroot = XmlElementTree.fromstring(content) + + network_configuration['status'] = vm_list_xmlroot.get("status") + network_configuration['name'] = vm_list_xmlroot.get("name") + network_configuration['uuid'] = vm_list_xmlroot.get("id").split(":")[3] + + for child in vm_list_xmlroot: + if child.tag.split("}")[1] == 'IsShared': + network_configuration['isShared'] = child.text.strip() + if child.tag.split("}")[1] == 'Configuration': + for configuration in child.iter(): + tagKey = configuration.tag.split("}")[1].strip() + if tagKey != "": + network_configuration[tagKey] = configuration.text.strip() + return network_configuration + except: + pass + + return network_configuration + + def delete_network_action(self, network_uuid=None): + """ + Method delete given network from vCloud director + + Args: + network_uuid - is a network uuid that client wish to delete + + Returns: + The return None or XML respond or false + """ + + vca = self.connect_as_admin() + if not vca: + raise vimconn.vimconnConnectionException("self.connect() is failed") + if network_uuid is None: + return False + + url_list = [vca.host, '/api/admin/network/', network_uuid] + vm_list_rest_call = ''.join(url_list) + + if not (not vca.vcloud_session or not vca.vcloud_session.organization): + response = Http.delete(url=vm_list_rest_call, + headers=vca.vcloud_session.get_vcloud_headers(), + verify=vca.verify, + logger=vca.logger) + + if response.status_code == 202: + return True + + return False + + def create_network(self, network_name=None, parent_network_uuid=None, isshared='true'): + """ + Method create network in vCloud director + + Args: + network_name - is network name to be created. + parent_network_uuid - is parent provider vdc network that will be used for mapping. + It optional attribute. by default if no parent network indicate the first available will be used. + + Returns: + The return network uuid or return None + """ + + new_network_name = [network_name, '-', str(uuid.uuid4())] + content = self.create_network_rest(network_name=''.join(new_network_name), + parent_network_uuid=parent_network_uuid, + isshared=isshared) + if content is None: + self.logger.debug("Failed create network {}.".format(network_name)) + return None + + try: + vm_list_xmlroot = XmlElementTree.fromstring(content) + vcd_uuid = vm_list_xmlroot.get('id').split(":") + if len(vcd_uuid) == 4: + self.logger.info("Create new network name: {} uuid: {}".format(network_name, vcd_uuid[3])) + return vcd_uuid[3] + except: + self.logger.debug("Failed create network {}".format(network_name)) + return None + + def create_network_rest(self, network_name=None, parent_network_uuid=None, isshared='true'): + """ + Method create network in vCloud director + + Args: + network_name - is network name to be created. + parent_network_uuid - is parent provider vdc network that will be used for mapping. + It optional attribute. by default if no parent network indicate the first available will be used. + + Returns: + The return network uuid or return None + """ + + vca = self.connect_as_admin() + if not vca: + raise vimconn.vimconnConnectionException("self.connect() is failed.") + if network_name is None: + return None + + url_list = [vca.host, '/api/admin/vdc/', self.tenant_id] + vm_list_rest_call = ''.join(url_list) + if not (not vca.vcloud_session or not vca.vcloud_session.organization): + response = Http.get(url=vm_list_rest_call, + headers=vca.vcloud_session.get_vcloud_headers(), + verify=vca.verify, + logger=vca.logger) + + provider_network = None + available_networks = None + add_vdc_rest_url = None + + if response.status_code != requests.codes.ok: + self.logger.debug("REST API call {} failed. Return status code {}".format(vm_list_rest_call, + response.status_code)) + return None + else: + try: + vm_list_xmlroot = XmlElementTree.fromstring(response.content) + for child in vm_list_xmlroot: + if child.tag.split("}")[1] == 'ProviderVdcReference': + provider_network = child.attrib.get('href') + # application/vnd.vmware.admin.providervdc+xml + if child.tag.split("}")[1] == 'Link': + if child.attrib.get('type') == 'application/vnd.vmware.vcloud.orgVdcNetwork+xml' \ + and child.attrib.get('rel') == 'add': + add_vdc_rest_url = child.attrib.get('href') + except: + self.logger.debug("Failed parse respond for rest api call {}".format(vm_list_rest_call)) + self.logger.debug("Respond body {}".format(response.content)) + return None + + # find pvdc provided available network + response = Http.get(url=provider_network, + headers=vca.vcloud_session.get_vcloud_headers(), + verify=vca.verify, + logger=vca.logger) + if response.status_code != requests.codes.ok: + self.logger.debug("REST API call {} failed. Return status code {}".format(vm_list_rest_call, + response.status_code)) + return None + + # available_networks.split("/")[-1] + + if parent_network_uuid is None: + try: + vm_list_xmlroot = XmlElementTree.fromstring(response.content) + for child in vm_list_xmlroot.iter(): + if child.tag.split("}")[1] == 'AvailableNetworks': + for networks in child.iter(): + # application/vnd.vmware.admin.network+xml + if networks.attrib.get('href') is not None: + available_networks = networks.attrib.get('href') + break + except: + return None + + # either use client provided UUID or search for a first available + # if both are not defined we return none + if parent_network_uuid is not None: + url_list = [vca.host, '/api/admin/network/', parent_network_uuid] + add_vdc_rest_url = ''.join(url_list) + + # return response.content + data = """ + Openmano created + + + {2:s} + + {3:s} + """.format(escape(network_name), available_networks, "bridged", isshared) + + headers = vca.vcloud_session.get_vcloud_headers() + headers['Content-Type'] = 'application/vnd.vmware.vcloud.orgVdcNetwork+xml' + response = Http.post(url=add_vdc_rest_url, headers=headers, data=data, verify=vca.verify, logger=vca.logger) + + # if we all ok we respond with content otherwise by default None + if response.status_code == 201: + return response.content + return None + + def get_provider_rest(self, vca=None): + """ + Method gets provider vdc view from vcloud director + + Args: + network_name - is network name to be created. + parent_network_uuid - is parent provider vdc network that will be used for mapping. + It optional attribute. by default if no parent network indicate the first available will be used. + + Returns: + The return xml content of respond or None + """ + + url_list = [vca.host, '/api/admin'] + response = Http.get(url=''.join(url_list), + headers=vca.vcloud_session.get_vcloud_headers(), + verify=vca.verify, + logger=vca.logger) + + if response.status_code == requests.codes.ok: + return response.content + return None + + def create_vdc(self, vdc_name=None): + + vdc_dict = {} + + xml_content = self.create_vdc_from_tmpl_rest(vdc_name=vdc_name) + if xml_content is not None: + try: + task_resp_xmlroot = XmlElementTree.fromstring(xml_content) + for child in task_resp_xmlroot: + if child.tag.split("}")[1] == 'Owner': + vdc_id = child.attrib.get('href').split("/")[-1] + vdc_dict[vdc_id] = task_resp_xmlroot.get('href') + return vdc_dict + except: + self.logger.debug("Respond body {}".format(xml_content)) + + return None + + def create_vdc_from_tmpl_rest(self, vdc_name=None): + """ + Method create vdc in vCloud director based on VDC template. + it uses pre-defined template that must be named openmano + + Args: + vdc_name - name of a new vdc. + + Returns: + The return xml content of respond or None + """ + + self.logger.info("Creating new vdc {}".format(vdc_name)) + vca = self.connect() + if not vca: + raise vimconn.vimconnConnectionException("self.connect() is failed") + if vdc_name is None: + return None + + url_list = [vca.host, '/api/vdcTemplates'] + vm_list_rest_call = ''.join(url_list) + response = Http.get(url=vm_list_rest_call, + headers=vca.vcloud_session.get_vcloud_headers(), + verify=vca.verify, + logger=vca.logger) + + # container url to a template + vdc_template_ref = None + try: + vm_list_xmlroot = XmlElementTree.fromstring(response.content) + for child in vm_list_xmlroot: + # application/vnd.vmware.admin.providervdc+xml + # we need find a template from witch we instantiate VDC + if child.tag.split("}")[1] == 'VdcTemplate': + if child.attrib.get('type') == 'application/vnd.vmware.admin.vdcTemplate+xml' and child.attrib.get( + 'name') == 'openmano': + vdc_template_ref = child.attrib.get('href') + except: + self.logger.debug("Failed parse respond for rest api call {}".format(vm_list_rest_call)) + self.logger.debug("Respond body {}".format(response.content)) + return None + + # if we didn't found required pre defined template we return None + if vdc_template_ref is None: + return None + + try: + # instantiate vdc + url_list = [vca.host, '/api/org/', self.org_uuid, '/action/instantiate'] + vm_list_rest_call = ''.join(url_list) + data = """ + + opnemano + """.format(vdc_name, vdc_template_ref) + headers = vca.vcloud_session.get_vcloud_headers() + headers['Content-Type'] = 'application/vnd.vmware.vcloud.instantiateVdcTemplateParams+xml' + response = Http.post(url=vm_list_rest_call, headers=headers, data=data, verify=vca.verify, + logger=vca.logger) + # if we all ok we respond with content otherwise by default None + if response.status_code >= 200 and response.status_code < 300: + return response.content + return None + except: + self.logger.debug("Failed parse respond for rest api call {}".format(vm_list_rest_call)) + self.logger.debug("Respond body {}".format(response.content)) + + return None + + def create_vdc_rest(self, vdc_name=None): + """ + Method create network in vCloud director + + Args: + network_name - is network name to be created. + parent_network_uuid - is parent provider vdc network that will be used for mapping. + It optional attribute. by default if no parent network indicate the first available will be used. + + Returns: + The return network uuid or return None + """ + + self.logger.info("Creating new vdc {}".format(vdc_name)) + + vca = self.connect_as_admin() + if not vca: + raise vimconn.vimconnConnectionException("self.connect() is failed") + if vdc_name is None: + return None + + url_list = [vca.host, '/api/admin/org/', self.org_uuid] + vm_list_rest_call = ''.join(url_list) + if not (not vca.vcloud_session or not vca.vcloud_session.organization): + response = Http.get(url=vm_list_rest_call, + headers=vca.vcloud_session.get_vcloud_headers(), + verify=vca.verify, + logger=vca.logger) + + provider_vdc_ref = None + add_vdc_rest_url = None + available_networks = None + + if response.status_code != requests.codes.ok: + self.logger.debug("REST API call {} failed. Return status code {}".format(vm_list_rest_call, + response.status_code)) + return None + else: + try: + vm_list_xmlroot = XmlElementTree.fromstring(response.content) + for child in vm_list_xmlroot: + # application/vnd.vmware.admin.providervdc+xml + if child.tag.split("}")[1] == 'Link': + if child.attrib.get('type') == 'application/vnd.vmware.admin.createVdcParams+xml' \ + and child.attrib.get('rel') == 'add': + add_vdc_rest_url = child.attrib.get('href') + except: + self.logger.debug("Failed parse respond for rest api call {}".format(vm_list_rest_call)) + self.logger.debug("Respond body {}".format(response.content)) + return None + + response = self.get_provider_rest(vca=vca) + try: + vm_list_xmlroot = XmlElementTree.fromstring(response) + for child in vm_list_xmlroot: + if child.tag.split("}")[1] == 'ProviderVdcReferences': + for sub_child in child: + provider_vdc_ref = sub_child.attrib.get('href') + except: + self.logger.debug("Failed parse respond for rest api call {}".format(vm_list_rest_call)) + self.logger.debug("Respond body {}".format(response)) + return None + + if add_vdc_rest_url is not None and provider_vdc_ref is not None: + data = """ {1:s} + ReservationPool + MHz20482048 + MB20482048 + 0100 + trueMB20480true + + true""".format(escape(vdc_name), + escape(vdc_name), + provider_vdc_ref) + + headers = vca.vcloud_session.get_vcloud_headers() + headers['Content-Type'] = 'application/vnd.vmware.admin.createVdcParams+xml' + response = Http.post(url=add_vdc_rest_url, headers=headers, data=data, verify=vca.verify, + logger=vca.logger) + + # if we all ok we respond with content otherwise by default None + if response.status_code == 201: + return response.content + return None + + def get_vapp_details_rest(self, vapp_uuid=None): + """ + Method retrieve vapp detail from vCloud director + + Args: + vapp_uuid - is vapp identifier. + + Returns: + The return network uuid or return None + """ + + parsed_respond = {} + + vca = self.connect() + if not vca: + raise vimconn.vimconnConnectionException("self.connect() is failed") + if vapp_uuid is None: + return None + + url_list = [vca.host, '/api/vApp/vapp-', vapp_uuid] + get_vapp_restcall = ''.join(url_list) + if not (not vca.vcloud_session or not vca.vcloud_session.organization): + response = Http.get(url=get_vapp_restcall, + headers=vca.vcloud_session.get_vcloud_headers(), + verify=vca.verify, + logger=vca.logger) + + if response.status_code != requests.codes.ok: + self.logger.debug("REST API call {} failed. Return status code {}".format(get_vapp_restcall, + response.status_code)) + return parsed_respond + + try: + xmlroot_respond = XmlElementTree.fromstring(response.content) + parsed_respond['ovfDescriptorUploaded'] = xmlroot_respond.attrib['ovfDescriptorUploaded'] + + namespaces_ovf = {'ovf': 'http://schemas.dmtf.org/ovf/envelope/1'} + namespace_vmm = {'vmw': 'http://www.vmware.com/schema/ovf'} + namespace_vm = {'vm': 'http://www.vmware.com/vcloud/v1.5'} + + created_section = xmlroot_respond.find('vm:DateCreated', namespace_vm) + if created_section is not None: + parsed_respond['created'] = created_section.text + + network_section = xmlroot_respond.find('vm:NetworkConfigSection/vm:NetworkConfig', namespace_vm) + if network_section is not None and 'networkName' in network_section.attrib: + parsed_respond['networkname'] = network_section.attrib['networkName'] + + ipscopes_section = \ + xmlroot_respond.find('vm:NetworkConfigSection/vm:NetworkConfig/vm:Configuration/vm:IpScopes', + namespace_vm) + if ipscopes_section is not None: + for ipscope in ipscopes_section: + for scope in ipscope: + tag_key = scope.tag.split("}")[1] + if tag_key == 'IpRanges': + ip_ranges = scope.getchildren() + for ipblock in ip_ranges: + for block in ipblock: + parsed_respond[block.tag.split("}")[1]] = block.text + else: + parsed_respond[tag_key] = scope.text + + # parse children section for other attrib + children_section = xmlroot_respond.find('vm:Children/', namespace_vm) + if children_section is not None: + parsed_respond['name'] = children_section.attrib['name'] + parsed_respond['nestedHypervisorEnabled'] = children_section.attrib['nestedHypervisorEnabled'] + parsed_respond['deployed'] = children_section.attrib['deployed'] + parsed_respond['status'] = children_section.attrib['status'] + parsed_respond['vmuuid'] = children_section.attrib['id'].split(":")[-1] + network_adapter = children_section.find('vm:NetworkConnectionSection', namespace_vm) + nic_list = [] + for adapters in network_adapter: + adapter_key = adapters.tag.split("}")[1] + if adapter_key == 'PrimaryNetworkConnectionIndex': + parsed_respond['primarynetwork'] = adapters.text + if adapter_key == 'NetworkConnection': + vnic = {} + if 'network' in adapters.attrib: + vnic['network'] = adapters.attrib['network'] + for adapter in adapters: + setting_key = adapter.tag.split("}")[1] + vnic[setting_key] = adapter.text + nic_list.append(vnic) + + for link in children_section: + if link.tag.split("}")[1] == 'Link' and 'rel' in link.attrib: + if link.attrib['rel'] == 'screen:acquireTicket': + parsed_respond['acquireTicket'] = link.attrib + if link.attrib['rel'] == 'screen:acquireMksTicket': + parsed_respond['acquireMksTicket'] = link.attrib + + parsed_respond['interfaces'] = nic_list + except: + pass + + return parsed_respond + + def acuire_console(self, vm_uuid=None): + + vca = self.connect() + if not vca: + raise vimconn.vimconnConnectionException("self.connect() is failed") + if vm_uuid is None: + return None + + if not (not vca.vcloud_session or not vca.vcloud_session.organization): + vm_dict = self.get_vapp_details_rest(self, vapp_uuid=vm_uuid) + console_dict = vm_dict['acquireTicket'] + console_rest_call = console_dict['href'] + + response = Http.post(url=console_rest_call, + headers=vca.vcloud_session.get_vcloud_headers(), + verify=vca.verify, + logger=vca.logger) + + if response.status_code == requests.codes.ok: + return response.content + return None \ No newline at end of file