osm_ro/vimconn_openstack.py

   1 # -*- coding: utf-8 -*-
   2
   3 ##
   4 # Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U.
   5 # This file is part of openmano
   6 # All Rights Reserved.
   7 #
   8 # Licensed under the Apache License, Version 2.0 (the "License"); you may
   9 # not use this file except in compliance with the License. You may obtain
  10 # a copy of the License at
  11 #
  12 #         http://www.apache.org/licenses/LICENSE-2.0
  13 #
  14 # Unless required by applicable law or agreed to in writing, software
  15 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  16 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  17 # License for the specific language governing permissions and limitations
  18 # under the License.
  19 #
  20 # For those usages not covered by the Apache License, Version 2.0 please
  21 # contact with: nfvlabs@tid.es
  22 ##
  23
  24 '''
  25 osconnector implements all the methods to interact with openstack using the python-client.
  26 '''
  27 __author__="Alfonso Tierno, Gerardo Garcia, Pablo Montes, xFlow Research"
  28 __date__ ="$22-jun-2014 11:19:29$"
  29
  30 import vimconn
  31 import json
  32 import yaml
  33 import logging
  34 import netaddr
  35 import time
  36 import yaml
  37 import random
  38
  39 from novaclient import client as nClient, exceptions as nvExceptions
  40 from keystoneauth1.identity import v2, v3
  41 from keystoneauth1 import session
  42 import keystoneclient.exceptions as ksExceptions
  43 import keystoneclient.v3.client as ksClient_v3
  44 import keystoneclient.v2_0.client as ksClient_v2
  45 from glanceclient import client as glClient
  46 import glanceclient.client as gl1Client
  47 import glanceclient.exc as gl1Exceptions
  48 from  cinderclient import client as cClient
  49 from httplib import HTTPException
  50 from neutronclient.neutron import client as neClient
  51 from neutronclient.common import exceptions as neExceptions
  52 from requests.exceptions import ConnectionError
  53
  54 '''contain the openstack virtual machine status to openmano status'''
  55 vmStatus2manoFormat={'ACTIVE':'ACTIVE',
  56                      'PAUSED':'PAUSED',
  57                      'SUSPENDED': 'SUSPENDED',
  58                      'SHUTOFF':'INACTIVE',
  59                      'BUILD':'BUILD',
  60                      'ERROR':'ERROR','DELETED':'DELETED'
  61                      }
  62 netStatus2manoFormat={'ACTIVE':'ACTIVE','PAUSED':'PAUSED','INACTIVE':'INACTIVE','BUILD':'BUILD','ERROR':'ERROR','DELETED':'DELETED'
  63                      }
  64
  65 #global var to have a timeout creating and deleting volumes
  66 volume_timeout = 60
  67 server_timeout = 60
  68
  69 class vimconnector(vimconn.vimconnector):
  70     def __init__(self, uuid, name, tenant_id, tenant_name, url, url_admin=None, user=None, passwd=None,
  71                  log_level=None, config={}, persistent_info={}):
  72         '''using common constructor parameters. In this case
  73         'url' is the keystone authorization url,
  74         'url_admin' is not use
  75         '''
  76         api_version = config.get('APIversion')
  77         if api_version and api_version not in ('v3.3', 'v2.0', '2', '3'):
  78             raise vimconn.vimconnException("Invalid value '{}' for config:APIversion. "
  79                                            "Allowed values are 'v3.3', 'v2.0', '2' or '3'".format(api_version))
  80         vimconn.vimconnector.__init__(self, uuid, name, tenant_id, tenant_name, url, url_admin, user, passwd, log_level,
  81                                       config)
  82
  83         self.insecure = self.config.get("insecure", False)
  84         if not url:
  85             raise TypeError, 'url param can not be NoneType'
  86         self.persistent_info = persistent_info
  87         self.session = persistent_info.get('session', {'reload_client': True})
  88         self.nova = self.session.get('nova')
  89         self.neutron = self.session.get('neutron')
  90         self.cinder = self.session.get('cinder')
  91         self.glance = self.session.get('glance')
  92         self.keystone = self.session.get('keystone')
  93         self.api_version3 = self.session.get('api_version3')
  94
  95         self.logger = logging.getLogger('openmano.vim.openstack')
  96         if log_level:
  97             self.logger.setLevel( getattr(logging, log_level) )
  98
  99     def __getitem__(self, index):
 100         """Get individuals parameters.
 101         Throw KeyError"""
 102         if index == 'project_domain_id':
 103             return self.config.get("project_domain_id")
 104         elif index == 'user_domain_id':
 105             return self.config.get("user_domain_id")
 106         else:
 107             return vimconn.vimconnector.__getitem__(self, index)
 108
 109     def __setitem__(self, index, value):
 110         """Set individuals parameters and it is marked as dirty so to force connection reload.
 111         Throw KeyError"""
 112         if index == 'project_domain_id':
 113             self.config["project_domain_id"] = value
 114         elif index == 'user_domain_id':
 115                 self.config["user_domain_id"] = value
 116         else:
 117             vimconn.vimconnector.__setitem__(self, index, value)
 118         self.session['reload_client'] = True
 119
 120     def _reload_connection(self):
 121         '''Called before any operation, it check if credentials has changed
 122         Throw keystoneclient.apiclient.exceptions.AuthorizationFailure
 123         '''
 124         #TODO control the timing and possible token timeout, but it seams that python client does this task for us :-)
 125         if self.session['reload_client']:
 126             if self.config.get('APIversion'):
 127                 self.api_version3 = self.config['APIversion'] == 'v3.3' or self.config['APIversion'] == '3'
 128             else:  # get from ending auth_url that end with v3 or with v2.0
 129                 self.api_version3 =  self.url.split("/")[-1] == "v3"
 130             self.session['api_version3'] = self.api_version3
 131             if self.api_version3:
 132                 auth = v3.Password(auth_url=self.url,
 133                                    username=self.user,
 134                                    password=self.passwd,
 135                                    project_name=self.tenant_name,
 136                                    project_id=self.tenant_id,
 137                                    project_domain_id=self.config.get('project_domain_id', 'default'),
 138                                    user_domain_id=self.config.get('user_domain_id', 'default'))
 139             else:
 140                 auth = v2.Password(auth_url=self.url,
 141                                    username=self.user,
 142                                    password=self.passwd,
 143                                    tenant_name=self.tenant_name,
 144                                    tenant_id=self.tenant_id)
 145             sess = session.Session(auth=auth, verify=not self.insecure)
 146             if self.api_version3:
 147                 self.keystone = ksClient_v3.Client(session=sess)
 148             else:
 149                 self.keystone = ksClient_v2.Client(session=sess)
 150             self.session['keystone'] = self.keystone
 151             self.nova = self.session['nova'] = nClient.Client("2.1", session=sess)
 152             self.neutron = self.session['neutron'] = neClient.Client('2.0', session=sess)
 153             self.cinder = self.session['cinder'] = cClient.Client(2, session=sess)
 154             self.glance = self.session['glance'] = glClient.Client(2, session=sess)
 155             self.session['reload_client'] = False
 156             self.persistent_info['session'] = self.session
 157
 158     def __net_os2mano(self, net_list_dict):
 159         '''Transform the net openstack format to mano format
 160         net_list_dict can be a list of dict or a single dict'''
 161         if type(net_list_dict) is dict:
 162             net_list_=(net_list_dict,)
 163         elif type(net_list_dict) is list:
 164             net_list_=net_list_dict
 165         else:
 166             raise TypeError("param net_list_dict must be a list or a dictionary")
 167         for net in net_list_:
 168             if net.get('provider:network_type') == "vlan":
 169                 net['type']='data'
 170             else:
 171                 net['type']='bridge'
 172
 173
 174
 175     def _format_exception(self, exception):
 176         '''Transform a keystone, nova, neutron  exception into a vimconn exception'''
 177         if isinstance(exception, (HTTPException, gl1Exceptions.HTTPException, gl1Exceptions.CommunicationError,
 178                                   ConnectionError, ksExceptions.ConnectionError, neExceptions.ConnectionFailed
 179                                   )):
 180             raise vimconn.vimconnConnectionException(type(exception).__name__ + ": " + str(exception))
 181         elif isinstance(exception, (nvExceptions.ClientException, ksExceptions.ClientException,
 182                                     neExceptions.NeutronException, nvExceptions.BadRequest)):
 183             raise vimconn.vimconnUnexpectedResponse(type(exception).__name__ + ": " + str(exception))
 184         elif isinstance(exception, (neExceptions.NetworkNotFoundClient, nvExceptions.NotFound)):
 185             raise vimconn.vimconnNotFoundException(type(exception).__name__ + ": " + str(exception))
 186         elif isinstance(exception, nvExceptions.Conflict):
 187             raise vimconn.vimconnConflictException(type(exception).__name__ + ": " + str(exception))
 188         else:  # ()
 189             raise vimconn.vimconnConnectionException(type(exception).__name__ + ": " + str(exception))
 190
 191     def get_tenant_list(self, filter_dict={}):
 192         '''Obtain tenants of VIM
 193         filter_dict can contain the following keys:
 194             name: filter by tenant name
 195             id: filter by tenant uuid/id
 196             <other VIM specific>
 197         Returns the tenant list of dictionaries: [{'name':'<name>, 'id':'<id>, ...}, ...]
 198         '''
 199         self.logger.debug("Getting tenants from VIM filter: '%s'", str(filter_dict))
 200         try:
 201             self._reload_connection()
 202             if self.api_version3:
 203                 project_class_list = self.keystone.projects.list(name=filter_dict.get("name"))
 204             else:
 205                 project_class_list = self.keystone.tenants.findall(**filter_dict)
 206             project_list=[]
 207             for project in project_class_list:
 208                 if filter_dict.get('id') and filter_dict["id"] != project.id:
 209                     continue
 210                 project_list.append(project.to_dict())
 211             return project_list
 212         except (ksExceptions.ConnectionError, ksExceptions.ClientException, ConnectionError) as e:
 213             self._format_exception(e)
 214
 215     def new_tenant(self, tenant_name, tenant_description):
 216         '''Adds a new tenant to openstack VIM. Returns the tenant identifier'''
 217         self.logger.debug("Adding a new tenant name: %s", tenant_name)
 218         try:
 219             self._reload_connection()
 220             if self.api_version3:
 221                 project = self.keystone.projects.create(tenant_name, self.config.get("project_domain_id", "default"),
 222                                                         description=tenant_description, is_domain=False)
 223             else:
 224                 project = self.keystone.tenants.create(tenant_name, tenant_description)
 225             return project.id
 226         except (ksExceptions.ConnectionError, ksExceptions.ClientException, ConnectionError)  as e:
 227             self._format_exception(e)
 228
 229     def delete_tenant(self, tenant_id):
 230         '''Delete a tenant from openstack VIM. Returns the old tenant identifier'''
 231         self.logger.debug("Deleting tenant %s from VIM", tenant_id)
 232         try:
 233             self._reload_connection()
 234             if self.api_version3:
 235                 self.keystone.projects.delete(tenant_id)
 236             else:
 237                 self.keystone.tenants.delete(tenant_id)
 238             return tenant_id
 239         except (ksExceptions.ConnectionError, ksExceptions.ClientException, ConnectionError)  as e:
 240             self._format_exception(e)
 241
 242     def new_network(self,net_name, net_type, ip_profile=None, shared=False, vlan=None):
 243         '''Adds a tenant network to VIM. Returns the network identifier'''
 244         self.logger.debug("Adding a new network to VIM name '%s', type '%s'", net_name, net_type)
 245         #self.logger.debug(">>>>>>>>>>>>>>>>>> IP profile %s", str(ip_profile))
 246         try:
 247             new_net = None
 248             self._reload_connection()
 249             network_dict = {'name': net_name, 'admin_state_up': True}
 250             if net_type=="data" or net_type=="ptp":
 251                 if self.config.get('dataplane_physical_net') == None:
 252                     raise vimconn.vimconnConflictException("You must provide a 'dataplane_physical_net' at config value before creating sriov network")
 253                 network_dict["provider:physical_network"] = self.config['dataplane_physical_net'] #"physnet_sriov" #TODO physical
 254                 network_dict["provider:network_type"]     = "vlan"
 255                 if vlan!=None:
 256                     network_dict["provider:network_type"] = vlan
 257             network_dict["shared"]=shared
 258             new_net=self.neutron.create_network({'network':network_dict})
 259             #print new_net
 260             #create subnetwork, even if there is no profile
 261             if not ip_profile:
 262                 ip_profile = {}
 263             if 'subnet_address' not in ip_profile:
 264                 #Fake subnet is required
 265                 subnet_rand = random.randint(0, 255)
 266                 ip_profile['subnet_address'] = "192.168.{}.0/24".format(subnet_rand)
 267             if 'ip_version' not in ip_profile:
 268                 ip_profile['ip_version'] = "IPv4"
 269             subnet={"name":net_name+"-subnet",
 270                     "network_id": new_net["network"]["id"],
 271                     "ip_version": 4 if ip_profile['ip_version']=="IPv4" else 6,
 272                     "cidr": ip_profile['subnet_address']
 273                     }
 274             if 'gateway_address' in ip_profile:
 275                 subnet['gateway_ip'] = ip_profile['gateway_address']
 276             if ip_profile.get('dns_address'):
 277                 subnet['dns_nameservers'] = ip_profile['dns_address'].split(";")
 278             if 'dhcp_enabled' in ip_profile:
 279                 subnet['enable_dhcp'] = False if ip_profile['dhcp_enabled']=="false" else True
 280             if 'dhcp_start_address' in ip_profile:
 281                 subnet['allocation_pools']=[]
 282                 subnet['allocation_pools'].append(dict())
 283                 subnet['allocation_pools'][0]['start'] = ip_profile['dhcp_start_address']
 284             if 'dhcp_count' in ip_profile:
 285                 #parts = ip_profile['dhcp_start_address'].split('.')
 286                 #ip_int = (int(parts[0]) << 24) + (int(parts[1]) << 16) + (int(parts[2]) << 8) + int(parts[3])
 287                 ip_int = int(netaddr.IPAddress(ip_profile['dhcp_start_address']))
 288                 ip_int += ip_profile['dhcp_count'] - 1
 289                 ip_str = str(netaddr.IPAddress(ip_int))
 290                 subnet['allocation_pools'][0]['end'] = ip_str
 291             #self.logger.debug(">>>>>>>>>>>>>>>>>> Subnet: %s", str(subnet))
 292             self.neutron.create_subnet({"subnet": subnet} )
 293             return new_net["network"]["id"]
 294         except (neExceptions.ConnectionFailed, ksExceptions.ClientException, neExceptions.NeutronException, ConnectionError) as e:
 295             if new_net:
 296                 self.neutron.delete_network(new_net['network']['id'])
 297             self._format_exception(e)
 298
 299     def get_network_list(self, filter_dict={}):
 300         '''Obtain tenant networks of VIM
 301         Filter_dict can be:
 302             name: network name
 303             id: network uuid
 304             shared: boolean
 305             tenant_id: tenant
 306             admin_state_up: boolean
 307             status: 'ACTIVE'
 308         Returns the network list of dictionaries
 309         '''
 310         self.logger.debug("Getting network from VIM filter: '%s'", str(filter_dict))
 311         try:
 312             self._reload_connection()
 313             if self.api_version3 and "tenant_id" in filter_dict:
 314                 filter_dict['project_id'] = filter_dict.pop('tenant_id') #TODO check
 315             net_dict=self.neutron.list_networks(**filter_dict)
 316             net_list=net_dict["networks"]
 317             self.__net_os2mano(net_list)
 318             return net_list
 319         except (neExceptions.ConnectionFailed, ksExceptions.ClientException, neExceptions.NeutronException, ConnectionError) as e:
 320             self._format_exception(e)
 321
 322     def get_network(self, net_id):
 323         '''Obtain details of network from VIM
 324         Returns the network information from a network id'''
 325         self.logger.debug(" Getting tenant network %s from VIM", net_id)
 326         filter_dict={"id": net_id}
 327         net_list = self.get_network_list(filter_dict)
 328         if len(net_list)==0:
 329             raise vimconn.vimconnNotFoundException("Network '{}' not found".format(net_id))
 330         elif len(net_list)>1:
 331             raise vimconn.vimconnConflictException("Found more than one network with this criteria")
 332         net = net_list[0]
 333         subnets=[]
 334         for subnet_id in net.get("subnets", () ):
 335             try:
 336                 subnet = self.neutron.show_subnet(subnet_id)
 337             except Exception as e:
 338                 self.logger.error("osconnector.get_network(): Error getting subnet %s %s" % (net_id, str(e)))
 339                 subnet = {"id": subnet_id, "fault": str(e)}
 340             subnets.append(subnet)
 341         net["subnets"] = subnets
 342         net["encapsulation"] = net.get('provider:network_type')
 343         net["segmentation_id"] = net.get('provider:segmentation_id')
 344         return net
 345
 346     def delete_network(self, net_id):
 347         '''Deletes a tenant network from VIM. Returns the old network identifier'''
 348         self.logger.debug("Deleting network '%s' from VIM", net_id)
 349         try:
 350             self._reload_connection()
 351             #delete VM ports attached to this networks before the network
 352             ports = self.neutron.list_ports(network_id=net_id)
 353             for p in ports['ports']:
 354                 try:
 355                     self.neutron.delete_port(p["id"])
 356                 except Exception as e:
 357                     self.logger.error("Error deleting port %s: %s", p["id"], str(e))
 358             self.neutron.delete_network(net_id)
 359             return net_id
 360         except (neExceptions.ConnectionFailed, neExceptions.NetworkNotFoundClient, neExceptions.NeutronException,
 361                 ksExceptions.ClientException, neExceptions.NeutronException, ConnectionError) as e:
 362             self._format_exception(e)
 363
 364     def refresh_nets_status(self, net_list):
 365         '''Get the status of the networks
 366            Params: the list of network identifiers
 367            Returns a dictionary with:
 368                 net_id:         #VIM id of this network
 369                     status:     #Mandatory. Text with one of:
 370                                 #  DELETED (not found at vim)
 371                                 #  VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
 372                                 #  OTHER (Vim reported other status not understood)
 373                                 #  ERROR (VIM indicates an ERROR status)
 374                                 #  ACTIVE, INACTIVE, DOWN (admin down),
 375                                 #  BUILD (on building process)
 376                                 #
 377                     error_msg:  #Text with VIM error message, if any. Or the VIM connection ERROR
 378                     vim_info:   #Text with plain information obtained from vim (yaml.safe_dump)
 379
 380         '''
 381         net_dict={}
 382         for net_id in net_list:
 383             net = {}
 384             try:
 385                 net_vim = self.get_network(net_id)
 386                 if net_vim['status'] in netStatus2manoFormat:
 387                     net["status"] = netStatus2manoFormat[ net_vim['status'] ]
 388                 else:
 389                     net["status"] = "OTHER"
 390                     net["error_msg"] = "VIM status reported " + net_vim['status']
 391
 392                 if net['status'] == "ACTIVE" and not net_vim['admin_state_up']:
 393                     net['status'] = 'DOWN'
 394                 try:
 395                     net['vim_info'] = yaml.safe_dump(net_vim, default_flow_style=True, width=256)
 396                 except yaml.representer.RepresenterError:
 397                     net['vim_info'] = str(net_vim)
 398                 if net_vim.get('fault'):  #TODO
 399                     net['error_msg'] = str(net_vim['fault'])
 400             except vimconn.vimconnNotFoundException as e:
 401                 self.logger.error("Exception getting net status: %s", str(e))
 402                 net['status'] = "DELETED"
 403                 net['error_msg'] = str(e)
 404             except vimconn.vimconnException as e:
 405                 self.logger.error("Exception getting net status: %s", str(e))
 406                 net['status'] = "VIM_ERROR"
 407                 net['error_msg'] = str(e)
 408             net_dict[net_id] = net
 409         return net_dict
 410
 411     def get_flavor(self, flavor_id):
 412         '''Obtain flavor details from the  VIM. Returns the flavor dict details'''
 413         self.logger.debug("Getting flavor '%s'", flavor_id)
 414         try:
 415             self._reload_connection()
 416             flavor = self.nova.flavors.find(id=flavor_id)
 417             #TODO parse input and translate to VIM format (openmano_schemas.new_vminstance_response_schema)
 418             return flavor.to_dict()
 419         except (nvExceptions.NotFound, nvExceptions.ClientException, ksExceptions.ClientException, ConnectionError) as e:
 420             self._format_exception(e)
 421
 422     def get_flavor_id_from_data(self, flavor_dict):
 423         """Obtain flavor id that match the flavor description
 424            Returns the flavor_id or raises a vimconnNotFoundException
 425            flavor_dict: contains the required ram, vcpus, disk
 426            If 'use_existing_flavors' is set to True at config, the closer flavor that provides same or more ram, vcpus
 427                 and disk is returned. Otherwise a flavor with exactly same ram, vcpus and disk is returned or a
 428                 vimconnNotFoundException is raised
 429         """
 430         exact_match = False if self.config.get('use_existing_flavors') else True
 431         try:
 432             self._reload_connection()
 433             flavor_candidate_id = None
 434             flavor_candidate_data = (10000, 10000, 10000)
 435             flavor_target = (flavor_dict["ram"], flavor_dict["vcpus"], flavor_dict["disk"])
 436             # numa=None
 437             numas = flavor_dict.get("extended", {}).get("numas")
 438             if numas:
 439                 #TODO
 440                 raise vimconn.vimconnNotFoundException("Flavor with EPA still not implemted")
 441                 # if len(numas) > 1:
 442                 #     raise vimconn.vimconnNotFoundException("Cannot find any flavor with more than one numa")
 443                 # numa=numas[0]
 444                 # numas = extended.get("numas")
 445             for flavor in self.nova.flavors.list():
 446                 epa = flavor.get_keys()
 447                 if epa:
 448                     continue
 449                     # TODO
 450                 flavor_data = (flavor.ram, flavor.vcpus, flavor.disk)
 451                 if flavor_data == flavor_target:
 452                     return flavor.id
 453                 elif not exact_match and flavor_target < flavor_data < flavor_candidate_data:
 454                     flavor_candidate_id = flavor.id
 455                     flavor_candidate_data = flavor_data
 456             if not exact_match and flavor_candidate_id:
 457                 return flavor_candidate_id
 458             raise vimconn.vimconnNotFoundException("Cannot find any flavor matching '{}'".format(str(flavor_dict)))
 459         except (nvExceptions.NotFound, nvExceptions.ClientException, ksExceptions.ClientException, ConnectionError) as e:
 460             self._format_exception(e)
 461
 462
 463     def new_flavor(self, flavor_data, change_name_if_used=True):
 464         '''Adds a tenant flavor to openstack VIM
 465         if change_name_if_used is True, it will change name in case of conflict, because it is not supported name repetition
 466         Returns the flavor identifier
 467         '''
 468         self.logger.debug("Adding flavor '%s'", str(flavor_data))
 469         retry=0
 470         max_retries=3
 471         name_suffix = 0
 472         name=flavor_data['name']
 473         while retry<max_retries:
 474             retry+=1
 475             try:
 476                 self._reload_connection()
 477                 if change_name_if_used:
 478                     #get used names
 479                     fl_names=[]
 480                     fl=self.nova.flavors.list()
 481                     for f in fl:
 482                         fl_names.append(f.name)
 483                     while name in fl_names:
 484                         name_suffix += 1
 485                         name = flavor_data['name']+"-" + str(name_suffix)
 486
 487                 ram = flavor_data.get('ram',64)
 488                 vcpus = flavor_data.get('vcpus',1)
 489                 numa_properties=None
 490
 491                 extended = flavor_data.get("extended")
 492                 if extended:
 493                     numas=extended.get("numas")
 494                     if numas:
 495                         numa_nodes = len(numas)
 496                         if numa_nodes > 1:
 497                             return -1, "Can not add flavor with more than one numa"
 498                         numa_properties = {"hw:numa_nodes":str(numa_nodes)}
 499                         numa_properties["hw:mem_page_size"] = "large"
 500                         numa_properties["hw:cpu_policy"] = "dedicated"
 501                         numa_properties["hw:numa_mempolicy"] = "strict"
 502                         for numa in numas:
 503                             #overwrite ram and vcpus
 504                             ram = numa['memory']*1024
 505                             #See for reference: https://specs.openstack.org/openstack/nova-specs/specs/mitaka/implemented/virt-driver-cpu-thread-pinning.html
 506                             if 'paired-threads' in numa:
 507                                 vcpus = numa['paired-threads']*2
 508                                 #cpu_thread_policy "require" implies that the compute node must have an STM architecture
 509                                 numa_properties["hw:cpu_thread_policy"] = "require"
 510                                 numa_properties["hw:cpu_policy"] = "dedicated"
 511                             elif 'cores' in numa:
 512                                 vcpus = numa['cores']
 513                                 # cpu_thread_policy "prefer" implies that the host must not have an SMT architecture, or a non-SMT architecture will be emulated
 514                                 numa_properties["hw:cpu_thread_policy"] = "isolate"
 515                                 numa_properties["hw:cpu_policy"] = "dedicated"
 516                             elif 'threads' in numa:
 517                                 vcpus = numa['threads']
 518                                 # cpu_thread_policy "prefer" implies that the host may or may not have an SMT architecture
 519                                 numa_properties["hw:cpu_thread_policy"] = "prefer"
 520                                 numa_properties["hw:cpu_policy"] = "dedicated"
 521                             # for interface in numa.get("interfaces",() ):
 522                             #     if interface["dedicated"]=="yes":
 523                             #         raise vimconn.vimconnException("Passthrough interfaces are not supported for the openstack connector", http_code=vimconn.HTTP_Service_Unavailable)
 524                             #     #TODO, add the key 'pci_passthrough:alias"="<label at config>:<number ifaces>"' when a way to connect it is available
 525
 526                 #create flavor
 527                 new_flavor=self.nova.flavors.create(name,
 528                                 ram,
 529                                 vcpus,
 530                                 flavor_data.get('disk',1),
 531                                 is_public=flavor_data.get('is_public', True)
 532                             )
 533                 #add metadata
 534                 if numa_properties:
 535                     new_flavor.set_keys(numa_properties)
 536                 return new_flavor.id
 537             except nvExceptions.Conflict as e:
 538                 if change_name_if_used and retry < max_retries:
 539                     continue
 540                 self._format_exception(e)
 541             #except nvExceptions.BadRequest as e:
 542             except (ksExceptions.ClientException, nvExceptions.ClientException, ConnectionError) as e:
 543                 self._format_exception(e)
 544
 545     def delete_flavor(self,flavor_id):
 546         '''Deletes a tenant flavor from openstack VIM. Returns the old flavor_id
 547         '''
 548         try:
 549             self._reload_connection()
 550             self.nova.flavors.delete(flavor_id)
 551             return flavor_id
 552         #except nvExceptions.BadRequest as e:
 553         except (nvExceptions.NotFound, ksExceptions.ClientException, nvExceptions.ClientException, ConnectionError) as e:
 554             self._format_exception(e)
 555
 556     def new_image(self,image_dict):
 557         '''
 558         Adds a tenant image to VIM. imge_dict is a dictionary with:
 559             name: name
 560             disk_format: qcow2, vhd, vmdk, raw (by default), ...
 561             location: path or URI
 562             public: "yes" or "no"
 563             metadata: metadata of the image
 564         Returns the image_id
 565         '''
 566         # ALF TODO: revise and change for the new method or session
 567         #using version 1 of glance client
 568         glancev1 = gl1Client.Client('1',self.glance_endpoint, token=self.keystone.auth_token, **self.k_creds)  #TODO check k_creds vs n_creds
 569         retry=0
 570         max_retries=3
 571         while retry<max_retries:
 572             retry+=1
 573             try:
 574                 self._reload_connection()
 575                 #determine format  http://docs.openstack.org/developer/glance/formats.html
 576                 if "disk_format" in image_dict:
 577                     disk_format=image_dict["disk_format"]
 578                 else: #autodiscover based on extension
 579                     if image_dict['location'][-6:]==".qcow2":
 580                         disk_format="qcow2"
 581                     elif image_dict['location'][-4:]==".vhd":
 582                         disk_format="vhd"
 583                     elif image_dict['location'][-5:]==".vmdk":
 584                         disk_format="vmdk"
 585                     elif image_dict['location'][-4:]==".vdi":
 586                         disk_format="vdi"
 587                     elif image_dict['location'][-4:]==".iso":
 588                         disk_format="iso"
 589                     elif image_dict['location'][-4:]==".aki":
 590                         disk_format="aki"
 591                     elif image_dict['location'][-4:]==".ari":
 592                         disk_format="ari"
 593                     elif image_dict['location'][-4:]==".ami":
 594                         disk_format="ami"
 595                     else:
 596                         disk_format="raw"
 597                 self.logger.debug("new_image: '%s' loading from '%s'", image_dict['name'], image_dict['location'])
 598                 if image_dict['location'][0:4]=="http":
 599                     new_image = glancev1.images.create(name=image_dict['name'], is_public=image_dict.get('public',"yes")=="yes",
 600                             container_format="bare", location=image_dict['location'], disk_format=disk_format)
 601                 else: #local path
 602                     with open(image_dict['location']) as fimage:
 603                         new_image = glancev1.images.create(name=image_dict['name'], is_public=image_dict.get('public',"yes")=="yes",
 604                             container_format="bare", data=fimage, disk_format=disk_format)
 605                 #insert metadata. We cannot use 'new_image.properties.setdefault'
 606                 #because nova and glance are "INDEPENDENT" and we are using nova for reading metadata
 607                 new_image_nova=self.nova.images.find(id=new_image.id)
 608                 new_image_nova.metadata.setdefault('location',image_dict['location'])
 609                 metadata_to_load = image_dict.get('metadata')
 610                 if metadata_to_load:
 611                     for k,v in yaml.load(metadata_to_load).iteritems():
 612                         new_image_nova.metadata.setdefault(k,v)
 613                 return new_image.id
 614             except (nvExceptions.Conflict, ksExceptions.ClientException, nvExceptions.ClientException) as e:
 615                 self._format_exception(e)
 616             except (HTTPException, gl1Exceptions.HTTPException, gl1Exceptions.CommunicationError, ConnectionError) as e:
 617                 if retry==max_retries:
 618                     continue
 619                 self._format_exception(e)
 620             except IOError as e:  #can not open the file
 621                 raise vimconn.vimconnConnectionException(type(e).__name__ + ": " + str(e)+ " for " + image_dict['location'],
 622                                                          http_code=vimconn.HTTP_Bad_Request)
 623
 624     def delete_image(self, image_id):
 625         '''Deletes a tenant image from openstack VIM. Returns the old id
 626         '''
 627         try:
 628             self._reload_connection()
 629             self.nova.images.delete(image_id)
 630             return image_id
 631         except (nvExceptions.NotFound, ksExceptions.ClientException, nvExceptions.ClientException, gl1Exceptions.CommunicationError, ConnectionError) as e: #TODO remove
 632             self._format_exception(e)
 633
 634     def get_image_id_from_path(self, path):
 635         '''Get the image id from image path in the VIM database. Returns the image_id'''
 636         try:
 637             self._reload_connection()
 638             images = self.nova.images.list()
 639             for image in images:
 640                 if image.metadata.get("location")==path:
 641                     return image.id
 642             raise vimconn.vimconnNotFoundException("image with location '{}' not found".format( path))
 643         except (ksExceptions.ClientException, nvExceptions.ClientException, gl1Exceptions.CommunicationError, ConnectionError) as e:
 644             self._format_exception(e)
 645
 646     def get_image_list(self, filter_dict={}):
 647         '''Obtain tenant images from VIM
 648         Filter_dict can be:
 649             id: image id
 650             name: image name
 651             checksum: image checksum
 652         Returns the image list of dictionaries:
 653             [{<the fields at Filter_dict plus some VIM specific>}, ...]
 654             List can be empty
 655         '''
 656         self.logger.debug("Getting image list from VIM filter: '%s'", str(filter_dict))
 657         try:
 658             self._reload_connection()
 659             filter_dict_os=filter_dict.copy()
 660             #First we filter by the available filter fields: name, id. The others are removed.
 661             filter_dict_os.pop('checksum',None)
 662             image_list=self.nova.images.findall(**filter_dict_os)
 663             if len(image_list)==0:
 664                 return []
 665             #Then we filter by the rest of filter fields: checksum
 666             filtered_list = []
 667             for image in image_list:
 668                 image_class=self.glance.images.get(image.id)
 669                 if 'checksum' not in filter_dict or image_class['checksum']==filter_dict.get('checksum'):
 670                     filtered_list.append(image_class.copy())
 671             return filtered_list
 672         except (ksExceptions.ClientException, nvExceptions.ClientException, gl1Exceptions.CommunicationError, ConnectionError) as e:
 673             self._format_exception(e)
 674
 675     def new_vminstance(self,name,description,start,image_id,flavor_id,net_list,cloud_config=None,disk_list=None):
 676         '''Adds a VM instance to VIM
 677         Params:
 678             start: indicates if VM must start or boot in pause mode. Ignored
 679             image_id,flavor_id: iamge and flavor uuid
 680             net_list: list of interfaces, each one is a dictionary with:
 681                 name:
 682                 net_id: network uuid to connect
 683                 vpci: virtual vcpi to assign, ignored because openstack lack #TODO
 684                 model: interface model, ignored #TODO
 685                 mac_address: used for  SR-IOV ifaces #TODO for other types
 686                 use: 'data', 'bridge',  'mgmt'
 687                 type: 'virtual', 'PF', 'VF', 'VFnotShared'
 688                 vim_id: filled/added by this function
 689                 floating_ip: True/False (or it can be None)
 690                 #TODO ip, security groups
 691         Returns the instance identifier
 692         '''
 693         self.logger.debug("new_vminstance input: image='%s' flavor='%s' nics='%s'",image_id, flavor_id,str(net_list))
 694         try:
 695             metadata={}
 696             net_list_vim=[]
 697             external_network=[] #list of external networks to be connected to instance, later on used to create floating_ip
 698             self._reload_connection()
 699             metadata_vpci={} #For a specific neutron plugin
 700             for net in net_list:
 701                 if not net.get("net_id"): #skip non connected iface
 702                     continue
 703
 704                 port_dict={
 705                     "network_id": net["net_id"],
 706                     "name": net.get("name"),
 707                     "admin_state_up": True
 708                 }
 709                 if net["type"]=="virtual":
 710                     if "vpci" in net:
 711                         metadata_vpci[ net["net_id"] ] = [[ net["vpci"], "" ]]
 712                 elif net["type"]=="VF": # for VF
 713                     if "vpci" in net:
 714                         if "VF" not in metadata_vpci:
 715                             metadata_vpci["VF"]=[]
 716                         metadata_vpci["VF"].append([ net["vpci"], "" ])
 717                     port_dict["binding:vnic_type"]="direct"
 718                 else: #For PT
 719                     if "vpci" in net:
 720                         if "PF" not in metadata_vpci:
 721                             metadata_vpci["PF"]=[]
 722                         metadata_vpci["PF"].append([ net["vpci"], "" ])
 723                     port_dict["binding:vnic_type"]="direct-physical"
 724                 if not port_dict["name"]:
 725                     port_dict["name"]=name
 726                 if net.get("mac_address"):
 727                     port_dict["mac_address"]=net["mac_address"]
 728                 if net.get("port_security") == False:
 729                     port_dict["port_security_enabled"]=net["port_security"]
 730                 new_port = self.neutron.create_port({"port": port_dict })
 731                 net["mac_adress"] = new_port["port"]["mac_address"]
 732                 net["vim_id"] = new_port["port"]["id"]
 733                 net["ip"] = new_port["port"].get("fixed_ips", [{}])[0].get("ip_address")
 734                 net_list_vim.append({"port-id": new_port["port"]["id"]})
 735
 736                 if net.get('floating_ip', False):
 737                     net['exit_on_floating_ip_error'] = True
 738                     external_network.append(net)
 739                 elif net['use'] == 'mgmt' and self.config.get('use_floating_ip'):
 740                     net['exit_on_floating_ip_error'] = False
 741                     external_network.append(net)
 742
 743             if metadata_vpci:
 744                 metadata = {"pci_assignement": json.dumps(metadata_vpci)}
 745                 if len(metadata["pci_assignement"]) >255:
 746                     #limit the metadata size
 747                     #metadata["pci_assignement"] = metadata["pci_assignement"][0:255]
 748                     self.logger.warn("Metadata deleted since it exceeds the expected length (255) ")
 749                     metadata = {}
 750
 751             self.logger.debug("name '%s' image_id '%s'flavor_id '%s' net_list_vim '%s' description '%s' metadata %s",
 752                               name, image_id, flavor_id, str(net_list_vim), description, str(metadata))
 753
 754             security_groups   = self.config.get('security_groups')
 755             if type(security_groups) is str:
 756                 security_groups = ( security_groups, )
 757             #cloud config
 758             userdata=None
 759             config_drive = None
 760             if isinstance(cloud_config, dict):
 761                 if cloud_config.get("user-data"):
 762                     userdata=cloud_config["user-data"]
 763                 if cloud_config.get("boot-data-drive") != None:
 764                     config_drive = cloud_config["boot-data-drive"]
 765                 if cloud_config.get("config-files") or cloud_config.get("users") or cloud_config.get("key-pairs"):
 766                     if userdata:
 767                         raise vimconn.vimconnConflictException("Cloud-config cannot contain both 'userdata' and 'config-files'/'users'/'key-pairs'")
 768                     userdata_dict={}
 769                     #default user
 770                     if cloud_config.get("key-pairs"):
 771                         userdata_dict["ssh-authorized-keys"] = cloud_config["key-pairs"]
 772                         userdata_dict["users"] = [{"default": None, "ssh-authorized-keys": cloud_config["key-pairs"] }]
 773                     if cloud_config.get("users"):
 774                         if "users" not in userdata_dict:
 775                             userdata_dict["users"] = [ "default" ]
 776                         for user in cloud_config["users"]:
 777                             user_info = {
 778                                 "name" : user["name"],
 779                                 "sudo": "ALL = (ALL)NOPASSWD:ALL"
 780                             }
 781                             if "user-info" in user:
 782                                 user_info["gecos"] = user["user-info"]
 783                             if user.get("key-pairs"):
 784                                 user_info["ssh-authorized-keys"] = user["key-pairs"]
 785                             userdata_dict["users"].append(user_info)
 786
 787                     if cloud_config.get("config-files"):
 788                         userdata_dict["write_files"] = []
 789                         for file in cloud_config["config-files"]:
 790                             file_info = {
 791                                 "path" : file["dest"],
 792                                 "content": file["content"]
 793                             }
 794                             if file.get("encoding"):
 795                                 file_info["encoding"] = file["encoding"]
 796                             if file.get("permissions"):
 797                                 file_info["permissions"] = file["permissions"]
 798                             if file.get("owner"):
 799                                 file_info["owner"] = file["owner"]
 800                             userdata_dict["write_files"].append(file_info)
 801                     userdata = "#cloud-config\n"
 802                     userdata += yaml.safe_dump(userdata_dict, indent=4, default_flow_style=False)
 803                 self.logger.debug("userdata: %s", userdata)
 804             elif isinstance(cloud_config, str):
 805                 userdata = cloud_config
 806
 807             #Create additional volumes in case these are present in disk_list
 808             block_device_mapping = None
 809             base_disk_index = ord('b')
 810             if disk_list != None:
 811                 block_device_mapping = dict()
 812                 for disk in disk_list:
 813                     if 'image_id' in disk:
 814                         volume = self.cinder.volumes.create(size = disk['size'],name = name + '_vd' +
 815                                     chr(base_disk_index), imageRef = disk['image_id'])
 816                     else:
 817                         volume = self.cinder.volumes.create(size=disk['size'], name=name + '_vd' +
 818                                     chr(base_disk_index))
 819                     block_device_mapping['_vd' +  chr(base_disk_index)] = volume.id
 820                     base_disk_index += 1
 821
 822                 #wait until volumes are with status available
 823                 keep_waiting = True
 824                 elapsed_time = 0
 825                 while keep_waiting and elapsed_time < volume_timeout:
 826                     keep_waiting = False
 827                     for volume_id in block_device_mapping.itervalues():
 828                         if self.cinder.volumes.get(volume_id).status != 'available':
 829                             keep_waiting = True
 830                     if keep_waiting:
 831                         time.sleep(1)
 832                         elapsed_time += 1
 833
 834                 #if we exceeded the timeout rollback
 835                 if elapsed_time >= volume_timeout:
 836                     #delete the volumes we just created
 837                     for volume_id in block_device_mapping.itervalues():
 838                         self.cinder.volumes.delete(volume_id)
 839
 840                     #delete ports we just created
 841                     for net_item  in net_list_vim:
 842                         if 'port-id' in net_item:
 843                             self.neutron.delete_port(net_item['port-id'])
 844
 845                     raise vimconn.vimconnException('Timeout creating volumes for instance ' + name,
 846                                                    http_code=vimconn.HTTP_Request_Timeout)
 847
 848             server = self.nova.servers.create(name, image_id, flavor_id, nics=net_list_vim, meta=metadata,
 849                                               security_groups=security_groups,
 850                                               availability_zone=self.config.get('availability_zone'),
 851                                               key_name=self.config.get('keypair'),
 852                                               userdata=userdata,
 853                                               config_drive = config_drive,
 854                                               block_device_mapping = block_device_mapping
 855                                               )  # , description=description)
 856             #print "DONE :-)", server
 857             pool_id = None
 858             floating_ips = self.neutron.list_floatingips().get("floatingips", ())
 859             for floating_network in external_network:
 860                 try:
 861                     # wait until vm is active
 862                     elapsed_time = 0
 863                     while elapsed_time < server_timeout:
 864                         status = self.nova.servers.get(server.id).status
 865                         if status == 'ACTIVE':
 866                             break
 867                         time.sleep(1)
 868                         elapsed_time += 1
 869
 870                     #if we exceeded the timeout rollback
 871                     if elapsed_time >= server_timeout:
 872                         raise vimconn.vimconnException('Timeout creating instance ' + name,
 873                                                        http_code=vimconn.HTTP_Request_Timeout)
 874
 875                     assigned = False
 876                     while(assigned == False):
 877                         if floating_ips:
 878                             ip = floating_ips.pop(0)
 879                             if not ip.get("port_id", False) and ip.get('tenant_id') == server.tenant_id:
 880                                 free_floating_ip = ip.get("floating_ip_address")
 881                                 try:
 882                                     fix_ip = floating_network.get('ip')
 883                                     server.add_floating_ip(free_floating_ip, fix_ip)
 884                                     assigned = True
 885                                 except Exception as e:
 886                                     raise vimconn.vimconnException(type(e).__name__ + ": Cannot create floating_ip "+  str(e), http_code=vimconn.HTTP_Conflict)
 887                         else:
 888                             #Find the external network
 889                             external_nets = list()
 890                             for net in self.neutron.list_networks()['networks']:
 891                                 if net['router:external']:
 892                                         external_nets.append(net)
 893
 894                             if len(external_nets) == 0:
 895                                 raise vimconn.vimconnException("Cannot create floating_ip automatically since no external "
 896                                                                "network is present",
 897                                                                 http_code=vimconn.HTTP_Conflict)
 898                             if len(external_nets) > 1:
 899                                 raise vimconn.vimconnException("Cannot create floating_ip automatically since multiple "
 900                                                                "external networks are present",
 901                                                                http_code=vimconn.HTTP_Conflict)
 902
 903                             pool_id = external_nets[0].get('id')
 904                             param = {'floatingip': {'floating_network_id': pool_id, 'tenant_id': server.tenant_id}}
 905                             try:
 906                                 #self.logger.debug("Creating floating IP")
 907                                 new_floating_ip = self.neutron.create_floatingip(param)
 908                                 free_floating_ip = new_floating_ip['floatingip']['floating_ip_address']
 909                                 fix_ip = floating_network.get('ip')
 910                                 server.add_floating_ip(free_floating_ip, fix_ip)
 911                                 assigned=True
 912                             except Exception as e:
 913                                 raise vimconn.vimconnException(type(e).__name__ + ": Cannot assign floating_ip "+  str(e), http_code=vimconn.HTTP_Conflict)
 914                 except Exception as e:
 915                     if not floating_network['exit_on_floating_ip_error']:
 916                         self.logger.warn("Cannot create floating_ip. %s", str(e))
 917                         continue
 918                     self.delete_vminstance(server.id)
 919                     raise
 920
 921             return server.id
 922 #        except nvExceptions.NotFound as e:
 923 #            error_value=-vimconn.HTTP_Not_Found
 924 #            error_text= "vm instance %s not found" % vm_id
 925         except (ksExceptions.ClientException, nvExceptions.ClientException, ConnectionError) as e:
 926             # delete the volumes we just created
 927             if block_device_mapping != None:
 928                 for volume_id in block_device_mapping.itervalues():
 929                     self.cinder.volumes.delete(volume_id)
 930
 931             # delete ports we just created
 932             for net_item in net_list_vim:
 933                 if 'port-id' in net_item:
 934                     self.neutron.delete_port(net_item['port-id'])
 935             self._format_exception(e)
 936         except TypeError as e:
 937             raise vimconn.vimconnException(type(e).__name__ + ": "+  str(e), http_code=vimconn.HTTP_Bad_Request)
 938
 939     def get_vminstance(self,vm_id):
 940         '''Returns the VM instance information from VIM'''
 941         #self.logger.debug("Getting VM from VIM")
 942         try:
 943             self._reload_connection()
 944             server = self.nova.servers.find(id=vm_id)
 945             #TODO parse input and translate to VIM format (openmano_schemas.new_vminstance_response_schema)
 946             return server.to_dict()
 947         except (ksExceptions.ClientException, nvExceptions.ClientException, nvExceptions.NotFound, ConnectionError) as e:
 948             self._format_exception(e)
 949
 950     def get_vminstance_console(self,vm_id, console_type="vnc"):
 951         '''
 952         Get a console for the virtual machine
 953         Params:
 954             vm_id: uuid of the VM
 955             console_type, can be:
 956                 "novnc" (by default), "xvpvnc" for VNC types,
 957                 "rdp-html5" for RDP types, "spice-html5" for SPICE types
 958         Returns dict with the console parameters:
 959                 protocol: ssh, ftp, http, https, ...
 960                 server:   usually ip address
 961                 port:     the http, ssh, ... port
 962                 suffix:   extra text, e.g. the http path and query string
 963         '''
 964         self.logger.debug("Getting VM CONSOLE from VIM")
 965         try:
 966             self._reload_connection()
 967             server = self.nova.servers.find(id=vm_id)
 968             if console_type == None or console_type == "novnc":
 969                 console_dict = server.get_vnc_console("novnc")
 970             elif console_type == "xvpvnc":
 971                 console_dict = server.get_vnc_console(console_type)
 972             elif console_type == "rdp-html5":
 973                 console_dict = server.get_rdp_console(console_type)
 974             elif console_type == "spice-html5":
 975                 console_dict = server.get_spice_console(console_type)
 976             else:
 977                 raise vimconn.vimconnException("console type '{}' not allowed".format(console_type), http_code=vimconn.HTTP_Bad_Request)
 978
 979             console_dict1 = console_dict.get("console")
 980             if console_dict1:
 981                 console_url = console_dict1.get("url")
 982                 if console_url:
 983                     #parse console_url
 984                     protocol_index = console_url.find("//")
 985                     suffix_index = console_url[protocol_index+2:].find("/") + protocol_index+2
 986                     port_index = console_url[protocol_index+2:suffix_index].find(":") + protocol_index+2
 987                     if protocol_index < 0 or port_index<0 or suffix_index<0:
 988                         return -vimconn.HTTP_Internal_Server_Error, "Unexpected response from VIM"
 989                     console_dict={"protocol": console_url[0:protocol_index],
 990                                   "server":   console_url[protocol_index+2:port_index],
 991                                   "port":     console_url[port_index:suffix_index],
 992                                   "suffix":   console_url[suffix_index+1:]
 993                                   }
 994                     protocol_index += 2
 995                     return console_dict
 996             raise vimconn.vimconnUnexpectedResponse("Unexpected response from VIM")
 997
 998         except (nvExceptions.NotFound, ksExceptions.ClientException, nvExceptions.ClientException, nvExceptions.BadRequest, ConnectionError) as e:
 999             self._format_exception(e)
1000
1001     def delete_vminstance(self, vm_id):
1002         '''Removes a VM instance from VIM. Returns the old identifier
1003         '''
1004         #print "osconnector: Getting VM from VIM"
1005         try:
1006             self._reload_connection()
1007             #delete VM ports attached to this networks before the virtual machine
1008             ports = self.neutron.list_ports(device_id=vm_id)
1009             for p in ports['ports']:
1010                 try:
1011                     self.neutron.delete_port(p["id"])
1012                 except Exception as e:
1013                     self.logger.error("Error deleting port: " + type(e).__name__ + ": "+  str(e))
1014
1015             #commented because detaching the volumes makes the servers.delete not work properly ?!?
1016             #dettach volumes attached
1017             server = self.nova.servers.get(vm_id)
1018             volumes_attached_dict = server._info['os-extended-volumes:volumes_attached']
1019             #for volume in volumes_attached_dict:
1020             #    self.cinder.volumes.detach(volume['id'])
1021
1022             self.nova.servers.delete(vm_id)
1023
1024             #delete volumes.
1025             #Although having detached them should have them  in active status
1026             #we ensure in this loop
1027             keep_waiting = True
1028             elapsed_time = 0
1029             while keep_waiting and elapsed_time < volume_timeout:
1030                 keep_waiting = False
1031                 for volume in volumes_attached_dict:
1032                     if self.cinder.volumes.get(volume['id']).status != 'available':
1033                         keep_waiting = True
1034                     else:
1035                         self.cinder.volumes.delete(volume['id'])
1036                 if keep_waiting:
1037                     time.sleep(1)
1038                     elapsed_time += 1
1039
1040             return vm_id
1041         except (nvExceptions.NotFound, ksExceptions.ClientException, nvExceptions.ClientException, ConnectionError) as e:
1042             self._format_exception(e)
1043         #TODO insert exception vimconn.HTTP_Unauthorized
1044         #if reaching here is because an exception
1045
1046     def refresh_vms_status(self, vm_list):
1047         '''Get the status of the virtual machines and their interfaces/ports
1048            Params: the list of VM identifiers
1049            Returns a dictionary with:
1050                 vm_id:          #VIM id of this Virtual Machine
1051                     status:     #Mandatory. Text with one of:
1052                                 #  DELETED (not found at vim)
1053                                 #  VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
1054                                 #  OTHER (Vim reported other status not understood)
1055                                 #  ERROR (VIM indicates an ERROR status)
1056                                 #  ACTIVE, PAUSED, SUSPENDED, INACTIVE (not running),
1057                                 #  CREATING (on building process), ERROR
1058                                 #  ACTIVE:NoMgmtIP (Active but any of its interface has an IP address
1059                                 #
1060                     error_msg:  #Text with VIM error message, if any. Or the VIM connection ERROR
1061                     vim_info:   #Text with plain information obtained from vim (yaml.safe_dump)
1062                     interfaces:
1063                      -  vim_info:         #Text with plain information obtained from vim (yaml.safe_dump)
1064                         mac_address:      #Text format XX:XX:XX:XX:XX:XX
1065                         vim_net_id:       #network id where this interface is connected
1066                         vim_interface_id: #interface/port VIM id
1067                         ip_address:       #null, or text with IPv4, IPv6 address
1068                         compute_node:     #identification of compute node where PF,VF interface is allocated
1069                         pci:              #PCI address of the NIC that hosts the PF,VF
1070                         vlan:             #physical VLAN used for VF
1071         '''
1072         vm_dict={}
1073         self.logger.debug("refresh_vms status: Getting tenant VM instance information from VIM")
1074         for vm_id in vm_list:
1075             vm={}
1076             try:
1077                 vm_vim = self.get_vminstance(vm_id)
1078                 if vm_vim['status'] in vmStatus2manoFormat:
1079                     vm['status']    =  vmStatus2manoFormat[ vm_vim['status'] ]
1080                 else:
1081                     vm['status']    = "OTHER"
1082                     vm['error_msg'] = "VIM status reported " + vm_vim['status']
1083                 try:
1084                     vm['vim_info']  = yaml.safe_dump(vm_vim, default_flow_style=True, width=256)
1085                 except yaml.representer.RepresenterError:
1086                     vm['vim_info'] = str(vm_vim)
1087                 vm["interfaces"] = []
1088                 if vm_vim.get('fault'):
1089                     vm['error_msg'] = str(vm_vim['fault'])
1090                 #get interfaces
1091                 try:
1092                     self._reload_connection()
1093                     port_dict=self.neutron.list_ports(device_id=vm_id)
1094                     for port in port_dict["ports"]:
1095                         interface={}
1096                         try:
1097                             interface['vim_info'] = yaml.safe_dump(port, default_flow_style=True, width=256)
1098                         except yaml.representer.RepresenterError:
1099                             interface['vim_info'] = str(port)
1100                         interface["mac_address"] = port.get("mac_address")
1101                         interface["vim_net_id"] = port["network_id"]
1102                         interface["vim_interface_id"] = port["id"]
1103                         # check if OS-EXT-SRV-ATTR:host is there,
1104                         # in case of non-admin credentials, it will be missing
1105                         if vm_vim.get('OS-EXT-SRV-ATTR:host'):
1106                             interface["compute_node"] = vm_vim['OS-EXT-SRV-ATTR:host']
1107                         interface["pci"] = None
1108
1109                         # check if binding:profile is there,
1110                         # in case of non-admin credentials, it will be missing
1111                         if port.get('binding:profile'):
1112                             if port['binding:profile'].get('pci_slot'):
1113                                 # TODO: At the moment sr-iov pci addresses are converted to PF pci addresses by setting the slot to 0x00
1114                                 # TODO: This is just a workaround valid for niantinc. Find a better way to do so
1115                                 #   CHANGE DDDD:BB:SS.F to DDDD:BB:00.(F%2)   assuming there are 2 ports per nic
1116                                 pci = port['binding:profile']['pci_slot']
1117                                 # interface["pci"] = pci[:-4] + "00." + str(int(pci[-1]) % 2)
1118                                 interface["pci"] = pci
1119                         interface["vlan"] = None
1120                         #if network is of type vlan and port is of type direct (sr-iov) then set vlan id
1121                         network = self.neutron.show_network(port["network_id"])
1122                         if network['network'].get('provider:network_type') == 'vlan' and \
1123                             port.get("binding:vnic_type") == "direct":
1124                             interface["vlan"] = network['network'].get('provider:segmentation_id')
1125                         ips=[]
1126                         #look for floating ip address
1127                         floating_ip_dict = self.neutron.list_floatingips(port_id=port["id"])
1128                         if floating_ip_dict.get("floatingips"):
1129                             ips.append(floating_ip_dict["floatingips"][0].get("floating_ip_address") )
1130
1131                         for subnet in port["fixed_ips"]:
1132                             ips.append(subnet["ip_address"])
1133                         interface["ip_address"] = ";".join(ips)
1134                         vm["interfaces"].append(interface)
1135                 except Exception as e:
1136                     self.logger.error("Error getting vm interface information " + type(e).__name__ + ": "+  str(e))
1137             except vimconn.vimconnNotFoundException as e:
1138                 self.logger.error("Exception getting vm status: %s", str(e))
1139                 vm['status'] = "DELETED"
1140                 vm['error_msg'] = str(e)
1141             except vimconn.vimconnException as e:
1142                 self.logger.error("Exception getting vm status: %s", str(e))
1143                 vm['status'] = "VIM_ERROR"
1144                 vm['error_msg'] = str(e)
1145             vm_dict[vm_id] = vm
1146         return vm_dict
1147
1148     def action_vminstance(self, vm_id, action_dict):
1149         '''Send and action over a VM instance from VIM
1150         Returns the vm_id if the action was successfully sent to the VIM'''
1151         self.logger.debug("Action over VM '%s': %s", vm_id, str(action_dict))
1152         try:
1153             self._reload_connection()
1154             server = self.nova.servers.find(id=vm_id)
1155             if "start" in action_dict:
1156                 if action_dict["start"]=="rebuild":
1157                     server.rebuild()
1158                 else:
1159                     if server.status=="PAUSED":
1160                         server.unpause()
1161                     elif server.status=="SUSPENDED":
1162                         server.resume()
1163                     elif server.status=="SHUTOFF":
1164                         server.start()
1165             elif "pause" in action_dict:
1166                 server.pause()
1167             elif "resume" in action_dict:
1168                 server.resume()
1169             elif "shutoff" in action_dict or "shutdown" in action_dict:
1170                 server.stop()
1171             elif "forceOff" in action_dict:
1172                 server.stop() #TODO
1173             elif "terminate" in action_dict:
1174                 server.delete()
1175             elif "createImage" in action_dict:
1176                 server.create_image()
1177                 #"path":path_schema,
1178                 #"description":description_schema,
1179                 #"name":name_schema,
1180                 #"metadata":metadata_schema,
1181                 #"imageRef": id_schema,
1182                 #"disk": {"oneOf":[{"type": "null"}, {"type":"string"}] },
1183             elif "rebuild" in action_dict:
1184                 server.rebuild(server.image['id'])
1185             elif "reboot" in action_dict:
1186                 server.reboot() #reboot_type='SOFT'
1187             elif "console" in action_dict:
1188                 console_type = action_dict["console"]
1189                 if console_type == None or console_type == "novnc":
1190                     console_dict = server.get_vnc_console("novnc")
1191                 elif console_type == "xvpvnc":
1192                     console_dict = server.get_vnc_console(console_type)
1193                 elif console_type == "rdp-html5":
1194                     console_dict = server.get_rdp_console(console_type)
1195                 elif console_type == "spice-html5":
1196                     console_dict = server.get_spice_console(console_type)
1197                 else:
1198                     raise vimconn.vimconnException("console type '{}' not allowed".format(console_type),
1199                                                    http_code=vimconn.HTTP_Bad_Request)
1200                 try:
1201                     console_url = console_dict["console"]["url"]
1202                     #parse console_url
1203                     protocol_index = console_url.find("//")
1204                     suffix_index = console_url[protocol_index+2:].find("/") + protocol_index+2
1205                     port_index = console_url[protocol_index+2:suffix_index].find(":") + protocol_index+2
1206                     if protocol_index < 0 or port_index<0 or suffix_index<0:
1207                         raise vimconn.vimconnException("Unexpected response from VIM " + str(console_dict))
1208                     console_dict2={"protocol": console_url[0:protocol_index],
1209                                   "server":   console_url[protocol_index+2 : port_index],
1210                                   "port":     int(console_url[port_index+1 : suffix_index]),
1211                                   "suffix":   console_url[suffix_index+1:]
1212                                   }
1213                     return console_dict2
1214                 except Exception as e:
1215                     raise vimconn.vimconnException("Unexpected response from VIM " + str(console_dict))
1216
1217             return vm_id
1218         except (ksExceptions.ClientException, nvExceptions.ClientException, nvExceptions.NotFound, ConnectionError) as e:
1219             self._format_exception(e)
1220         #TODO insert exception vimconn.HTTP_Unauthorized
1221
1222 #NOT USED FUNCTIONS
1223
1224     def new_external_port(self, port_data):
1225         #TODO openstack if needed
1226         '''Adds a external port to VIM'''
1227         '''Returns the port identifier'''
1228         return -vimconn.HTTP_Internal_Server_Error, "osconnector.new_external_port() not implemented"
1229
1230     def connect_port_network(self, port_id, network_id, admin=False):
1231         #TODO openstack if needed
1232         '''Connects a external port to a network'''
1233         '''Returns status code of the VIM response'''
1234         return -vimconn.HTTP_Internal_Server_Error, "osconnector.connect_port_network() not implemented"
1235
1236     def new_user(self, user_name, user_passwd, tenant_id=None):
1237         '''Adds a new user to openstack VIM'''
1238         '''Returns the user identifier'''
1239         self.logger.debug("osconnector: Adding a new user to VIM")
1240         try:
1241             self._reload_connection()
1242             user=self.keystone.users.create(user_name, user_passwd, tenant_id=tenant_id)
1243             #self.keystone.tenants.add_user(self.k_creds["username"], #role)
1244             return user.id
1245         except ksExceptions.ConnectionError as e:
1246             error_value=-vimconn.HTTP_Bad_Request
1247             error_text= type(e).__name__ + ": "+  (str(e) if len(e.args)==0 else str(e.args[0]))
1248         except ksExceptions.ClientException as e: #TODO remove
1249             error_value=-vimconn.HTTP_Bad_Request
1250             error_text= type(e).__name__ + ": "+  (str(e) if len(e.args)==0 else str(e.args[0]))
1251         #TODO insert exception vimconn.HTTP_Unauthorized
1252         #if reaching here is because an exception
1253         if self.debug:
1254             self.logger.debug("new_user " + error_text)
1255         return error_value, error_text
1256
1257     def delete_user(self, user_id):
1258         '''Delete a user from openstack VIM'''
1259         '''Returns the user identifier'''
1260         if self.debug:
1261             print "osconnector: Deleting  a  user from VIM"
1262         try:
1263             self._reload_connection()
1264             self.keystone.users.delete(user_id)
1265             return 1, user_id
1266         except ksExceptions.ConnectionError as e:
1267             error_value=-vimconn.HTTP_Bad_Request
1268             error_text= type(e).__name__ + ": "+  (str(e) if len(e.args)==0 else str(e.args[0]))
1269         except ksExceptions.NotFound as e:
1270             error_value=-vimconn.HTTP_Not_Found
1271             error_text= type(e).__name__ + ": "+  (str(e) if len(e.args)==0 else str(e.args[0]))
1272         except ksExceptions.ClientException as e: #TODO remove
1273             error_value=-vimconn.HTTP_Bad_Request
1274             error_text= type(e).__name__ + ": "+  (str(e) if len(e.args)==0 else str(e.args[0]))
1275         #TODO insert exception vimconn.HTTP_Unauthorized
1276         #if reaching here is because an exception
1277         if self.debug:
1278             print "delete_tenant " + error_text
1279         return error_value, error_text
1280
1281     def get_hosts_info(self):
1282         '''Get the information of deployed hosts
1283         Returns the hosts content'''
1284         if self.debug:
1285             print "osconnector: Getting Host info from VIM"
1286         try:
1287             h_list=[]
1288             self._reload_connection()
1289             hypervisors = self.nova.hypervisors.list()
1290             for hype in hypervisors:
1291                 h_list.append( hype.to_dict() )
1292             return 1, {"hosts":h_list}
1293         except nvExceptions.NotFound as e:
1294             error_value=-vimconn.HTTP_Not_Found
1295             error_text= (str(e) if len(e.args)==0 else str(e.args[0]))
1296         except (ksExceptions.ClientException, nvExceptions.ClientException) as e:
1297             error_value=-vimconn.HTTP_Bad_Request
1298             error_text= type(e).__name__ + ": "+  (str(e) if len(e.args)==0 else str(e.args[0]))
1299         #TODO insert exception vimconn.HTTP_Unauthorized
1300         #if reaching here is because an exception
1301         if self.debug:
1302             print "get_hosts_info " + error_text
1303         return error_value, error_text
1304
1305     def get_hosts(self, vim_tenant):
1306         '''Get the hosts and deployed instances
1307         Returns the hosts content'''
1308         r, hype_dict = self.get_hosts_info()
1309         if r<0:
1310             return r, hype_dict
1311         hypervisors = hype_dict["hosts"]
1312         try:
1313             servers = self.nova.servers.list()
1314             for hype in hypervisors:
1315                 for server in servers:
1316                     if server.to_dict()['OS-EXT-SRV-ATTR:hypervisor_hostname']==hype['hypervisor_hostname']:
1317                         if 'vm' in hype:
1318                             hype['vm'].append(server.id)
1319                         else:
1320                             hype['vm'] = [server.id]
1321             return 1, hype_dict
1322         except nvExceptions.NotFound as e:
1323             error_value=-vimconn.HTTP_Not_Found
1324             error_text= (str(e) if len(e.args)==0 else str(e.args[0]))
1325         except (ksExceptions.ClientException, nvExceptions.ClientException) as e:
1326             error_value=-vimconn.HTTP_Bad_Request
1327             error_text= type(e).__name__ + ": "+  (str(e) if len(e.args)==0 else str(e.args[0]))
1328         #TODO insert exception vimconn.HTTP_Unauthorized
1329         #if reaching here is because an exception
1330         if self.debug:
1331             print "get_hosts " + error_text
1332         return error_value, error_text
1333
1334