blob: 733cf6540f744dacd7be085012c785fbd119af66 [file] [log] [blame]
bayramov325fa1c2016-09-08 01:42:46 -07001# -*- coding: utf-8 -*-
2
3##
bhangare1a0b97c2017-06-21 02:20:15 -07004# Copyright 2016-2017 VMware Inc.
5# This file is part of ETSI OSM
bayramov325fa1c2016-09-08 01:42:46 -07006# 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
bhangare1a0b97c2017-06-21 02:20:15 -070021# contact: osslegalrouting@vmware.com
bayramov325fa1c2016-09-08 01:42:46 -070022##
23
bayramov5761ad12016-10-04 09:00:30 +040024"""
bayramov325fa1c2016-09-08 01:42:46 -070025vimconn_vmware implementation an Abstract class in order to interact with VMware vCloud Director.
26mbayramov@vmware.com
bayramov5761ad12016-10-04 09:00:30 +040027"""
bayramovfe3f3c92016-10-04 07:53:41 +040028from progressbar import Percentage, Bar, ETA, FileTransferSpeed, ProgressBar
bayramovbd6160f2016-09-28 04:12:05 +040029
30import vimconn
bayramov325fa1c2016-09-08 01:42:46 -070031import os
bayramovef390722016-09-27 03:34:46 -070032import traceback
bayramovef390722016-09-27 03:34:46 -070033import itertools
bayramov325fa1c2016-09-08 01:42:46 -070034import requests
bhangarefda5f7c2017-01-12 23:50:34 -080035import ssl
36import atexit
37
38from pyVmomi import vim, vmodl
39from pyVim.connect import SmartConnect, Disconnect
bayramov325fa1c2016-09-08 01:42:46 -070040
bayramovef390722016-09-27 03:34:46 -070041from xml.etree import ElementTree as XmlElementTree
bhangarea92ae392017-01-12 22:30:29 -080042from lxml import etree as lxmlElementTree
bayramov325fa1c2016-09-08 01:42:46 -070043
bayramovef390722016-09-27 03:34:46 -070044import yaml
kasarc5bf2932018-03-09 04:15:22 -080045from pyvcloud.vcd.client import BasicLoginCredentials,Client,VcdTaskException
46from pyvcloud.vcd.vdc import VDC
47from pyvcloud.vcd.org import Org
48import re
49from pyvcloud.vcd.vapp import VApp
bayramov325fa1c2016-09-08 01:42:46 -070050from xml.sax.saxutils import escape
bayramov325fa1c2016-09-08 01:42:46 -070051import logging
52import json
bayramov325fa1c2016-09-08 01:42:46 -070053import time
54import uuid
55import httplib
kasarc5bf2932018-03-09 04:15:22 -080056#For python3
57#import http.client
kate15f1c382016-12-15 01:12:40 -080058import hashlib
bhangare0e571a92017-01-12 04:02:23 -080059import socket
60import struct
61import netaddr
kasarde691232017-03-25 03:37:31 -070062import random
bayramov325fa1c2016-09-08 01:42:46 -070063
bayramovbd6160f2016-09-28 04:12:05 +040064# global variable for vcd connector type
65STANDALONE = 'standalone'
66
kate15f1c382016-12-15 01:12:40 -080067# key for flavor dicts
68FLAVOR_RAM_KEY = 'ram'
69FLAVOR_VCPUS_KEY = 'vcpus'
bhangarea92ae392017-01-12 22:30:29 -080070FLAVOR_DISK_KEY = 'disk'
kasarde691232017-03-25 03:37:31 -070071DEFAULT_IP_PROFILE = {'dhcp_count':50,
bhangare0e571a92017-01-12 04:02:23 -080072 'dhcp_enabled':True,
kasarde691232017-03-25 03:37:31 -070073 'ip_version':"IPv4"
bhangare0e571a92017-01-12 04:02:23 -080074 }
75# global variable for wait time
kate13ab2c42016-12-23 01:34:24 -080076INTERVAL_TIME = 5
77MAX_WAIT_TIME = 1800
bayramov325fa1c2016-09-08 01:42:46 -070078
kasarc5bf2932018-03-09 04:15:22 -080079API_VERSION = '5.9'
bayramovbd6160f2016-09-28 04:12:05 +040080
kasarc5bf2932018-03-09 04:15:22 -080081__author__ = "Mustafa Bayramov, Arpita Kate, Sachin Bhangare, Prakash Kasar"
82__date__ = "$09-Mar-2018 11:09:29$"
83__version__ = '0.2'
bayramov325fa1c2016-09-08 01:42:46 -070084
bayramovef390722016-09-27 03:34:46 -070085# -1: "Could not be created",
86# 0: "Unresolved",
87# 1: "Resolved",
88# 2: "Deployed",
89# 3: "Suspended",
90# 4: "Powered on",
91# 5: "Waiting for user input",
92# 6: "Unknown state",
93# 7: "Unrecognized state",
94# 8: "Powered off",
95# 9: "Inconsistent state",
96# 10: "Children do not all have the same status",
97# 11: "Upload initiated, OVF descriptor pending",
98# 12: "Upload initiated, copying contents",
99# 13: "Upload initiated , disk contents pending",
100# 14: "Upload has been quarantined",
101# 15: "Upload quarantine period has expired"
102
103# mapping vCD status to MANO
104vcdStatusCode2manoFormat = {4: 'ACTIVE',
105 7: 'PAUSED',
106 3: 'SUSPENDED',
107 8: 'INACTIVE',
108 12: 'BUILD',
109 -1: 'ERROR',
110 14: 'DELETED'}
111
112#
113netStatus2manoFormat = {'ACTIVE': 'ACTIVE', 'PAUSED': 'PAUSED', 'INACTIVE': 'INACTIVE', 'BUILD': 'BUILD',
114 'ERROR': 'ERROR', 'DELETED': 'DELETED'
115 }
116
bayramovbd6160f2016-09-28 04:12:05 +0400117class vimconnector(vimconn.vimconnector):
kateeb044522017-03-06 23:54:39 -0800118 # dict used to store flavor in memory
119 flavorlist = {}
120
bayramovbd6160f2016-09-28 04:12:05 +0400121 def __init__(self, uuid=None, name=None, tenant_id=None, tenant_name=None,
tiernob3d36742017-03-03 23:51:05 +0100122 url=None, url_admin=None, user=None, passwd=None, log_level=None, config={}, persistent_info={}):
bayramovb6ffe792016-09-28 11:50:56 +0400123 """
124 Constructor create vmware connector to vCloud director.
125
126 By default construct doesn't validate connection state. So client can create object with None arguments.
127 If client specified username , password and host and VDC name. Connector initialize other missing attributes.
128
129 a) It initialize organization UUID
130 b) Initialize tenant_id/vdc ID. (This information derived from tenant name)
131
132 Args:
133 uuid - is organization uuid.
134 name - is organization name that must be presented in vCloud director.
135 tenant_id - is VDC uuid it must be presented in vCloud director
136 tenant_name - is VDC name.
137 url - is hostname or ip address of vCloud director
138 url_admin - same as above.
139 user - is user that administrator for organization. Caller must make sure that
140 username has right privileges.
141
142 password - is password for a user.
143
144 VMware connector also requires PVDC administrative privileges and separate account.
145 This variables must be passed via config argument dict contains keys
146
147 dict['admin_username']
148 dict['admin_password']
kateeb044522017-03-06 23:54:39 -0800149 config - Provide NSX and vCenter information
bayramovb6ffe792016-09-28 11:50:56 +0400150
151 Returns:
152 Nothing.
153 """
154
bayramovbd6160f2016-09-28 04:12:05 +0400155 vimconn.vimconnector.__init__(self, uuid, name, tenant_id, tenant_name, url,
156 url_admin, user, passwd, log_level, config)
kate15f1c382016-12-15 01:12:40 -0800157
158 self.logger = logging.getLogger('openmano.vim.vmware')
159 self.logger.setLevel(10)
tiernob3d36742017-03-03 23:51:05 +0100160 self.persistent_info = persistent_info
kate15f1c382016-12-15 01:12:40 -0800161
bayramovef390722016-09-27 03:34:46 -0700162 self.name = name
kate15f1c382016-12-15 01:12:40 -0800163 self.id = uuid
bayramovef390722016-09-27 03:34:46 -0700164 self.url = url
bayramov325fa1c2016-09-08 01:42:46 -0700165 self.url_admin = url_admin
166 self.tenant_id = tenant_id
167 self.tenant_name = tenant_name
bayramovef390722016-09-27 03:34:46 -0700168 self.user = user
169 self.passwd = passwd
170 self.config = config
171 self.admin_password = None
172 self.admin_user = None
kate15f1c382016-12-15 01:12:40 -0800173 self.org_name = ""
bhangare985a1fd2017-01-31 01:53:21 -0800174 self.nsx_manager = None
175 self.nsx_user = None
176 self.nsx_password = None
bayramovef390722016-09-27 03:34:46 -0700177
kasarc5bf2932018-03-09 04:15:22 -0800178 # Disable warnings from self-signed certificates.
179 requests.packages.urllib3.disable_warnings()
180
kate15f1c382016-12-15 01:12:40 -0800181 if tenant_name is not None:
182 orgnameandtenant = tenant_name.split(":")
183 if len(orgnameandtenant) == 2:
katec324e002016-12-23 00:54:47 -0800184 self.tenant_name = orgnameandtenant[1]
185 self.org_name = orgnameandtenant[0]
kate15f1c382016-12-15 01:12:40 -0800186 else:
187 self.tenant_name = tenant_name
bhangarea92ae392017-01-12 22:30:29 -0800188 if "orgname" in config:
kate15f1c382016-12-15 01:12:40 -0800189 self.org_name = config['orgname']
katec324e002016-12-23 00:54:47 -0800190
tiernofe789902016-09-29 14:20:44 +0000191 if log_level:
bayramov5761ad12016-10-04 09:00:30 +0400192 self.logger.setLevel(getattr(logging, log_level))
bayramov325fa1c2016-09-08 01:42:46 -0700193
bayramovef390722016-09-27 03:34:46 -0700194 try:
195 self.admin_user = config['admin_username']
196 self.admin_password = config['admin_password']
197 except KeyError:
bayramovbd6160f2016-09-28 04:12:05 +0400198 raise vimconn.vimconnException(message="Error admin username or admin password is empty.")
bayramov325fa1c2016-09-08 01:42:46 -0700199
bhangare985a1fd2017-01-31 01:53:21 -0800200 try:
201 self.nsx_manager = config['nsx_manager']
202 self.nsx_user = config['nsx_user']
203 self.nsx_password = config['nsx_password']
204 except KeyError:
205 raise vimconn.vimconnException(message="Error: nsx manager or nsx user or nsx password is empty in Config")
206
kateeb044522017-03-06 23:54:39 -0800207 self.vcenter_ip = config.get("vcenter_ip", None)
208 self.vcenter_port = config.get("vcenter_port", None)
209 self.vcenter_user = config.get("vcenter_user", None)
210 self.vcenter_password = config.get("vcenter_password", None)
211
kateac1e3792017-04-01 02:16:39 -0700212# ############# Stub code for SRIOV #################
213# try:
214# self.dvs_name = config['dv_switch_name']
215# except KeyError:
216# raise vimconn.vimconnException(message="Error: distributed virtaul switch name is empty in Config")
217#
218# self.vlanID_range = config.get("vlanID_range", None)
219
bayramovef390722016-09-27 03:34:46 -0700220 self.org_uuid = None
kasarc5bf2932018-03-09 04:15:22 -0800221 self.client = None
bayramov325fa1c2016-09-08 01:42:46 -0700222
223 if not url:
bayramov5761ad12016-10-04 09:00:30 +0400224 raise vimconn.vimconnException('url param can not be NoneType')
bayramov325fa1c2016-09-08 01:42:46 -0700225
bayramovef390722016-09-27 03:34:46 -0700226 if not self.url_admin: # try to use normal url
bayramov325fa1c2016-09-08 01:42:46 -0700227 self.url_admin = self.url
228
kate15f1c382016-12-15 01:12:40 -0800229 logging.debug("UUID: {} name: {} tenant_id: {} tenant name {}".format(self.id, self.org_name,
bayramovef390722016-09-27 03:34:46 -0700230 self.tenant_id, self.tenant_name))
231 logging.debug("vcd url {} vcd username: {} vcd password: {}".format(self.url, self.user, self.passwd))
232 logging.debug("vcd admin username {} vcd admin passowrd {}".format(self.admin_user, self.admin_password))
bayramov325fa1c2016-09-08 01:42:46 -0700233
bayramovef390722016-09-27 03:34:46 -0700234 # initialize organization
bayramovbd6160f2016-09-28 04:12:05 +0400235 if self.user is not None and self.passwd is not None and self.url:
236 self.init_organization()
bayramovef390722016-09-27 03:34:46 -0700237
238 def __getitem__(self, index):
kate15f1c382016-12-15 01:12:40 -0800239 if index == 'name':
240 return self.name
bayramovef390722016-09-27 03:34:46 -0700241 if index == 'tenant_id':
bayramov325fa1c2016-09-08 01:42:46 -0700242 return self.tenant_id
bayramovef390722016-09-27 03:34:46 -0700243 if index == 'tenant_name':
bayramov325fa1c2016-09-08 01:42:46 -0700244 return self.tenant_name
bayramovef390722016-09-27 03:34:46 -0700245 elif index == 'id':
bayramov325fa1c2016-09-08 01:42:46 -0700246 return self.id
bayramovef390722016-09-27 03:34:46 -0700247 elif index == 'org_name':
248 return self.org_name
249 elif index == 'org_uuid':
250 return self.org_uuid
251 elif index == 'user':
bayramov325fa1c2016-09-08 01:42:46 -0700252 return self.user
bayramovef390722016-09-27 03:34:46 -0700253 elif index == 'passwd':
bayramov325fa1c2016-09-08 01:42:46 -0700254 return self.passwd
bayramovef390722016-09-27 03:34:46 -0700255 elif index == 'url':
bayramov325fa1c2016-09-08 01:42:46 -0700256 return self.url
bayramovef390722016-09-27 03:34:46 -0700257 elif index == 'url_admin':
bayramov325fa1c2016-09-08 01:42:46 -0700258 return self.url_admin
bayramovef390722016-09-27 03:34:46 -0700259 elif index == "config":
bayramov325fa1c2016-09-08 01:42:46 -0700260 return self.config
261 else:
bayramovef390722016-09-27 03:34:46 -0700262 raise KeyError("Invalid key '%s'" % str(index))
bayramov325fa1c2016-09-08 01:42:46 -0700263
bayramovef390722016-09-27 03:34:46 -0700264 def __setitem__(self, index, value):
kate15f1c382016-12-15 01:12:40 -0800265 if index == 'name':
266 self.name = value
bayramovef390722016-09-27 03:34:46 -0700267 if index == 'tenant_id':
bayramov325fa1c2016-09-08 01:42:46 -0700268 self.tenant_id = value
bayramovef390722016-09-27 03:34:46 -0700269 if index == 'tenant_name':
bayramov325fa1c2016-09-08 01:42:46 -0700270 self.tenant_name = value
bayramovef390722016-09-27 03:34:46 -0700271 elif index == 'id':
bayramov325fa1c2016-09-08 01:42:46 -0700272 self.id = value
bayramovef390722016-09-27 03:34:46 -0700273 elif index == 'org_name':
274 self.org_name = value
bayramovef390722016-09-27 03:34:46 -0700275 elif index == 'org_uuid':
kate15f1c382016-12-15 01:12:40 -0800276 self.org_uuid = value
bayramovef390722016-09-27 03:34:46 -0700277 elif index == 'user':
bayramov325fa1c2016-09-08 01:42:46 -0700278 self.user = value
bayramovef390722016-09-27 03:34:46 -0700279 elif index == 'passwd':
bayramov325fa1c2016-09-08 01:42:46 -0700280 self.passwd = value
bayramovef390722016-09-27 03:34:46 -0700281 elif index == 'url':
bayramov325fa1c2016-09-08 01:42:46 -0700282 self.url = value
bayramovef390722016-09-27 03:34:46 -0700283 elif index == 'url_admin':
bayramov325fa1c2016-09-08 01:42:46 -0700284 self.url_admin = value
285 else:
bayramovef390722016-09-27 03:34:46 -0700286 raise KeyError("Invalid key '%s'" % str(index))
bayramov325fa1c2016-09-08 01:42:46 -0700287
bayramovef390722016-09-27 03:34:46 -0700288 def connect_as_admin(self):
bayramovb6ffe792016-09-28 11:50:56 +0400289 """ Method connect as pvdc admin user to vCloud director.
290 There are certain action that can be done only by provider vdc admin user.
291 Organization creation / provider network creation etc.
bayramovef390722016-09-27 03:34:46 -0700292
293 Returns:
kasarc5bf2932018-03-09 04:15:22 -0800294 The return client object that latter can be used to connect to vcloud director as admin for provider vdc
bayramovef390722016-09-27 03:34:46 -0700295 """
296
kasarc5bf2932018-03-09 04:15:22 -0800297 self.logger.debug("Logging into vCD {} as admin.".format(self.org_name))
bayramov325fa1c2016-09-08 01:42:46 -0700298
kasarc5bf2932018-03-09 04:15:22 -0800299 try:
300 host = self.url
301 org = 'System'
302 client_as_admin = Client(host, verify_ssl_certs=False)
303 client_as_admin.set_credentials(BasicLoginCredentials(self.admin_user, org, self.admin_password))
304 except Exception as e:
305 raise vimconn.vimconnException(
306 "Can't connect to a vCloud director as: {} with exception {}".format(self.admin_user, e))
bayramov325fa1c2016-09-08 01:42:46 -0700307
kasarc5bf2932018-03-09 04:15:22 -0800308 return client_as_admin
bayramov325fa1c2016-09-08 01:42:46 -0700309
bayramovef390722016-09-27 03:34:46 -0700310 def connect(self):
311 """ Method connect as normal user to vCloud director.
312
313 Returns:
kasarc5bf2932018-03-09 04:15:22 -0800314 The return client object that latter can be used to connect to vCloud director as admin for VDC
bayramovef390722016-09-27 03:34:46 -0700315 """
316
bayramovb6ffe792016-09-28 11:50:56 +0400317 try:
kasarc5bf2932018-03-09 04:15:22 -0800318 self.logger.debug("Logging into vCD {} as {} to datacenter {}.".format(self.org_name,
kate15f1c382016-12-15 01:12:40 -0800319 self.user,
320 self.org_name))
kasarc5bf2932018-03-09 04:15:22 -0800321 host = self.url
322 client = Client(host, verify_ssl_certs=False)
323 client.set_credentials(BasicLoginCredentials(self.user, self.org_name, self.passwd))
bayramovb6ffe792016-09-28 11:50:56 +0400324 except:
kate15f1c382016-12-15 01:12:40 -0800325 raise vimconn.vimconnConnectionException("Can't connect to a vCloud director org: "
326 "{} as user: {}".format(self.org_name, self.user))
bayramov325fa1c2016-09-08 01:42:46 -0700327
kasarc5bf2932018-03-09 04:15:22 -0800328 return client
bayramov325fa1c2016-09-08 01:42:46 -0700329
bayramovbd6160f2016-09-28 04:12:05 +0400330 def init_organization(self):
331 """ Method initialize organization UUID and VDC parameters.
332
333 At bare minimum client must provide organization name that present in vCloud director and VDC.
334
335 The VDC - UUID ( tenant_id) will be initialized at the run time if client didn't call constructor.
336 The Org - UUID will be initialized at the run time if data center present in vCloud director.
bayramov325fa1c2016-09-08 01:42:46 -0700337
bayramovef390722016-09-27 03:34:46 -0700338 Returns:
339 The return vca object that letter can be used to connect to vcloud direct as admin
340 """
kasarc5bf2932018-03-09 04:15:22 -0800341 client = self.connect()
342 if not client:
343 raise vimconn.vimconnConnectionException("Failed to connect vCD.")
bhangare1a0b97c2017-06-21 02:20:15 -0700344
kasarc5bf2932018-03-09 04:15:22 -0800345 self.client = client
bayramovef390722016-09-27 03:34:46 -0700346 try:
347 if self.org_uuid is None:
kasarc5bf2932018-03-09 04:15:22 -0800348 org_list = client.get_org_list()
349 for org in org_list.Org:
bayramovbd6160f2016-09-28 04:12:05 +0400350 # we set org UUID at the init phase but we can do it only when we have valid credential.
kasarc5bf2932018-03-09 04:15:22 -0800351 if org.get('name') == self.org_name:
352 self.org_uuid = org.get('href').split('/')[-1]
bayramovbd6160f2016-09-28 04:12:05 +0400353 self.logger.debug("Setting organization UUID {}".format(self.org_uuid))
354 break
bayramovbd6160f2016-09-28 04:12:05 +0400355 else:
356 raise vimconn.vimconnException("Vcloud director organization {} not found".format(self.org_name))
357
358 # if well good we require for org details
359 org_details_dict = self.get_org(org_uuid=self.org_uuid)
360
361 # we have two case if we want to initialize VDC ID or VDC name at run time
362 # tenant_name provided but no tenant id
bayramov5761ad12016-10-04 09:00:30 +0400363 if self.tenant_id is None and self.tenant_name is not None and 'vdcs' in org_details_dict:
bayramovbd6160f2016-09-28 04:12:05 +0400364 vdcs_dict = org_details_dict['vdcs']
bayramovbd6160f2016-09-28 04:12:05 +0400365 for vdc in vdcs_dict:
366 if vdcs_dict[vdc] == self.tenant_name:
367 self.tenant_id = vdc
368 self.logger.debug("Setting vdc uuid {} for organization UUID {}".format(self.tenant_id,
kate15f1c382016-12-15 01:12:40 -0800369 self.org_name))
bayramovbd6160f2016-09-28 04:12:05 +0400370 break
371 else:
372 raise vimconn.vimconnException("Tenant name indicated but not present in vcloud director.")
373 # case two we have tenant_id but we don't have tenant name so we find and set it.
bayramov5761ad12016-10-04 09:00:30 +0400374 if self.tenant_id is not None and self.tenant_name is None and 'vdcs' in org_details_dict:
bayramovbd6160f2016-09-28 04:12:05 +0400375 vdcs_dict = org_details_dict['vdcs']
376 for vdc in vdcs_dict:
377 if vdc == self.tenant_id:
378 self.tenant_name = vdcs_dict[vdc]
379 self.logger.debug("Setting vdc uuid {} for organization UUID {}".format(self.tenant_id,
kate15f1c382016-12-15 01:12:40 -0800380 self.org_name))
bayramovbd6160f2016-09-28 04:12:05 +0400381 break
382 else:
383 raise vimconn.vimconnException("Tenant id indicated but not present in vcloud director")
bayramovef390722016-09-27 03:34:46 -0700384 self.logger.debug("Setting organization uuid {}".format(self.org_uuid))
385 except:
386 self.logger.debug("Failed initialize organization UUID for org {}".format(self.org_name))
387 self.logger.debug(traceback.format_exc())
388 self.org_uuid = None
bayramov325fa1c2016-09-08 01:42:46 -0700389
bayramovef390722016-09-27 03:34:46 -0700390 def new_tenant(self, tenant_name=None, tenant_description=None):
bayramovb6ffe792016-09-28 11:50:56 +0400391 """ Method adds a new tenant to VIM with this name.
392 This action requires access to create VDC action in vCloud director.
bayramovef390722016-09-27 03:34:46 -0700393
bayramovb6ffe792016-09-28 11:50:56 +0400394 Args:
395 tenant_name is tenant_name to be created.
396 tenant_description not used for this call
397
398 Return:
399 returns the tenant identifier in UUID format.
400 If action is failed method will throw vimconn.vimconnException method
bayramovbd6160f2016-09-28 04:12:05 +0400401 """
bayramovef390722016-09-27 03:34:46 -0700402 vdc_task = self.create_vdc(vdc_name=tenant_name)
403 if vdc_task is not None:
404 vdc_uuid, value = vdc_task.popitem()
kasarc5bf2932018-03-09 04:15:22 -0800405 self.logger.info("Created new vdc {} and uuid: {}".format(tenant_name, vdc_uuid))
bayramovef390722016-09-27 03:34:46 -0700406 return vdc_uuid
407 else:
bayramovbd6160f2016-09-28 04:12:05 +0400408 raise vimconn.vimconnException("Failed create tenant {}".format(tenant_name))
bayramovef390722016-09-27 03:34:46 -0700409
bayramov163f1ae2016-09-28 17:16:55 +0400410 def delete_tenant(self, tenant_id=None):
kated47ad5f2017-08-03 02:16:13 -0700411 """ Delete a tenant from VIM
412 Args:
413 tenant_id is tenant_id to be deleted.
414
415 Return:
416 returns the tenant identifier in UUID format.
417 If action is failed method will throw exception
418 """
419 vca = self.connect_as_admin()
420 if not vca:
kasarc5bf2932018-03-09 04:15:22 -0800421 raise vimconn.vimconnConnectionException("Failed to connect vCD")
kated47ad5f2017-08-03 02:16:13 -0700422
423 if tenant_id is not None:
kasarc5bf2932018-03-09 04:15:22 -0800424 if vca._session:
kated47ad5f2017-08-03 02:16:13 -0700425 #Get OrgVDC
kasarc5bf2932018-03-09 04:15:22 -0800426 url_list = [self.url, '/api/vdc/', tenant_id]
kated47ad5f2017-08-03 02:16:13 -0700427 orgvdc_herf = ''.join(url_list)
kasarc5bf2932018-03-09 04:15:22 -0800428
429 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
430 'x-vcloud-authorization': vca._session.headers['x-vcloud-authorization']}
431 response = self.perform_request(req_type='GET',
432 url=orgvdc_herf,
433 headers=headers)
kated47ad5f2017-08-03 02:16:13 -0700434
435 if response.status_code != requests.codes.ok:
436 self.logger.debug("delete_tenant():GET REST API call {} failed. "\
437 "Return status code {}".format(orgvdc_herf,
438 response.status_code))
439 raise vimconn.vimconnNotFoundException("Fail to get tenant {}".format(tenant_id))
440
441 lxmlroot_respond = lxmlElementTree.fromstring(response.content)
442 namespaces = {prefix:uri for prefix,uri in lxmlroot_respond.nsmap.iteritems() if prefix}
kasarc5bf2932018-03-09 04:15:22 -0800443 #For python3
444 #namespaces = {prefix:uri for prefix,uri in lxmlroot_respond.nsmap.items() if prefix}
kated47ad5f2017-08-03 02:16:13 -0700445 namespaces["xmlns"]= "http://www.vmware.com/vcloud/v1.5"
446 vdc_remove_href = lxmlroot_respond.find("xmlns:Link[@rel='remove']",namespaces).attrib['href']
447 vdc_remove_href = vdc_remove_href + '?recursive=true&force=true'
448
kasarc5bf2932018-03-09 04:15:22 -0800449 response = self.perform_request(req_type='DELETE',
450 url=vdc_remove_href,
451 headers=headers)
kated47ad5f2017-08-03 02:16:13 -0700452
453 if response.status_code == 202:
kasarc5bf2932018-03-09 04:15:22 -0800454 time.sleep(5)
455 return tenant_id
kated47ad5f2017-08-03 02:16:13 -0700456 else:
457 self.logger.debug("delete_tenant(): DELETE REST API call {} failed. "\
458 "Return status code {}".format(vdc_remove_href,
459 response.status_code))
460 raise vimconn.vimconnException("Fail to delete tenant with ID {}".format(tenant_id))
461 else:
462 self.logger.debug("delete_tenant():Incorrect tenant ID {}".format(tenant_id))
463 raise vimconn.vimconnNotFoundException("Fail to get tenant {}".format(tenant_id))
464
bayramov325fa1c2016-09-08 01:42:46 -0700465
466 def get_tenant_list(self, filter_dict={}):
bayramovb6ffe792016-09-28 11:50:56 +0400467 """Obtain tenants of VIM
bayramov325fa1c2016-09-08 01:42:46 -0700468 filter_dict can contain the following keys:
469 name: filter by tenant name
470 id: filter by tenant uuid/id
471 <other VIM specific>
bayramovb6ffe792016-09-28 11:50:56 +0400472 Returns the tenant list of dictionaries:
bayramov325fa1c2016-09-08 01:42:46 -0700473 [{'name':'<name>, 'id':'<id>, ...}, ...]
bayramov325fa1c2016-09-08 01:42:46 -0700474
bayramovb6ffe792016-09-28 11:50:56 +0400475 """
bayramovef390722016-09-27 03:34:46 -0700476 org_dict = self.get_org(self.org_uuid)
477 vdcs_dict = org_dict['vdcs']
478
479 vdclist = []
480 try:
481 for k in vdcs_dict:
482 entry = {'name': vdcs_dict[k], 'id': k}
bayramovb6ffe792016-09-28 11:50:56 +0400483 # if caller didn't specify dictionary we return all tenants.
484 if filter_dict is not None and filter_dict:
485 filtered_entry = entry.copy()
486 filtered_dict = set(entry.keys()) - set(filter_dict)
487 for unwanted_key in filtered_dict: del entry[unwanted_key]
488 if filter_dict == entry:
489 vdclist.append(filtered_entry)
490 else:
491 vdclist.append(entry)
bayramovef390722016-09-27 03:34:46 -0700492 except:
493 self.logger.debug("Error in get_tenant_list()")
494 self.logger.debug(traceback.format_exc())
bayramovb6ffe792016-09-28 11:50:56 +0400495 raise vimconn.vimconnException("Incorrect state. {}")
bayramovef390722016-09-27 03:34:46 -0700496
497 return vdclist
498
499 def new_network(self, net_name, net_type, ip_profile=None, shared=False):
bayramovb6ffe792016-09-28 11:50:56 +0400500 """Adds a tenant network to VIM
bayramov325fa1c2016-09-08 01:42:46 -0700501 net_name is the name
bhangare0e571a92017-01-12 04:02:23 -0800502 net_type can be 'bridge','data'.'ptp'.
bayramovb6ffe792016-09-28 11:50:56 +0400503 ip_profile is a dict containing the IP parameters of the network
bayramov325fa1c2016-09-08 01:42:46 -0700504 shared is a boolean
bayramovb6ffe792016-09-28 11:50:56 +0400505 Returns the network identifier"""
bayramov325fa1c2016-09-08 01:42:46 -0700506
bhangare0e571a92017-01-12 04:02:23 -0800507 self.logger.debug("new_network tenant {} net_type {} ip_profile {} shared {}"
508 .format(net_name, net_type, ip_profile, shared))
bayramov325fa1c2016-09-08 01:42:46 -0700509
bayramovef390722016-09-27 03:34:46 -0700510 isshared = 'false'
511 if shared:
512 isshared = 'true'
513
kateac1e3792017-04-01 02:16:39 -0700514# ############# Stub code for SRIOV #################
515# if net_type == "data" or net_type == "ptp":
516# if self.config.get('dv_switch_name') == None:
517# raise vimconn.vimconnConflictException("You must provide 'dv_switch_name' at config value")
518# network_uuid = self.create_dvPort_group(net_name)
519
bhangare0e571a92017-01-12 04:02:23 -0800520 network_uuid = self.create_network(network_name=net_name, net_type=net_type,
521 ip_profile=ip_profile, isshared=isshared)
bayramovef390722016-09-27 03:34:46 -0700522 if network_uuid is not None:
523 return network_uuid
524 else:
bayramovbd6160f2016-09-28 04:12:05 +0400525 raise vimconn.vimconnUnexpectedResponse("Failed create a new network {}".format(net_name))
bayramovef390722016-09-27 03:34:46 -0700526
527 def get_vcd_network_list(self):
528 """ Method available organization for a logged in tenant
529
530 Returns:
531 The return vca object that letter can be used to connect to vcloud direct as admin
532 """
533
kate15f1c382016-12-15 01:12:40 -0800534 self.logger.debug("get_vcd_network_list(): retrieving network list for vcd {}".format(self.tenant_name))
bayramovef390722016-09-27 03:34:46 -0700535
kate15f1c382016-12-15 01:12:40 -0800536 if not self.tenant_name:
537 raise vimconn.vimconnConnectionException("Tenant name is empty.")
538
kasarc5bf2932018-03-09 04:15:22 -0800539 org, vdc = self.get_vdc_details()
kate15f1c382016-12-15 01:12:40 -0800540 if vdc is None:
541 raise vimconn.vimconnConnectionException("Can't retrieve information for a VDC {}".format(self.tenant_name))
542
kasarc5bf2932018-03-09 04:15:22 -0800543 vdc_uuid = vdc.get('id').split(":")[3]
544 if self.client._session:
545 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
546 'x-vcloud-authorization': self.client._session.headers['x-vcloud-authorization']}
547 response = self.perform_request(req_type='GET',
548 url=vdc.get('href'),
549 headers=headers)
550 if response.status_code != 200:
551 self.logger.error("Failed to get vdc content")
552 raise vimconn.vimconnNotFoundException("Failed to get vdc content")
553 else:
554 content = XmlElementTree.fromstring(response.content)
555
bayramovef390722016-09-27 03:34:46 -0700556 network_list = []
557 try:
kasarc5bf2932018-03-09 04:15:22 -0800558 for item in content:
559 if item.tag.split('}')[-1] == 'AvailableNetworks':
560 for net in item:
561 response = self.perform_request(req_type='GET',
562 url=net.get('href'),
563 headers=headers)
bayramovef390722016-09-27 03:34:46 -0700564
kasarc5bf2932018-03-09 04:15:22 -0800565 if response.status_code != 200:
566 self.logger.error("Failed to get network content")
567 raise vimconn.vimconnNotFoundException("Failed to get network content")
568 else:
569 net_details = XmlElementTree.fromstring(response.content)
570
571 filter_dict = {}
572 net_uuid = net_details.get('id').split(":")
573 if len(net_uuid) != 4:
574 continue
575 else:
576 net_uuid = net_uuid[3]
577 # create dict entry
578 self.logger.debug("Adding {} to a list vcd id {} network {}".format(net_uuid,
579 vdc_uuid,
580 net_details.get('name')))
581 filter_dict["name"] = net_details.get('name')
582 filter_dict["id"] = net_uuid
583 if [i.text for i in net_details if i.tag.split('}')[-1] == 'IsShared'][0] == 'true':
584 shared = True
585 else:
586 shared = False
587 filter_dict["shared"] = shared
588 filter_dict["tenant_id"] = vdc_uuid
kasar40d97802018-05-02 05:58:07 -0700589 if int(net_details.get('status')) == 1:
kasarc5bf2932018-03-09 04:15:22 -0800590 filter_dict["admin_state_up"] = True
591 else:
592 filter_dict["admin_state_up"] = False
593 filter_dict["status"] = "ACTIVE"
594 filter_dict["type"] = "bridge"
595 network_list.append(filter_dict)
596 self.logger.debug("get_vcd_network_list adding entry {}".format(filter_dict))
bayramovef390722016-09-27 03:34:46 -0700597 except:
kasarc5bf2932018-03-09 04:15:22 -0800598 self.logger.debug("Error in get_vcd_network_list", exc_info=True)
bayramovef390722016-09-27 03:34:46 -0700599 pass
600
601 self.logger.debug("get_vcd_network_list returning {}".format(network_list))
602 return network_list
bayramov325fa1c2016-09-08 01:42:46 -0700603
604 def get_network_list(self, filter_dict={}):
bayramovb6ffe792016-09-28 11:50:56 +0400605 """Obtain tenant networks of VIM
bayramov325fa1c2016-09-08 01:42:46 -0700606 Filter_dict can be:
bayramovef390722016-09-27 03:34:46 -0700607 name: network name OR/AND
608 id: network uuid OR/AND
609 shared: boolean OR/AND
610 tenant_id: tenant OR/AND
bayramov325fa1c2016-09-08 01:42:46 -0700611 admin_state_up: boolean
612 status: 'ACTIVE'
bayramovef390722016-09-27 03:34:46 -0700613
614 [{key : value , key : value}]
615
bayramov325fa1c2016-09-08 01:42:46 -0700616 Returns the network list of dictionaries:
617 [{<the fields at Filter_dict plus some VIM specific>}, ...]
618 List can be empty
bayramovb6ffe792016-09-28 11:50:56 +0400619 """
bayramov325fa1c2016-09-08 01:42:46 -0700620
bhangare1a0b97c2017-06-21 02:20:15 -0700621 self.logger.debug("get_network_list(): retrieving network list for vcd {}".format(self.tenant_name))
kate15f1c382016-12-15 01:12:40 -0800622
623 if not self.tenant_name:
624 raise vimconn.vimconnConnectionException("Tenant name is empty.")
bayramov325fa1c2016-09-08 01:42:46 -0700625
kasarc5bf2932018-03-09 04:15:22 -0800626 org, vdc = self.get_vdc_details()
kate15f1c382016-12-15 01:12:40 -0800627 if vdc is None:
628 raise vimconn.vimconnConnectionException("Can't retrieve information for a VDC {}.".format(self.tenant_name))
bayramov325fa1c2016-09-08 01:42:46 -0700629
bayramovef390722016-09-27 03:34:46 -0700630 try:
kasarc5bf2932018-03-09 04:15:22 -0800631 vdcid = vdc.get('id').split(":")[3]
632
633 if self.client._session:
634 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
635 'x-vcloud-authorization': self.client._session.headers['x-vcloud-authorization']}
636 response = self.perform_request(req_type='GET',
637 url=vdc.get('href'),
638 headers=headers)
639 if response.status_code != 200:
640 self.logger.error("Failed to get vdc content")
641 raise vimconn.vimconnNotFoundException("Failed to get vdc content")
642 else:
643 content = XmlElementTree.fromstring(response.content)
644
bhangarebfdca492017-03-11 01:32:46 -0800645 network_list = []
kasarc5bf2932018-03-09 04:15:22 -0800646 for item in content:
647 if item.tag.split('}')[-1] == 'AvailableNetworks':
648 for net in item:
649 response = self.perform_request(req_type='GET',
650 url=net.get('href'),
651 headers=headers)
bhangarebfdca492017-03-11 01:32:46 -0800652
kasarc5bf2932018-03-09 04:15:22 -0800653 if response.status_code != 200:
654 self.logger.error("Failed to get network content")
655 raise vimconn.vimconnNotFoundException("Failed to get network content")
656 else:
657 net_details = XmlElementTree.fromstring(response.content)
bayramovef390722016-09-27 03:34:46 -0700658
kasarc5bf2932018-03-09 04:15:22 -0800659 filter_entry = {}
660 net_uuid = net_details.get('id').split(":")
661 if len(net_uuid) != 4:
662 continue
663 else:
664 net_uuid = net_uuid[3]
665 # create dict entry
666 self.logger.debug("Adding {} to a list vcd id {} network {}".format(net_uuid,
667 vdcid,
668 net_details.get('name')))
669 filter_entry["name"] = net_details.get('name')
670 filter_entry["id"] = net_uuid
671 if [i.text for i in net_details if i.tag.split('}')[-1] == 'IsShared'][0] == 'true':
672 shared = True
673 else:
674 shared = False
675 filter_entry["shared"] = shared
676 filter_entry["tenant_id"] = vdcid
kasar40d97802018-05-02 05:58:07 -0700677 if int(net_details.get('status')) == 1:
kasarc5bf2932018-03-09 04:15:22 -0800678 filter_entry["admin_state_up"] = True
679 else:
680 filter_entry["admin_state_up"] = False
681 filter_entry["status"] = "ACTIVE"
682 filter_entry["type"] = "bridge"
683 filtered_entry = filter_entry.copy()
684
685 if filter_dict is not None and filter_dict:
686 # we remove all the key : value we don't care and match only
687 # respected field
688 filtered_dict = set(filter_entry.keys()) - set(filter_dict)
689 for unwanted_key in filtered_dict: del filter_entry[unwanted_key]
690 if filter_dict == filter_entry:
691 network_list.append(filtered_entry)
692 else:
693 network_list.append(filtered_entry)
694 except Exception as e:
695 self.logger.debug("Error in get_network_list",exc_info=True)
696 if isinstance(e, vimconn.vimconnException):
697 raise
698 else:
699 raise vimconn.vimconnNotFoundException("Failed : Networks list not found {} ".format(e))
bayramov325fa1c2016-09-08 01:42:46 -0700700
701 self.logger.debug("Returning {}".format(network_list))
702 return network_list
703
704 def get_network(self, net_id):
bayramovfe3f3c92016-10-04 07:53:41 +0400705 """Method obtains network details of net_id VIM network
bayramovef390722016-09-27 03:34:46 -0700706 Return a dict with the fields at filter_dict (see get_network_list) plus some VIM specific>}, ...]"""
707
bayramovef390722016-09-27 03:34:46 -0700708 try:
kasarc5bf2932018-03-09 04:15:22 -0800709 org, vdc = self.get_vdc_details()
710 vdc_id = vdc.get('id').split(":")[3]
711 if self.client._session:
712 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
713 'x-vcloud-authorization': self.client._session.headers['x-vcloud-authorization']}
714 response = self.perform_request(req_type='GET',
715 url=vdc.get('href'),
716 headers=headers)
717 if response.status_code != 200:
718 self.logger.error("Failed to get vdc content")
719 raise vimconn.vimconnNotFoundException("Failed to get vdc content")
720 else:
721 content = XmlElementTree.fromstring(response.content)
bhangarebfdca492017-03-11 01:32:46 -0800722
bhangarebfdca492017-03-11 01:32:46 -0800723 filter_dict = {}
724
kasarc5bf2932018-03-09 04:15:22 -0800725 for item in content:
726 if item.tag.split('}')[-1] == 'AvailableNetworks':
727 for net in item:
728 response = self.perform_request(req_type='GET',
729 url=net.get('href'),
730 headers=headers)
kasarc30a04e2017-08-24 05:58:18 -0700731
kasarc5bf2932018-03-09 04:15:22 -0800732 if response.status_code != 200:
733 self.logger.error("Failed to get network content")
734 raise vimconn.vimconnNotFoundException("Failed to get network content")
735 else:
736 net_details = XmlElementTree.fromstring(response.content)
737
738 vdc_network_id = net_details.get('id').split(":")
739 if len(vdc_network_id) == 4 and vdc_network_id[3] == net_id:
740 filter_dict["name"] = net_details.get('name')
741 filter_dict["id"] = vdc_network_id[3]
742 if [i.text for i in net_details if i.tag.split('}')[-1] == 'IsShared'][0] == 'true':
743 shared = True
744 else:
745 shared = False
746 filter_dict["shared"] = shared
747 filter_dict["tenant_id"] = vdc_id
kasar40d97802018-05-02 05:58:07 -0700748 if int(net_details.get('status')) == 1:
kasarc5bf2932018-03-09 04:15:22 -0800749 filter_dict["admin_state_up"] = True
750 else:
751 filter_dict["admin_state_up"] = False
752 filter_dict["status"] = "ACTIVE"
753 filter_dict["type"] = "bridge"
754 self.logger.debug("Returning {}".format(filter_dict))
755 return filter_dict
bayramovef390722016-09-27 03:34:46 -0700756 else:
kasarc5bf2932018-03-09 04:15:22 -0800757 raise vimconn.vimconnNotFoundException("Network {} not found".format(net_id))
kasarc30a04e2017-08-24 05:58:18 -0700758 except Exception as e:
bayramovef390722016-09-27 03:34:46 -0700759 self.logger.debug("Error in get_network")
760 self.logger.debug(traceback.format_exc())
kasarc30a04e2017-08-24 05:58:18 -0700761 if isinstance(e, vimconn.vimconnException):
762 raise
763 else:
764 raise vimconn.vimconnNotFoundException("Failed : Network not found {} ".format(e))
bayramovef390722016-09-27 03:34:46 -0700765
766 return filter_dict
bayramov325fa1c2016-09-08 01:42:46 -0700767
768 def delete_network(self, net_id):
bayramovef390722016-09-27 03:34:46 -0700769 """
770 Method Deletes a tenant network from VIM, provide the network id.
771
772 Returns the network identifier or raise an exception
773 """
774
kateac1e3792017-04-01 02:16:39 -0700775 # ############# Stub code for SRIOV #################
776# dvport_group = self.get_dvport_group(net_id)
777# if dvport_group:
778# #delete portgroup
779# status = self.destroy_dvport_group(net_id)
780# if status:
781# # Remove vlanID from persistent info
782# if net_id in self.persistent_info["used_vlanIDs"]:
783# del self.persistent_info["used_vlanIDs"][net_id]
784#
785# return net_id
786
bayramovfe3f3c92016-10-04 07:53:41 +0400787 vcd_network = self.get_vcd_network(network_uuid=net_id)
788 if vcd_network is not None and vcd_network:
789 if self.delete_network_action(network_uuid=net_id):
790 return net_id
bayramovef390722016-09-27 03:34:46 -0700791 else:
792 raise vimconn.vimconnNotFoundException("Network {} not found".format(net_id))
bayramov325fa1c2016-09-08 01:42:46 -0700793
794 def refresh_nets_status(self, net_list):
bayramovbd6160f2016-09-28 04:12:05 +0400795 """Get the status of the networks
bayramov325fa1c2016-09-08 01:42:46 -0700796 Params: the list of network identifiers
797 Returns a dictionary with:
798 net_id: #VIM id of this network
799 status: #Mandatory. Text with one of:
800 # DELETED (not found at vim)
bayramovbd6160f2016-09-28 04:12:05 +0400801 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
bayramov325fa1c2016-09-08 01:42:46 -0700802 # OTHER (Vim reported other status not understood)
803 # ERROR (VIM indicates an ERROR status)
bayramovbd6160f2016-09-28 04:12:05 +0400804 # ACTIVE, INACTIVE, DOWN (admin down),
bayramov325fa1c2016-09-08 01:42:46 -0700805 # BUILD (on building process)
806 #
bayramovbd6160f2016-09-28 04:12:05 +0400807 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
bayramov325fa1c2016-09-08 01:42:46 -0700808 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
809
bayramovbd6160f2016-09-28 04:12:05 +0400810 """
bayramov325fa1c2016-09-08 01:42:46 -0700811
bayramovef390722016-09-27 03:34:46 -0700812 dict_entry = {}
813 try:
814 for net in net_list:
bayramovef390722016-09-27 03:34:46 -0700815 errormsg = ''
816 vcd_network = self.get_vcd_network(network_uuid=net)
bayramovfe3f3c92016-10-04 07:53:41 +0400817 if vcd_network is not None and vcd_network:
bhangare92d4af32016-12-24 02:54:51 -0800818 if vcd_network['status'] == '1':
bayramovef390722016-09-27 03:34:46 -0700819 status = 'ACTIVE'
820 else:
821 status = 'DOWN'
822 else:
823 status = 'DELETED'
bayramovfe3f3c92016-10-04 07:53:41 +0400824 errormsg = 'Network not found.'
825
826 dict_entry[net] = {'status': status, 'error_msg': errormsg,
bhangare92d4af32016-12-24 02:54:51 -0800827 'vim_info': yaml.safe_dump(vcd_network)}
bayramovef390722016-09-27 03:34:46 -0700828 except:
829 self.logger.debug("Error in refresh_nets_status")
830 self.logger.debug(traceback.format_exc())
831
832 return dict_entry
833
bayramovbd6160f2016-09-28 04:12:05 +0400834 def get_flavor(self, flavor_id):
bayramovef390722016-09-27 03:34:46 -0700835 """Obtain flavor details from the VIM
836 Returns the flavor dict details {'id':<>, 'name':<>, other vim specific } #TODO to concrete
837 """
kateeb044522017-03-06 23:54:39 -0800838 if flavor_id not in vimconnector.flavorlist:
bayramovfe3f3c92016-10-04 07:53:41 +0400839 raise vimconn.vimconnNotFoundException("Flavor not found.")
kateeb044522017-03-06 23:54:39 -0800840 return vimconnector.flavorlist[flavor_id]
bayramov325fa1c2016-09-08 01:42:46 -0700841
842 def new_flavor(self, flavor_data):
bayramovef390722016-09-27 03:34:46 -0700843 """Adds a tenant flavor to VIM
bayramov325fa1c2016-09-08 01:42:46 -0700844 flavor_data contains a dictionary with information, keys:
845 name: flavor name
846 ram: memory (cloud type) in MBytes
847 vpcus: cpus (cloud type)
848 extended: EPA parameters
849 - numas: #items requested in same NUMA
850 memory: number of 1G huge pages memory
851 paired-threads|cores|threads: number of paired hyperthreads, complete cores OR individual threads
852 interfaces: # passthrough(PT) or SRIOV interfaces attached to this numa
853 - name: interface name
854 dedicated: yes|no|yes:sriov; for PT, SRIOV or only one SRIOV for the physical NIC
855 bandwidth: X Gbps; requested guarantee bandwidth
bayramovef390722016-09-27 03:34:46 -0700856 vpci: requested virtual PCI address
bayramov325fa1c2016-09-08 01:42:46 -0700857 disk: disk size
858 is_public:
bayramov325fa1c2016-09-08 01:42:46 -0700859 #TODO to concrete
bayramovef390722016-09-27 03:34:46 -0700860 Returns the flavor identifier"""
bayramov325fa1c2016-09-08 01:42:46 -0700861
bayramovef390722016-09-27 03:34:46 -0700862 # generate a new uuid put to internal dict and return it.
bhangarea92ae392017-01-12 22:30:29 -0800863 self.logger.debug("Creating new flavor - flavor_data: {}".format(flavor_data))
864 new_flavor=flavor_data
865 ram = flavor_data.get(FLAVOR_RAM_KEY, 1024)
866 cpu = flavor_data.get(FLAVOR_VCPUS_KEY, 1)
garciadeblas79d1a1a2017-12-11 16:07:07 +0100867 disk = flavor_data.get(FLAVOR_DISK_KEY, 0)
bhangarea92ae392017-01-12 22:30:29 -0800868
kasarfeaaa052017-06-08 03:46:18 -0700869 if not isinstance(ram, int):
870 raise vimconn.vimconnException("Non-integer value for ram")
871 elif not isinstance(cpu, int):
872 raise vimconn.vimconnException("Non-integer value for cpu")
873 elif not isinstance(disk, int):
874 raise vimconn.vimconnException("Non-integer value for disk")
875
bhangarea92ae392017-01-12 22:30:29 -0800876 extended_flv = flavor_data.get("extended")
877 if extended_flv:
878 numas=extended_flv.get("numas")
879 if numas:
880 for numa in numas:
881 #overwrite ram and vcpus
882 ram = numa['memory']*1024
883 if 'paired-threads' in numa:
884 cpu = numa['paired-threads']*2
885 elif 'cores' in numa:
886 cpu = numa['cores']
887 elif 'threads' in numa:
888 cpu = numa['threads']
889
890 new_flavor[FLAVOR_RAM_KEY] = ram
891 new_flavor[FLAVOR_VCPUS_KEY] = cpu
892 new_flavor[FLAVOR_DISK_KEY] = disk
893 # generate a new uuid put to internal dict and return it.
bayramovef390722016-09-27 03:34:46 -0700894 flavor_id = uuid.uuid4()
kateeb044522017-03-06 23:54:39 -0800895 vimconnector.flavorlist[str(flavor_id)] = new_flavor
bhangarea92ae392017-01-12 22:30:29 -0800896 self.logger.debug("Created flavor - {} : {}".format(flavor_id, new_flavor))
bayramov325fa1c2016-09-08 01:42:46 -0700897
bayramovef390722016-09-27 03:34:46 -0700898 return str(flavor_id)
bayramov325fa1c2016-09-08 01:42:46 -0700899
900 def delete_flavor(self, flavor_id):
bayramovef390722016-09-27 03:34:46 -0700901 """Deletes a tenant flavor from VIM identify by its id
bayramov325fa1c2016-09-08 01:42:46 -0700902
bayramovfe3f3c92016-10-04 07:53:41 +0400903 Returns the used id or raise an exception
bayramovef390722016-09-27 03:34:46 -0700904 """
kateeb044522017-03-06 23:54:39 -0800905 if flavor_id not in vimconnector.flavorlist:
bayramovfe3f3c92016-10-04 07:53:41 +0400906 raise vimconn.vimconnNotFoundException("Flavor not found.")
bayramovef390722016-09-27 03:34:46 -0700907
kateeb044522017-03-06 23:54:39 -0800908 vimconnector.flavorlist.pop(flavor_id, None)
bayramovef390722016-09-27 03:34:46 -0700909 return flavor_id
910
911 def new_image(self, image_dict):
bayramov5761ad12016-10-04 09:00:30 +0400912 """
bayramov325fa1c2016-09-08 01:42:46 -0700913 Adds a tenant image to VIM
914 Returns:
915 200, image-id if the image is created
916 <0, message if there is an error
bayramov5761ad12016-10-04 09:00:30 +0400917 """
bayramov325fa1c2016-09-08 01:42:46 -0700918
bayramovef390722016-09-27 03:34:46 -0700919 return self.get_image_id_from_path(image_dict['location'])
bayramov325fa1c2016-09-08 01:42:46 -0700920
921 def delete_image(self, image_id):
bayramovfe3f3c92016-10-04 07:53:41 +0400922 """
kated47ad5f2017-08-03 02:16:13 -0700923 Deletes a tenant image from VIM
924 Args:
925 image_id is ID of Image to be deleted
926 Return:
927 returns the image identifier in UUID format or raises an exception on error
bayramovfe3f3c92016-10-04 07:53:41 +0400928 """
kasarc5bf2932018-03-09 04:15:22 -0800929 conn = self.connect_as_admin()
930 if not conn:
931 raise vimconn.vimconnConnectionException("Failed to connect vCD")
kated47ad5f2017-08-03 02:16:13 -0700932 # Get Catalog details
kasarc5bf2932018-03-09 04:15:22 -0800933 url_list = [self.url, '/api/catalog/', image_id]
kated47ad5f2017-08-03 02:16:13 -0700934 catalog_herf = ''.join(url_list)
kasarc5bf2932018-03-09 04:15:22 -0800935
936 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
937 'x-vcloud-authorization': conn._session.headers['x-vcloud-authorization']}
938
939 response = self.perform_request(req_type='GET',
940 url=catalog_herf,
941 headers=headers)
bayramovfe3f3c92016-10-04 07:53:41 +0400942
kated47ad5f2017-08-03 02:16:13 -0700943 if response.status_code != requests.codes.ok:
944 self.logger.debug("delete_image():GET REST API call {} failed. "\
945 "Return status code {}".format(catalog_herf,
946 response.status_code))
947 raise vimconn.vimconnNotFoundException("Fail to get image {}".format(image_id))
948
949 lxmlroot_respond = lxmlElementTree.fromstring(response.content)
950 namespaces = {prefix:uri for prefix,uri in lxmlroot_respond.nsmap.iteritems() if prefix}
kasarc5bf2932018-03-09 04:15:22 -0800951 #For python3
952 #namespaces = {prefix:uri for prefix,uri in lxmlroot_respond.nsmap.items() if prefix}
kated47ad5f2017-08-03 02:16:13 -0700953 namespaces["xmlns"]= "http://www.vmware.com/vcloud/v1.5"
954
955 catalogItems_section = lxmlroot_respond.find("xmlns:CatalogItems",namespaces)
956 catalogItems = catalogItems_section.iterfind("xmlns:CatalogItem",namespaces)
957 for catalogItem in catalogItems:
958 catalogItem_href = catalogItem.attrib['href']
959
kasarc5bf2932018-03-09 04:15:22 -0800960 response = self.perform_request(req_type='GET',
961 url=catalogItem_href,
962 headers=headers)
kated47ad5f2017-08-03 02:16:13 -0700963
964 if response.status_code != requests.codes.ok:
965 self.logger.debug("delete_image():GET REST API call {} failed. "\
966 "Return status code {}".format(catalog_herf,
967 response.status_code))
968 raise vimconn.vimconnNotFoundException("Fail to get catalogItem {} for catalog {}".format(
969 catalogItem,
970 image_id))
971
972 lxmlroot_respond = lxmlElementTree.fromstring(response.content)
973 namespaces = {prefix:uri for prefix,uri in lxmlroot_respond.nsmap.iteritems() if prefix}
kasarc5bf2932018-03-09 04:15:22 -0800974 #For python3
975 #namespaces = {prefix:uri for prefix,uri in lxmlroot_respond.nsmap.items() if prefix}
kated47ad5f2017-08-03 02:16:13 -0700976 namespaces["xmlns"]= "http://www.vmware.com/vcloud/v1.5"
977 catalogitem_remove_href = lxmlroot_respond.find("xmlns:Link[@rel='remove']",namespaces).attrib['href']
978
979 #Remove catalogItem
kasarc5bf2932018-03-09 04:15:22 -0800980 response = self.perform_request(req_type='DELETE',
981 url=catalogitem_remove_href,
982 headers=headers)
kated47ad5f2017-08-03 02:16:13 -0700983 if response.status_code == requests.codes.no_content:
984 self.logger.debug("Deleted Catalog item {}".format(catalogItem))
985 else:
986 raise vimconn.vimconnException("Fail to delete Catalog Item {}".format(catalogItem))
987
988 #Remove catalog
kasarc5bf2932018-03-09 04:15:22 -0800989 url_list = [self.url, '/api/admin/catalog/', image_id]
kated47ad5f2017-08-03 02:16:13 -0700990 catalog_remove_herf = ''.join(url_list)
kasarc5bf2932018-03-09 04:15:22 -0800991 response = self.perform_request(req_type='DELETE',
992 url=catalog_remove_herf,
993 headers=headers)
kated47ad5f2017-08-03 02:16:13 -0700994
995 if response.status_code == requests.codes.no_content:
996 self.logger.debug("Deleted Catalog {}".format(image_id))
997 return image_id
998 else:
999 raise vimconn.vimconnException("Fail to delete Catalog {}".format(image_id))
1000
bayramov325fa1c2016-09-08 01:42:46 -07001001
1002 def catalog_exists(self, catalog_name, catalogs):
bayramovfe3f3c92016-10-04 07:53:41 +04001003 """
1004
1005 :param catalog_name:
1006 :param catalogs:
1007 :return:
1008 """
bayramov325fa1c2016-09-08 01:42:46 -07001009 for catalog in catalogs:
kasarc5bf2932018-03-09 04:15:22 -08001010 if catalog['name'] == catalog_name:
bayramov325fa1c2016-09-08 01:42:46 -07001011 return True
1012 return False
1013
bayramovb6ffe792016-09-28 11:50:56 +04001014 def create_vimcatalog(self, vca=None, catalog_name=None):
bayramovfe3f3c92016-10-04 07:53:41 +04001015 """ Create new catalog entry in vCloud director.
bayramovb6ffe792016-09-28 11:50:56 +04001016
1017 Args
1018 vca: vCloud director.
1019 catalog_name catalog that client wish to create. Note no validation done for a name.
1020 Client must make sure that provide valid string representation.
1021
1022 Return (bool) True if catalog created.
1023
1024 """
1025 try:
kasarc5bf2932018-03-09 04:15:22 -08001026 result = vca.create_catalog(catalog_name, catalog_name)
1027 if result is not None:
1028 return True
1029 catalogs = vca.list_catalogs()
bayramovb6ffe792016-09-28 11:50:56 +04001030 except:
bayramov325fa1c2016-09-08 01:42:46 -07001031 return False
bayramov325fa1c2016-09-08 01:42:46 -07001032 return self.catalog_exists(catalog_name, catalogs)
1033
bayramov5761ad12016-10-04 09:00:30 +04001034 # noinspection PyIncorrectDocstring
bayramovfe3f3c92016-10-04 07:53:41 +04001035 def upload_ovf(self, vca=None, catalog_name=None, image_name=None, media_file_name=None,
1036 description='', progress=False, chunk_bytes=128 * 1024):
bayramov325fa1c2016-09-08 01:42:46 -07001037 """
1038 Uploads a OVF file to a vCloud catalog
1039
bayramov5761ad12016-10-04 09:00:30 +04001040 :param chunk_bytes:
1041 :param progress:
1042 :param description:
1043 :param image_name:
1044 :param vca:
bayramov325fa1c2016-09-08 01:42:46 -07001045 :param catalog_name: (str): The name of the catalog to upload the media.
bayramov325fa1c2016-09-08 01:42:46 -07001046 :param media_file_name: (str): The name of the local media file to upload.
1047 :return: (bool) True if the media file was successfully uploaded, false otherwise.
1048 """
1049 os.path.isfile(media_file_name)
1050 statinfo = os.stat(media_file_name)
bayramov325fa1c2016-09-08 01:42:46 -07001051
1052 # find a catalog entry where we upload OVF.
1053 # create vApp Template and check the status if vCD able to read OVF it will respond with appropirate
1054 # status change.
1055 # if VCD can parse OVF we upload VMDK file
bhangarebfdca492017-03-11 01:32:46 -08001056 try:
kasarc5bf2932018-03-09 04:15:22 -08001057 for catalog in vca.list_catalogs():
1058 if catalog_name != catalog['name']:
bhangarebfdca492017-03-11 01:32:46 -08001059 continue
kasarc5bf2932018-03-09 04:15:22 -08001060 catalog_href = "{}/api/catalog/{}/action/upload".format(self.url, catalog['id'])
bhangarebfdca492017-03-11 01:32:46 -08001061 data = """
kasarc5bf2932018-03-09 04:15:22 -08001062 <UploadVAppTemplateParams name="{}" xmlns="http://www.vmware.com/vcloud/v1.5" xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"><Description>{} vApp Template</Description></UploadVAppTemplateParams>
1063 """.format(catalog_name, description)
1064
1065 if self.client:
1066 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
1067 'x-vcloud-authorization': self.client._session.headers['x-vcloud-authorization']}
1068 headers['Content-Type'] = 'application/vnd.vmware.vcloud.uploadVAppTemplateParams+xml'
1069
1070 response = self.perform_request(req_type='POST',
1071 url=catalog_href,
1072 headers=headers,
1073 data=data)
1074
bhangarebfdca492017-03-11 01:32:46 -08001075 if response.status_code == requests.codes.created:
1076 catalogItem = XmlElementTree.fromstring(response.content)
1077 entity = [child for child in catalogItem if
1078 child.get("type") == "application/vnd.vmware.vcloud.vAppTemplate+xml"][0]
1079 href = entity.get('href')
1080 template = href
kasarc5bf2932018-03-09 04:15:22 -08001081
1082 response = self.perform_request(req_type='GET',
1083 url=href,
1084 headers=headers)
bhangarebfdca492017-03-11 01:32:46 -08001085
1086 if response.status_code == requests.codes.ok:
bhangarebfdca492017-03-11 01:32:46 -08001087 headers['Content-Type'] = 'Content-Type text/xml'
kasarc5bf2932018-03-09 04:15:22 -08001088 result = re.search('rel="upload:default"\shref="(.*?\/descriptor.ovf)"',response.content)
1089 if result:
1090 transfer_href = result.group(1)
1091
1092 response = self.perform_request(req_type='PUT',
1093 url=transfer_href,
1094 headers=headers,
1095 data=open(media_file_name, 'rb'))
bhangarebfdca492017-03-11 01:32:46 -08001096 if response.status_code != requests.codes.ok:
1097 self.logger.debug(
1098 "Failed create vApp template for catalog name {} and image {}".format(catalog_name,
1099 media_file_name))
1100 return False
1101
1102 # TODO fix this with aync block
1103 time.sleep(5)
1104
1105 self.logger.debug("vApp template for catalog name {} and image {}".format(catalog_name, media_file_name))
1106
1107 # uploading VMDK file
1108 # check status of OVF upload and upload remaining files.
kasarc5bf2932018-03-09 04:15:22 -08001109 response = self.perform_request(req_type='GET',
1110 url=template,
1111 headers=headers)
bhangarebfdca492017-03-11 01:32:46 -08001112
1113 if response.status_code == requests.codes.ok:
kasarc5bf2932018-03-09 04:15:22 -08001114 result = re.search('rel="upload:default"\s*href="(.*?vmdk)"',response.content)
1115 if result:
1116 link_href = result.group(1)
1117 # we skip ovf since it already uploaded.
1118 if 'ovf' in link_href:
1119 continue
1120 # The OVF file and VMDK must be in a same directory
1121 head, tail = os.path.split(media_file_name)
1122 file_vmdk = head + '/' + link_href.split("/")[-1]
1123 if not os.path.isfile(file_vmdk):
1124 return False
1125 statinfo = os.stat(file_vmdk)
1126 if statinfo.st_size == 0:
1127 return False
1128 hrefvmdk = link_href
1129
1130 if progress:
1131 widgets = ['Uploading file: ', Percentage(), ' ', Bar(), ' ', ETA(), ' ',
1132 FileTransferSpeed()]
1133 progress_bar = ProgressBar(widgets=widgets, maxval=statinfo.st_size).start()
1134
1135 bytes_transferred = 0
1136 f = open(file_vmdk, 'rb')
1137 while bytes_transferred < statinfo.st_size:
1138 my_bytes = f.read(chunk_bytes)
1139 if len(my_bytes) <= chunk_bytes:
1140 headers['Content-Range'] = 'bytes %s-%s/%s' % (
1141 bytes_transferred, len(my_bytes) - 1, statinfo.st_size)
1142 headers['Content-Length'] = str(len(my_bytes))
1143 response = requests.put(url=hrefvmdk,
1144 headers=headers,
1145 data=my_bytes,
1146 verify=False)
1147 if response.status_code == requests.codes.ok:
1148 bytes_transferred += len(my_bytes)
1149 if progress:
1150 progress_bar.update(bytes_transferred)
1151 else:
1152 self.logger.debug(
1153 'file upload failed with error: [%s] %s' % (response.status_code,
1154 response.content))
1155
1156 f.close()
bhangarebfdca492017-03-11 01:32:46 -08001157 return False
kasarc5bf2932018-03-09 04:15:22 -08001158 f.close()
1159 if progress:
1160 progress_bar.finish()
1161 time.sleep(10)
1162 return True
1163 else:
1164 self.logger.debug("Failed retrieve vApp template for catalog name {} for OVF {}".
1165 format(catalog_name, media_file_name))
1166 return False
bhangarebfdca492017-03-11 01:32:46 -08001167 except Exception as exp:
1168 self.logger.debug("Failed while uploading OVF to catalog {} for OVF file {} with Exception {}"
1169 .format(catalog_name,media_file_name, exp))
1170 raise vimconn.vimconnException(
1171 "Failed while uploading OVF to catalog {} for OVF file {} with Exception {}"
1172 .format(catalog_name,media_file_name, exp))
bayramov325fa1c2016-09-08 01:42:46 -07001173
1174 self.logger.debug("Failed retrieve catalog name {} for OVF file {}".format(catalog_name, media_file_name))
1175 return False
1176
bayramovfe3f3c92016-10-04 07:53:41 +04001177 def upload_vimimage(self, vca=None, catalog_name=None, media_name=None, medial_file_name=None, progress=False):
bayramov325fa1c2016-09-08 01:42:46 -07001178 """Upload media file"""
bayramovfe3f3c92016-10-04 07:53:41 +04001179 # TODO add named parameters for readability
1180
1181 return self.upload_ovf(vca=vca, catalog_name=catalog_name, image_name=media_name.split(".")[0],
1182 media_file_name=medial_file_name, description='medial_file_name', progress=progress)
bayramov325fa1c2016-09-08 01:42:46 -07001183
bayramovb6ffe792016-09-28 11:50:56 +04001184 def validate_uuid4(self, uuid_string=None):
1185 """ Method validate correct format of UUID.
1186
1187 Return: true if string represent valid uuid
1188 """
1189 try:
1190 val = uuid.UUID(uuid_string, version=4)
1191 except ValueError:
1192 return False
1193 return True
1194
1195 def get_catalogid(self, catalog_name=None, catalogs=None):
1196 """ Method check catalog and return catalog ID in UUID format.
1197
1198 Args
1199 catalog_name: catalog name as string
1200 catalogs: list of catalogs.
1201
1202 Return: catalogs uuid
1203 """
1204
bayramov325fa1c2016-09-08 01:42:46 -07001205 for catalog in catalogs:
kasarc5bf2932018-03-09 04:15:22 -08001206 if catalog['name'] == catalog_name:
1207 catalog_id = catalog['id']
1208 return catalog_id
bayramov325fa1c2016-09-08 01:42:46 -07001209 return None
1210
bayramovb6ffe792016-09-28 11:50:56 +04001211 def get_catalogbyid(self, catalog_uuid=None, catalogs=None):
1212 """ Method check catalog and return catalog name lookup done by catalog UUID.
1213
1214 Args
1215 catalog_name: catalog name as string
1216 catalogs: list of catalogs.
1217
1218 Return: catalogs name or None
1219 """
1220
1221 if not self.validate_uuid4(uuid_string=catalog_uuid):
1222 return None
1223
bayramov325fa1c2016-09-08 01:42:46 -07001224 for catalog in catalogs:
kasarc5bf2932018-03-09 04:15:22 -08001225 catalog_id = catalog.get('id')
bayramovb6ffe792016-09-28 11:50:56 +04001226 if catalog_id == catalog_uuid:
kasarc5bf2932018-03-09 04:15:22 -08001227 return catalog.get('name')
bayramov325fa1c2016-09-08 01:42:46 -07001228 return None
1229
bhangare06312472017-03-30 05:49:07 -07001230 def get_catalog_obj(self, catalog_uuid=None, catalogs=None):
1231 """ Method check catalog and return catalog name lookup done by catalog UUID.
1232
1233 Args
1234 catalog_name: catalog name as string
1235 catalogs: list of catalogs.
1236
1237 Return: catalogs name or None
1238 """
1239
1240 if not self.validate_uuid4(uuid_string=catalog_uuid):
1241 return None
1242
1243 for catalog in catalogs:
kasarc5bf2932018-03-09 04:15:22 -08001244 catalog_id = catalog.get('id')
bhangare06312472017-03-30 05:49:07 -07001245 if catalog_id == catalog_uuid:
1246 return catalog
1247 return None
1248
bayramovfe3f3c92016-10-04 07:53:41 +04001249 def get_image_id_from_path(self, path=None, progress=False):
bayramovb6ffe792016-09-28 11:50:56 +04001250 """ Method upload OVF image to vCloud director.
bayramov325fa1c2016-09-08 01:42:46 -07001251
bayramovb6ffe792016-09-28 11:50:56 +04001252 Each OVF image represented as single catalog entry in vcloud director.
1253 The method check for existing catalog entry. The check done by file name without file extension.
1254
1255 if given catalog name already present method will respond with existing catalog uuid otherwise
1256 it will create new catalog entry and upload OVF file to newly created catalog.
1257
1258 If method can't create catalog entry or upload a file it will throw exception.
1259
bayramovfe3f3c92016-10-04 07:53:41 +04001260 Method accept boolean flag progress that will output progress bar. It useful method
1261 for standalone upload use case. In case to test large file upload.
1262
bayramovb6ffe792016-09-28 11:50:56 +04001263 Args
bayramovfe3f3c92016-10-04 07:53:41 +04001264 path: - valid path to OVF file.
1265 progress - boolean progress bar show progress bar.
bayramovb6ffe792016-09-28 11:50:56 +04001266
1267 Return: if image uploaded correct method will provide image catalog UUID.
1268 """
bayramov325fa1c2016-09-08 01:42:46 -07001269
kate15f1c382016-12-15 01:12:40 -08001270 if not path:
bayramovfe3f3c92016-10-04 07:53:41 +04001271 raise vimconn.vimconnException("Image path can't be None.")
1272
1273 if not os.path.isfile(path):
1274 raise vimconn.vimconnException("Can't read file. File not found.")
1275
1276 if not os.access(path, os.R_OK):
1277 raise vimconn.vimconnException("Can't read file. Check file permission to read.")
1278
1279 self.logger.debug("get_image_id_from_path() client requesting {} ".format(path))
bayramov325fa1c2016-09-08 01:42:46 -07001280
1281 dirpath, filename = os.path.split(path)
1282 flname, file_extension = os.path.splitext(path)
1283 if file_extension != '.ovf':
bayramovfe3f3c92016-10-04 07:53:41 +04001284 self.logger.debug("Wrong file extension {} connector support only OVF container.".format(file_extension))
bayramovb6ffe792016-09-28 11:50:56 +04001285 raise vimconn.vimconnException("Wrong container. vCloud director supports only OVF.")
kate15f1c382016-12-15 01:12:40 -08001286
bayramov325fa1c2016-09-08 01:42:46 -07001287 catalog_name = os.path.splitext(filename)[0]
kate15f1c382016-12-15 01:12:40 -08001288 catalog_md5_name = hashlib.md5(path).hexdigest()
1289 self.logger.debug("File name {} Catalog Name {} file path {} "
1290 "vdc catalog name {}".format(filename, catalog_name, path, catalog_md5_name))
bayramov325fa1c2016-09-08 01:42:46 -07001291
bhangarebfdca492017-03-11 01:32:46 -08001292 try:
kasarc5bf2932018-03-09 04:15:22 -08001293 org,vdc = self.get_vdc_details()
1294 catalogs = org.list_catalogs()
bhangarebfdca492017-03-11 01:32:46 -08001295 except Exception as exp:
1296 self.logger.debug("Failed get catalogs() with Exception {} ".format(exp))
1297 raise vimconn.vimconnException("Failed get catalogs() with Exception {} ".format(exp))
1298
bayramov325fa1c2016-09-08 01:42:46 -07001299 if len(catalogs) == 0:
bayramovfe3f3c92016-10-04 07:53:41 +04001300 self.logger.info("Creating a new catalog entry {} in vcloud director".format(catalog_name))
kasarc5bf2932018-03-09 04:15:22 -08001301 result = self.create_vimcatalog(org, catalog_md5_name)
bayramov325fa1c2016-09-08 01:42:46 -07001302 if not result:
kate15f1c382016-12-15 01:12:40 -08001303 raise vimconn.vimconnException("Failed create new catalog {} ".format(catalog_md5_name))
kasarc5bf2932018-03-09 04:15:22 -08001304
1305 result = self.upload_vimimage(vca=org, catalog_name=catalog_md5_name,
bayramovfe3f3c92016-10-04 07:53:41 +04001306 media_name=filename, medial_file_name=path, progress=progress)
bayramov325fa1c2016-09-08 01:42:46 -07001307 if not result:
bayramovb6ffe792016-09-28 11:50:56 +04001308 raise vimconn.vimconnException("Failed create vApp template for catalog {} ".format(catalog_name))
kasarc5bf2932018-03-09 04:15:22 -08001309 return self.get_catalogid(catalog_name, catalogs)
bayramov325fa1c2016-09-08 01:42:46 -07001310 else:
1311 for catalog in catalogs:
1312 # search for existing catalog if we find same name we return ID
1313 # TODO optimize this
kasarc5bf2932018-03-09 04:15:22 -08001314 if catalog['name'] == catalog_md5_name:
kate15f1c382016-12-15 01:12:40 -08001315 self.logger.debug("Found existing catalog entry for {} "
1316 "catalog id {}".format(catalog_name,
1317 self.get_catalogid(catalog_md5_name, catalogs)))
kasarc5bf2932018-03-09 04:15:22 -08001318 return self.get_catalogid(catalog_md5_name, catalogs)
bayramov325fa1c2016-09-08 01:42:46 -07001319
bayramovfe3f3c92016-10-04 07:53:41 +04001320 # if we didn't find existing catalog we create a new one and upload image.
kate15f1c382016-12-15 01:12:40 -08001321 self.logger.debug("Creating new catalog entry {} - {}".format(catalog_name, catalog_md5_name))
kasarc5bf2932018-03-09 04:15:22 -08001322 result = self.create_vimcatalog(org, catalog_md5_name)
bayramov325fa1c2016-09-08 01:42:46 -07001323 if not result:
kate15f1c382016-12-15 01:12:40 -08001324 raise vimconn.vimconnException("Failed create new catalog {} ".format(catalog_md5_name))
bayramovfe3f3c92016-10-04 07:53:41 +04001325
kasarc5bf2932018-03-09 04:15:22 -08001326 result = self.upload_vimimage(vca=org, catalog_name=catalog_md5_name,
bayramovfe3f3c92016-10-04 07:53:41 +04001327 media_name=filename, medial_file_name=path, progress=progress)
bayramov325fa1c2016-09-08 01:42:46 -07001328 if not result:
kate15f1c382016-12-15 01:12:40 -08001329 raise vimconn.vimconnException("Failed create vApp template for catalog {} ".format(catalog_md5_name))
bayramov325fa1c2016-09-08 01:42:46 -07001330
kasarc5bf2932018-03-09 04:15:22 -08001331 return self.get_catalogid(catalog_md5_name, org.list_catalogs())
bayramov325fa1c2016-09-08 01:42:46 -07001332
kate8fc61fc2017-01-23 19:57:06 -08001333 def get_image_list(self, filter_dict={}):
1334 '''Obtain tenant images from VIM
1335 Filter_dict can be:
1336 name: image name
1337 id: image uuid
1338 checksum: image checksum
1339 location: image path
1340 Returns the image list of dictionaries:
1341 [{<the fields at Filter_dict plus some VIM specific>}, ...]
1342 List can be empty
1343 '''
bhangare1a0b97c2017-06-21 02:20:15 -07001344
kate8fc61fc2017-01-23 19:57:06 -08001345 try:
kasarc5bf2932018-03-09 04:15:22 -08001346 org, vdc = self.get_vdc_details()
kate8fc61fc2017-01-23 19:57:06 -08001347 image_list = []
kasarc5bf2932018-03-09 04:15:22 -08001348 catalogs = org.list_catalogs()
kate8fc61fc2017-01-23 19:57:06 -08001349 if len(catalogs) == 0:
1350 return image_list
1351 else:
1352 for catalog in catalogs:
kasarc5bf2932018-03-09 04:15:22 -08001353 catalog_uuid = catalog.get('id')
1354 name = catalog.get('name')
kate8fc61fc2017-01-23 19:57:06 -08001355 filtered_dict = {}
kate34718682017-01-24 03:20:43 -08001356 if filter_dict.get("name") and filter_dict["name"] != name:
1357 continue
1358 if filter_dict.get("id") and filter_dict["id"] != catalog_uuid:
1359 continue
1360 filtered_dict ["name"] = name
1361 filtered_dict ["id"] = catalog_uuid
1362 image_list.append(filtered_dict)
kate8fc61fc2017-01-23 19:57:06 -08001363
1364 self.logger.debug("List of already created catalog items: {}".format(image_list))
1365 return image_list
1366 except Exception as exp:
kated63062f2017-01-24 07:26:52 -08001367 raise vimconn.vimconnException("Exception occured while retriving catalog items {}".format(exp))
kate8fc61fc2017-01-23 19:57:06 -08001368
bayramovef390722016-09-27 03:34:46 -07001369 def get_vappid(self, vdc=None, vapp_name=None):
1370 """ Method takes vdc object and vApp name and returns vapp uuid or None
1371
1372 Args:
bayramovef390722016-09-27 03:34:46 -07001373 vdc: The VDC object.
1374 vapp_name: is application vappp name identifier
1375
bayramovb6ffe792016-09-28 11:50:56 +04001376 Returns:
bayramovef390722016-09-27 03:34:46 -07001377 The return vApp name otherwise None
1378 """
bayramovef390722016-09-27 03:34:46 -07001379 if vdc is None or vapp_name is None:
1380 return None
1381 # UUID has following format https://host/api/vApp/vapp-30da58a3-e7c7-4d09-8f68-d4c8201169cf
bayramov325fa1c2016-09-08 01:42:46 -07001382 try:
1383 refs = filter(lambda ref: ref.name == vapp_name and ref.type_ == 'application/vnd.vmware.vcloud.vApp+xml',
bayramovef390722016-09-27 03:34:46 -07001384 vdc.ResourceEntities.ResourceEntity)
kasarc5bf2932018-03-09 04:15:22 -08001385 #For python3
1386 #refs = [ref for ref in vdc.ResourceEntities.ResourceEntity\
1387 # if ref.name == vapp_name and ref.type_ == 'application/vnd.vmware.vcloud.vApp+xml']
bayramov325fa1c2016-09-08 01:42:46 -07001388 if len(refs) == 1:
1389 return refs[0].href.split("vapp")[1][1:]
bayramovef390722016-09-27 03:34:46 -07001390 except Exception as e:
1391 self.logger.exception(e)
1392 return False
1393 return None
1394
bayramovfe3f3c92016-10-04 07:53:41 +04001395 def check_vapp(self, vdc=None, vapp_uuid=None):
1396 """ Method Method returns True or False if vapp deployed in vCloud director
bayramovef390722016-09-27 03:34:46 -07001397
1398 Args:
1399 vca: Connector to VCA
1400 vdc: The VDC object.
1401 vappid: vappid is application identifier
1402
1403 Returns:
bayramovfe3f3c92016-10-04 07:53:41 +04001404 The return True if vApp deployed
bayramov5761ad12016-10-04 09:00:30 +04001405 :param vdc:
1406 :param vapp_uuid:
bayramovef390722016-09-27 03:34:46 -07001407 """
1408 try:
1409 refs = filter(lambda ref:
1410 ref.type_ == 'application/vnd.vmware.vcloud.vApp+xml',
1411 vdc.ResourceEntities.ResourceEntity)
kasarc5bf2932018-03-09 04:15:22 -08001412 #For python3
1413 #refs = [ref for ref in vdc.ResourceEntities.ResourceEntity\
1414 # if ref.type_ == 'application/vnd.vmware.vcloud.vApp+xml']
bayramovef390722016-09-27 03:34:46 -07001415 for ref in refs:
1416 vappid = ref.href.split("vapp")[1][1:]
1417 # find vapp with respected vapp uuid
bayramovfe3f3c92016-10-04 07:53:41 +04001418 if vappid == vapp_uuid:
bayramovef390722016-09-27 03:34:46 -07001419 return True
1420 except Exception as e:
1421 self.logger.exception(e)
1422 return False
1423 return False
1424
kasarc5bf2932018-03-09 04:15:22 -08001425 def get_namebyvappid(self, vapp_uuid=None):
bayramovef390722016-09-27 03:34:46 -07001426 """Method returns vApp name from vCD and lookup done by vapp_id.
1427
1428 Args:
bayramovfe3f3c92016-10-04 07:53:41 +04001429 vapp_uuid: vappid is application identifier
bayramovef390722016-09-27 03:34:46 -07001430
1431 Returns:
1432 The return vApp name otherwise None
1433 """
bayramovef390722016-09-27 03:34:46 -07001434 try:
kasarc5bf2932018-03-09 04:15:22 -08001435 if self.client and vapp_uuid:
1436 vapp_call = "{}/api/vApp/vapp-{}".format(self.url, vapp_uuid)
1437 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
1438 'x-vcloud-authorization': self.client._session.headers['x-vcloud-authorization']}
bhangare1a0b97c2017-06-21 02:20:15 -07001439
kasarc5bf2932018-03-09 04:15:22 -08001440 response = self.perform_request(req_type='GET',
1441 url=vapp_call,
1442 headers=headers)
1443 #Retry login if session expired & retry sending request
1444 if response.status_code == 403:
1445 response = self.retry_rest('GET', vapp_call)
bhangare1a0b97c2017-06-21 02:20:15 -07001446
kasarc5bf2932018-03-09 04:15:22 -08001447 tree = XmlElementTree.fromstring(response.content)
1448 return tree.attrib['name']
bayramovef390722016-09-27 03:34:46 -07001449 except Exception as e:
1450 self.logger.exception(e)
bayramov325fa1c2016-09-08 01:42:46 -07001451 return None
1452 return None
1453
tierno19860412017-10-03 10:46:46 +02001454 def new_vminstance(self, name=None, description="", start=False, image_id=None, flavor_id=None, net_list=[],
tierno5a3273c2017-08-29 11:43:46 +02001455 cloud_config=None, disk_list=None, availability_zone_index=None, availability_zone_list=None):
bayramov325fa1c2016-09-08 01:42:46 -07001456 """Adds a VM instance to VIM
1457 Params:
tierno19860412017-10-03 10:46:46 +02001458 'start': (boolean) indicates if VM must start or created in pause mode.
1459 'image_id','flavor_id': image and flavor VIM id to use for the VM
1460 'net_list': list of interfaces, each one is a dictionary with:
1461 'name': (optional) name for the interface.
1462 'net_id': VIM network id where this interface must be connect to. Mandatory for type==virtual
1463 'vpci': (optional) virtual vPCI address to assign at the VM. Can be ignored depending on VIM capabilities
1464 'model': (optional and only have sense for type==virtual) interface model: virtio, e2000, ...
1465 'mac_address': (optional) mac address to assign to this interface
1466 #TODO: CHECK if an optional 'vlan' parameter is needed for VIMs when type if VF and net_id is not provided,
1467 the VLAN tag to be used. In case net_id is provided, the internal network vlan is used for tagging VF
1468 'type': (mandatory) can be one of:
1469 'virtual', in this case always connected to a network of type 'net_type=bridge'
tierno66eba6e2017-11-10 17:09:18 +01001470 'PCI-PASSTHROUGH' or 'PF' (passthrough): depending on VIM capabilities it can be connected to a data/ptp network ot it
tierno19860412017-10-03 10:46:46 +02001471 can created unconnected
tierno66eba6e2017-11-10 17:09:18 +01001472 'SR-IOV' or 'VF' (SRIOV with VLAN tag): same as PF for network connectivity.
tierno19860412017-10-03 10:46:46 +02001473 'VFnotShared'(SRIOV without VLAN tag) same as PF for network connectivity. VF where no other VFs
1474 are allocated on the same physical NIC
1475 'bw': (optional) only for PF/VF/VFnotShared. Minimal Bandwidth required for the interface in GBPS
1476 'port_security': (optional) If False it must avoid any traffic filtering at this interface. If missing
1477 or True, it must apply the default VIM behaviour
1478 After execution the method will add the key:
1479 'vim_id': must be filled/added by this method with the VIM identifier generated by the VIM for this
1480 interface. 'net_list' is modified
1481 'cloud_config': (optional) dictionary with:
1482 'key-pairs': (optional) list of strings with the public key to be inserted to the default user
1483 'users': (optional) list of users to be inserted, each item is a dict with:
1484 'name': (mandatory) user name,
1485 'key-pairs': (optional) list of strings with the public key to be inserted to the user
1486 'user-data': (optional) can be a string with the text script to be passed directly to cloud-init,
1487 or a list of strings, each one contains a script to be passed, usually with a MIMEmultipart file
1488 'config-files': (optional). List of files to be transferred. Each item is a dict with:
1489 'dest': (mandatory) string with the destination absolute path
1490 'encoding': (optional, by default text). Can be one of:
1491 'b64', 'base64', 'gz', 'gz+b64', 'gz+base64', 'gzip+b64', 'gzip+base64'
1492 'content' (mandatory): string with the content of the file
1493 'permissions': (optional) string with file permissions, typically octal notation '0644'
1494 'owner': (optional) file owner, string with the format 'owner:group'
1495 'boot-data-drive': boolean to indicate if user-data must be passed using a boot drive (hard disk)
1496 'disk_list': (optional) list with additional disks to the VM. Each item is a dict with:
1497 'image_id': (optional). VIM id of an existing image. If not provided an empty disk must be mounted
1498 'size': (mandatory) string with the size of the disk in GB
1499 availability_zone_index: Index of availability_zone_list to use for this this VM. None if not AV required
1500 availability_zone_list: list of availability zones given by user in the VNFD descriptor. Ignore if
1501 availability_zone_index is None
tierno98e909c2017-10-14 13:27:03 +02001502 Returns a tuple with the instance identifier and created_items or raises an exception on error
1503 created_items can be None or a dictionary where this method can include key-values that will be passed to
1504 the method delete_vminstance and action_vminstance. Can be used to store created ports, volumes, etc.
1505 Format is vimconnector dependent, but do not use nested dictionaries and a value of None should be the same
1506 as not present.
bayramov325fa1c2016-09-08 01:42:46 -07001507 """
kate15f1c382016-12-15 01:12:40 -08001508 self.logger.info("Creating new instance for entry {}".format(name))
bhangare06312472017-03-30 05:49:07 -07001509 self.logger.debug("desc {} boot {} image_id: {} flavor_id: {} net_list: {} cloud_config {} disk_list {}".format(
1510 description, start, image_id, flavor_id, net_list, cloud_config, disk_list))
bayramov325fa1c2016-09-08 01:42:46 -07001511
bayramov5761ad12016-10-04 09:00:30 +04001512 #new vm name = vmname + tenant_id + uuid
1513 new_vm_name = [name, '-', str(uuid.uuid4())]
kate15f1c382016-12-15 01:12:40 -08001514 vmname_andid = ''.join(new_vm_name)
bayramov5761ad12016-10-04 09:00:30 +04001515
kasarc5bf2932018-03-09 04:15:22 -08001516 for net in net_list:
1517 if net['type'] == "SR-IOV" or net['type'] == "PCI-PASSTHROUGH":
1518 raise vimconn.vimconnNotSupportedException(
1519 "Current vCD version does not support type : {}".format(net['type']))
bayramov325fa1c2016-09-08 01:42:46 -07001520
kasarc5bf2932018-03-09 04:15:22 -08001521 if len(net_list) > 10:
1522 raise vimconn.vimconnNotSupportedException(
1523 "The VM hardware versions 7 and above support upto 10 NICs only")
1524
1525 # if vm already deployed we return existing uuid
bayramovef390722016-09-27 03:34:46 -07001526 # we check for presence of VDC, Catalog entry and Flavor.
kasarc5bf2932018-03-09 04:15:22 -08001527 org, vdc = self.get_vdc_details()
bayramovef390722016-09-27 03:34:46 -07001528 if vdc is None:
bayramovfe3f3c92016-10-04 07:53:41 +04001529 raise vimconn.vimconnNotFoundException(
bayramovb6ffe792016-09-28 11:50:56 +04001530 "new_vminstance(): Failed create vApp {}: (Failed retrieve VDC information)".format(name))
kasarc5bf2932018-03-09 04:15:22 -08001531 catalogs = org.list_catalogs()
bhangare1a0b97c2017-06-21 02:20:15 -07001532 if catalogs is None:
1533 #Retry once, if failed by refreshing token
1534 self.get_token()
kasarc5bf2932018-03-09 04:15:22 -08001535 org = Org(self.client, resource=self.client.get_org())
1536 catalogs = org.list_catalogs()
bayramovef390722016-09-27 03:34:46 -07001537 if catalogs is None:
bayramovfe3f3c92016-10-04 07:53:41 +04001538 raise vimconn.vimconnNotFoundException(
kate15f1c382016-12-15 01:12:40 -08001539 "new_vminstance(): Failed create vApp {}: (Failed retrieve catalogs list)".format(name))
bayramovbd6160f2016-09-28 04:12:05 +04001540
kate15f1c382016-12-15 01:12:40 -08001541 catalog_hash_name = self.get_catalogbyid(catalog_uuid=image_id, catalogs=catalogs)
1542 if catalog_hash_name:
1543 self.logger.info("Found catalog entry {} for image id {}".format(catalog_hash_name, image_id))
1544 else:
1545 raise vimconn.vimconnNotFoundException("new_vminstance(): Failed create vApp {}: "
1546 "(Failed retrieve catalog information {})".format(name, image_id))
1547
1548
1549 # Set vCPU and Memory based on flavor.
bayramovb6ffe792016-09-28 11:50:56 +04001550 vm_cpus = None
1551 vm_memory = None
bhangarea92ae392017-01-12 22:30:29 -08001552 vm_disk = None
bhangare68e73e62017-07-04 22:44:01 -07001553 numas = None
kateac1e3792017-04-01 02:16:39 -07001554
bayramovb6ffe792016-09-28 11:50:56 +04001555 if flavor_id is not None:
kateeb044522017-03-06 23:54:39 -08001556 if flavor_id not in vimconnector.flavorlist:
kate15f1c382016-12-15 01:12:40 -08001557 raise vimconn.vimconnNotFoundException("new_vminstance(): Failed create vApp {}: "
1558 "Failed retrieve flavor information "
1559 "flavor id {}".format(name, flavor_id))
bayramovb6ffe792016-09-28 11:50:56 +04001560 else:
1561 try:
kateeb044522017-03-06 23:54:39 -08001562 flavor = vimconnector.flavorlist[flavor_id]
kate15f1c382016-12-15 01:12:40 -08001563 vm_cpus = flavor[FLAVOR_VCPUS_KEY]
1564 vm_memory = flavor[FLAVOR_RAM_KEY]
bhangarea92ae392017-01-12 22:30:29 -08001565 vm_disk = flavor[FLAVOR_DISK_KEY]
bhangarefda5f7c2017-01-12 23:50:34 -08001566 extended = flavor.get("extended", None)
1567 if extended:
1568 numas=extended.get("numas", None)
kateac1e3792017-04-01 02:16:39 -07001569
kateeb044522017-03-06 23:54:39 -08001570 except Exception as exp:
1571 raise vimconn.vimconnException("Corrupted flavor. {}.Exception: {}".format(flavor_id, exp))
bayramov325fa1c2016-09-08 01:42:46 -07001572
bayramovef390722016-09-27 03:34:46 -07001573 # image upload creates template name as catalog name space Template.
kate15f1c382016-12-15 01:12:40 -08001574 templateName = self.get_catalogbyid(catalog_uuid=image_id, catalogs=catalogs)
bayramovef390722016-09-27 03:34:46 -07001575 power_on = 'false'
1576 if start:
1577 power_on = 'true'
1578
1579 # client must provide at least one entry in net_list if not we report error
bhangare0e571a92017-01-12 04:02:23 -08001580 #If net type is mgmt, then configure it as primary net & use its NIC index as primary NIC
1581 #If no mgmt, then the 1st NN in netlist is considered as primary net.
1582 primary_net = None
kate15f1c382016-12-15 01:12:40 -08001583 primary_netname = None
1584 network_mode = 'bridged'
bayramovb6ffe792016-09-28 11:50:56 +04001585 if net_list is not None and len(net_list) > 0:
bhangare0e571a92017-01-12 04:02:23 -08001586 for net in net_list:
tierno19860412017-10-03 10:46:46 +02001587 if 'use' in net and net['use'] == 'mgmt' and not primary_net:
bhangare0e571a92017-01-12 04:02:23 -08001588 primary_net = net
bayramovb6ffe792016-09-28 11:50:56 +04001589 if primary_net is None:
bhangare0e571a92017-01-12 04:02:23 -08001590 primary_net = net_list[0]
1591
1592 try:
1593 primary_net_id = primary_net['net_id']
1594 network_dict = self.get_vcd_network(network_uuid=primary_net_id)
1595 if 'name' in network_dict:
1596 primary_netname = network_dict['name']
1597
1598 except KeyError:
1599 raise vimconn.vimconnException("Corrupted flavor. {}".format(primary_net))
1600 else:
1601 raise vimconn.vimconnUnexpectedResponse("new_vminstance(): Failed network list is empty.".format(name))
bayramovef390722016-09-27 03:34:46 -07001602
1603 # use: 'data', 'bridge', 'mgmt'
1604 # create vApp. Set vcpu and ram based on flavor id.
bhangarebfdca492017-03-11 01:32:46 -08001605 try:
kasarc5bf2932018-03-09 04:15:22 -08001606 vdc_obj = VDC(self.client, resource=org.get_vdc(self.tenant_name))
1607 if not vdc_obj:
1608 raise vimconn.vimconnNotFoundException("new_vminstance(): Failed to get VDC object")
bhangare1a0b97c2017-06-21 02:20:15 -07001609
kasarc5bf2932018-03-09 04:15:22 -08001610 for retry in (1,2):
1611 items = org.get_catalog_item(catalog_hash_name, catalog_hash_name)
1612 catalog_items = [items.attrib]
1613
1614 if len(catalog_items) == 1:
1615 if self.client:
1616 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
1617 'x-vcloud-authorization': self.client._session.headers['x-vcloud-authorization']}
1618
1619 response = self.perform_request(req_type='GET',
1620 url=catalog_items[0].get('href'),
1621 headers=headers)
1622 catalogItem = XmlElementTree.fromstring(response.content)
1623 entity = [child for child in catalogItem if child.get("type") == "application/vnd.vmware.vcloud.vAppTemplate+xml"][0]
1624 vapp_tempalte_href = entity.get("href")
1625
1626 response = self.perform_request(req_type='GET',
1627 url=vapp_tempalte_href,
1628 headers=headers)
1629 if response.status_code != requests.codes.ok:
1630 self.logger.debug("REST API call {} failed. Return status code {}".format(vapp_tempalte_href,
1631 response.status_code))
1632 else:
1633 result = (response.content).replace("\n"," ")
1634
1635 src = re.search('<Vm goldMaster="false"\sstatus="\d+"\sname="(.*?)"\s'
1636 'id="(\w+:\w+:vm:.*?)"\shref="(.*?)"\s'
1637 'type="application/vnd\.vmware\.vcloud\.vm\+xml',result)
1638 if src:
1639 vm_name = src.group(1)
1640 vm_id = src.group(2)
1641 vm_href = src.group(3)
1642
1643 cpus = re.search('<rasd:Description>Number of Virtual CPUs</.*?>(\d+)</rasd:VirtualQuantity>',result).group(1)
1644 memory_mb = re.search('<rasd:Description>Memory Size</.*?>(\d+)</rasd:VirtualQuantity>',result).group(1)
1645 cores = re.search('<vmw:CoresPerSocket ovf:required.*?>(\d+)</vmw:CoresPerSocket>',result).group(1)
1646
1647 headers['Content-Type'] = 'application/vnd.vmware.vcloud.instantiateVAppTemplateParams+xml'
1648 vdc_id = vdc.get('id').split(':')[-1]
1649 instantiate_vapp_href = "{}/api/vdc/{}/action/instantiateVAppTemplate".format(self.url,
1650 vdc_id)
1651 data = """<?xml version="1.0" encoding="UTF-8"?>
1652 <InstantiateVAppTemplateParams
1653 xmlns="http://www.vmware.com/vcloud/v1.5"
1654 name="{}"
1655 deploy="false"
1656 powerOn="false"
1657 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
1658 xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1">
1659 <Description>Vapp instantiation</Description>
1660 <InstantiationParams>
1661 <NetworkConfigSection>
1662 <ovf:Info>Configuration parameters for logical networks</ovf:Info>
1663 <NetworkConfig networkName="None">
1664 <Configuration>
1665 <ParentNetwork href=""/>
1666 <FenceMode>bridged</FenceMode>
1667 </Configuration>
1668 </NetworkConfig>
1669 </NetworkConfigSection>
1670 <LeaseSettingsSection
1671 type="application/vnd.vmware.vcloud.leaseSettingsSection+xml">
1672 <ovf:Info>Lease Settings</ovf:Info>
1673 <StorageLeaseInSeconds>172800</StorageLeaseInSeconds>
1674 <StorageLeaseExpiration>2014-04-25T08:08:16.438-07:00</StorageLeaseExpiration>
1675 </LeaseSettingsSection>
1676 </InstantiationParams>
1677 <Source href="{}"/>
1678 <SourcedItem>
1679 <Source href="{}" id="{}" name="{}"
1680 type="application/vnd.vmware.vcloud.vm+xml"/>
1681 <VmGeneralParams>
1682 <NeedsCustomization>false</NeedsCustomization>
1683 </VmGeneralParams>
1684 <InstantiationParams>
1685 <NetworkConnectionSection>
1686 <ovf:Info>Specifies the available VM network connections</ovf:Info>
1687 <NetworkConnection network="{}">
1688 <NetworkConnectionIndex>0</NetworkConnectionIndex>
1689 <IsConnected>true</IsConnected>
1690 <IpAddressAllocationMode>DHCP</IpAddressAllocationMode>
1691 </NetworkConnection>
1692 </NetworkConnectionSection><ovf:VirtualHardwareSection>
1693 <ovf:Info>Virtual hardware requirements</ovf:Info>
1694 <ovf:Item xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData"
1695 xmlns:vmw="http://www.vmware.com/schema/ovf">
1696 <rasd:AllocationUnits>hertz * 10^6</rasd:AllocationUnits>
1697 <rasd:Description>Number of Virtual CPUs</rasd:Description>
1698 <rasd:ElementName xmlns:py="http://codespeak.net/lxml/objectify/pytype" py:pytype="str">{cpu} virtual CPU(s)</rasd:ElementName>
1699 <rasd:InstanceID>4</rasd:InstanceID>
1700 <rasd:Reservation>0</rasd:Reservation>
1701 <rasd:ResourceType>3</rasd:ResourceType>
1702 <rasd:VirtualQuantity xmlns:py="http://codespeak.net/lxml/objectify/pytype" py:pytype="int">{cpu}</rasd:VirtualQuantity>
1703 <rasd:Weight>0</rasd:Weight>
1704 <vmw:CoresPerSocket ovf:required="false">{core}</vmw:CoresPerSocket>
1705 </ovf:Item><ovf:Item xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData">
1706 <rasd:AllocationUnits>byte * 2^20</rasd:AllocationUnits>
1707 <rasd:Description>Memory Size</rasd:Description>
1708 <rasd:ElementName xmlns:py="http://codespeak.net/lxml/objectify/pytype" py:pytype="str">{memory} MB of memory</rasd:ElementName>
1709 <rasd:InstanceID>5</rasd:InstanceID>
1710 <rasd:Reservation>0</rasd:Reservation>
1711 <rasd:ResourceType>4</rasd:ResourceType>
1712 <rasd:VirtualQuantity xmlns:py="http://codespeak.net/lxml/objectify/pytype" py:pytype="int">{memory}</rasd:VirtualQuantity>
1713 <rasd:Weight>0</rasd:Weight>
1714 </ovf:Item>
1715 </ovf:VirtualHardwareSection>
1716 </InstantiationParams>
1717 </SourcedItem>
1718 <AllEULAsAccepted>false</AllEULAsAccepted>
1719 </InstantiateVAppTemplateParams>""".format(vmname_andid,
1720 vapp_tempalte_href,
1721 vm_href,
1722 vm_id,
1723 vm_name,
1724 primary_netname,
1725 cpu=cpus,
1726 core=cores,
1727 memory=memory_mb)
1728
1729 response = self.perform_request(req_type='POST',
1730 url=instantiate_vapp_href,
1731 headers=headers,
1732 data=data)
1733
1734 if response.status_code != 201:
1735 self.logger.error("REST call {} failed reason : {}"\
1736 "status code : {}".format(instantiate_vapp_href,
1737 response.content,
1738 response.status_code))
1739 raise vimconn.vimconnException("new_vminstance(): Failed to create"\
1740 "vAapp {}".format(vmname_andid))
1741 else:
1742 vapptask = self.get_task_from_response(response.content)
1743
1744 if vapptask is None and retry==1:
bhangare68e73e62017-07-04 22:44:01 -07001745 self.get_token() # Retry getting token
1746 continue
1747 else:
1748 break
1749
bhangare1a0b97c2017-06-21 02:20:15 -07001750 if vapptask is None or vapptask is False:
bhangarebfdca492017-03-11 01:32:46 -08001751 raise vimconn.vimconnUnexpectedResponse(
1752 "new_vminstance(): failed to create vApp {}".format(vmname_andid))
kasarc5bf2932018-03-09 04:15:22 -08001753
1754 # wait for task to complete
1755 result = self.client.get_task_monitor().wait_for_success(task=vapptask)
1756
1757 if result.get('status') == 'success':
1758 self.logger.debug("new_vminstance(): Sucessfully created Vapp {}".format(vmname_andid))
1759 else:
1760 raise vimconn.vimconnUnexpectedResponse(
1761 "new_vminstance(): failed to create vApp {}".format(vmname_andid))
bhangarebfdca492017-03-11 01:32:46 -08001762
1763 except Exception as exp:
1764 raise vimconn.vimconnUnexpectedResponse(
1765 "new_vminstance(): failed to create vApp {} with Exception:{}".format(vmname_andid, exp))
bayramovef390722016-09-27 03:34:46 -07001766
1767 # we should have now vapp in undeployed state.
bhangarebfdca492017-03-11 01:32:46 -08001768 try:
kasarc5bf2932018-03-09 04:15:22 -08001769 vdc_obj = VDC(self.client, href=vdc.get('href'))
1770 vapp_resource = vdc_obj.get_vapp(vmname_andid)
1771 vapp_uuid = vapp_resource.get('id').split(':')[-1]
1772 vapp = VApp(self.client, resource=vapp_resource)
bhangare1a0b97c2017-06-21 02:20:15 -07001773
bhangarebfdca492017-03-11 01:32:46 -08001774 except Exception as exp:
1775 raise vimconn.vimconnUnexpectedResponse(
1776 "new_vminstance(): Failed to retrieve vApp {} after creation: Exception:{}"
1777 .format(vmname_andid, exp))
1778
bhangare1a0b97c2017-06-21 02:20:15 -07001779 if vapp_uuid is None:
bayramovbd6160f2016-09-28 04:12:05 +04001780 raise vimconn.vimconnUnexpectedResponse(
bhangarebfdca492017-03-11 01:32:46 -08001781 "new_vminstance(): Failed to retrieve vApp {} after creation".format(
bhangarea92ae392017-01-12 22:30:29 -08001782 vmname_andid))
1783
kateac1e3792017-04-01 02:16:39 -07001784 #Add PCI passthrough/SRIOV configrations
bhangarefda5f7c2017-01-12 23:50:34 -08001785 vm_obj = None
kateac1e3792017-04-01 02:16:39 -07001786 pci_devices_info = []
1787 sriov_net_info = []
1788 reserve_memory = False
1789
1790 for net in net_list:
tierno66eba6e2017-11-10 17:09:18 +01001791 if net["type"] == "PF" or net["type"] == "PCI-PASSTHROUGH":
kateac1e3792017-04-01 02:16:39 -07001792 pci_devices_info.append(net)
tierno66eba6e2017-11-10 17:09:18 +01001793 elif (net["type"] == "VF" or net["type"] == "SR-IOV" or net["type"] == "VFnotShared") and 'net_id'in net:
kateac1e3792017-04-01 02:16:39 -07001794 sriov_net_info.append(net)
1795
1796 #Add PCI
bhangarefda5f7c2017-01-12 23:50:34 -08001797 if len(pci_devices_info) > 0:
1798 self.logger.info("Need to add PCI devices {} into VM {}".format(pci_devices_info,
1799 vmname_andid ))
1800 PCI_devices_status, vm_obj, vcenter_conect = self.add_pci_devices(vapp_uuid,
1801 pci_devices_info,
1802 vmname_andid)
1803 if PCI_devices_status:
1804 self.logger.info("Added PCI devives {} to VM {}".format(
1805 pci_devices_info,
1806 vmname_andid)
1807 )
kateac1e3792017-04-01 02:16:39 -07001808 reserve_memory = True
bhangarefda5f7c2017-01-12 23:50:34 -08001809 else:
1810 self.logger.info("Fail to add PCI devives {} to VM {}".format(
1811 pci_devices_info,
1812 vmname_andid)
1813 )
bhangare1a0b97c2017-06-21 02:20:15 -07001814
bhangare06312472017-03-30 05:49:07 -07001815 # Modify vm disk
bhangarea92ae392017-01-12 22:30:29 -08001816 if vm_disk:
1817 #Assuming there is only one disk in ovf and fast provisioning in organization vDC is disabled
1818 result = self.modify_vm_disk(vapp_uuid, vm_disk)
1819 if result :
1820 self.logger.debug("Modified Disk size of VM {} ".format(vmname_andid))
bayramovef390722016-09-27 03:34:46 -07001821
bhangare06312472017-03-30 05:49:07 -07001822 #Add new or existing disks to vApp
1823 if disk_list:
1824 added_existing_disk = False
1825 for disk in disk_list:
kasar0c007d62017-05-19 03:13:57 -07001826 if 'device_type' in disk and disk['device_type'] == 'cdrom':
1827 image_id = disk['image_id']
1828 # Adding CD-ROM to VM
1829 # will revisit code once specification ready to support this feature
1830 self.insert_media_to_vm(vapp, image_id)
1831 elif "image_id" in disk and disk["image_id"] is not None:
bhangare06312472017-03-30 05:49:07 -07001832 self.logger.debug("Adding existing disk from image {} to vm {} ".format(
1833 disk["image_id"] , vapp_uuid))
1834 self.add_existing_disk(catalogs=catalogs,
1835 image_id=disk["image_id"],
1836 size = disk["size"],
1837 template_name=templateName,
1838 vapp_uuid=vapp_uuid
1839 )
1840 added_existing_disk = True
1841 else:
1842 #Wait till added existing disk gets reflected into vCD database/API
1843 if added_existing_disk:
1844 time.sleep(5)
1845 added_existing_disk = False
bhangare1a0b97c2017-06-21 02:20:15 -07001846 self.add_new_disk(vapp_uuid, disk['size'])
bhangare06312472017-03-30 05:49:07 -07001847
kasarde691232017-03-25 03:37:31 -07001848 if numas:
1849 # Assigning numa affinity setting
1850 for numa in numas:
1851 if 'paired-threads-id' in numa:
1852 paired_threads_id = numa['paired-threads-id']
1853 self.set_numa_affinity(vapp_uuid, paired_threads_id)
1854
bhangare0e571a92017-01-12 04:02:23 -08001855 # add NICs & connect to networks in netlist
bayramovef390722016-09-27 03:34:46 -07001856 try:
kate15f1c382016-12-15 01:12:40 -08001857 self.logger.info("Request to connect VM to a network: {}".format(net_list))
bayramovef390722016-09-27 03:34:46 -07001858 nicIndex = 0
bhangare0e571a92017-01-12 04:02:23 -08001859 primary_nic_index = 0
bayramovef390722016-09-27 03:34:46 -07001860 for net in net_list:
1861 # openmano uses network id in UUID format.
1862 # vCloud Director need a name so we do reverse operation from provided UUID we lookup a name
kate15f1c382016-12-15 01:12:40 -08001863 # [{'use': 'bridge', 'net_id': '527d4bf7-566a-41e7-a9e7-ca3cdd9cef4f', 'type': 'virtual',
1864 # 'vpci': '0000:00:11.0', 'name': 'eth0'}]
1865
1866 if 'net_id' not in net:
1867 continue
1868
bhangare97b192d2017-10-05 00:51:15 -07001869 #Using net_id as a vim_id i.e. vim interface id, as do not have saperate vim interface id
1870 #Same will be returned in refresh_vms_status() as vim_interface_id
1871 net['vim_id'] = net['net_id'] # Provide the same VIM identifier as the VIM network
tierno19860412017-10-03 10:46:46 +02001872
bayramovef390722016-09-27 03:34:46 -07001873 interface_net_id = net['net_id']
kate15f1c382016-12-15 01:12:40 -08001874 interface_net_name = self.get_network_name_by_id(network_uuid=interface_net_id)
bayramovef390722016-09-27 03:34:46 -07001875 interface_network_mode = net['use']
1876
bhangare0e571a92017-01-12 04:02:23 -08001877 if interface_network_mode == 'mgmt':
1878 primary_nic_index = nicIndex
1879
kate15f1c382016-12-15 01:12:40 -08001880 """- POOL (A static IP address is allocated automatically from a pool of addresses.)
1881 - DHCP (The IP address is obtained from a DHCP service.)
1882 - MANUAL (The IP address is assigned manually in the IpAddress element.)
1883 - NONE (No IP addressing mode specified.)"""
1884
1885 if primary_netname is not None:
kasarc5bf2932018-03-09 04:15:22 -08001886 nets = filter(lambda n: n.get('name') == interface_net_name, self.get_network_list())
1887 #For python3
1888 #nets = [n for n in self.get_network_list() if n.get('name') == interface_net_name]
bayramovef390722016-09-27 03:34:46 -07001889 if len(nets) == 1:
kasarc5bf2932018-03-09 04:15:22 -08001890 self.logger.info("new_vminstance(): Found requested network: {}".format(nets[0].get('name')))
bhangare1a0b97c2017-06-21 02:20:15 -07001891
kasarc5bf2932018-03-09 04:15:22 -08001892 vdc_obj = VDC(self.client, href=vdc.get('href'))
1893 vapp_resource = vdc_obj.get_vapp(vmname_andid)
1894 vapp = VApp(self.client, resource=vapp_resource)
bhangare0e571a92017-01-12 04:02:23 -08001895 # connect network to VM - with all DHCP by default
kasarc5bf2932018-03-09 04:15:22 -08001896 task = vapp.connect_org_vdc_network(nets[0].get('name'))
1897
1898 self.client.get_task_monitor().wait_for_success(task=task)
kasar3ac5dc42017-03-15 06:28:22 -07001899
tierno66eba6e2017-11-10 17:09:18 +01001900 type_list = ('PF', 'PCI-PASSTHROUGH', 'VF', 'SR-IOV', 'VFnotShared')
kasar3ac5dc42017-03-15 06:28:22 -07001901 if 'type' in net and net['type'] not in type_list:
1902 # fetching nic type from vnf
1903 if 'model' in net:
kasarc5bf2932018-03-09 04:15:22 -08001904 if net['model'] is not None and net['model'].lower() == 'virtio':
kasar204e39e2018-01-25 00:57:02 -08001905 nic_type = 'VMXNET3'
1906 else:
1907 nic_type = net['model']
1908
kasar3ac5dc42017-03-15 06:28:22 -07001909 self.logger.info("new_vminstance(): adding network adapter "\
kasarc5bf2932018-03-09 04:15:22 -08001910 "to a network {}".format(nets[0].get('name')))
1911 self.add_network_adapter_to_vms(vapp, nets[0].get('name'),
kasar3ac5dc42017-03-15 06:28:22 -07001912 primary_nic_index,
1913 nicIndex,
kasardc1f02e2017-03-25 07:20:30 -07001914 net,
kasar3ac5dc42017-03-15 06:28:22 -07001915 nic_type=nic_type)
1916 else:
1917 self.logger.info("new_vminstance(): adding network adapter "\
kasarc5bf2932018-03-09 04:15:22 -08001918 "to a network {}".format(nets[0].get('name')))
1919 self.add_network_adapter_to_vms(vapp, nets[0].get('name'),
kasar3ac5dc42017-03-15 06:28:22 -07001920 primary_nic_index,
kasardc1f02e2017-03-25 07:20:30 -07001921 nicIndex,
1922 net)
bhangare0e571a92017-01-12 04:02:23 -08001923 nicIndex += 1
bayramovef390722016-09-27 03:34:46 -07001924
kasardc1f02e2017-03-25 07:20:30 -07001925 # cloud-init for ssh-key injection
1926 if cloud_config:
1927 self.cloud_init(vapp,cloud_config)
1928
kateac1e3792017-04-01 02:16:39 -07001929 # ############# Stub code for SRIOV #################
1930 #Add SRIOV
1931# if len(sriov_net_info) > 0:
1932# self.logger.info("Need to add SRIOV adapters {} into VM {}".format(sriov_net_info,
1933# vmname_andid ))
1934# sriov_status, vm_obj, vcenter_conect = self.add_sriov(vapp_uuid,
1935# sriov_net_info,
1936# vmname_andid)
1937# if sriov_status:
1938# self.logger.info("Added SRIOV {} to VM {}".format(
1939# sriov_net_info,
1940# vmname_andid)
1941# )
1942# reserve_memory = True
1943# else:
1944# self.logger.info("Fail to add SRIOV {} to VM {}".format(
1945# sriov_net_info,
1946# vmname_andid)
1947# )
1948
1949 # If VM has PCI devices or SRIOV reserve memory for VM
1950 if reserve_memory:
bhangarebfdca492017-03-11 01:32:46 -08001951 memReserve = vm_obj.config.hardware.memoryMB
1952 spec = vim.vm.ConfigSpec()
1953 spec.memoryAllocation = vim.ResourceAllocationInfo(reservation=memReserve)
1954 task = vm_obj.ReconfigVM_Task(spec=spec)
1955 if task:
1956 result = self.wait_for_vcenter_task(task, vcenter_conect)
tierno19860412017-10-03 10:46:46 +02001957 self.logger.info("Reserved memory {} MB for "
1958 "VM VM status: {}".format(str(memReserve), result))
bhangarebfdca492017-03-11 01:32:46 -08001959 else:
tierno19860412017-10-03 10:46:46 +02001960 self.logger.info("Fail to reserved memory {} to VM {}".format(
1961 str(memReserve), str(vm_obj)))
bhangarefda5f7c2017-01-12 23:50:34 -08001962
kasarc5bf2932018-03-09 04:15:22 -08001963 self.logger.debug("new_vminstance(): starting power on vApp {} ".format(vmname_andid))
bhangare1a0b97c2017-06-21 02:20:15 -07001964
kasarc5bf2932018-03-09 04:15:22 -08001965 vapp_id = vapp_resource.get('id').split(':')[-1]
1966 poweron_task = self.power_on_vapp(vapp_id, vmname_andid)
1967 result = self.client.get_task_monitor().wait_for_success(task=poweron_task)
1968 if result.get('status') == 'success':
1969 self.logger.info("new_vminstance(): Successfully power on "\
1970 "vApp {}".format(vmname_andid))
1971 else:
1972 self.logger.error("new_vminstance(): failed to power on vApp "\
1973 "{}".format(vmname_andid))
bhangarebfdca492017-03-11 01:32:46 -08001974
1975 except Exception as exp :
1976 # it might be a case if specific mandatory entry in dict is empty or some other pyVcloud exception
kasarc5bf2932018-03-09 04:15:22 -08001977 self.logger.error("new_vminstance(): Failed create new vm instance {} with exception {}"
bhangare1a0b97c2017-06-21 02:20:15 -07001978 .format(name, exp))
1979 raise vimconn.vimconnException("new_vminstance(): Failed create new vm instance {} with exception {}"
1980 .format(name, exp))
bhangarefda5f7c2017-01-12 23:50:34 -08001981
bayramovef390722016-09-27 03:34:46 -07001982 # check if vApp deployed and if that the case return vApp UUID otherwise -1
kate13ab2c42016-12-23 01:34:24 -08001983 wait_time = 0
1984 vapp_uuid = None
1985 while wait_time <= MAX_WAIT_TIME:
bhangarebfdca492017-03-11 01:32:46 -08001986 try:
kasarc5bf2932018-03-09 04:15:22 -08001987 vapp_resource = vdc_obj.get_vapp(vmname_andid)
1988 vapp = VApp(self.client, resource=vapp_resource)
bhangarebfdca492017-03-11 01:32:46 -08001989 except Exception as exp:
1990 raise vimconn.vimconnUnexpectedResponse(
1991 "new_vminstance(): Failed to retrieve vApp {} after creation: Exception:{}"
1992 .format(vmname_andid, exp))
1993
kasarc5bf2932018-03-09 04:15:22 -08001994 #if vapp and vapp.me.deployed:
1995 if vapp and vapp_resource.get('deployed') == 'true':
1996 vapp_uuid = vapp_resource.get('id').split(':')[-1]
kate13ab2c42016-12-23 01:34:24 -08001997 break
1998 else:
1999 self.logger.debug("new_vminstance(): Wait for vApp {} to deploy".format(name))
2000 time.sleep(INTERVAL_TIME)
2001
2002 wait_time +=INTERVAL_TIME
2003
bayramovef390722016-09-27 03:34:46 -07002004 if vapp_uuid is not None:
tierno98e909c2017-10-14 13:27:03 +02002005 return vapp_uuid, None
bayramovbd6160f2016-09-28 04:12:05 +04002006 else:
2007 raise vimconn.vimconnUnexpectedResponse("new_vminstance(): Failed create new vm instance {}".format(name))
bayramov325fa1c2016-09-08 01:42:46 -07002008
bayramovef390722016-09-27 03:34:46 -07002009 ##
2010 ##
2011 ## based on current discussion
2012 ##
2013 ##
2014 ## server:
2015 # created: '2016-09-08T11:51:58'
2016 # description: simple-instance.linux1.1
2017 # flavor: ddc6776e-75a9-11e6-ad5f-0800273e724c
2018 # hostId: e836c036-74e7-11e6-b249-0800273e724c
2019 # image: dde30fe6-75a9-11e6-ad5f-0800273e724c
2020 # status: ACTIVE
2021 # error_msg:
2022 # interfaces: …
2023 #
bayramovfe3f3c92016-10-04 07:53:41 +04002024 def get_vminstance(self, vim_vm_uuid=None):
bayramov5761ad12016-10-04 09:00:30 +04002025 """Returns the VM instance information from VIM"""
bayramov325fa1c2016-09-08 01:42:46 -07002026
bayramovef390722016-09-27 03:34:46 -07002027 self.logger.debug("Client requesting vm instance {} ".format(vim_vm_uuid))
bayramov325fa1c2016-09-08 01:42:46 -07002028
kasarc5bf2932018-03-09 04:15:22 -08002029 org, vdc = self.get_vdc_details()
bayramovef390722016-09-27 03:34:46 -07002030 if vdc is None:
bayramovfe3f3c92016-10-04 07:53:41 +04002031 raise vimconn.vimconnConnectionException(
2032 "Failed to get a reference of VDC for a tenant {}".format(self.tenant_name))
bayramov325fa1c2016-09-08 01:42:46 -07002033
bayramovfe3f3c92016-10-04 07:53:41 +04002034 vm_info_dict = self.get_vapp_details_rest(vapp_uuid=vim_vm_uuid)
2035 if not vm_info_dict:
bayramovef390722016-09-27 03:34:46 -07002036 self.logger.debug("get_vminstance(): Failed to get vApp name by UUID {}".format(vim_vm_uuid))
bayramovfe3f3c92016-10-04 07:53:41 +04002037 raise vimconn.vimconnNotFoundException("Failed to get vApp name by UUID {}".format(vim_vm_uuid))
bayramov325fa1c2016-09-08 01:42:46 -07002038
bayramovfe3f3c92016-10-04 07:53:41 +04002039 status_key = vm_info_dict['status']
2040 error = ''
bayramovef390722016-09-27 03:34:46 -07002041 try:
bayramovfe3f3c92016-10-04 07:53:41 +04002042 vm_dict = {'created': vm_info_dict['created'],
2043 'description': vm_info_dict['name'],
2044 'status': vcdStatusCode2manoFormat[int(status_key)],
2045 'hostId': vm_info_dict['vmuuid'],
2046 'error_msg': error,
2047 'vim_info': yaml.safe_dump(vm_info_dict), 'interfaces': []}
bayramovef390722016-09-27 03:34:46 -07002048
bayramov5761ad12016-10-04 09:00:30 +04002049 if 'interfaces' in vm_info_dict:
bayramovfe3f3c92016-10-04 07:53:41 +04002050 vm_dict['interfaces'] = vm_info_dict['interfaces']
2051 else:
2052 vm_dict['interfaces'] = []
2053 except KeyError:
2054 vm_dict = {'created': '',
2055 'description': '',
2056 'status': vcdStatusCode2manoFormat[int(-1)],
2057 'hostId': vm_info_dict['vmuuid'],
2058 'error_msg': "Inconsistency state",
2059 'vim_info': yaml.safe_dump(vm_info_dict), 'interfaces': []}
bayramovef390722016-09-27 03:34:46 -07002060
2061 return vm_dict
2062
tierno98e909c2017-10-14 13:27:03 +02002063 def delete_vminstance(self, vm__vim_uuid, created_items=None):
bayramovef390722016-09-27 03:34:46 -07002064 """Method poweroff and remove VM instance from vcloud director network.
2065
2066 Args:
2067 vm__vim_uuid: VM UUID
2068
2069 Returns:
2070 Returns the instance identifier
2071 """
2072
2073 self.logger.debug("Client requesting delete vm instance {} ".format(vm__vim_uuid))
bayramov325fa1c2016-09-08 01:42:46 -07002074
kasarc5bf2932018-03-09 04:15:22 -08002075 org, vdc = self.get_vdc_details()
2076 vdc_obj = VDC(self.client, href=vdc.get('href'))
2077 if vdc_obj is None:
bayramovef390722016-09-27 03:34:46 -07002078 self.logger.debug("delete_vminstance(): Failed to get a reference of VDC for a tenant {}".format(
2079 self.tenant_name))
bayramovbd6160f2016-09-28 04:12:05 +04002080 raise vimconn.vimconnException(
2081 "delete_vminstance(): Failed to get a reference of VDC for a tenant {}".format(self.tenant_name))
bayramov325fa1c2016-09-08 01:42:46 -07002082
bayramovef390722016-09-27 03:34:46 -07002083 try:
kasarc5bf2932018-03-09 04:15:22 -08002084 vapp_name = self.get_namebyvappid(vm__vim_uuid)
2085 vapp_resource = vdc_obj.get_vapp(vapp_name)
2086 vapp = VApp(self.client, resource=vapp_resource)
bayramovef390722016-09-27 03:34:46 -07002087 if vapp_name is None:
2088 self.logger.debug("delete_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid))
2089 return -1, "delete_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid)
2090 else:
2091 self.logger.info("Deleting vApp {} and UUID {}".format(vapp_name, vm__vim_uuid))
bayramov325fa1c2016-09-08 01:42:46 -07002092
bayramovef390722016-09-27 03:34:46 -07002093 # Delete vApp and wait for status change if task executed and vApp is None.
bayramov325fa1c2016-09-08 01:42:46 -07002094
kate13ab2c42016-12-23 01:34:24 -08002095 if vapp:
kasarc5bf2932018-03-09 04:15:22 -08002096 if vapp_resource.get('deployed') == 'true':
kate13ab2c42016-12-23 01:34:24 -08002097 self.logger.info("Powering off vApp {}".format(vapp_name))
2098 #Power off vApp
2099 powered_off = False
2100 wait_time = 0
2101 while wait_time <= MAX_WAIT_TIME:
kasarc5bf2932018-03-09 04:15:22 -08002102 power_off_task = vapp.power_off()
2103 result = self.client.get_task_monitor().wait_for_success(task=power_off_task)
bayramovef390722016-09-27 03:34:46 -07002104
kasarc5bf2932018-03-09 04:15:22 -08002105 if result.get('status') == 'success':
2106 powered_off = True
2107 break
kate13ab2c42016-12-23 01:34:24 -08002108 else:
2109 self.logger.info("Wait for vApp {} to power off".format(vapp_name))
2110 time.sleep(INTERVAL_TIME)
2111
2112 wait_time +=INTERVAL_TIME
2113 if not powered_off:
2114 self.logger.debug("delete_vminstance(): Failed to power off VM instance {} ".format(vm__vim_uuid))
2115 else:
2116 self.logger.info("delete_vminstance(): Powered off VM instance {} ".format(vm__vim_uuid))
2117
2118 #Undeploy vApp
2119 self.logger.info("Undeploy vApp {}".format(vapp_name))
2120 wait_time = 0
2121 undeployed = False
2122 while wait_time <= MAX_WAIT_TIME:
kasarc5bf2932018-03-09 04:15:22 -08002123 vapp = VApp(self.client, resource=vapp_resource)
kate13ab2c42016-12-23 01:34:24 -08002124 if not vapp:
2125 self.logger.debug("delete_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid))
2126 return -1, "delete_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid)
kasarc5bf2932018-03-09 04:15:22 -08002127 undeploy_task = vapp.undeploy()
kate13ab2c42016-12-23 01:34:24 -08002128
kasarc5bf2932018-03-09 04:15:22 -08002129 result = self.client.get_task_monitor().wait_for_success(task=undeploy_task)
2130 if result.get('status') == 'success':
2131 undeployed = True
2132 break
kate13ab2c42016-12-23 01:34:24 -08002133 else:
2134 self.logger.debug("Wait for vApp {} to undeploy".format(vapp_name))
2135 time.sleep(INTERVAL_TIME)
2136
2137 wait_time +=INTERVAL_TIME
2138
2139 if not undeployed:
2140 self.logger.debug("delete_vminstance(): Failed to undeploy vApp {} ".format(vm__vim_uuid))
2141
2142 # delete vapp
2143 self.logger.info("Start deletion of vApp {} ".format(vapp_name))
kate13ab2c42016-12-23 01:34:24 -08002144
2145 if vapp is not None:
2146 wait_time = 0
2147 result = False
2148
2149 while wait_time <= MAX_WAIT_TIME:
kasarc5bf2932018-03-09 04:15:22 -08002150 vapp = VApp(self.client, resource=vapp_resource)
kate13ab2c42016-12-23 01:34:24 -08002151 if not vapp:
2152 self.logger.debug("delete_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid))
2153 return -1, "delete_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid)
2154
kasarc5bf2932018-03-09 04:15:22 -08002155 delete_task = vdc_obj.delete_vapp(vapp.name, force=True)
kate13ab2c42016-12-23 01:34:24 -08002156
kasarc5bf2932018-03-09 04:15:22 -08002157 result = self.client.get_task_monitor().wait_for_success(task=delete_task)
2158 if result.get('status') == 'success':
2159 break
kate13ab2c42016-12-23 01:34:24 -08002160 else:
2161 self.logger.debug("Wait for vApp {} to delete".format(vapp_name))
2162 time.sleep(INTERVAL_TIME)
2163
2164 wait_time +=INTERVAL_TIME
2165
kasarc5bf2932018-03-09 04:15:22 -08002166 if result is None:
bayramovbd6160f2016-09-28 04:12:05 +04002167 self.logger.debug("delete_vminstance(): Failed delete uuid {} ".format(vm__vim_uuid))
kasarc5bf2932018-03-09 04:15:22 -08002168 else:
2169 self.logger.info("Deleted vm instance {} sccessfully".format(vm__vim_uuid))
2170 return vm__vim_uuid
bayramovef390722016-09-27 03:34:46 -07002171 except:
2172 self.logger.debug(traceback.format_exc())
bayramovbd6160f2016-09-28 04:12:05 +04002173 raise vimconn.vimconnException("delete_vminstance(): Failed delete vm instance {}".format(vm__vim_uuid))
bayramovef390722016-09-27 03:34:46 -07002174
bayramov325fa1c2016-09-08 01:42:46 -07002175
2176 def refresh_vms_status(self, vm_list):
bayramovef390722016-09-27 03:34:46 -07002177 """Get the status of the virtual machines and their interfaces/ports
bayramov325fa1c2016-09-08 01:42:46 -07002178 Params: the list of VM identifiers
2179 Returns a dictionary with:
2180 vm_id: #VIM id of this Virtual Machine
2181 status: #Mandatory. Text with one of:
2182 # DELETED (not found at vim)
bayramovef390722016-09-27 03:34:46 -07002183 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
bayramov325fa1c2016-09-08 01:42:46 -07002184 # OTHER (Vim reported other status not understood)
2185 # ERROR (VIM indicates an ERROR status)
bayramovef390722016-09-27 03:34:46 -07002186 # ACTIVE, PAUSED, SUSPENDED, INACTIVE (not running),
bayramov325fa1c2016-09-08 01:42:46 -07002187 # CREATING (on building process), ERROR
2188 # ACTIVE:NoMgmtIP (Active but any of its interface has an IP address
2189 #
bayramovef390722016-09-27 03:34:46 -07002190 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
bayramov325fa1c2016-09-08 01:42:46 -07002191 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
2192 interfaces:
2193 - vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
2194 mac_address: #Text format XX:XX:XX:XX:XX:XX
2195 vim_net_id: #network id where this interface is connected
2196 vim_interface_id: #interface/port VIM id
2197 ip_address: #null, or text with IPv4, IPv6 address
bayramovef390722016-09-27 03:34:46 -07002198 """
bayramov325fa1c2016-09-08 01:42:46 -07002199
bayramovef390722016-09-27 03:34:46 -07002200 self.logger.debug("Client requesting refresh vm status for {} ".format(vm_list))
bhangare985a1fd2017-01-31 01:53:21 -08002201
kasarc5bf2932018-03-09 04:15:22 -08002202 org,vdc = self.get_vdc_details()
bayramovef390722016-09-27 03:34:46 -07002203 if vdc is None:
bayramovbd6160f2016-09-28 04:12:05 +04002204 raise vimconn.vimconnException("Failed to get a reference of VDC for a tenant {}".format(self.tenant_name))
bayramovef390722016-09-27 03:34:46 -07002205
2206 vms_dict = {}
kasarde691232017-03-25 03:37:31 -07002207 nsx_edge_list = []
bayramovef390722016-09-27 03:34:46 -07002208 for vmuuid in vm_list:
kasarc5bf2932018-03-09 04:15:22 -08002209 vapp_name = self.get_namebyvappid(vmuuid)
2210 if vapp_name is not None:
bayramovef390722016-09-27 03:34:46 -07002211
bayramovef390722016-09-27 03:34:46 -07002212 try:
bhangare1a0b97c2017-06-21 02:20:15 -07002213 vm_pci_details = self.get_vm_pci_details(vmuuid)
kasarc5bf2932018-03-09 04:15:22 -08002214 vdc_obj = VDC(self.client, href=vdc.get('href'))
2215 vapp_resource = vdc_obj.get_vapp(vapp_name)
2216 the_vapp = VApp(self.client, resource=vapp_resource)
bhangarebfdca492017-03-11 01:32:46 -08002217
kasarc5bf2932018-03-09 04:15:22 -08002218 vm_details = {}
2219 for vm in the_vapp.get_all_vms():
2220 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
2221 'x-vcloud-authorization': self.client._session.headers['x-vcloud-authorization']}
2222 response = self.perform_request(req_type='GET',
2223 url=vm.get('href'),
2224 headers=headers)
bhangarebfdca492017-03-11 01:32:46 -08002225
kasarc5bf2932018-03-09 04:15:22 -08002226 if response.status_code != 200:
2227 self.logger.error("refresh_vms_status : REST call {} failed reason : {}"\
2228 "status code : {}".format(vm.get('href'),
2229 response.content,
2230 response.status_code))
2231 raise vimconn.vimconnException("refresh_vms_status : Failed to get "\
2232 "VM details")
2233 xmlroot = XmlElementTree.fromstring(response.content)
kasarde691232017-03-25 03:37:31 -07002234
kasarc5bf2932018-03-09 04:15:22 -08002235 result = response.content.replace("\n"," ")
2236 hdd_mb = re.search('vcloud:capacity="(\d+)"\svcloud:storageProfileOverrideVmDefault=',result).group(1)
2237 vm_details['hdd_mb'] = int(hdd_mb) if hdd_mb else None
2238 cpus = re.search('<rasd:Description>Number of Virtual CPUs</.*?>(\d+)</rasd:VirtualQuantity>',result).group(1)
2239 vm_details['cpus'] = int(cpus) if cpus else None
2240 memory_mb = re.search('<rasd:Description>Memory Size</.*?>(\d+)</rasd:VirtualQuantity>',result).group(1)
2241 vm_details['memory_mb'] = int(memory_mb) if memory_mb else None
2242 vm_details['status'] = vcdStatusCode2manoFormat[int(xmlroot.get('status'))]
2243 vm_details['id'] = xmlroot.get('id')
2244 vm_details['name'] = xmlroot.get('name')
2245 vm_info = [vm_details]
2246 if vm_pci_details:
2247 vm_info[0].update(vm_pci_details)
2248
2249 vm_dict = {'status': vcdStatusCode2manoFormat[int(vapp_resource.get('status'))],
2250 'error_msg': vcdStatusCode2manoFormat[int(vapp_resource.get('status'))],
2251 'vim_info': yaml.safe_dump(vm_info), 'interfaces': []}
2252
2253 # get networks
kasar1b7b9522018-05-15 06:15:07 -07002254 vm_ip= None
2255 vm_mac = None
2256 networks = re.findall('<NetworkConnection needsCustomization=.*?</NetworkConnection>',result)
2257 for network in networks:
2258 mac_s = re.search('<MACAddress>(.*?)</MACAddress>',network)
2259 vm_mac = mac_s.group(1) if mac_s else None
2260 ip_s = re.search('<IpAddress>(.*?)</IpAddress>',network)
2261 vm_ip = ip_s.group(1) if ip_s else None
kasarc5bf2932018-03-09 04:15:22 -08002262
kasar1b7b9522018-05-15 06:15:07 -07002263 if vm_ip is None:
2264 if not nsx_edge_list:
2265 nsx_edge_list = self.get_edge_details()
2266 if nsx_edge_list is None:
2267 raise vimconn.vimconnException("refresh_vms_status:"\
2268 "Failed to get edge details from NSX Manager")
2269 if vm_mac is not None:
2270 vm_ip = self.get_ipaddr_from_NSXedge(nsx_edge_list, vm_mac)
kasarc5bf2932018-03-09 04:15:22 -08002271
kasarabac1e22018-05-17 02:44:39 -07002272 net_s = re.search('network="(.*?)"',network)
2273 network_name = net_s.group(1) if net_s else None
2274
kasar1b7b9522018-05-15 06:15:07 -07002275 vm_net_id = self.get_network_id_by_name(network_name)
2276 interface = {"mac_address": vm_mac,
2277 "vim_net_id": vm_net_id,
2278 "vim_interface_id": vm_net_id,
2279 "ip_address": vm_ip}
2280
2281 vm_dict["interfaces"].append(interface)
kasarc5bf2932018-03-09 04:15:22 -08002282
bayramovef390722016-09-27 03:34:46 -07002283 # add a vm to vm dict
2284 vms_dict.setdefault(vmuuid, vm_dict)
kasarc5bf2932018-03-09 04:15:22 -08002285 self.logger.debug("refresh_vms_status : vm info {}".format(vm_dict))
bhangarebfdca492017-03-11 01:32:46 -08002286 except Exception as exp:
2287 self.logger.debug("Error in response {}".format(exp))
bayramovef390722016-09-27 03:34:46 -07002288 self.logger.debug(traceback.format_exc())
2289
2290 return vms_dict
2291
kasarde691232017-03-25 03:37:31 -07002292
2293 def get_edge_details(self):
2294 """Get the NSX edge list from NSX Manager
2295 Returns list of NSX edges
2296 """
2297 edge_list = []
2298 rheaders = {'Content-Type': 'application/xml'}
2299 nsx_api_url = '/api/4.0/edges'
2300
2301 self.logger.debug("Get edge details from NSX Manager {} {}".format(self.nsx_manager, nsx_api_url))
2302
2303 try:
2304 resp = requests.get(self.nsx_manager + nsx_api_url,
2305 auth = (self.nsx_user, self.nsx_password),
2306 verify = False, headers = rheaders)
2307 if resp.status_code == requests.codes.ok:
2308 paged_Edge_List = XmlElementTree.fromstring(resp.text)
2309 for edge_pages in paged_Edge_List:
2310 if edge_pages.tag == 'edgePage':
2311 for edge_summary in edge_pages:
2312 if edge_summary.tag == 'pagingInfo':
2313 for element in edge_summary:
2314 if element.tag == 'totalCount' and element.text == '0':
2315 raise vimconn.vimconnException("get_edge_details: No NSX edges details found: {}"
2316 .format(self.nsx_manager))
2317
2318 if edge_summary.tag == 'edgeSummary':
2319 for element in edge_summary:
2320 if element.tag == 'id':
2321 edge_list.append(element.text)
2322 else:
2323 raise vimconn.vimconnException("get_edge_details: No NSX edge details found: {}"
2324 .format(self.nsx_manager))
2325
2326 if not edge_list:
2327 raise vimconn.vimconnException("get_edge_details: "\
2328 "No NSX edge details found: {}"
2329 .format(self.nsx_manager))
2330 else:
2331 self.logger.debug("get_edge_details: Found NSX edges {}".format(edge_list))
2332 return edge_list
2333 else:
2334 self.logger.debug("get_edge_details: "
2335 "Failed to get NSX edge details from NSX Manager: {}"
2336 .format(resp.content))
2337 return None
2338
2339 except Exception as exp:
2340 self.logger.debug("get_edge_details: "\
2341 "Failed to get NSX edge details from NSX Manager: {}"
2342 .format(exp))
2343 raise vimconn.vimconnException("get_edge_details: "\
2344 "Failed to get NSX edge details from NSX Manager: {}"
2345 .format(exp))
2346
2347
2348 def get_ipaddr_from_NSXedge(self, nsx_edges, mac_address):
2349 """Get IP address details from NSX edges, using the MAC address
2350 PARAMS: nsx_edges : List of NSX edges
2351 mac_address : Find IP address corresponding to this MAC address
2352 Returns: IP address corrresponding to the provided MAC address
2353 """
2354
2355 ip_addr = None
2356 rheaders = {'Content-Type': 'application/xml'}
2357
2358 self.logger.debug("get_ipaddr_from_NSXedge: Finding IP addr from NSX edge")
2359
2360 try:
2361 for edge in nsx_edges:
2362 nsx_api_url = '/api/4.0/edges/'+ edge +'/dhcp/leaseInfo'
2363
2364 resp = requests.get(self.nsx_manager + nsx_api_url,
2365 auth = (self.nsx_user, self.nsx_password),
2366 verify = False, headers = rheaders)
2367
2368 if resp.status_code == requests.codes.ok:
2369 dhcp_leases = XmlElementTree.fromstring(resp.text)
2370 for child in dhcp_leases:
2371 if child.tag == 'dhcpLeaseInfo':
2372 dhcpLeaseInfo = child
2373 for leaseInfo in dhcpLeaseInfo:
2374 for elem in leaseInfo:
2375 if (elem.tag)=='macAddress':
2376 edge_mac_addr = elem.text
2377 if (elem.tag)=='ipAddress':
2378 ip_addr = elem.text
2379 if edge_mac_addr is not None:
2380 if edge_mac_addr == mac_address:
2381 self.logger.debug("Found ip addr {} for mac {} at NSX edge {}"
2382 .format(ip_addr, mac_address,edge))
2383 return ip_addr
2384 else:
2385 self.logger.debug("get_ipaddr_from_NSXedge: "\
2386 "Error occurred while getting DHCP lease info from NSX Manager: {}"
2387 .format(resp.content))
2388
2389 self.logger.debug("get_ipaddr_from_NSXedge: No IP addr found in any NSX edge")
2390 return None
2391
2392 except XmlElementTree.ParseError as Err:
2393 self.logger.debug("ParseError in response from NSX Manager {}".format(Err.message), exc_info=True)
2394
2395
tierno98e909c2017-10-14 13:27:03 +02002396 def action_vminstance(self, vm__vim_uuid=None, action_dict=None, created_items={}):
bayramovef390722016-09-27 03:34:46 -07002397 """Send and action over a VM instance from VIM
2398 Returns the vm_id if the action was successfully sent to the VIM"""
2399
2400 self.logger.debug("Received action for vm {} and action dict {}".format(vm__vim_uuid, action_dict))
2401 if vm__vim_uuid is None or action_dict is None:
bayramovbd6160f2016-09-28 04:12:05 +04002402 raise vimconn.vimconnException("Invalid request. VM id or action is None.")
bayramovef390722016-09-27 03:34:46 -07002403
kasarc5bf2932018-03-09 04:15:22 -08002404 org, vdc = self.get_vdc_details()
bayramovef390722016-09-27 03:34:46 -07002405 if vdc is None:
tierno98e909c2017-10-14 13:27:03 +02002406 raise vimconn.vimconnException("Failed to get a reference of VDC for a tenant {}".format(self.tenant_name))
bayramovef390722016-09-27 03:34:46 -07002407
kasarc5bf2932018-03-09 04:15:22 -08002408 vapp_name = self.get_namebyvappid(vm__vim_uuid)
bayramovef390722016-09-27 03:34:46 -07002409 if vapp_name is None:
2410 self.logger.debug("action_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid))
bayramovbd6160f2016-09-28 04:12:05 +04002411 raise vimconn.vimconnException("Failed to get vm by given {} vm uuid".format(vm__vim_uuid))
bayramovef390722016-09-27 03:34:46 -07002412 else:
2413 self.logger.info("Action_vminstance vApp {} and UUID {}".format(vapp_name, vm__vim_uuid))
2414
2415 try:
kasarc5bf2932018-03-09 04:15:22 -08002416 vdc_obj = VDC(self.client, href=vdc.get('href'))
2417 vapp_resource = vdc_obj.get_vapp(vapp_name)
2418 vapp = VApp(self.client, resource=vapp_resource)
bayramovef390722016-09-27 03:34:46 -07002419 if "start" in action_dict:
kasar3ac5dc42017-03-15 06:28:22 -07002420 self.logger.info("action_vminstance: Power on vApp: {}".format(vapp_name))
kasarc5bf2932018-03-09 04:15:22 -08002421 poweron_task = self.power_on_vapp(vm__vim_uuid, vapp_name)
2422 result = self.client.get_task_monitor().wait_for_success(task=poweron_task)
2423 self.instance_actions_result("start", result, vapp_name)
kasar3ac5dc42017-03-15 06:28:22 -07002424 elif "rebuild" in action_dict:
2425 self.logger.info("action_vminstance: Rebuild vApp: {}".format(vapp_name))
kasarc5bf2932018-03-09 04:15:22 -08002426 rebuild_task = vapp.deploy(power_on=True)
2427 result = self.client.get_task_monitor().wait_for_success(task=rebuild_task)
kasar3ac5dc42017-03-15 06:28:22 -07002428 self.instance_actions_result("rebuild", result, vapp_name)
bayramovef390722016-09-27 03:34:46 -07002429 elif "pause" in action_dict:
kasar3ac5dc42017-03-15 06:28:22 -07002430 self.logger.info("action_vminstance: pause vApp: {}".format(vapp_name))
kasarc5bf2932018-03-09 04:15:22 -08002431 pause_task = vapp.undeploy(action='suspend')
2432 result = self.client.get_task_monitor().wait_for_success(task=pause_task)
kasar3ac5dc42017-03-15 06:28:22 -07002433 self.instance_actions_result("pause", result, vapp_name)
bayramovef390722016-09-27 03:34:46 -07002434 elif "resume" in action_dict:
kasar3ac5dc42017-03-15 06:28:22 -07002435 self.logger.info("action_vminstance: resume vApp: {}".format(vapp_name))
kasarc5bf2932018-03-09 04:15:22 -08002436 poweron_task = self.power_on_vapp(vm__vim_uuid, vapp_name)
2437 result = self.client.get_task_monitor().wait_for_success(task=poweron_task)
kasar3ac5dc42017-03-15 06:28:22 -07002438 self.instance_actions_result("resume", result, vapp_name)
bayramovef390722016-09-27 03:34:46 -07002439 elif "shutoff" in action_dict or "shutdown" in action_dict:
kasar3ac5dc42017-03-15 06:28:22 -07002440 action_name , value = action_dict.items()[0]
kasarc5bf2932018-03-09 04:15:22 -08002441 #For python3
2442 #action_name , value = list(action_dict.items())[0]
kasar3ac5dc42017-03-15 06:28:22 -07002443 self.logger.info("action_vminstance: {} vApp: {}".format(action_name, vapp_name))
kasarc5bf2932018-03-09 04:15:22 -08002444 shutdown_task = vapp.shutdown()
2445 result = self.client.get_task_monitor().wait_for_success(task=shutdown_task)
kasar3ac5dc42017-03-15 06:28:22 -07002446 if action_name == "shutdown":
2447 self.instance_actions_result("shutdown", result, vapp_name)
bhangare985a1fd2017-01-31 01:53:21 -08002448 else:
kasar3ac5dc42017-03-15 06:28:22 -07002449 self.instance_actions_result("shutoff", result, vapp_name)
bayramovef390722016-09-27 03:34:46 -07002450 elif "forceOff" in action_dict:
kasarc5bf2932018-03-09 04:15:22 -08002451 result = vapp.undeploy(action='powerOff')
kasar3ac5dc42017-03-15 06:28:22 -07002452 self.instance_actions_result("forceOff", result, vapp_name)
2453 elif "reboot" in action_dict:
2454 self.logger.info("action_vminstance: reboot vApp: {}".format(vapp_name))
kasarc5bf2932018-03-09 04:15:22 -08002455 reboot_task = vapp.reboot()
2456 self.client.get_task_monitor().wait_for_success(task=reboot_task)
bayramovef390722016-09-27 03:34:46 -07002457 else:
kasar3ac5dc42017-03-15 06:28:22 -07002458 raise vimconn.vimconnException("action_vminstance: Invalid action {} or action is None.".format(action_dict))
kasarc5bf2932018-03-09 04:15:22 -08002459 return vm__vim_uuid
bhangarebfdca492017-03-11 01:32:46 -08002460 except Exception as exp :
2461 self.logger.debug("action_vminstance: Failed with Exception {}".format(exp))
2462 raise vimconn.vimconnException("action_vminstance: Failed with Exception {}".format(exp))
bayramovef390722016-09-27 03:34:46 -07002463
kasar3ac5dc42017-03-15 06:28:22 -07002464 def instance_actions_result(self, action, result, vapp_name):
kasarc5bf2932018-03-09 04:15:22 -08002465 if result.get('status') == 'success':
kasar3ac5dc42017-03-15 06:28:22 -07002466 self.logger.info("action_vminstance: Sucessfully {} the vApp: {}".format(action, vapp_name))
2467 else:
2468 self.logger.error("action_vminstance: Failed to {} vApp: {}".format(action, vapp_name))
2469
bayramovef390722016-09-27 03:34:46 -07002470 def get_vminstance_console(self, vm_id, console_type="vnc"):
2471 """
bayramov325fa1c2016-09-08 01:42:46 -07002472 Get a console for the virtual machine
2473 Params:
2474 vm_id: uuid of the VM
2475 console_type, can be:
bayramovef390722016-09-27 03:34:46 -07002476 "novnc" (by default), "xvpvnc" for VNC types,
bayramov325fa1c2016-09-08 01:42:46 -07002477 "rdp-html5" for RDP types, "spice-html5" for SPICE types
2478 Returns dict with the console parameters:
2479 protocol: ssh, ftp, http, https, ...
bayramovef390722016-09-27 03:34:46 -07002480 server: usually ip address
2481 port: the http, ssh, ... port
2482 suffix: extra text, e.g. the http path and query string
2483 """
bayramovbd6160f2016-09-28 04:12:05 +04002484 raise vimconn.vimconnNotImplemented("Should have implemented this")
bayramov325fa1c2016-09-08 01:42:46 -07002485
bayramovef390722016-09-27 03:34:46 -07002486 # NOT USED METHODS in current version
bayramov325fa1c2016-09-08 01:42:46 -07002487
2488 def host_vim2gui(self, host, server_dict):
bayramov5761ad12016-10-04 09:00:30 +04002489 """Transform host dictionary from VIM format to GUI format,
bayramov325fa1c2016-09-08 01:42:46 -07002490 and append to the server_dict
bayramov5761ad12016-10-04 09:00:30 +04002491 """
bayramovbd6160f2016-09-28 04:12:05 +04002492 raise vimconn.vimconnNotImplemented("Should have implemented this")
bayramov325fa1c2016-09-08 01:42:46 -07002493
2494 def get_hosts_info(self):
bayramov5761ad12016-10-04 09:00:30 +04002495 """Get the information of deployed hosts
2496 Returns the hosts content"""
bayramovbd6160f2016-09-28 04:12:05 +04002497 raise vimconn.vimconnNotImplemented("Should have implemented this")
bayramov325fa1c2016-09-08 01:42:46 -07002498
2499 def get_hosts(self, vim_tenant):
bayramov5761ad12016-10-04 09:00:30 +04002500 """Get the hosts and deployed instances
2501 Returns the hosts content"""
bayramovbd6160f2016-09-28 04:12:05 +04002502 raise vimconn.vimconnNotImplemented("Should have implemented this")
bayramov325fa1c2016-09-08 01:42:46 -07002503
2504 def get_processor_rankings(self):
bayramov5761ad12016-10-04 09:00:30 +04002505 """Get the processor rankings in the VIM database"""
bayramovbd6160f2016-09-28 04:12:05 +04002506 raise vimconn.vimconnNotImplemented("Should have implemented this")
bayramov325fa1c2016-09-08 01:42:46 -07002507
2508 def new_host(self, host_data):
bayramov5761ad12016-10-04 09:00:30 +04002509 """Adds a new host to VIM"""
bayramov325fa1c2016-09-08 01:42:46 -07002510 '''Returns status code of the VIM response'''
bayramovbd6160f2016-09-28 04:12:05 +04002511 raise vimconn.vimconnNotImplemented("Should have implemented this")
bayramov325fa1c2016-09-08 01:42:46 -07002512
2513 def new_external_port(self, port_data):
bayramov5761ad12016-10-04 09:00:30 +04002514 """Adds a external port to VIM"""
bayramov325fa1c2016-09-08 01:42:46 -07002515 '''Returns the port identifier'''
bayramovbd6160f2016-09-28 04:12:05 +04002516 raise vimconn.vimconnNotImplemented("Should have implemented this")
bayramov325fa1c2016-09-08 01:42:46 -07002517
bayramovef390722016-09-27 03:34:46 -07002518 def new_external_network(self, net_name, net_type):
bayramov5761ad12016-10-04 09:00:30 +04002519 """Adds a external network to VIM (shared)"""
bayramov325fa1c2016-09-08 01:42:46 -07002520 '''Returns the network identifier'''
bayramovbd6160f2016-09-28 04:12:05 +04002521 raise vimconn.vimconnNotImplemented("Should have implemented this")
bayramov325fa1c2016-09-08 01:42:46 -07002522
2523 def connect_port_network(self, port_id, network_id, admin=False):
bayramov5761ad12016-10-04 09:00:30 +04002524 """Connects a external port to a network"""
bayramov325fa1c2016-09-08 01:42:46 -07002525 '''Returns status code of the VIM response'''
bayramovbd6160f2016-09-28 04:12:05 +04002526 raise vimconn.vimconnNotImplemented("Should have implemented this")
bayramov325fa1c2016-09-08 01:42:46 -07002527
2528 def new_vminstancefromJSON(self, vm_data):
bayramov5761ad12016-10-04 09:00:30 +04002529 """Adds a VM instance to VIM"""
bayramov325fa1c2016-09-08 01:42:46 -07002530 '''Returns the instance identifier'''
bayramovbd6160f2016-09-28 04:12:05 +04002531 raise vimconn.vimconnNotImplemented("Should have implemented this")
bayramov325fa1c2016-09-08 01:42:46 -07002532
kate15f1c382016-12-15 01:12:40 -08002533 def get_network_name_by_id(self, network_uuid=None):
bayramovef390722016-09-27 03:34:46 -07002534 """Method gets vcloud director network named based on supplied uuid.
2535
2536 Args:
kate15f1c382016-12-15 01:12:40 -08002537 network_uuid: network_id
bayramovef390722016-09-27 03:34:46 -07002538
2539 Returns:
2540 The return network name.
2541 """
2542
kate15f1c382016-12-15 01:12:40 -08002543 if not network_uuid:
bayramovef390722016-09-27 03:34:46 -07002544 return None
2545
2546 try:
kate15f1c382016-12-15 01:12:40 -08002547 org_dict = self.get_org(self.org_uuid)
2548 if 'networks' in org_dict:
2549 org_network_dict = org_dict['networks']
2550 for net_uuid in org_network_dict:
2551 if net_uuid == network_uuid:
2552 return org_network_dict[net_uuid]
bayramovef390722016-09-27 03:34:46 -07002553 except:
2554 self.logger.debug("Exception in get_network_name_by_id")
2555 self.logger.debug(traceback.format_exc())
2556
2557 return None
2558
bhangare2c855072016-12-27 01:41:28 -08002559 def get_network_id_by_name(self, network_name=None):
2560 """Method gets vcloud director network uuid based on supplied name.
2561
2562 Args:
2563 network_name: network_name
2564 Returns:
2565 The return network uuid.
2566 network_uuid: network_id
2567 """
2568
bhangare2c855072016-12-27 01:41:28 -08002569 if not network_name:
2570 self.logger.debug("get_network_id_by_name() : Network name is empty")
2571 return None
2572
2573 try:
2574 org_dict = self.get_org(self.org_uuid)
2575 if org_dict and 'networks' in org_dict:
2576 org_network_dict = org_dict['networks']
2577 for net_uuid,net_name in org_network_dict.iteritems():
kasarc5bf2932018-03-09 04:15:22 -08002578 #For python3
2579 #for net_uuid,net_name in org_network_dict.items():
bhangare2c855072016-12-27 01:41:28 -08002580 if net_name == network_name:
2581 return net_uuid
2582
2583 except KeyError as exp:
2584 self.logger.debug("get_network_id_by_name() : KeyError- {} ".format(exp))
2585
2586 return None
2587
bayramovef390722016-09-27 03:34:46 -07002588 def list_org_action(self):
2589 """
2590 Method leverages vCloud director and query for available organization for particular user
2591
2592 Args:
2593 vca - is active VCA connection.
2594 vdc_name - is a vdc name that will be used to query vms action
2595
2596 Returns:
2597 The return XML respond
2598 """
kasarc5bf2932018-03-09 04:15:22 -08002599 url_list = [self.url, '/api/org']
bayramovef390722016-09-27 03:34:46 -07002600 vm_list_rest_call = ''.join(url_list)
2601
kasarc5bf2932018-03-09 04:15:22 -08002602 if self.client._session:
2603 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
2604 'x-vcloud-authorization': self.client._session.headers['x-vcloud-authorization']}
2605
2606 response = self.perform_request(req_type='GET',
2607 url=vm_list_rest_call,
2608 headers=headers)
bhangare1a0b97c2017-06-21 02:20:15 -07002609
2610 if response.status_code == 403:
2611 response = self.retry_rest('GET', vm_list_rest_call)
2612
bayramovef390722016-09-27 03:34:46 -07002613 if response.status_code == requests.codes.ok:
2614 return response.content
2615
2616 return None
2617
2618 def get_org_action(self, org_uuid=None):
2619 """
kasarc5bf2932018-03-09 04:15:22 -08002620 Method leverages vCloud director and retrieve available object for organization.
bayramovef390722016-09-27 03:34:46 -07002621
2622 Args:
kasarc5bf2932018-03-09 04:15:22 -08002623 org_uuid - vCD organization uuid
2624 self.client - is active connection.
bayramovef390722016-09-27 03:34:46 -07002625
2626 Returns:
2627 The return XML respond
2628 """
2629
bayramovef390722016-09-27 03:34:46 -07002630 if org_uuid is None:
2631 return None
2632
kasarc5bf2932018-03-09 04:15:22 -08002633 url_list = [self.url, '/api/org/', org_uuid]
bayramovef390722016-09-27 03:34:46 -07002634 vm_list_rest_call = ''.join(url_list)
2635
kasarc5bf2932018-03-09 04:15:22 -08002636 if self.client._session:
2637 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
2638 'x-vcloud-authorization': self.client._session.headers['x-vcloud-authorization']}
bhangare1a0b97c2017-06-21 02:20:15 -07002639
kasarc5bf2932018-03-09 04:15:22 -08002640 #response = requests.get(vm_list_rest_call, headers=headers, verify=False)
2641 response = self.perform_request(req_type='GET',
2642 url=vm_list_rest_call,
2643 headers=headers)
bhangare1a0b97c2017-06-21 02:20:15 -07002644 if response.status_code == 403:
2645 response = self.retry_rest('GET', vm_list_rest_call)
2646
bayramovef390722016-09-27 03:34:46 -07002647 if response.status_code == requests.codes.ok:
kasarc5bf2932018-03-09 04:15:22 -08002648 return response.content
bayramovef390722016-09-27 03:34:46 -07002649 return None
2650
2651 def get_org(self, org_uuid=None):
2652 """
2653 Method retrieves available organization in vCloud Director
2654
2655 Args:
bayramovb6ffe792016-09-28 11:50:56 +04002656 org_uuid - is a organization uuid.
bayramovef390722016-09-27 03:34:46 -07002657
2658 Returns:
bayramovb6ffe792016-09-28 11:50:56 +04002659 The return dictionary with following key
2660 "network" - for network list under the org
2661 "catalogs" - for network list under the org
2662 "vdcs" - for vdc list under org
bayramovef390722016-09-27 03:34:46 -07002663 """
2664
2665 org_dict = {}
bayramovef390722016-09-27 03:34:46 -07002666
2667 if org_uuid is None:
2668 return org_dict
2669
2670 content = self.get_org_action(org_uuid=org_uuid)
2671 try:
2672 vdc_list = {}
2673 network_list = {}
2674 catalog_list = {}
2675 vm_list_xmlroot = XmlElementTree.fromstring(content)
2676 for child in vm_list_xmlroot:
2677 if child.attrib['type'] == 'application/vnd.vmware.vcloud.vdc+xml':
2678 vdc_list[child.attrib['href'].split("/")[-1:][0]] = child.attrib['name']
2679 org_dict['vdcs'] = vdc_list
2680 if child.attrib['type'] == 'application/vnd.vmware.vcloud.orgNetwork+xml':
2681 network_list[child.attrib['href'].split("/")[-1:][0]] = child.attrib['name']
2682 org_dict['networks'] = network_list
2683 if child.attrib['type'] == 'application/vnd.vmware.vcloud.catalog+xml':
2684 catalog_list[child.attrib['href'].split("/")[-1:][0]] = child.attrib['name']
2685 org_dict['catalogs'] = catalog_list
2686 except:
2687 pass
2688
2689 return org_dict
2690
2691 def get_org_list(self):
2692 """
2693 Method retrieves available organization in vCloud Director
2694
2695 Args:
2696 vca - is active VCA connection.
2697
2698 Returns:
2699 The return dictionary and key for each entry VDC UUID
2700 """
2701
2702 org_dict = {}
bayramovef390722016-09-27 03:34:46 -07002703
2704 content = self.list_org_action()
2705 try:
2706 vm_list_xmlroot = XmlElementTree.fromstring(content)
2707 for vm_xml in vm_list_xmlroot:
2708 if vm_xml.tag.split("}")[1] == 'Org':
2709 org_uuid = vm_xml.attrib['href'].split('/')[-1:]
2710 org_dict[org_uuid[0]] = vm_xml.attrib['name']
2711 except:
2712 pass
2713
2714 return org_dict
2715
2716 def vms_view_action(self, vdc_name=None):
2717 """ Method leverages vCloud director vms query call
2718
2719 Args:
2720 vca - is active VCA connection.
2721 vdc_name - is a vdc name that will be used to query vms action
2722
2723 Returns:
2724 The return XML respond
2725 """
2726 vca = self.connect()
2727 if vdc_name is None:
2728 return None
2729
2730 url_list = [vca.host, '/api/vms/query']
2731 vm_list_rest_call = ''.join(url_list)
2732
2733 if not (not vca.vcloud_session or not vca.vcloud_session.organization):
2734 refs = filter(lambda ref: ref.name == vdc_name and ref.type_ == 'application/vnd.vmware.vcloud.vdc+xml',
2735 vca.vcloud_session.organization.Link)
kasarc5bf2932018-03-09 04:15:22 -08002736 #For python3
2737 #refs = [ref for ref in vca.vcloud_session.organization.Link if ref.name == vdc_name and\
2738 # ref.type_ == 'application/vnd.vmware.vcloud.vdc+xml']
bayramovef390722016-09-27 03:34:46 -07002739 if len(refs) == 1:
2740 response = Http.get(url=vm_list_rest_call,
2741 headers=vca.vcloud_session.get_vcloud_headers(),
2742 verify=vca.verify,
2743 logger=vca.logger)
2744 if response.status_code == requests.codes.ok:
2745 return response.content
2746
2747 return None
2748
2749 def get_vapp_list(self, vdc_name=None):
2750 """
2751 Method retrieves vApp list deployed vCloud director and returns a dictionary
2752 contains a list of all vapp deployed for queried VDC.
2753 The key for a dictionary is vApp UUID
2754
2755
2756 Args:
2757 vca - is active VCA connection.
2758 vdc_name - is a vdc name that will be used to query vms action
2759
2760 Returns:
2761 The return dictionary and key for each entry vapp UUID
2762 """
2763
2764 vapp_dict = {}
2765 if vdc_name is None:
2766 return vapp_dict
2767
2768 content = self.vms_view_action(vdc_name=vdc_name)
2769 try:
2770 vm_list_xmlroot = XmlElementTree.fromstring(content)
2771 for vm_xml in vm_list_xmlroot:
2772 if vm_xml.tag.split("}")[1] == 'VMRecord':
2773 if vm_xml.attrib['isVAppTemplate'] == 'true':
2774 rawuuid = vm_xml.attrib['container'].split('/')[-1:]
2775 if 'vappTemplate-' in rawuuid[0]:
2776 # vm in format vappTemplate-e63d40e7-4ff5-4c6d-851f-96c1e4da86a5 we remove
2777 # vm and use raw UUID as key
2778 vapp_dict[rawuuid[0][13:]] = vm_xml.attrib
2779 except:
2780 pass
2781
2782 return vapp_dict
2783
2784 def get_vm_list(self, vdc_name=None):
2785 """
2786 Method retrieves VM's list deployed vCloud director. It returns a dictionary
2787 contains a list of all VM's deployed for queried VDC.
2788 The key for a dictionary is VM UUID
2789
2790
2791 Args:
2792 vca - is active VCA connection.
2793 vdc_name - is a vdc name that will be used to query vms action
2794
2795 Returns:
2796 The return dictionary and key for each entry vapp UUID
2797 """
2798 vm_dict = {}
2799
2800 if vdc_name is None:
2801 return vm_dict
2802
2803 content = self.vms_view_action(vdc_name=vdc_name)
2804 try:
2805 vm_list_xmlroot = XmlElementTree.fromstring(content)
2806 for vm_xml in vm_list_xmlroot:
2807 if vm_xml.tag.split("}")[1] == 'VMRecord':
2808 if vm_xml.attrib['isVAppTemplate'] == 'false':
2809 rawuuid = vm_xml.attrib['href'].split('/')[-1:]
2810 if 'vm-' in rawuuid[0]:
2811 # vm in format vm-e63d40e7-4ff5-4c6d-851f-96c1e4da86a5 we remove
2812 # vm and use raw UUID as key
2813 vm_dict[rawuuid[0][3:]] = vm_xml.attrib
2814 except:
2815 pass
2816
2817 return vm_dict
2818
2819 def get_vapp(self, vdc_name=None, vapp_name=None, isuuid=False):
2820 """
bayramovb6ffe792016-09-28 11:50:56 +04002821 Method retrieves VM deployed vCloud director. It returns VM attribute as dictionary
bayramovef390722016-09-27 03:34:46 -07002822 contains a list of all VM's deployed for queried VDC.
2823 The key for a dictionary is VM UUID
2824
2825
2826 Args:
2827 vca - is active VCA connection.
2828 vdc_name - is a vdc name that will be used to query vms action
2829
2830 Returns:
2831 The return dictionary and key for each entry vapp UUID
2832 """
2833 vm_dict = {}
2834 vca = self.connect()
2835 if not vca:
2836 raise vimconn.vimconnConnectionException("self.connect() is failed")
2837
2838 if vdc_name is None:
2839 return vm_dict
2840
2841 content = self.vms_view_action(vdc_name=vdc_name)
2842 try:
2843 vm_list_xmlroot = XmlElementTree.fromstring(content)
2844 for vm_xml in vm_list_xmlroot:
bayramovb6ffe792016-09-28 11:50:56 +04002845 if vm_xml.tag.split("}")[1] == 'VMRecord' and vm_xml.attrib['isVAppTemplate'] == 'false':
2846 # lookup done by UUID
bayramovef390722016-09-27 03:34:46 -07002847 if isuuid:
bayramovef390722016-09-27 03:34:46 -07002848 if vapp_name in vm_xml.attrib['container']:
2849 rawuuid = vm_xml.attrib['href'].split('/')[-1:]
2850 if 'vm-' in rawuuid[0]:
bayramovef390722016-09-27 03:34:46 -07002851 vm_dict[rawuuid[0][3:]] = vm_xml.attrib
bayramovb6ffe792016-09-28 11:50:56 +04002852 break
2853 # lookup done by Name
2854 else:
2855 if vapp_name in vm_xml.attrib['name']:
2856 rawuuid = vm_xml.attrib['href'].split('/')[-1:]
2857 if 'vm-' in rawuuid[0]:
2858 vm_dict[rawuuid[0][3:]] = vm_xml.attrib
2859 break
bayramovef390722016-09-27 03:34:46 -07002860 except:
2861 pass
2862
2863 return vm_dict
2864
2865 def get_network_action(self, network_uuid=None):
2866 """
2867 Method leverages vCloud director and query network based on network uuid
2868
2869 Args:
2870 vca - is active VCA connection.
2871 network_uuid - is a network uuid
2872
2873 Returns:
2874 The return XML respond
2875 """
2876
bayramovef390722016-09-27 03:34:46 -07002877 if network_uuid is None:
2878 return None
2879
kasarc5bf2932018-03-09 04:15:22 -08002880 url_list = [self.url, '/api/network/', network_uuid]
bayramovef390722016-09-27 03:34:46 -07002881 vm_list_rest_call = ''.join(url_list)
2882
kasarc5bf2932018-03-09 04:15:22 -08002883 if self.client._session:
2884 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
2885 'x-vcloud-authorization': self.client._session.headers['x-vcloud-authorization']}
bhangare1a0b97c2017-06-21 02:20:15 -07002886
kasarc5bf2932018-03-09 04:15:22 -08002887 response = self.perform_request(req_type='GET',
2888 url=vm_list_rest_call,
2889 headers=headers)
bhangare1a0b97c2017-06-21 02:20:15 -07002890 #Retry login if session expired & retry sending request
2891 if response.status_code == 403:
2892 response = self.retry_rest('GET', vm_list_rest_call)
2893
bayramovef390722016-09-27 03:34:46 -07002894 if response.status_code == requests.codes.ok:
2895 return response.content
2896
2897 return None
2898
2899 def get_vcd_network(self, network_uuid=None):
2900 """
2901 Method retrieves available network from vCloud Director
2902
2903 Args:
2904 network_uuid - is VCD network UUID
2905
2906 Each element serialized as key : value pair
2907
2908 Following keys available for access. network_configuration['Gateway'}
2909 <Configuration>
2910 <IpScopes>
2911 <IpScope>
2912 <IsInherited>true</IsInherited>
2913 <Gateway>172.16.252.100</Gateway>
2914 <Netmask>255.255.255.0</Netmask>
2915 <Dns1>172.16.254.201</Dns1>
2916 <Dns2>172.16.254.202</Dns2>
2917 <DnsSuffix>vmwarelab.edu</DnsSuffix>
2918 <IsEnabled>true</IsEnabled>
2919 <IpRanges>
2920 <IpRange>
2921 <StartAddress>172.16.252.1</StartAddress>
2922 <EndAddress>172.16.252.99</EndAddress>
2923 </IpRange>
2924 </IpRanges>
2925 </IpScope>
2926 </IpScopes>
2927 <FenceMode>bridged</FenceMode>
2928
2929 Returns:
2930 The return dictionary and key for each entry vapp UUID
2931 """
2932
2933 network_configuration = {}
2934 if network_uuid is None:
2935 return network_uuid
2936
bayramovef390722016-09-27 03:34:46 -07002937 try:
bhangarebfdca492017-03-11 01:32:46 -08002938 content = self.get_network_action(network_uuid=network_uuid)
bayramovef390722016-09-27 03:34:46 -07002939 vm_list_xmlroot = XmlElementTree.fromstring(content)
2940
2941 network_configuration['status'] = vm_list_xmlroot.get("status")
2942 network_configuration['name'] = vm_list_xmlroot.get("name")
2943 network_configuration['uuid'] = vm_list_xmlroot.get("id").split(":")[3]
2944
2945 for child in vm_list_xmlroot:
2946 if child.tag.split("}")[1] == 'IsShared':
2947 network_configuration['isShared'] = child.text.strip()
2948 if child.tag.split("}")[1] == 'Configuration':
2949 for configuration in child.iter():
2950 tagKey = configuration.tag.split("}")[1].strip()
2951 if tagKey != "":
2952 network_configuration[tagKey] = configuration.text.strip()
2953 return network_configuration
bhangarebfdca492017-03-11 01:32:46 -08002954 except Exception as exp :
2955 self.logger.debug("get_vcd_network: Failed with Exception {}".format(exp))
2956 raise vimconn.vimconnException("get_vcd_network: Failed with Exception {}".format(exp))
bayramovef390722016-09-27 03:34:46 -07002957
2958 return network_configuration
2959
2960 def delete_network_action(self, network_uuid=None):
2961 """
2962 Method delete given network from vCloud director
2963
2964 Args:
2965 network_uuid - is a network uuid that client wish to delete
2966
2967 Returns:
2968 The return None or XML respond or false
2969 """
kasarc5bf2932018-03-09 04:15:22 -08002970 client = self.connect_as_admin()
2971 if not client:
2972 raise vimconn.vimconnConnectionException("Failed to connect vCD as admin")
bayramovef390722016-09-27 03:34:46 -07002973 if network_uuid is None:
2974 return False
2975
kasarc5bf2932018-03-09 04:15:22 -08002976 url_list = [self.url, '/api/admin/network/', network_uuid]
bayramovef390722016-09-27 03:34:46 -07002977 vm_list_rest_call = ''.join(url_list)
2978
kasarc5bf2932018-03-09 04:15:22 -08002979 if client._session:
2980 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
2981 'x-vcloud-authorization': client._session.headers['x-vcloud-authorization']}
2982 response = self.perform_request(req_type='DELETE',
2983 url=vm_list_rest_call,
2984 headers=headers)
bayramovef390722016-09-27 03:34:46 -07002985 if response.status_code == 202:
2986 return True
2987
2988 return False
2989
bhangare0e571a92017-01-12 04:02:23 -08002990 def create_network(self, network_name=None, net_type='bridge', parent_network_uuid=None,
2991 ip_profile=None, isshared='true'):
bayramovef390722016-09-27 03:34:46 -07002992 """
2993 Method create network in vCloud director
2994
2995 Args:
2996 network_name - is network name to be created.
bhangare0e571a92017-01-12 04:02:23 -08002997 net_type - can be 'bridge','data','ptp','mgmt'.
2998 ip_profile is a dict containing the IP parameters of the network
2999 isshared - is a boolean
bayramovef390722016-09-27 03:34:46 -07003000 parent_network_uuid - is parent provider vdc network that will be used for mapping.
3001 It optional attribute. by default if no parent network indicate the first available will be used.
3002
3003 Returns:
3004 The return network uuid or return None
3005 """
3006
bayramov5761ad12016-10-04 09:00:30 +04003007 new_network_name = [network_name, '-', str(uuid.uuid4())]
3008 content = self.create_network_rest(network_name=''.join(new_network_name),
bhangare0e571a92017-01-12 04:02:23 -08003009 ip_profile=ip_profile,
3010 net_type=net_type,
bayramovef390722016-09-27 03:34:46 -07003011 parent_network_uuid=parent_network_uuid,
3012 isshared=isshared)
3013 if content is None:
3014 self.logger.debug("Failed create network {}.".format(network_name))
3015 return None
3016
3017 try:
3018 vm_list_xmlroot = XmlElementTree.fromstring(content)
3019 vcd_uuid = vm_list_xmlroot.get('id').split(":")
3020 if len(vcd_uuid) == 4:
bhangarebfdca492017-03-11 01:32:46 -08003021 self.logger.info("Created new network name: {} uuid: {}".format(network_name, vcd_uuid[3]))
bayramovef390722016-09-27 03:34:46 -07003022 return vcd_uuid[3]
3023 except:
3024 self.logger.debug("Failed create network {}".format(network_name))
3025 return None
3026
bhangare0e571a92017-01-12 04:02:23 -08003027 def create_network_rest(self, network_name=None, net_type='bridge', parent_network_uuid=None,
3028 ip_profile=None, isshared='true'):
bayramovef390722016-09-27 03:34:46 -07003029 """
3030 Method create network in vCloud director
3031
3032 Args:
3033 network_name - is network name to be created.
bhangare0e571a92017-01-12 04:02:23 -08003034 net_type - can be 'bridge','data','ptp','mgmt'.
3035 ip_profile is a dict containing the IP parameters of the network
3036 isshared - is a boolean
bayramovef390722016-09-27 03:34:46 -07003037 parent_network_uuid - is parent provider vdc network that will be used for mapping.
3038 It optional attribute. by default if no parent network indicate the first available will be used.
3039
3040 Returns:
3041 The return network uuid or return None
3042 """
kasarc5bf2932018-03-09 04:15:22 -08003043 client_as_admin = self.connect_as_admin()
3044 if not client_as_admin:
3045 raise vimconn.vimconnConnectionException("Failed to connect vCD.")
bayramovef390722016-09-27 03:34:46 -07003046 if network_name is None:
3047 return None
3048
kasarc5bf2932018-03-09 04:15:22 -08003049 url_list = [self.url, '/api/admin/vdc/', self.tenant_id]
bayramovef390722016-09-27 03:34:46 -07003050 vm_list_rest_call = ''.join(url_list)
kasarc5bf2932018-03-09 04:15:22 -08003051
3052 if client_as_admin._session:
3053 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
3054 'x-vcloud-authorization': client_as_admin._session.headers['x-vcloud-authorization']}
3055
3056 response = self.perform_request(req_type='GET',
3057 url=vm_list_rest_call,
3058 headers=headers)
bayramovef390722016-09-27 03:34:46 -07003059
3060 provider_network = None
3061 available_networks = None
3062 add_vdc_rest_url = None
3063
3064 if response.status_code != requests.codes.ok:
3065 self.logger.debug("REST API call {} failed. Return status code {}".format(vm_list_rest_call,
3066 response.status_code))
3067 return None
3068 else:
3069 try:
3070 vm_list_xmlroot = XmlElementTree.fromstring(response.content)
3071 for child in vm_list_xmlroot:
3072 if child.tag.split("}")[1] == 'ProviderVdcReference':
3073 provider_network = child.attrib.get('href')
3074 # application/vnd.vmware.admin.providervdc+xml
3075 if child.tag.split("}")[1] == 'Link':
3076 if child.attrib.get('type') == 'application/vnd.vmware.vcloud.orgVdcNetwork+xml' \
3077 and child.attrib.get('rel') == 'add':
3078 add_vdc_rest_url = child.attrib.get('href')
3079 except:
3080 self.logger.debug("Failed parse respond for rest api call {}".format(vm_list_rest_call))
3081 self.logger.debug("Respond body {}".format(response.content))
3082 return None
3083
3084 # find pvdc provided available network
kasarc5bf2932018-03-09 04:15:22 -08003085 response = self.perform_request(req_type='GET',
3086 url=provider_network,
3087 headers=headers)
bayramovef390722016-09-27 03:34:46 -07003088 if response.status_code != requests.codes.ok:
3089 self.logger.debug("REST API call {} failed. Return status code {}".format(vm_list_rest_call,
3090 response.status_code))
3091 return None
3092
bayramovef390722016-09-27 03:34:46 -07003093 if parent_network_uuid is None:
3094 try:
3095 vm_list_xmlroot = XmlElementTree.fromstring(response.content)
3096 for child in vm_list_xmlroot.iter():
3097 if child.tag.split("}")[1] == 'AvailableNetworks':
3098 for networks in child.iter():
3099 # application/vnd.vmware.admin.network+xml
3100 if networks.attrib.get('href') is not None:
3101 available_networks = networks.attrib.get('href')
3102 break
3103 except:
3104 return None
3105
bhangarebfdca492017-03-11 01:32:46 -08003106 try:
3107 #Configure IP profile of the network
3108 ip_profile = ip_profile if ip_profile is not None else DEFAULT_IP_PROFILE
bhangare0e571a92017-01-12 04:02:23 -08003109
kasarde691232017-03-25 03:37:31 -07003110 if 'subnet_address' not in ip_profile or ip_profile['subnet_address'] is None:
3111 subnet_rand = random.randint(0, 255)
3112 ip_base = "192.168.{}.".format(subnet_rand)
3113 ip_profile['subnet_address'] = ip_base + "0/24"
3114 else:
3115 ip_base = ip_profile['subnet_address'].rsplit('.',1)[0] + '.'
3116
bhangarebfdca492017-03-11 01:32:46 -08003117 if 'gateway_address' not in ip_profile or ip_profile['gateway_address'] is None:
kasarde691232017-03-25 03:37:31 -07003118 ip_profile['gateway_address']=ip_base + "1"
bhangarebfdca492017-03-11 01:32:46 -08003119 if 'dhcp_count' not in ip_profile or ip_profile['dhcp_count'] is None:
3120 ip_profile['dhcp_count']=DEFAULT_IP_PROFILE['dhcp_count']
bhangarebfdca492017-03-11 01:32:46 -08003121 if 'dhcp_enabled' not in ip_profile or ip_profile['dhcp_enabled'] is None:
3122 ip_profile['dhcp_enabled']=DEFAULT_IP_PROFILE['dhcp_enabled']
3123 if 'dhcp_start_address' not in ip_profile or ip_profile['dhcp_start_address'] is None:
kasarde691232017-03-25 03:37:31 -07003124 ip_profile['dhcp_start_address']=ip_base + "3"
bhangarebfdca492017-03-11 01:32:46 -08003125 if 'ip_version' not in ip_profile or ip_profile['ip_version'] is None:
3126 ip_profile['ip_version']=DEFAULT_IP_PROFILE['ip_version']
3127 if 'dns_address' not in ip_profile or ip_profile['dns_address'] is None:
kasarde691232017-03-25 03:37:31 -07003128 ip_profile['dns_address']=ip_base + "2"
bhangare0e571a92017-01-12 04:02:23 -08003129
bhangarebfdca492017-03-11 01:32:46 -08003130 gateway_address=ip_profile['gateway_address']
3131 dhcp_count=int(ip_profile['dhcp_count'])
3132 subnet_address=self.convert_cidr_to_netmask(ip_profile['subnet_address'])
bhangare0e571a92017-01-12 04:02:23 -08003133
bhangarebfdca492017-03-11 01:32:46 -08003134 if ip_profile['dhcp_enabled']==True:
3135 dhcp_enabled='true'
3136 else:
3137 dhcp_enabled='false'
3138 dhcp_start_address=ip_profile['dhcp_start_address']
bhangare0e571a92017-01-12 04:02:23 -08003139
bhangarebfdca492017-03-11 01:32:46 -08003140 #derive dhcp_end_address from dhcp_start_address & dhcp_count
3141 end_ip_int = int(netaddr.IPAddress(dhcp_start_address))
3142 end_ip_int += dhcp_count - 1
3143 dhcp_end_address = str(netaddr.IPAddress(end_ip_int))
3144
3145 ip_version=ip_profile['ip_version']
3146 dns_address=ip_profile['dns_address']
3147 except KeyError as exp:
3148 self.logger.debug("Create Network REST: Key error {}".format(exp))
3149 raise vimconn.vimconnException("Create Network REST: Key error{}".format(exp))
bhangare0e571a92017-01-12 04:02:23 -08003150
bayramovef390722016-09-27 03:34:46 -07003151 # either use client provided UUID or search for a first available
3152 # if both are not defined we return none
3153 if parent_network_uuid is not None:
kasarc5bf2932018-03-09 04:15:22 -08003154 url_list = [self.url, '/api/admin/network/', parent_network_uuid]
bayramovef390722016-09-27 03:34:46 -07003155 add_vdc_rest_url = ''.join(url_list)
3156
bhangare06312472017-03-30 05:49:07 -07003157 #Creating all networks as Direct Org VDC type networks.
3158 #Unused in case of Underlay (data/ptp) network interface.
3159 fence_mode="bridged"
3160 is_inherited='false'
tierno455612d2017-05-30 16:40:10 +02003161 dns_list = dns_address.split(";")
3162 dns1 = dns_list[0]
3163 dns2_text = ""
3164 if len(dns_list) >= 2:
3165 dns2_text = "\n <Dns2>{}</Dns2>\n".format(dns_list[1])
bhangare06312472017-03-30 05:49:07 -07003166 data = """ <OrgVdcNetwork name="{0:s}" xmlns="http://www.vmware.com/vcloud/v1.5">
3167 <Description>Openmano created</Description>
3168 <Configuration>
3169 <IpScopes>
3170 <IpScope>
3171 <IsInherited>{1:s}</IsInherited>
3172 <Gateway>{2:s}</Gateway>
3173 <Netmask>{3:s}</Netmask>
tierno455612d2017-05-30 16:40:10 +02003174 <Dns1>{4:s}</Dns1>{5:s}
3175 <IsEnabled>{6:s}</IsEnabled>
bhangare06312472017-03-30 05:49:07 -07003176 <IpRanges>
3177 <IpRange>
tierno455612d2017-05-30 16:40:10 +02003178 <StartAddress>{7:s}</StartAddress>
3179 <EndAddress>{8:s}</EndAddress>
bhangare06312472017-03-30 05:49:07 -07003180 </IpRange>
3181 </IpRanges>
3182 </IpScope>
3183 </IpScopes>
tierno455612d2017-05-30 16:40:10 +02003184 <ParentNetwork href="{9:s}"/>
3185 <FenceMode>{10:s}</FenceMode>
bhangare06312472017-03-30 05:49:07 -07003186 </Configuration>
tierno455612d2017-05-30 16:40:10 +02003187 <IsShared>{11:s}</IsShared>
bhangare06312472017-03-30 05:49:07 -07003188 </OrgVdcNetwork> """.format(escape(network_name), is_inherited, gateway_address,
tierno455612d2017-05-30 16:40:10 +02003189 subnet_address, dns1, dns2_text, dhcp_enabled,
bhangare06312472017-03-30 05:49:07 -07003190 dhcp_start_address, dhcp_end_address, available_networks,
3191 fence_mode, isshared)
bayramovef390722016-09-27 03:34:46 -07003192
bayramovef390722016-09-27 03:34:46 -07003193 headers['Content-Type'] = 'application/vnd.vmware.vcloud.orgVdcNetwork+xml'
bhangare0e571a92017-01-12 04:02:23 -08003194 try:
kasarc5bf2932018-03-09 04:15:22 -08003195 response = self.perform_request(req_type='POST',
3196 url=add_vdc_rest_url,
3197 headers=headers,
3198 data=data)
bayramovef390722016-09-27 03:34:46 -07003199
bhangare0e571a92017-01-12 04:02:23 -08003200 if response.status_code != 201:
bhangarebfdca492017-03-11 01:32:46 -08003201 self.logger.debug("Create Network POST REST API call failed. Return status code {}, Response content: {}"
3202 .format(response.status_code,response.content))
bhangare0e571a92017-01-12 04:02:23 -08003203 else:
kasarc5bf2932018-03-09 04:15:22 -08003204 network_task = self.get_task_from_response(response.content)
3205 self.logger.debug("Create Network REST : Waiting for Network creation complete")
3206 time.sleep(5)
3207 result = self.client.get_task_monitor().wait_for_success(task=network_task)
3208 if result.get('status') == 'success':
3209 return response.content
3210 else:
3211 self.logger.debug("create_network_rest task failed. Network Create response : {}"
3212 .format(response.content))
bhangare0e571a92017-01-12 04:02:23 -08003213 except Exception as exp:
3214 self.logger.debug("create_network_rest : Exception : {} ".format(exp))
3215
3216 return None
3217
3218 def convert_cidr_to_netmask(self, cidr_ip=None):
3219 """
3220 Method sets convert CIDR netmask address to normal IP format
3221 Args:
3222 cidr_ip : CIDR IP address
3223 Returns:
3224 netmask : Converted netmask
3225 """
3226 if cidr_ip is not None:
3227 if '/' in cidr_ip:
3228 network, net_bits = cidr_ip.split('/')
3229 netmask = socket.inet_ntoa(struct.pack(">I", (0xffffffff << (32 - int(net_bits))) & 0xffffffff))
3230 else:
3231 netmask = cidr_ip
3232 return netmask
bayramovef390722016-09-27 03:34:46 -07003233 return None
3234
3235 def get_provider_rest(self, vca=None):
3236 """
3237 Method gets provider vdc view from vcloud director
3238
3239 Args:
3240 network_name - is network name to be created.
3241 parent_network_uuid - is parent provider vdc network that will be used for mapping.
3242 It optional attribute. by default if no parent network indicate the first available will be used.
3243
3244 Returns:
3245 The return xml content of respond or None
3246 """
3247
kasarc5bf2932018-03-09 04:15:22 -08003248 url_list = [self.url, '/api/admin']
3249 if vca:
3250 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
3251 'x-vcloud-authorization': self.client._session.headers['x-vcloud-authorization']}
3252 response = self.perform_request(req_type='GET',
3253 url=''.join(url_list),
3254 headers=headers)
bayramovef390722016-09-27 03:34:46 -07003255
3256 if response.status_code == requests.codes.ok:
3257 return response.content
3258 return None
3259
3260 def create_vdc(self, vdc_name=None):
3261
3262 vdc_dict = {}
3263
3264 xml_content = self.create_vdc_from_tmpl_rest(vdc_name=vdc_name)
3265 if xml_content is not None:
bayramovef390722016-09-27 03:34:46 -07003266 try:
3267 task_resp_xmlroot = XmlElementTree.fromstring(xml_content)
3268 for child in task_resp_xmlroot:
3269 if child.tag.split("}")[1] == 'Owner':
3270 vdc_id = child.attrib.get('href').split("/")[-1]
3271 vdc_dict[vdc_id] = task_resp_xmlroot.get('href')
3272 return vdc_dict
3273 except:
3274 self.logger.debug("Respond body {}".format(xml_content))
3275
3276 return None
3277
3278 def create_vdc_from_tmpl_rest(self, vdc_name=None):
3279 """
3280 Method create vdc in vCloud director based on VDC template.
kasarc5bf2932018-03-09 04:15:22 -08003281 it uses pre-defined template.
bayramovef390722016-09-27 03:34:46 -07003282
3283 Args:
3284 vdc_name - name of a new vdc.
3285
3286 Returns:
3287 The return xml content of respond or None
3288 """
kasarc5bf2932018-03-09 04:15:22 -08003289 # pre-requesite atleast one vdc template should be available in vCD
bayramovef390722016-09-27 03:34:46 -07003290 self.logger.info("Creating new vdc {}".format(vdc_name))
kasarc5bf2932018-03-09 04:15:22 -08003291 vca = self.connect_as_admin()
bayramovef390722016-09-27 03:34:46 -07003292 if not vca:
kasarc5bf2932018-03-09 04:15:22 -08003293 raise vimconn.vimconnConnectionException("Failed to connect vCD")
bayramovef390722016-09-27 03:34:46 -07003294 if vdc_name is None:
3295 return None
3296
kasarc5bf2932018-03-09 04:15:22 -08003297 url_list = [self.url, '/api/vdcTemplates']
bayramovef390722016-09-27 03:34:46 -07003298 vm_list_rest_call = ''.join(url_list)
kasarc5bf2932018-03-09 04:15:22 -08003299
3300 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
3301 'x-vcloud-authorization': vca._session.headers['x-vcloud-authorization']}
3302 response = self.perform_request(req_type='GET',
3303 url=vm_list_rest_call,
3304 headers=headers)
bayramovef390722016-09-27 03:34:46 -07003305
3306 # container url to a template
3307 vdc_template_ref = None
3308 try:
3309 vm_list_xmlroot = XmlElementTree.fromstring(response.content)
3310 for child in vm_list_xmlroot:
3311 # application/vnd.vmware.admin.providervdc+xml
3312 # we need find a template from witch we instantiate VDC
3313 if child.tag.split("}")[1] == 'VdcTemplate':
kated47ad5f2017-08-03 02:16:13 -07003314 if child.attrib.get('type') == 'application/vnd.vmware.admin.vdcTemplate+xml':
bayramovef390722016-09-27 03:34:46 -07003315 vdc_template_ref = child.attrib.get('href')
3316 except:
3317 self.logger.debug("Failed parse respond for rest api call {}".format(vm_list_rest_call))
3318 self.logger.debug("Respond body {}".format(response.content))
3319 return None
3320
3321 # if we didn't found required pre defined template we return None
3322 if vdc_template_ref is None:
3323 return None
3324
3325 try:
3326 # instantiate vdc
kasarc5bf2932018-03-09 04:15:22 -08003327 url_list = [self.url, '/api/org/', self.org_uuid, '/action/instantiate']
bayramovef390722016-09-27 03:34:46 -07003328 vm_list_rest_call = ''.join(url_list)
3329 data = """<InstantiateVdcTemplateParams name="{0:s}" xmlns="http://www.vmware.com/vcloud/v1.5">
3330 <Source href="{1:s}"></Source>
3331 <Description>opnemano</Description>
3332 </InstantiateVdcTemplateParams>""".format(vdc_name, vdc_template_ref)
kated47ad5f2017-08-03 02:16:13 -07003333
kasarc5bf2932018-03-09 04:15:22 -08003334 headers['Content-Type'] = 'application/vnd.vmware.vcloud.instantiateVdcTemplateParams+xml'
3335
3336 response = self.perform_request(req_type='POST',
3337 url=vm_list_rest_call,
3338 headers=headers,
3339 data=data)
3340
3341 vdc_task = self.get_task_from_response(response.content)
3342 self.client.get_task_monitor().wait_for_success(task=vdc_task)
kated47ad5f2017-08-03 02:16:13 -07003343
bayramovef390722016-09-27 03:34:46 -07003344 # if we all ok we respond with content otherwise by default None
3345 if response.status_code >= 200 and response.status_code < 300:
3346 return response.content
3347 return None
3348 except:
3349 self.logger.debug("Failed parse respond for rest api call {}".format(vm_list_rest_call))
3350 self.logger.debug("Respond body {}".format(response.content))
3351
3352 return None
3353
3354 def create_vdc_rest(self, vdc_name=None):
3355 """
3356 Method create network in vCloud director
3357
3358 Args:
kasarc5bf2932018-03-09 04:15:22 -08003359 vdc_name - vdc name to be created
bayramovef390722016-09-27 03:34:46 -07003360 Returns:
kasarc5bf2932018-03-09 04:15:22 -08003361 The return response
bayramovef390722016-09-27 03:34:46 -07003362 """
3363
3364 self.logger.info("Creating new vdc {}".format(vdc_name))
bayramovef390722016-09-27 03:34:46 -07003365
3366 vca = self.connect_as_admin()
3367 if not vca:
kasarc5bf2932018-03-09 04:15:22 -08003368 raise vimconn.vimconnConnectionException("Failed to connect vCD")
bayramovef390722016-09-27 03:34:46 -07003369 if vdc_name is None:
3370 return None
3371
kasarc5bf2932018-03-09 04:15:22 -08003372 url_list = [self.url, '/api/admin/org/', self.org_uuid]
bayramovef390722016-09-27 03:34:46 -07003373 vm_list_rest_call = ''.join(url_list)
kasarc5bf2932018-03-09 04:15:22 -08003374
3375 if vca._session:
3376 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
3377 'x-vcloud-authorization': self.client._session.headers['x-vcloud-authorization']}
3378 response = self.perform_request(req_type='GET',
3379 url=vm_list_rest_call,
3380 headers=headers)
bayramovef390722016-09-27 03:34:46 -07003381
3382 provider_vdc_ref = None
3383 add_vdc_rest_url = None
3384 available_networks = None
3385
3386 if response.status_code != requests.codes.ok:
3387 self.logger.debug("REST API call {} failed. Return status code {}".format(vm_list_rest_call,
3388 response.status_code))
3389 return None
3390 else:
3391 try:
3392 vm_list_xmlroot = XmlElementTree.fromstring(response.content)
3393 for child in vm_list_xmlroot:
3394 # application/vnd.vmware.admin.providervdc+xml
3395 if child.tag.split("}")[1] == 'Link':
3396 if child.attrib.get('type') == 'application/vnd.vmware.admin.createVdcParams+xml' \
3397 and child.attrib.get('rel') == 'add':
3398 add_vdc_rest_url = child.attrib.get('href')
3399 except:
3400 self.logger.debug("Failed parse respond for rest api call {}".format(vm_list_rest_call))
3401 self.logger.debug("Respond body {}".format(response.content))
3402 return None
3403
3404 response = self.get_provider_rest(vca=vca)
bayramovef390722016-09-27 03:34:46 -07003405 try:
3406 vm_list_xmlroot = XmlElementTree.fromstring(response)
3407 for child in vm_list_xmlroot:
3408 if child.tag.split("}")[1] == 'ProviderVdcReferences':
3409 for sub_child in child:
3410 provider_vdc_ref = sub_child.attrib.get('href')
3411 except:
3412 self.logger.debug("Failed parse respond for rest api call {}".format(vm_list_rest_call))
3413 self.logger.debug("Respond body {}".format(response))
3414 return None
3415
bayramovef390722016-09-27 03:34:46 -07003416 if add_vdc_rest_url is not None and provider_vdc_ref is not None:
3417 data = """ <CreateVdcParams name="{0:s}" xmlns="http://www.vmware.com/vcloud/v1.5"><Description>{1:s}</Description>
3418 <AllocationModel>ReservationPool</AllocationModel>
3419 <ComputeCapacity><Cpu><Units>MHz</Units><Allocated>2048</Allocated><Limit>2048</Limit></Cpu>
3420 <Memory><Units>MB</Units><Allocated>2048</Allocated><Limit>2048</Limit></Memory>
3421 </ComputeCapacity><NicQuota>0</NicQuota><NetworkQuota>100</NetworkQuota>
3422 <VdcStorageProfile><Enabled>true</Enabled><Units>MB</Units><Limit>20480</Limit><Default>true</Default></VdcStorageProfile>
3423 <ProviderVdcReference
3424 name="Main Provider"
3425 href="{2:s}" />
3426 <UsesFastProvisioning>true</UsesFastProvisioning></CreateVdcParams>""".format(escape(vdc_name),
3427 escape(vdc_name),
3428 provider_vdc_ref)
3429
bayramovef390722016-09-27 03:34:46 -07003430 headers['Content-Type'] = 'application/vnd.vmware.admin.createVdcParams+xml'
kasarc5bf2932018-03-09 04:15:22 -08003431
3432 response = self.perform_request(req_type='POST',
3433 url=add_vdc_rest_url,
3434 headers=headers,
3435 data=data)
bayramovef390722016-09-27 03:34:46 -07003436
bayramovef390722016-09-27 03:34:46 -07003437 # if we all ok we respond with content otherwise by default None
3438 if response.status_code == 201:
3439 return response.content
3440 return None
bayramovfe3f3c92016-10-04 07:53:41 +04003441
bhangarefda5f7c2017-01-12 23:50:34 -08003442 def get_vapp_details_rest(self, vapp_uuid=None, need_admin_access=False):
bayramovfe3f3c92016-10-04 07:53:41 +04003443 """
3444 Method retrieve vapp detail from vCloud director
3445
3446 Args:
3447 vapp_uuid - is vapp identifier.
3448
3449 Returns:
3450 The return network uuid or return None
3451 """
3452
3453 parsed_respond = {}
bhangarefda5f7c2017-01-12 23:50:34 -08003454 vca = None
bayramovfe3f3c92016-10-04 07:53:41 +04003455
bhangarefda5f7c2017-01-12 23:50:34 -08003456 if need_admin_access:
3457 vca = self.connect_as_admin()
3458 else:
kasarc5bf2932018-03-09 04:15:22 -08003459 vca = self.client
bhangarefda5f7c2017-01-12 23:50:34 -08003460
bayramovfe3f3c92016-10-04 07:53:41 +04003461 if not vca:
kasarc5bf2932018-03-09 04:15:22 -08003462 raise vimconn.vimconnConnectionException("Failed to connect vCD")
bayramovfe3f3c92016-10-04 07:53:41 +04003463 if vapp_uuid is None:
3464 return None
3465
kasarc5bf2932018-03-09 04:15:22 -08003466 url_list = [self.url, '/api/vApp/vapp-', vapp_uuid]
bayramovfe3f3c92016-10-04 07:53:41 +04003467 get_vapp_restcall = ''.join(url_list)
bhangarefda5f7c2017-01-12 23:50:34 -08003468
kasarc5bf2932018-03-09 04:15:22 -08003469 if vca._session:
3470 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
3471 'x-vcloud-authorization': vca._session.headers['x-vcloud-authorization']}
3472 response = self.perform_request(req_type='GET',
3473 url=get_vapp_restcall,
3474 headers=headers)
bayramovfe3f3c92016-10-04 07:53:41 +04003475
bhangare1a0b97c2017-06-21 02:20:15 -07003476 if response.status_code == 403:
3477 if need_admin_access == False:
3478 response = self.retry_rest('GET', get_vapp_restcall)
3479
bayramovfe3f3c92016-10-04 07:53:41 +04003480 if response.status_code != requests.codes.ok:
3481 self.logger.debug("REST API call {} failed. Return status code {}".format(get_vapp_restcall,
3482 response.status_code))
3483 return parsed_respond
3484
3485 try:
3486 xmlroot_respond = XmlElementTree.fromstring(response.content)
3487 parsed_respond['ovfDescriptorUploaded'] = xmlroot_respond.attrib['ovfDescriptorUploaded']
3488
bhangarea92ae392017-01-12 22:30:29 -08003489 namespaces = {"vssd":"http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData" ,
3490 'ovf': 'http://schemas.dmtf.org/ovf/envelope/1',
3491 'vmw': 'http://www.vmware.com/schema/ovf',
3492 'vm': 'http://www.vmware.com/vcloud/v1.5',
3493 'rasd':"http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData",
3494 "vmext":"http://www.vmware.com/vcloud/extension/v1.5",
3495 "xmlns":"http://www.vmware.com/vcloud/v1.5"
3496 }
bayramovfe3f3c92016-10-04 07:53:41 +04003497
bhangarea92ae392017-01-12 22:30:29 -08003498 created_section = xmlroot_respond.find('vm:DateCreated', namespaces)
bayramovfe3f3c92016-10-04 07:53:41 +04003499 if created_section is not None:
3500 parsed_respond['created'] = created_section.text
3501
bhangarea92ae392017-01-12 22:30:29 -08003502 network_section = xmlroot_respond.find('vm:NetworkConfigSection/vm:NetworkConfig', namespaces)
bayramov5761ad12016-10-04 09:00:30 +04003503 if network_section is not None and 'networkName' in network_section.attrib:
bayramovfe3f3c92016-10-04 07:53:41 +04003504 parsed_respond['networkname'] = network_section.attrib['networkName']
3505
3506 ipscopes_section = \
3507 xmlroot_respond.find('vm:NetworkConfigSection/vm:NetworkConfig/vm:Configuration/vm:IpScopes',
bhangarea92ae392017-01-12 22:30:29 -08003508 namespaces)
bayramovfe3f3c92016-10-04 07:53:41 +04003509 if ipscopes_section is not None:
3510 for ipscope in ipscopes_section:
3511 for scope in ipscope:
3512 tag_key = scope.tag.split("}")[1]
3513 if tag_key == 'IpRanges':
3514 ip_ranges = scope.getchildren()
3515 for ipblock in ip_ranges:
3516 for block in ipblock:
3517 parsed_respond[block.tag.split("}")[1]] = block.text
3518 else:
3519 parsed_respond[tag_key] = scope.text
3520
3521 # parse children section for other attrib
bhangarea92ae392017-01-12 22:30:29 -08003522 children_section = xmlroot_respond.find('vm:Children/', namespaces)
bayramovfe3f3c92016-10-04 07:53:41 +04003523 if children_section is not None:
3524 parsed_respond['name'] = children_section.attrib['name']
bhangarea92ae392017-01-12 22:30:29 -08003525 parsed_respond['nestedHypervisorEnabled'] = children_section.attrib['nestedHypervisorEnabled'] \
3526 if "nestedHypervisorEnabled" in children_section.attrib else None
bayramovfe3f3c92016-10-04 07:53:41 +04003527 parsed_respond['deployed'] = children_section.attrib['deployed']
3528 parsed_respond['status'] = children_section.attrib['status']
3529 parsed_respond['vmuuid'] = children_section.attrib['id'].split(":")[-1]
bhangarea92ae392017-01-12 22:30:29 -08003530 network_adapter = children_section.find('vm:NetworkConnectionSection', namespaces)
bayramovfe3f3c92016-10-04 07:53:41 +04003531 nic_list = []
3532 for adapters in network_adapter:
3533 adapter_key = adapters.tag.split("}")[1]
3534 if adapter_key == 'PrimaryNetworkConnectionIndex':
3535 parsed_respond['primarynetwork'] = adapters.text
3536 if adapter_key == 'NetworkConnection':
3537 vnic = {}
bayramov5761ad12016-10-04 09:00:30 +04003538 if 'network' in adapters.attrib:
bayramovfe3f3c92016-10-04 07:53:41 +04003539 vnic['network'] = adapters.attrib['network']
3540 for adapter in adapters:
3541 setting_key = adapter.tag.split("}")[1]
3542 vnic[setting_key] = adapter.text
3543 nic_list.append(vnic)
3544
3545 for link in children_section:
bayramov5761ad12016-10-04 09:00:30 +04003546 if link.tag.split("}")[1] == 'Link' and 'rel' in link.attrib:
bayramovfe3f3c92016-10-04 07:53:41 +04003547 if link.attrib['rel'] == 'screen:acquireTicket':
3548 parsed_respond['acquireTicket'] = link.attrib
3549 if link.attrib['rel'] == 'screen:acquireMksTicket':
3550 parsed_respond['acquireMksTicket'] = link.attrib
3551
3552 parsed_respond['interfaces'] = nic_list
bhangarefda5f7c2017-01-12 23:50:34 -08003553 vCloud_extension_section = children_section.find('xmlns:VCloudExtension', namespaces)
3554 if vCloud_extension_section is not None:
3555 vm_vcenter_info = {}
3556 vim_info = vCloud_extension_section.find('vmext:VmVimInfo', namespaces)
3557 vmext = vim_info.find('vmext:VmVimObjectRef', namespaces)
3558 if vmext is not None:
3559 vm_vcenter_info["vm_moref_id"] = vmext.find('vmext:MoRef', namespaces).text
bhangarefda5f7c2017-01-12 23:50:34 -08003560 parsed_respond["vm_vcenter_info"]= vm_vcenter_info
bayramovfe3f3c92016-10-04 07:53:41 +04003561
bhangarea92ae392017-01-12 22:30:29 -08003562 virtual_hardware_section = children_section.find('ovf:VirtualHardwareSection', namespaces)
3563 vm_virtual_hardware_info = {}
3564 if virtual_hardware_section is not None:
3565 for item in virtual_hardware_section.iterfind('ovf:Item',namespaces):
3566 if item.find("rasd:Description",namespaces).text == "Hard disk":
3567 disk_size = item.find("rasd:HostResource" ,namespaces
3568 ).attrib["{"+namespaces['vm']+"}capacity"]
3569
3570 vm_virtual_hardware_info["disk_size"]= disk_size
3571 break
3572
3573 for link in virtual_hardware_section:
3574 if link.tag.split("}")[1] == 'Link' and 'rel' in link.attrib:
3575 if link.attrib['rel'] == 'edit' and link.attrib['href'].endswith("/disks"):
3576 vm_virtual_hardware_info["disk_edit_href"] = link.attrib['href']
3577 break
3578
3579 parsed_respond["vm_virtual_hardware"]= vm_virtual_hardware_info
3580 except Exception as exp :
3581 self.logger.info("Error occurred calling rest api for getting vApp details {}".format(exp))
bayramovfe3f3c92016-10-04 07:53:41 +04003582 return parsed_respond
3583
kasarc5bf2932018-03-09 04:15:22 -08003584 def acquire_console(self, vm_uuid=None):
bayramovfe3f3c92016-10-04 07:53:41 +04003585
bayramovfe3f3c92016-10-04 07:53:41 +04003586 if vm_uuid is None:
3587 return None
kasarc5bf2932018-03-09 04:15:22 -08003588 if self.client._session:
3589 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
3590 'x-vcloud-authorization': self.client._session.headers['x-vcloud-authorization']}
3591 vm_dict = self.get_vapp_details_rest(vapp_uuid=vm_uuid)
bayramovfe3f3c92016-10-04 07:53:41 +04003592 console_dict = vm_dict['acquireTicket']
3593 console_rest_call = console_dict['href']
3594
kasarc5bf2932018-03-09 04:15:22 -08003595 response = self.perform_request(req_type='POST',
3596 url=console_rest_call,
3597 headers=headers)
3598
bhangare1a0b97c2017-06-21 02:20:15 -07003599 if response.status_code == 403:
3600 response = self.retry_rest('POST', console_rest_call)
bayramovfe3f3c92016-10-04 07:53:41 +04003601
bayramov5761ad12016-10-04 09:00:30 +04003602 if response.status_code == requests.codes.ok:
3603 return response.content
bayramovfe3f3c92016-10-04 07:53:41 +04003604
kate15f1c382016-12-15 01:12:40 -08003605 return None
kate13ab2c42016-12-23 01:34:24 -08003606
bhangarea92ae392017-01-12 22:30:29 -08003607 def modify_vm_disk(self, vapp_uuid, flavor_disk):
3608 """
3609 Method retrieve vm disk details
3610
3611 Args:
3612 vapp_uuid - is vapp identifier.
3613 flavor_disk - disk size as specified in VNFD (flavor)
3614
3615 Returns:
3616 The return network uuid or return None
3617 """
3618 status = None
3619 try:
3620 #Flavor disk is in GB convert it into MB
3621 flavor_disk = int(flavor_disk) * 1024
3622 vm_details = self.get_vapp_details_rest(vapp_uuid)
3623 if vm_details:
3624 vm_name = vm_details["name"]
3625 self.logger.info("VM: {} flavor_disk :{}".format(vm_name , flavor_disk))
3626
3627 if vm_details and "vm_virtual_hardware" in vm_details:
3628 vm_disk = int(vm_details["vm_virtual_hardware"]["disk_size"])
3629 disk_edit_href = vm_details["vm_virtual_hardware"]["disk_edit_href"]
3630
3631 self.logger.info("VM: {} VM_disk :{}".format(vm_name , vm_disk))
3632
3633 if flavor_disk > vm_disk:
3634 status = self.modify_vm_disk_rest(disk_edit_href ,flavor_disk)
3635 self.logger.info("Modify disk of VM {} from {} to {} MB".format(vm_name,
3636 vm_disk, flavor_disk ))
3637 else:
3638 status = True
3639 self.logger.info("No need to modify disk of VM {}".format(vm_name))
3640
3641 return status
3642 except Exception as exp:
3643 self.logger.info("Error occurred while modifing disk size {}".format(exp))
3644
3645
3646 def modify_vm_disk_rest(self, disk_href , disk_size):
3647 """
3648 Method retrieve modify vm disk size
3649
3650 Args:
3651 disk_href - vCD API URL to GET and PUT disk data
3652 disk_size - disk size as specified in VNFD (flavor)
3653
3654 Returns:
3655 The return network uuid or return None
3656 """
bhangarea92ae392017-01-12 22:30:29 -08003657 if disk_href is None or disk_size is None:
3658 return None
3659
kasarc5bf2932018-03-09 04:15:22 -08003660 if self.client._session:
3661 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
3662 'x-vcloud-authorization': self.client._session.headers['x-vcloud-authorization']}
3663 response = self.perform_request(req_type='GET',
3664 url=disk_href,
3665 headers=headers)
bhangare1a0b97c2017-06-21 02:20:15 -07003666
3667 if response.status_code == 403:
3668 response = self.retry_rest('GET', disk_href)
bhangarea92ae392017-01-12 22:30:29 -08003669
3670 if response.status_code != requests.codes.ok:
3671 self.logger.debug("GET REST API call {} failed. Return status code {}".format(disk_href,
3672 response.status_code))
3673 return None
3674 try:
3675 lxmlroot_respond = lxmlElementTree.fromstring(response.content)
3676 namespaces = {prefix:uri for prefix,uri in lxmlroot_respond.nsmap.iteritems() if prefix}
kasarc5bf2932018-03-09 04:15:22 -08003677 #For python3
3678 #namespaces = {prefix:uri for prefix,uri in lxmlroot_respond.nsmap.items() if prefix}
bhangarea92ae392017-01-12 22:30:29 -08003679 namespaces["xmlns"]= "http://www.vmware.com/vcloud/v1.5"
3680
3681 for item in lxmlroot_respond.iterfind('xmlns:Item',namespaces):
3682 if item.find("rasd:Description",namespaces).text == "Hard disk":
3683 disk_item = item.find("rasd:HostResource" ,namespaces )
3684 if disk_item is not None:
3685 disk_item.attrib["{"+namespaces['xmlns']+"}capacity"] = str(disk_size)
3686 break
3687
3688 data = lxmlElementTree.tostring(lxmlroot_respond, encoding='utf8', method='xml',
3689 xml_declaration=True)
3690
3691 #Send PUT request to modify disk size
bhangarea92ae392017-01-12 22:30:29 -08003692 headers['Content-Type'] = 'application/vnd.vmware.vcloud.rasdItemsList+xml; charset=ISO-8859-1'
3693
kasarc5bf2932018-03-09 04:15:22 -08003694 response = self.perform_request(req_type='PUT',
3695 url=disk_href,
3696 headers=headers,
3697 data=data)
bhangare1a0b97c2017-06-21 02:20:15 -07003698 if response.status_code == 403:
3699 add_headers = {'Content-Type': headers['Content-Type']}
3700 response = self.retry_rest('PUT', disk_href, add_headers, data)
bhangarea92ae392017-01-12 22:30:29 -08003701
3702 if response.status_code != 202:
3703 self.logger.debug("PUT REST API call {} failed. Return status code {}".format(disk_href,
3704 response.status_code))
3705 else:
kasarc5bf2932018-03-09 04:15:22 -08003706 modify_disk_task = self.get_task_from_response(response.content)
3707 result = self.client.get_task_monitor().wait_for_success(task=modify_disk_task)
3708 if result.get('status') == 'success':
3709 return True
3710 else:
3711 return False
bhangarea92ae392017-01-12 22:30:29 -08003712 return None
3713
3714 except Exception as exp :
3715 self.logger.info("Error occurred calling rest api for modifing disk size {}".format(exp))
3716 return None
3717
bhangarefda5f7c2017-01-12 23:50:34 -08003718 def add_pci_devices(self, vapp_uuid , pci_devices , vmname_andid):
3719 """
3720 Method to attach pci devices to VM
3721
3722 Args:
3723 vapp_uuid - uuid of vApp/VM
3724 pci_devices - pci devices infromation as specified in VNFD (flavor)
3725
3726 Returns:
3727 The status of add pci device task , vm object and
3728 vcenter_conect object
3729 """
3730 vm_obj = None
bhangarefda5f7c2017-01-12 23:50:34 -08003731 self.logger.info("Add pci devices {} into vApp {}".format(pci_devices , vapp_uuid))
bhangare06312472017-03-30 05:49:07 -07003732 vcenter_conect, content = self.get_vcenter_content()
3733 vm_moref_id = self.get_vm_moref_id(vapp_uuid)
kateeb044522017-03-06 23:54:39 -08003734
bhangare06312472017-03-30 05:49:07 -07003735 if vm_moref_id:
bhangarefda5f7c2017-01-12 23:50:34 -08003736 try:
3737 no_of_pci_devices = len(pci_devices)
3738 if no_of_pci_devices > 0:
bhangarefda5f7c2017-01-12 23:50:34 -08003739 #Get VM and its host
bhangare06312472017-03-30 05:49:07 -07003740 host_obj, vm_obj = self.get_vm_obj(content, vm_moref_id)
bhangarefda5f7c2017-01-12 23:50:34 -08003741 self.logger.info("VM {} is currently on host {}".format(vm_obj, host_obj))
3742 if host_obj and vm_obj:
3743 #get PCI devies from host on which vapp is currently installed
3744 avilable_pci_devices = self.get_pci_devices(host_obj, no_of_pci_devices)
3745
3746 if avilable_pci_devices is None:
3747 #find other hosts with active pci devices
3748 new_host_obj , avilable_pci_devices = self.get_host_and_PCIdevices(
3749 content,
3750 no_of_pci_devices
3751 )
3752
3753 if new_host_obj is not None and avilable_pci_devices is not None and len(avilable_pci_devices)> 0:
3754 #Migrate vm to the host where PCI devices are availble
3755 self.logger.info("Relocate VM {} on new host {}".format(vm_obj, new_host_obj))
3756 task = self.relocate_vm(new_host_obj, vm_obj)
3757 if task is not None:
3758 result = self.wait_for_vcenter_task(task, vcenter_conect)
3759 self.logger.info("Migrate VM status: {}".format(result))
3760 host_obj = new_host_obj
3761 else:
3762 self.logger.info("Fail to migrate VM : {}".format(result))
3763 raise vimconn.vimconnNotFoundException(
3764 "Fail to migrate VM : {} to host {}".format(
3765 vmname_andid,
3766 new_host_obj)
3767 )
3768
3769 if host_obj is not None and avilable_pci_devices is not None and len(avilable_pci_devices)> 0:
3770 #Add PCI devices one by one
3771 for pci_device in avilable_pci_devices:
3772 task = self.add_pci_to_vm(host_obj, vm_obj, pci_device)
3773 if task:
3774 status= self.wait_for_vcenter_task(task, vcenter_conect)
3775 if status:
3776 self.logger.info("Added PCI device {} to VM {}".format(pci_device,str(vm_obj)))
3777 else:
kateeb044522017-03-06 23:54:39 -08003778 self.logger.error("Fail to add PCI device {} to VM {}".format(pci_device,str(vm_obj)))
bhangarefda5f7c2017-01-12 23:50:34 -08003779 return True, vm_obj, vcenter_conect
3780 else:
3781 self.logger.error("Currently there is no host with"\
3782 " {} number of avaialble PCI devices required for VM {}".format(
3783 no_of_pci_devices,
3784 vmname_andid)
3785 )
3786 raise vimconn.vimconnNotFoundException(
3787 "Currently there is no host with {} "\
3788 "number of avaialble PCI devices required for VM {}".format(
3789 no_of_pci_devices,
3790 vmname_andid))
3791 else:
3792 self.logger.debug("No infromation about PCI devices {} ",pci_devices)
3793
3794 except vmodl.MethodFault as error:
3795 self.logger.error("Error occurred while adding PCI devices {} ",error)
3796 return None, vm_obj, vcenter_conect
3797
3798 def get_vm_obj(self, content, mob_id):
3799 """
3800 Method to get the vsphere VM object associated with a given morf ID
3801 Args:
3802 vapp_uuid - uuid of vApp/VM
3803 content - vCenter content object
3804 mob_id - mob_id of VM
3805
3806 Returns:
3807 VM and host object
3808 """
3809 vm_obj = None
3810 host_obj = None
3811 try :
3812 container = content.viewManager.CreateContainerView(content.rootFolder,
3813 [vim.VirtualMachine], True
3814 )
3815 for vm in container.view:
3816 mobID = vm._GetMoId()
3817 if mobID == mob_id:
3818 vm_obj = vm
3819 host_obj = vm_obj.runtime.host
3820 break
3821 except Exception as exp:
3822 self.logger.error("Error occurred while finding VM object : {}".format(exp))
3823 return host_obj, vm_obj
3824
3825 def get_pci_devices(self, host, need_devices):
3826 """
3827 Method to get the details of pci devices on given host
3828 Args:
3829 host - vSphere host object
3830 need_devices - number of pci devices needed on host
3831
3832 Returns:
3833 array of pci devices
3834 """
3835 all_devices = []
3836 all_device_ids = []
3837 used_devices_ids = []
3838
3839 try:
3840 if host:
3841 pciPassthruInfo = host.config.pciPassthruInfo
3842 pciDevies = host.hardware.pciDevice
3843
3844 for pci_status in pciPassthruInfo:
3845 if pci_status.passthruActive:
3846 for device in pciDevies:
3847 if device.id == pci_status.id:
3848 all_device_ids.append(device.id)
3849 all_devices.append(device)
3850
3851 #check if devices are in use
3852 avalible_devices = all_devices
3853 for vm in host.vm:
3854 if vm.runtime.powerState == vim.VirtualMachinePowerState.poweredOn:
3855 vm_devices = vm.config.hardware.device
3856 for device in vm_devices:
3857 if type(device) is vim.vm.device.VirtualPCIPassthrough:
3858 if device.backing.id in all_device_ids:
3859 for use_device in avalible_devices:
3860 if use_device.id == device.backing.id:
3861 avalible_devices.remove(use_device)
3862 used_devices_ids.append(device.backing.id)
3863 self.logger.debug("Device {} from devices {}"\
3864 "is in use".format(device.backing.id,
3865 device)
3866 )
3867 if len(avalible_devices) < need_devices:
3868 self.logger.debug("Host {} don't have {} number of active devices".format(host,
3869 need_devices))
3870 self.logger.debug("found only {} devives {}".format(len(avalible_devices),
3871 avalible_devices))
3872 return None
3873 else:
3874 required_devices = avalible_devices[:need_devices]
3875 self.logger.info("Found {} PCI devivces on host {} but required only {}".format(
3876 len(avalible_devices),
3877 host,
3878 need_devices))
3879 self.logger.info("Retruning {} devices as {}".format(need_devices,
3880 required_devices ))
3881 return required_devices
3882
3883 except Exception as exp:
3884 self.logger.error("Error {} occurred while finding pci devices on host: {}".format(exp, host))
3885
3886 return None
3887
3888 def get_host_and_PCIdevices(self, content, need_devices):
3889 """
3890 Method to get the details of pci devices infromation on all hosts
3891
3892 Args:
3893 content - vSphere host object
3894 need_devices - number of pci devices needed on host
3895
3896 Returns:
3897 array of pci devices and host object
3898 """
3899 host_obj = None
3900 pci_device_objs = None
3901 try:
3902 if content:
3903 container = content.viewManager.CreateContainerView(content.rootFolder,
3904 [vim.HostSystem], True)
3905 for host in container.view:
3906 devices = self.get_pci_devices(host, need_devices)
3907 if devices:
3908 host_obj = host
3909 pci_device_objs = devices
3910 break
3911 except Exception as exp:
3912 self.logger.error("Error {} occurred while finding pci devices on host: {}".format(exp, host_obj))
3913
3914 return host_obj,pci_device_objs
3915
3916 def relocate_vm(self, dest_host, vm) :
3917 """
3918 Method to get the relocate VM to new host
3919
3920 Args:
3921 dest_host - vSphere host object
3922 vm - vSphere VM object
3923
3924 Returns:
3925 task object
3926 """
3927 task = None
3928 try:
3929 relocate_spec = vim.vm.RelocateSpec(host=dest_host)
3930 task = vm.Relocate(relocate_spec)
3931 self.logger.info("Migrating {} to destination host {}".format(vm, dest_host))
3932 except Exception as exp:
3933 self.logger.error("Error occurred while relocate VM {} to new host {}: {}".format(
3934 dest_host, vm, exp))
3935 return task
3936
3937 def wait_for_vcenter_task(self, task, actionName='job', hideResult=False):
3938 """
3939 Waits and provides updates on a vSphere task
3940 """
3941 while task.info.state == vim.TaskInfo.State.running:
3942 time.sleep(2)
3943
3944 if task.info.state == vim.TaskInfo.State.success:
3945 if task.info.result is not None and not hideResult:
3946 self.logger.info('{} completed successfully, result: {}'.format(
3947 actionName,
3948 task.info.result))
3949 else:
3950 self.logger.info('Task {} completed successfully.'.format(actionName))
3951 else:
3952 self.logger.error('{} did not complete successfully: {} '.format(
3953 actionName,
3954 task.info.error)
3955 )
3956
3957 return task.info.result
3958
3959 def add_pci_to_vm(self,host_object, vm_object, host_pci_dev):
3960 """
3961 Method to add pci device in given VM
3962
3963 Args:
3964 host_object - vSphere host object
3965 vm_object - vSphere VM object
3966 host_pci_dev - host_pci_dev must be one of the devices from the
3967 host_object.hardware.pciDevice list
3968 which is configured as a PCI passthrough device
3969
3970 Returns:
3971 task object
3972 """
3973 task = None
3974 if vm_object and host_object and host_pci_dev:
3975 try :
3976 #Add PCI device to VM
3977 pci_passthroughs = vm_object.environmentBrowser.QueryConfigTarget(host=None).pciPassthrough
3978 systemid_by_pciid = {item.pciDevice.id: item.systemId for item in pci_passthroughs}
3979
3980 if host_pci_dev.id not in systemid_by_pciid:
3981 self.logger.error("Device {} is not a passthrough device ".format(host_pci_dev))
3982 return None
3983
3984 deviceId = hex(host_pci_dev.deviceId % 2**16).lstrip('0x')
3985 backing = vim.VirtualPCIPassthroughDeviceBackingInfo(deviceId=deviceId,
3986 id=host_pci_dev.id,
3987 systemId=systemid_by_pciid[host_pci_dev.id],
3988 vendorId=host_pci_dev.vendorId,
3989 deviceName=host_pci_dev.deviceName)
3990
3991 hba_object = vim.VirtualPCIPassthrough(key=-100, backing=backing)
3992
3993 new_device_config = vim.VirtualDeviceConfigSpec(device=hba_object)
3994 new_device_config.operation = "add"
3995 vmConfigSpec = vim.vm.ConfigSpec()
3996 vmConfigSpec.deviceChange = [new_device_config]
3997
3998 task = vm_object.ReconfigVM_Task(spec=vmConfigSpec)
3999 self.logger.info("Adding PCI device {} into VM {} from host {} ".format(
4000 host_pci_dev, vm_object, host_object)
4001 )
4002 except Exception as exp:
4003 self.logger.error("Error occurred while adding pci devive {} to VM {}: {}".format(
4004 host_pci_dev,
4005 vm_object,
4006 exp))
4007 return task
4008
bhangare06312472017-03-30 05:49:07 -07004009 def get_vm_vcenter_info(self):
bhangarefda5f7c2017-01-12 23:50:34 -08004010 """
kateeb044522017-03-06 23:54:39 -08004011 Method to get details of vCenter and vm
bhangarefda5f7c2017-01-12 23:50:34 -08004012
4013 Args:
4014 vapp_uuid - uuid of vApp or VM
4015
4016 Returns:
4017 Moref Id of VM and deails of vCenter
4018 """
kateeb044522017-03-06 23:54:39 -08004019 vm_vcenter_info = {}
bhangarefda5f7c2017-01-12 23:50:34 -08004020
kateeb044522017-03-06 23:54:39 -08004021 if self.vcenter_ip is not None:
4022 vm_vcenter_info["vm_vcenter_ip"] = self.vcenter_ip
4023 else:
4024 raise vimconn.vimconnException(message="vCenter IP is not provided."\
4025 " Please provide vCenter IP while attaching datacenter to tenant in --config")
4026 if self.vcenter_port is not None:
4027 vm_vcenter_info["vm_vcenter_port"] = self.vcenter_port
4028 else:
4029 raise vimconn.vimconnException(message="vCenter port is not provided."\
4030 " Please provide vCenter port while attaching datacenter to tenant in --config")
4031 if self.vcenter_user is not None:
4032 vm_vcenter_info["vm_vcenter_user"] = self.vcenter_user
4033 else:
4034 raise vimconn.vimconnException(message="vCenter user is not provided."\
4035 " Please provide vCenter user while attaching datacenter to tenant in --config")
bhangarefda5f7c2017-01-12 23:50:34 -08004036
kateeb044522017-03-06 23:54:39 -08004037 if self.vcenter_password is not None:
4038 vm_vcenter_info["vm_vcenter_password"] = self.vcenter_password
4039 else:
4040 raise vimconn.vimconnException(message="vCenter user password is not provided."\
4041 " Please provide vCenter user password while attaching datacenter to tenant in --config")
bhangarefda5f7c2017-01-12 23:50:34 -08004042
bhangare06312472017-03-30 05:49:07 -07004043 return vm_vcenter_info
bhangarefda5f7c2017-01-12 23:50:34 -08004044
4045
4046 def get_vm_pci_details(self, vmuuid):
4047 """
4048 Method to get VM PCI device details from vCenter
4049
4050 Args:
4051 vm_obj - vSphere VM object
4052
4053 Returns:
4054 dict of PCI devives attached to VM
4055
4056 """
4057 vm_pci_devices_info = {}
4058 try:
bhangare06312472017-03-30 05:49:07 -07004059 vcenter_conect, content = self.get_vcenter_content()
4060 vm_moref_id = self.get_vm_moref_id(vmuuid)
4061 if vm_moref_id:
bhangarefda5f7c2017-01-12 23:50:34 -08004062 #Get VM and its host
kateeb044522017-03-06 23:54:39 -08004063 if content:
bhangare06312472017-03-30 05:49:07 -07004064 host_obj, vm_obj = self.get_vm_obj(content, vm_moref_id)
kateeb044522017-03-06 23:54:39 -08004065 if host_obj and vm_obj:
4066 vm_pci_devices_info["host_name"]= host_obj.name
4067 vm_pci_devices_info["host_ip"]= host_obj.config.network.vnic[0].spec.ip.ipAddress
4068 for device in vm_obj.config.hardware.device:
4069 if type(device) == vim.vm.device.VirtualPCIPassthrough:
4070 device_details={'devide_id':device.backing.id,
4071 'pciSlotNumber':device.slotInfo.pciSlotNumber,
4072 }
4073 vm_pci_devices_info[device.deviceInfo.label] = device_details
4074 else:
4075 self.logger.error("Can not connect to vCenter while getting "\
4076 "PCI devices infromationn")
4077 return vm_pci_devices_info
bhangarefda5f7c2017-01-12 23:50:34 -08004078 except Exception as exp:
kateeb044522017-03-06 23:54:39 -08004079 self.logger.error("Error occurred while getting VM infromationn"\
4080 " for VM : {}".format(exp))
4081 raise vimconn.vimconnException(message=exp)
bhangare0e571a92017-01-12 04:02:23 -08004082
kasardc1f02e2017-03-25 07:20:30 -07004083 def add_network_adapter_to_vms(self, vapp, network_name, primary_nic_index, nicIndex, net, nic_type=None):
kasar3ac5dc42017-03-15 06:28:22 -07004084 """
4085 Method to add network adapter type to vm
4086 Args :
4087 network_name - name of network
4088 primary_nic_index - int value for primary nic index
4089 nicIndex - int value for nic index
4090 nic_type - specify model name to which add to vm
4091 Returns:
4092 None
4093 """
kasar3ac5dc42017-03-15 06:28:22 -07004094
kasar4cb6e902017-03-18 00:17:27 -07004095 try:
kasard2963622017-03-31 05:53:17 -07004096 ip_address = None
kasardc1f02e2017-03-25 07:20:30 -07004097 floating_ip = False
kasarc5bf2932018-03-09 04:15:22 -08004098 mac_address = None
kasardc1f02e2017-03-25 07:20:30 -07004099 if 'floating_ip' in net: floating_ip = net['floating_ip']
kasard2963622017-03-31 05:53:17 -07004100
4101 # Stub for ip_address feature
4102 if 'ip_address' in net: ip_address = net['ip_address']
4103
kasarc5bf2932018-03-09 04:15:22 -08004104 if 'mac_address' in net: mac_address = net['mac_address']
4105
kasard2963622017-03-31 05:53:17 -07004106 if floating_ip:
4107 allocation_mode = "POOL"
4108 elif ip_address:
4109 allocation_mode = "MANUAL"
4110 else:
4111 allocation_mode = "DHCP"
kasardc1f02e2017-03-25 07:20:30 -07004112
kasar3ac5dc42017-03-15 06:28:22 -07004113 if not nic_type:
kasarc5bf2932018-03-09 04:15:22 -08004114 for vms in vapp.get_all_vms():
4115 vm_id = vms.get('id').split(':')[-1]
kasar3ac5dc42017-03-15 06:28:22 -07004116
kasarc5bf2932018-03-09 04:15:22 -08004117 url_rest_call = "{}/api/vApp/vm-{}/networkConnectionSection/".format(self.url, vm_id)
kasar3ac5dc42017-03-15 06:28:22 -07004118
kasarc5bf2932018-03-09 04:15:22 -08004119 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
4120 'x-vcloud-authorization': self.client._session.headers['x-vcloud-authorization']}
4121 response = self.perform_request(req_type='GET',
4122 url=url_rest_call,
4123 headers=headers)
bhangare1a0b97c2017-06-21 02:20:15 -07004124
4125 if response.status_code == 403:
4126 response = self.retry_rest('GET', url_rest_call)
4127
kasar3ac5dc42017-03-15 06:28:22 -07004128 if response.status_code != 200:
kasar4cb6e902017-03-18 00:17:27 -07004129 self.logger.error("REST call {} failed reason : {}"\
4130 "status code : {}".format(url_rest_call,
4131 response.content,
4132 response.status_code))
4133 raise vimconn.vimconnException("add_network_adapter_to_vms : Failed to get "\
4134 "network connection section")
kasar3ac5dc42017-03-15 06:28:22 -07004135
4136 data = response.content
kasarc5bf2932018-03-09 04:15:22 -08004137 data = data.split('<Link rel="edit"')[0]
kasar3ac5dc42017-03-15 06:28:22 -07004138 if '<PrimaryNetworkConnectionIndex>' not in data:
4139 item = """<PrimaryNetworkConnectionIndex>{}</PrimaryNetworkConnectionIndex>
4140 <NetworkConnection network="{}">
4141 <NetworkConnectionIndex>{}</NetworkConnectionIndex>
4142 <IsConnected>true</IsConnected>
kasardc1f02e2017-03-25 07:20:30 -07004143 <IpAddressAllocationMode>{}</IpAddressAllocationMode>
4144 </NetworkConnection>""".format(primary_nic_index, network_name, nicIndex,
4145 allocation_mode)
kasard2963622017-03-31 05:53:17 -07004146 # Stub for ip_address feature
4147 if ip_address:
4148 ip_tag = '<IpAddress>{}</IpAddress>'.format(ip_address)
4149 item = item.replace('</NetworkConnectionIndex>\n','</NetworkConnectionIndex>\n{}\n'.format(ip_tag))
kasardc1f02e2017-03-25 07:20:30 -07004150
kasarc5bf2932018-03-09 04:15:22 -08004151 if mac_address:
4152 mac_tag = '<MACAddress>{}</MACAddress>'.format(mac_address)
4153 item = item.replace('</IsConnected>\n','</IsConnected>\n{}\n'.format(mac_tag))
4154
4155 data = data.replace('</ovf:Info>\n','</ovf:Info>\n{}\n</NetworkConnectionSection>'.format(item))
kasar3ac5dc42017-03-15 06:28:22 -07004156 else:
4157 new_item = """<NetworkConnection network="{}">
4158 <NetworkConnectionIndex>{}</NetworkConnectionIndex>
4159 <IsConnected>true</IsConnected>
kasardc1f02e2017-03-25 07:20:30 -07004160 <IpAddressAllocationMode>{}</IpAddressAllocationMode>
4161 </NetworkConnection>""".format(network_name, nicIndex,
4162 allocation_mode)
kasard2963622017-03-31 05:53:17 -07004163 # Stub for ip_address feature
4164 if ip_address:
4165 ip_tag = '<IpAddress>{}</IpAddress>'.format(ip_address)
4166 new_item = new_item.replace('</NetworkConnectionIndex>\n','</NetworkConnectionIndex>\n{}\n'.format(ip_tag))
kasardc1f02e2017-03-25 07:20:30 -07004167
kasarc5bf2932018-03-09 04:15:22 -08004168 if mac_address:
4169 mac_tag = '<MACAddress>{}</MACAddress>'.format(mac_address)
4170 new_item = new_item.replace('</IsConnected>\n','</IsConnected>\n{}\n'.format(mac_tag))
kasar3ac5dc42017-03-15 06:28:22 -07004171
kasarc5bf2932018-03-09 04:15:22 -08004172 data = data + new_item + '</NetworkConnectionSection>'
4173
kasar3ac5dc42017-03-15 06:28:22 -07004174 headers['Content-Type'] = 'application/vnd.vmware.vcloud.networkConnectionSection+xml'
kasarc5bf2932018-03-09 04:15:22 -08004175
4176 response = self.perform_request(req_type='PUT',
4177 url=url_rest_call,
4178 headers=headers,
4179 data=data)
bhangare1a0b97c2017-06-21 02:20:15 -07004180
4181 if response.status_code == 403:
4182 add_headers = {'Content-Type': headers['Content-Type']}
4183 response = self.retry_rest('PUT', url_rest_call, add_headers, data)
4184
kasar3ac5dc42017-03-15 06:28:22 -07004185 if response.status_code != 202:
kasar4cb6e902017-03-18 00:17:27 -07004186 self.logger.error("REST call {} failed reason : {}"\
4187 "status code : {} ".format(url_rest_call,
4188 response.content,
4189 response.status_code))
4190 raise vimconn.vimconnException("add_network_adapter_to_vms : Failed to update "\
4191 "network connection section")
kasar3ac5dc42017-03-15 06:28:22 -07004192 else:
kasarc5bf2932018-03-09 04:15:22 -08004193 nic_task = self.get_task_from_response(response.content)
4194 result = self.client.get_task_monitor().wait_for_success(task=nic_task)
4195 if result.get('status') == 'success':
kasar3ac5dc42017-03-15 06:28:22 -07004196 self.logger.info("add_network_adapter_to_vms(): VM {} conneced to "\
4197 "default NIC type".format(vm_id))
4198 else:
4199 self.logger.error("add_network_adapter_to_vms(): VM {} failed to "\
4200 "connect NIC type".format(vm_id))
4201 else:
kasarc5bf2932018-03-09 04:15:22 -08004202 for vms in vapp.get_all_vms():
4203 vm_id = vms.get('id').split(':')[-1]
kasar3ac5dc42017-03-15 06:28:22 -07004204
kasar3ac5dc42017-03-15 06:28:22 -07004205
kasarc5bf2932018-03-09 04:15:22 -08004206 url_rest_call = "{}/api/vApp/vm-{}/networkConnectionSection/".format(self.url, vm_id)
4207
4208 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
4209 'x-vcloud-authorization': self.client._session.headers['x-vcloud-authorization']}
4210 response = self.perform_request(req_type='GET',
4211 url=url_rest_call,
4212 headers=headers)
bhangare1a0b97c2017-06-21 02:20:15 -07004213
4214 if response.status_code == 403:
4215 response = self.retry_rest('GET', url_rest_call)
4216
kasar3ac5dc42017-03-15 06:28:22 -07004217 if response.status_code != 200:
kasar4cb6e902017-03-18 00:17:27 -07004218 self.logger.error("REST call {} failed reason : {}"\
4219 "status code : {}".format(url_rest_call,
4220 response.content,
4221 response.status_code))
4222 raise vimconn.vimconnException("add_network_adapter_to_vms : Failed to get "\
4223 "network connection section")
kasar3ac5dc42017-03-15 06:28:22 -07004224 data = response.content
kasarc5bf2932018-03-09 04:15:22 -08004225 data = data.split('<Link rel="edit"')[0]
kasar3ac5dc42017-03-15 06:28:22 -07004226 if '<PrimaryNetworkConnectionIndex>' not in data:
4227 item = """<PrimaryNetworkConnectionIndex>{}</PrimaryNetworkConnectionIndex>
4228 <NetworkConnection network="{}">
4229 <NetworkConnectionIndex>{}</NetworkConnectionIndex>
4230 <IsConnected>true</IsConnected>
kasardc1f02e2017-03-25 07:20:30 -07004231 <IpAddressAllocationMode>{}</IpAddressAllocationMode>
kasar3ac5dc42017-03-15 06:28:22 -07004232 <NetworkAdapterType>{}</NetworkAdapterType>
kasardc1f02e2017-03-25 07:20:30 -07004233 </NetworkConnection>""".format(primary_nic_index, network_name, nicIndex,
4234 allocation_mode, nic_type)
kasard2963622017-03-31 05:53:17 -07004235 # Stub for ip_address feature
4236 if ip_address:
4237 ip_tag = '<IpAddress>{}</IpAddress>'.format(ip_address)
4238 item = item.replace('</NetworkConnectionIndex>\n','</NetworkConnectionIndex>\n{}\n'.format(ip_tag))
kasardc1f02e2017-03-25 07:20:30 -07004239
kasarc5bf2932018-03-09 04:15:22 -08004240 if mac_address:
4241 mac_tag = '<MACAddress>{}</MACAddress>'.format(mac_address)
4242 item = item.replace('</IsConnected>\n','</IsConnected>\n{}\n'.format(mac_tag))
4243
4244 data = data.replace('</ovf:Info>\n','</ovf:Info>\n{}\n</NetworkConnectionSection>'.format(item))
kasar3ac5dc42017-03-15 06:28:22 -07004245 else:
4246 new_item = """<NetworkConnection network="{}">
4247 <NetworkConnectionIndex>{}</NetworkConnectionIndex>
4248 <IsConnected>true</IsConnected>
kasardc1f02e2017-03-25 07:20:30 -07004249 <IpAddressAllocationMode>{}</IpAddressAllocationMode>
kasar3ac5dc42017-03-15 06:28:22 -07004250 <NetworkAdapterType>{}</NetworkAdapterType>
kasardc1f02e2017-03-25 07:20:30 -07004251 </NetworkConnection>""".format(network_name, nicIndex,
4252 allocation_mode, nic_type)
kasard2963622017-03-31 05:53:17 -07004253 # Stub for ip_address feature
4254 if ip_address:
4255 ip_tag = '<IpAddress>{}</IpAddress>'.format(ip_address)
4256 new_item = new_item.replace('</NetworkConnectionIndex>\n','</NetworkConnectionIndex>\n{}\n'.format(ip_tag))
kasardc1f02e2017-03-25 07:20:30 -07004257
kasarc5bf2932018-03-09 04:15:22 -08004258 if mac_address:
4259 mac_tag = '<MACAddress>{}</MACAddress>'.format(mac_address)
4260 new_item = new_item.replace('</IsConnected>\n','</IsConnected>\n{}\n'.format(mac_tag))
kasar3ac5dc42017-03-15 06:28:22 -07004261
kasarc5bf2932018-03-09 04:15:22 -08004262 data = data + new_item + '</NetworkConnectionSection>'
4263
kasar3ac5dc42017-03-15 06:28:22 -07004264 headers['Content-Type'] = 'application/vnd.vmware.vcloud.networkConnectionSection+xml'
kasarc5bf2932018-03-09 04:15:22 -08004265
4266 response = self.perform_request(req_type='PUT',
4267 url=url_rest_call,
4268 headers=headers,
4269 data=data)
bhangare1a0b97c2017-06-21 02:20:15 -07004270
4271 if response.status_code == 403:
4272 add_headers = {'Content-Type': headers['Content-Type']}
4273 response = self.retry_rest('PUT', url_rest_call, add_headers, data)
kasar3ac5dc42017-03-15 06:28:22 -07004274
4275 if response.status_code != 202:
kasar4cb6e902017-03-18 00:17:27 -07004276 self.logger.error("REST call {} failed reason : {}"\
4277 "status code : {}".format(url_rest_call,
4278 response.content,
4279 response.status_code))
4280 raise vimconn.vimconnException("add_network_adapter_to_vms : Failed to update "\
4281 "network connection section")
kasar3ac5dc42017-03-15 06:28:22 -07004282 else:
kasarc5bf2932018-03-09 04:15:22 -08004283 nic_task = self.get_task_from_response(response.content)
4284 result = self.client.get_task_monitor().wait_for_success(task=nic_task)
4285 if result.get('status') == 'success':
kasar3ac5dc42017-03-15 06:28:22 -07004286 self.logger.info("add_network_adapter_to_vms(): VM {} "\
4287 "conneced to NIC type {}".format(vm_id, nic_type))
4288 else:
4289 self.logger.error("add_network_adapter_to_vms(): VM {} "\
4290 "failed to connect NIC type {}".format(vm_id, nic_type))
4291 except Exception as exp:
kasar4cb6e902017-03-18 00:17:27 -07004292 self.logger.error("add_network_adapter_to_vms() : exception occurred "\
4293 "while adding Network adapter")
4294 raise vimconn.vimconnException(message=exp)
kasarde691232017-03-25 03:37:31 -07004295
4296
4297 def set_numa_affinity(self, vmuuid, paired_threads_id):
4298 """
4299 Method to assign numa affinity in vm configuration parammeters
4300 Args :
4301 vmuuid - vm uuid
4302 paired_threads_id - one or more virtual processor
4303 numbers
4304 Returns:
4305 return if True
4306 """
4307 try:
kasar204e39e2018-01-25 00:57:02 -08004308 vcenter_conect, content = self.get_vcenter_content()
4309 vm_moref_id = self.get_vm_moref_id(vmuuid)
kasarde691232017-03-25 03:37:31 -07004310
kasar204e39e2018-01-25 00:57:02 -08004311 host_obj, vm_obj = self.get_vm_obj(content ,vm_moref_id)
4312 if vm_obj:
4313 config_spec = vim.vm.ConfigSpec()
4314 config_spec.extraConfig = []
4315 opt = vim.option.OptionValue()
4316 opt.key = 'numa.nodeAffinity'
4317 opt.value = str(paired_threads_id)
4318 config_spec.extraConfig.append(opt)
4319 task = vm_obj.ReconfigVM_Task(config_spec)
4320 if task:
4321 result = self.wait_for_vcenter_task(task, vcenter_conect)
4322 extra_config = vm_obj.config.extraConfig
4323 flag = False
4324 for opts in extra_config:
4325 if 'numa.nodeAffinity' in opts.key:
4326 flag = True
4327 self.logger.info("set_numa_affinity: Sucessfully assign numa affinity "\
4328 "value {} for vm {}".format(opt.value, vm_obj))
4329 if flag:
4330 return
4331 else:
4332 self.logger.error("set_numa_affinity: Failed to assign numa affinity")
kasarde691232017-03-25 03:37:31 -07004333 except Exception as exp:
4334 self.logger.error("set_numa_affinity : exception occurred while setting numa affinity "\
4335 "for VM {} : {}".format(vm_obj, vm_moref_id))
4336 raise vimconn.vimconnException("set_numa_affinity : Error {} failed to assign numa "\
4337 "affinity".format(exp))
kasardc1f02e2017-03-25 07:20:30 -07004338
4339
4340 def cloud_init(self, vapp, cloud_config):
4341 """
4342 Method to inject ssh-key
4343 vapp - vapp object
4344 cloud_config a dictionary with:
4345 'key-pairs': (optional) list of strings with the public key to be inserted to the default user
4346 'users': (optional) list of users to be inserted, each item is a dict with:
4347 'name': (mandatory) user name,
4348 'key-pairs': (optional) list of strings with the public key to be inserted to the user
tierno40e1bce2017-08-09 09:12:04 +02004349 'user-data': (optional) can be a string with the text script to be passed directly to cloud-init,
4350 or a list of strings, each one contains a script to be passed, usually with a MIMEmultipart file
kasardc1f02e2017-03-25 07:20:30 -07004351 'config-files': (optional). List of files to be transferred. Each item is a dict with:
4352 'dest': (mandatory) string with the destination absolute path
4353 'encoding': (optional, by default text). Can be one of:
4354 'b64', 'base64', 'gz', 'gz+b64', 'gz+base64', 'gzip+b64', 'gzip+base64'
4355 'content' (mandatory): string with the content of the file
4356 'permissions': (optional) string with file permissions, typically octal notation '0644'
4357 'owner': (optional) file owner, string with the format 'owner:group'
4358 'boot-data-drive': boolean to indicate if user-data must be passed using a boot drive (hard disk
4359 """
kasardc1f02e2017-03-25 07:20:30 -07004360 try:
kasar2aa50742017-08-08 02:11:22 -07004361 if not isinstance(cloud_config, dict):
4362 raise Exception("cloud_init : parameter cloud_config is not a dictionary")
4363 else:
kasardc1f02e2017-03-25 07:20:30 -07004364 key_pairs = []
4365 userdata = []
4366 if "key-pairs" in cloud_config:
4367 key_pairs = cloud_config["key-pairs"]
4368
4369 if "users" in cloud_config:
4370 userdata = cloud_config["users"]
4371
kasar2aa50742017-08-08 02:11:22 -07004372 self.logger.debug("cloud_init : Guest os customization started..")
4373 customize_script = self.format_script(key_pairs=key_pairs, users_list=userdata)
kasarc5bf2932018-03-09 04:15:22 -08004374 customize_script = customize_script.replace("&","&amp;")
kasar2aa50742017-08-08 02:11:22 -07004375 self.guest_customization(vapp, customize_script)
kasardc1f02e2017-03-25 07:20:30 -07004376
kasardc1f02e2017-03-25 07:20:30 -07004377 except Exception as exp:
4378 self.logger.error("cloud_init : exception occurred while injecting "\
4379 "ssh-key")
4380 raise vimconn.vimconnException("cloud_init : Error {} failed to inject "\
4381 "ssh-key".format(exp))
bhangare06312472017-03-30 05:49:07 -07004382
kasar2aa50742017-08-08 02:11:22 -07004383 def format_script(self, key_pairs=[], users_list=[]):
kasarc5bf2932018-03-09 04:15:22 -08004384 bash_script = """#!/bin/sh
kasar2aa50742017-08-08 02:11:22 -07004385 echo performing customization tasks with param $1 at `date "+DATE: %Y-%m-%d - TIME: %H:%M:%S"` >> /root/customization.log
4386 if [ "$1" = "precustomization" ];then
4387 echo performing precustomization tasks on `date "+DATE: %Y-%m-%d - TIME: %H:%M:%S"` >> /root/customization.log
4388 """
4389
4390 keys = "\n".join(key_pairs)
4391 if keys:
4392 keys_data = """
4393 if [ ! -d /root/.ssh ];then
4394 mkdir /root/.ssh
4395 chown root:root /root/.ssh
4396 chmod 700 /root/.ssh
4397 touch /root/.ssh/authorized_keys
4398 chown root:root /root/.ssh/authorized_keys
4399 chmod 600 /root/.ssh/authorized_keys
4400 # make centos with selinux happy
4401 which restorecon && restorecon -Rv /root/.ssh
4402 else
4403 touch /root/.ssh/authorized_keys
4404 chown root:root /root/.ssh/authorized_keys
4405 chmod 600 /root/.ssh/authorized_keys
4406 fi
4407 echo '{key}' >> /root/.ssh/authorized_keys
4408 """.format(key=keys)
4409
4410 bash_script+= keys_data
4411
4412 for user in users_list:
4413 if 'name' in user: user_name = user['name']
4414 if 'key-pairs' in user:
4415 user_keys = "\n".join(user['key-pairs'])
4416 else:
4417 user_keys = None
4418
4419 add_user_name = """
4420 useradd -d /home/{user_name} -m -g users -s /bin/bash {user_name}
4421 """.format(user_name=user_name)
4422
4423 bash_script+= add_user_name
4424
4425 if user_keys:
4426 user_keys_data = """
4427 mkdir /home/{user_name}/.ssh
4428 chown {user_name}:{user_name} /home/{user_name}/.ssh
4429 chmod 700 /home/{user_name}/.ssh
4430 touch /home/{user_name}/.ssh/authorized_keys
4431 chown {user_name}:{user_name} /home/{user_name}/.ssh/authorized_keys
4432 chmod 600 /home/{user_name}/.ssh/authorized_keys
4433 # make centos with selinux happy
4434 which restorecon && restorecon -Rv /home/{user_name}/.ssh
4435 echo '{user_key}' >> /home/{user_name}/.ssh/authorized_keys
4436 """.format(user_name=user_name,user_key=user_keys)
4437
4438 bash_script+= user_keys_data
4439
4440 return bash_script+"\n\tfi"
4441
4442 def guest_customization(self, vapp, customize_script):
4443 """
4444 Method to customize guest os
4445 vapp - Vapp object
4446 customize_script - Customize script to be run at first boot of VM.
4447 """
kasarc5bf2932018-03-09 04:15:22 -08004448 for vm in vapp.get_all_vms():
4449 vm_id = vm.get('id').split(':')[-1]
4450 vm_name = vm.get('name')
4451 vm_name = vm_name.replace('_','-')
4452
4453 vm_customization_url = "{}/api/vApp/vm-{}/guestCustomizationSection/".format(self.url, vm_id)
4454 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
4455 'x-vcloud-authorization': self.client._session.headers['x-vcloud-authorization']}
4456
4457 headers['Content-Type'] = "application/vnd.vmware.vcloud.guestCustomizationSection+xml"
4458
4459 data = """<GuestCustomizationSection
4460 xmlns="http://www.vmware.com/vcloud/v1.5"
4461 xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
4462 ovf:required="false" href="{}" type="application/vnd.vmware.vcloud.guestCustomizationSection+xml">
4463 <ovf:Info>Specifies Guest OS Customization Settings</ovf:Info>
4464 <Enabled>true</Enabled>
4465 <ChangeSid>false</ChangeSid>
4466 <VirtualMachineId>{}</VirtualMachineId>
4467 <JoinDomainEnabled>false</JoinDomainEnabled>
4468 <UseOrgSettings>false</UseOrgSettings>
4469 <AdminPasswordEnabled>false</AdminPasswordEnabled>
4470 <AdminPasswordAuto>true</AdminPasswordAuto>
4471 <AdminAutoLogonEnabled>false</AdminAutoLogonEnabled>
4472 <AdminAutoLogonCount>0</AdminAutoLogonCount>
4473 <ResetPasswordRequired>false</ResetPasswordRequired>
4474 <CustomizationScript>{}</CustomizationScript>
4475 <ComputerName>{}</ComputerName>
4476 <Link href="{}" type="application/vnd.vmware.vcloud.guestCustomizationSection+xml" rel="edit"/>
4477 </GuestCustomizationSection>
4478 """.format(vm_customization_url,
4479 vm_id,
4480 customize_script,
4481 vm_name,
4482 vm_customization_url)
4483
4484 response = self.perform_request(req_type='PUT',
4485 url=vm_customization_url,
4486 headers=headers,
4487 data=data)
4488 if response.status_code == 202:
4489 guest_task = self.get_task_from_response(response.content)
4490 self.client.get_task_monitor().wait_for_success(task=guest_task)
kasar2aa50742017-08-08 02:11:22 -07004491 self.logger.info("guest_customization : customized guest os task "\
4492 "completed for VM {}".format(vm_name))
4493 else:
4494 self.logger.error("guest_customization : task for customized guest os"\
4495 "failed for VM {}".format(vm_name))
4496 raise vimconn.vimconnException("guest_customization : failed to perform"\
4497 "guest os customization on VM {}".format(vm_name))
bhangare06312472017-03-30 05:49:07 -07004498
bhangare1a0b97c2017-06-21 02:20:15 -07004499 def add_new_disk(self, vapp_uuid, disk_size):
bhangare06312472017-03-30 05:49:07 -07004500 """
4501 Method to create an empty vm disk
4502
4503 Args:
4504 vapp_uuid - is vapp identifier.
4505 disk_size - size of disk to be created in GB
4506
4507 Returns:
4508 None
4509 """
4510 status = False
4511 vm_details = None
4512 try:
4513 #Disk size in GB, convert it into MB
4514 if disk_size is not None:
4515 disk_size_mb = int(disk_size) * 1024
4516 vm_details = self.get_vapp_details_rest(vapp_uuid)
4517
4518 if vm_details and "vm_virtual_hardware" in vm_details:
4519 self.logger.info("Adding disk to VM: {} disk size:{}GB".format(vm_details["name"], disk_size))
4520 disk_href = vm_details["vm_virtual_hardware"]["disk_edit_href"]
bhangare1a0b97c2017-06-21 02:20:15 -07004521 status = self.add_new_disk_rest(disk_href, disk_size_mb)
bhangare06312472017-03-30 05:49:07 -07004522
4523 except Exception as exp:
4524 msg = "Error occurred while creating new disk {}.".format(exp)
4525 self.rollback_newvm(vapp_uuid, msg)
4526
4527 if status:
4528 self.logger.info("Added new disk to VM: {} disk size:{}GB".format(vm_details["name"], disk_size))
4529 else:
4530 #If failed to add disk, delete VM
4531 msg = "add_new_disk: Failed to add new disk to {}".format(vm_details["name"])
4532 self.rollback_newvm(vapp_uuid, msg)
4533
4534
bhangare1a0b97c2017-06-21 02:20:15 -07004535 def add_new_disk_rest(self, disk_href, disk_size_mb):
bhangare06312472017-03-30 05:49:07 -07004536 """
4537 Retrives vApp Disks section & add new empty disk
4538
4539 Args:
4540 disk_href: Disk section href to addd disk
4541 disk_size_mb: Disk size in MB
4542
4543 Returns: Status of add new disk task
4544 """
4545 status = False
kasarc5bf2932018-03-09 04:15:22 -08004546 if self.client._session:
4547 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
4548 'x-vcloud-authorization': self.client._session.headers['x-vcloud-authorization']}
4549 response = self.perform_request(req_type='GET',
4550 url=disk_href,
4551 headers=headers)
bhangare1a0b97c2017-06-21 02:20:15 -07004552
4553 if response.status_code == 403:
4554 response = self.retry_rest('GET', disk_href)
bhangare06312472017-03-30 05:49:07 -07004555
4556 if response.status_code != requests.codes.ok:
4557 self.logger.error("add_new_disk_rest: GET REST API call {} failed. Return status code {}"
4558 .format(disk_href, response.status_code))
4559 return status
4560 try:
4561 #Find but type & max of instance IDs assigned to disks
4562 lxmlroot_respond = lxmlElementTree.fromstring(response.content)
4563 namespaces = {prefix:uri for prefix,uri in lxmlroot_respond.nsmap.iteritems() if prefix}
kasarc5bf2932018-03-09 04:15:22 -08004564 #For python3
4565 #namespaces = {prefix:uri for prefix,uri in lxmlroot_respond.nsmap.items() if prefix}
bhangare06312472017-03-30 05:49:07 -07004566 namespaces["xmlns"]= "http://www.vmware.com/vcloud/v1.5"
4567 instance_id = 0
4568 for item in lxmlroot_respond.iterfind('xmlns:Item',namespaces):
4569 if item.find("rasd:Description",namespaces).text == "Hard disk":
4570 inst_id = int(item.find("rasd:InstanceID" ,namespaces).text)
4571 if inst_id > instance_id:
4572 instance_id = inst_id
4573 disk_item = item.find("rasd:HostResource" ,namespaces)
4574 bus_subtype = disk_item.attrib["{"+namespaces['xmlns']+"}busSubType"]
4575 bus_type = disk_item.attrib["{"+namespaces['xmlns']+"}busType"]
4576
4577 instance_id = instance_id + 1
4578 new_item = """<Item>
4579 <rasd:Description>Hard disk</rasd:Description>
4580 <rasd:ElementName>New disk</rasd:ElementName>
4581 <rasd:HostResource
4582 xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
4583 vcloud:capacity="{}"
4584 vcloud:busSubType="{}"
4585 vcloud:busType="{}"></rasd:HostResource>
4586 <rasd:InstanceID>{}</rasd:InstanceID>
4587 <rasd:ResourceType>17</rasd:ResourceType>
4588 </Item>""".format(disk_size_mb, bus_subtype, bus_type, instance_id)
4589
4590 new_data = response.content
4591 #Add new item at the bottom
4592 new_data = new_data.replace('</Item>\n</RasdItemsList>', '</Item>\n{}\n</RasdItemsList>'.format(new_item))
4593
4594 # Send PUT request to modify virtual hardware section with new disk
bhangare06312472017-03-30 05:49:07 -07004595 headers['Content-Type'] = 'application/vnd.vmware.vcloud.rasdItemsList+xml; charset=ISO-8859-1'
4596
kasarc5bf2932018-03-09 04:15:22 -08004597 response = self.perform_request(req_type='PUT',
4598 url=disk_href,
4599 data=new_data,
4600 headers=headers)
bhangare1a0b97c2017-06-21 02:20:15 -07004601
4602 if response.status_code == 403:
4603 add_headers = {'Content-Type': headers['Content-Type']}
4604 response = self.retry_rest('PUT', disk_href, add_headers, new_data)
bhangare06312472017-03-30 05:49:07 -07004605
4606 if response.status_code != 202:
4607 self.logger.error("PUT REST API call {} failed. Return status code {}. Response Content:{}"
4608 .format(disk_href, response.status_code, response.content))
4609 else:
kasarc5bf2932018-03-09 04:15:22 -08004610 add_disk_task = self.get_task_from_response(response.content)
4611 result = self.client.get_task_monitor().wait_for_success(task=add_disk_task)
4612 if result.get('status') == 'success':
4613 status = True
4614 else:
4615 self.logger.error("Add new disk REST task failed to add {} MB disk".format(disk_size_mb))
bhangare06312472017-03-30 05:49:07 -07004616
4617 except Exception as exp:
4618 self.logger.error("Error occurred calling rest api for creating new disk {}".format(exp))
4619
4620 return status
4621
4622
4623 def add_existing_disk(self, catalogs=None, image_id=None, size=None, template_name=None, vapp_uuid=None):
4624 """
4625 Method to add existing disk to vm
4626 Args :
4627 catalogs - List of VDC catalogs
4628 image_id - Catalog ID
4629 template_name - Name of template in catalog
4630 vapp_uuid - UUID of vApp
4631 Returns:
4632 None
4633 """
4634 disk_info = None
4635 vcenter_conect, content = self.get_vcenter_content()
4636 #find moref-id of vm in image
4637 catalog_vm_info = self.get_vapp_template_details(catalogs=catalogs,
4638 image_id=image_id,
4639 )
4640
4641 if catalog_vm_info and "vm_vcenter_info" in catalog_vm_info:
4642 if "vm_moref_id" in catalog_vm_info["vm_vcenter_info"]:
4643 catalog_vm_moref_id = catalog_vm_info["vm_vcenter_info"].get("vm_moref_id", None)
4644 if catalog_vm_moref_id:
4645 self.logger.info("Moref_id of VM in catalog : {}" .format(catalog_vm_moref_id))
4646 host, catalog_vm_obj = self.get_vm_obj(content, catalog_vm_moref_id)
4647 if catalog_vm_obj:
4648 #find existing disk
4649 disk_info = self.find_disk(catalog_vm_obj)
4650 else:
4651 exp_msg = "No VM with image id {} found".format(image_id)
4652 self.rollback_newvm(vapp_uuid, exp_msg, exp_type="NotFound")
4653 else:
4654 exp_msg = "No Image found with image ID {} ".format(image_id)
4655 self.rollback_newvm(vapp_uuid, exp_msg, exp_type="NotFound")
4656
4657 if disk_info:
4658 self.logger.info("Existing disk_info : {}".format(disk_info))
4659 #get VM
4660 vm_moref_id = self.get_vm_moref_id(vapp_uuid)
4661 host, vm_obj = self.get_vm_obj(content, vm_moref_id)
4662 if vm_obj:
4663 status = self.add_disk(vcenter_conect=vcenter_conect,
4664 vm=vm_obj,
4665 disk_info=disk_info,
4666 size=size,
4667 vapp_uuid=vapp_uuid
4668 )
4669 if status:
4670 self.logger.info("Disk from image id {} added to {}".format(image_id,
4671 vm_obj.config.name)
4672 )
4673 else:
4674 msg = "No disk found with image id {} to add in VM {}".format(
4675 image_id,
4676 vm_obj.config.name)
4677 self.rollback_newvm(vapp_uuid, msg, exp_type="NotFound")
4678
4679
4680 def find_disk(self, vm_obj):
4681 """
4682 Method to find details of existing disk in VM
4683 Args :
4684 vm_obj - vCenter object of VM
4685 image_id - Catalog ID
4686 Returns:
4687 disk_info : dict of disk details
4688 """
4689 disk_info = {}
4690 if vm_obj:
4691 try:
4692 devices = vm_obj.config.hardware.device
4693 for device in devices:
4694 if type(device) is vim.vm.device.VirtualDisk:
4695 if isinstance(device.backing,vim.vm.device.VirtualDisk.FlatVer2BackingInfo) and hasattr(device.backing, 'fileName'):
4696 disk_info["full_path"] = device.backing.fileName
4697 disk_info["datastore"] = device.backing.datastore
4698 disk_info["capacityKB"] = device.capacityInKB
4699 break
4700 except Exception as exp:
4701 self.logger.error("find_disk() : exception occurred while "\
4702 "getting existing disk details :{}".format(exp))
4703 return disk_info
4704
4705
4706 def add_disk(self, vcenter_conect=None, vm=None, size=None, vapp_uuid=None, disk_info={}):
4707 """
4708 Method to add existing disk in VM
4709 Args :
4710 vcenter_conect - vCenter content object
4711 vm - vCenter vm object
4712 disk_info : dict of disk details
4713 Returns:
4714 status : status of add disk task
4715 """
4716 datastore = disk_info["datastore"] if "datastore" in disk_info else None
4717 fullpath = disk_info["full_path"] if "full_path" in disk_info else None
4718 capacityKB = disk_info["capacityKB"] if "capacityKB" in disk_info else None
4719 if size is not None:
4720 #Convert size from GB to KB
4721 sizeKB = int(size) * 1024 * 1024
4722 #compare size of existing disk and user given size.Assign whicherver is greater
4723 self.logger.info("Add Existing disk : sizeKB {} , capacityKB {}".format(
4724 sizeKB, capacityKB))
4725 if sizeKB > capacityKB:
4726 capacityKB = sizeKB
4727
4728 if datastore and fullpath and capacityKB:
4729 try:
4730 spec = vim.vm.ConfigSpec()
4731 # get all disks on a VM, set unit_number to the next available
4732 unit_number = 0
4733 for dev in vm.config.hardware.device:
4734 if hasattr(dev.backing, 'fileName'):
4735 unit_number = int(dev.unitNumber) + 1
4736 # unit_number 7 reserved for scsi controller
4737 if unit_number == 7:
4738 unit_number += 1
4739 if isinstance(dev, vim.vm.device.VirtualDisk):
4740 #vim.vm.device.VirtualSCSIController
4741 controller_key = dev.controllerKey
4742
4743 self.logger.info("Add Existing disk : unit number {} , controller key {}".format(
4744 unit_number, controller_key))
4745 # add disk here
4746 dev_changes = []
4747 disk_spec = vim.vm.device.VirtualDeviceSpec()
4748 disk_spec.operation = vim.vm.device.VirtualDeviceSpec.Operation.add
4749 disk_spec.device = vim.vm.device.VirtualDisk()
4750 disk_spec.device.backing = \
4751 vim.vm.device.VirtualDisk.FlatVer2BackingInfo()
4752 disk_spec.device.backing.thinProvisioned = True
4753 disk_spec.device.backing.diskMode = 'persistent'
4754 disk_spec.device.backing.datastore = datastore
4755 disk_spec.device.backing.fileName = fullpath
4756
4757 disk_spec.device.unitNumber = unit_number
4758 disk_spec.device.capacityInKB = capacityKB
4759 disk_spec.device.controllerKey = controller_key
4760 dev_changes.append(disk_spec)
4761 spec.deviceChange = dev_changes
4762 task = vm.ReconfigVM_Task(spec=spec)
4763 status = self.wait_for_vcenter_task(task, vcenter_conect)
4764 return status
4765 except Exception as exp:
4766 exp_msg = "add_disk() : exception {} occurred while adding disk "\
4767 "{} to vm {}".format(exp,
4768 fullpath,
4769 vm.config.name)
4770 self.rollback_newvm(vapp_uuid, exp_msg)
4771 else:
4772 msg = "add_disk() : Can not add disk to VM with disk info {} ".format(disk_info)
4773 self.rollback_newvm(vapp_uuid, msg)
4774
4775
4776 def get_vcenter_content(self):
4777 """
4778 Get the vsphere content object
4779 """
4780 try:
4781 vm_vcenter_info = self.get_vm_vcenter_info()
4782 except Exception as exp:
4783 self.logger.error("Error occurred while getting vCenter infromationn"\
4784 " for VM : {}".format(exp))
4785 raise vimconn.vimconnException(message=exp)
4786
4787 context = None
4788 if hasattr(ssl, '_create_unverified_context'):
4789 context = ssl._create_unverified_context()
4790
4791 vcenter_conect = SmartConnect(
4792 host=vm_vcenter_info["vm_vcenter_ip"],
4793 user=vm_vcenter_info["vm_vcenter_user"],
4794 pwd=vm_vcenter_info["vm_vcenter_password"],
4795 port=int(vm_vcenter_info["vm_vcenter_port"]),
4796 sslContext=context
4797 )
4798 atexit.register(Disconnect, vcenter_conect)
4799 content = vcenter_conect.RetrieveContent()
4800 return vcenter_conect, content
4801
4802
4803 def get_vm_moref_id(self, vapp_uuid):
4804 """
4805 Get the moref_id of given VM
4806 """
4807 try:
4808 if vapp_uuid:
4809 vm_details = self.get_vapp_details_rest(vapp_uuid, need_admin_access=True)
4810 if vm_details and "vm_vcenter_info" in vm_details:
4811 vm_moref_id = vm_details["vm_vcenter_info"].get("vm_moref_id", None)
bhangare06312472017-03-30 05:49:07 -07004812 return vm_moref_id
4813
4814 except Exception as exp:
4815 self.logger.error("Error occurred while getting VM moref ID "\
4816 " for VM : {}".format(exp))
4817 return None
4818
4819
4820 def get_vapp_template_details(self, catalogs=None, image_id=None , template_name=None):
4821 """
4822 Method to get vApp template details
4823 Args :
4824 catalogs - list of VDC catalogs
4825 image_id - Catalog ID to find
4826 template_name : template name in catalog
4827 Returns:
4828 parsed_respond : dict of vApp tempalte details
4829 """
4830 parsed_response = {}
4831
4832 vca = self.connect_as_admin()
4833 if not vca:
kasarc5bf2932018-03-09 04:15:22 -08004834 raise vimconn.vimconnConnectionException("Failed to connect vCD")
bhangare06312472017-03-30 05:49:07 -07004835
4836 try:
kasarc5bf2932018-03-09 04:15:22 -08004837 org, vdc = self.get_vdc_details()
bhangare06312472017-03-30 05:49:07 -07004838 catalog = self.get_catalog_obj(image_id, catalogs)
4839 if catalog:
kasarc5bf2932018-03-09 04:15:22 -08004840 items = org.get_catalog_item(catalog.get('name'), catalog.get('name'))
4841 catalog_items = [items.attrib]
4842
bhangare06312472017-03-30 05:49:07 -07004843 if len(catalog_items) == 1:
kasarc5bf2932018-03-09 04:15:22 -08004844 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
4845 'x-vcloud-authorization': vca._session.headers['x-vcloud-authorization']}
4846
4847 response = self.perform_request(req_type='GET',
4848 url=catalog_items[0].get('href'),
4849 headers=headers)
bhangare06312472017-03-30 05:49:07 -07004850 catalogItem = XmlElementTree.fromstring(response.content)
4851 entity = [child for child in catalogItem if child.get("type") == "application/vnd.vmware.vcloud.vAppTemplate+xml"][0]
4852 vapp_tempalte_href = entity.get("href")
4853 #get vapp details and parse moref id
4854
4855 namespaces = {"vssd":"http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData" ,
4856 'ovf': 'http://schemas.dmtf.org/ovf/envelope/1',
4857 'vmw': 'http://www.vmware.com/schema/ovf',
4858 'vm': 'http://www.vmware.com/vcloud/v1.5',
4859 'rasd':"http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData",
4860 'vmext':"http://www.vmware.com/vcloud/extension/v1.5",
4861 'xmlns':"http://www.vmware.com/vcloud/v1.5"
4862 }
4863
kasarc5bf2932018-03-09 04:15:22 -08004864 if vca._session:
4865 response = self.perform_request(req_type='GET',
4866 url=vapp_tempalte_href,
4867 headers=headers)
bhangare06312472017-03-30 05:49:07 -07004868
4869 if response.status_code != requests.codes.ok:
4870 self.logger.debug("REST API call {} failed. Return status code {}".format(
4871 vapp_tempalte_href, response.status_code))
4872
4873 else:
4874 xmlroot_respond = XmlElementTree.fromstring(response.content)
4875 children_section = xmlroot_respond.find('vm:Children/', namespaces)
4876 if children_section is not None:
4877 vCloud_extension_section = children_section.find('xmlns:VCloudExtension', namespaces)
4878 if vCloud_extension_section is not None:
4879 vm_vcenter_info = {}
4880 vim_info = vCloud_extension_section.find('vmext:VmVimInfo', namespaces)
4881 vmext = vim_info.find('vmext:VmVimObjectRef', namespaces)
4882 if vmext is not None:
4883 vm_vcenter_info["vm_moref_id"] = vmext.find('vmext:MoRef', namespaces).text
4884 parsed_response["vm_vcenter_info"]= vm_vcenter_info
4885
4886 except Exception as exp :
4887 self.logger.info("Error occurred calling rest api for getting vApp details {}".format(exp))
4888
4889 return parsed_response
4890
4891
4892 def rollback_newvm(self, vapp_uuid, msg , exp_type="Genric"):
4893 """
4894 Method to delete vApp
4895 Args :
4896 vapp_uuid - vApp UUID
4897 msg - Error message to be logged
4898 exp_type : Exception type
4899 Returns:
4900 None
4901 """
4902 if vapp_uuid:
4903 status = self.delete_vminstance(vapp_uuid)
4904 else:
4905 msg = "No vApp ID"
4906 self.logger.error(msg)
4907 if exp_type == "Genric":
4908 raise vimconn.vimconnException(msg)
4909 elif exp_type == "NotFound":
4910 raise vimconn.vimconnNotFoundException(message=msg)
4911
kateac1e3792017-04-01 02:16:39 -07004912 def add_sriov(self, vapp_uuid, sriov_nets, vmname_andid):
4913 """
4914 Method to attach SRIOV adapters to VM
4915
4916 Args:
4917 vapp_uuid - uuid of vApp/VM
4918 sriov_nets - SRIOV devices infromation as specified in VNFD (flavor)
4919 vmname_andid - vmname
4920
4921 Returns:
4922 The status of add SRIOV adapter task , vm object and
4923 vcenter_conect object
4924 """
4925 vm_obj = None
4926 vcenter_conect, content = self.get_vcenter_content()
4927 vm_moref_id = self.get_vm_moref_id(vapp_uuid)
4928
4929 if vm_moref_id:
4930 try:
4931 no_of_sriov_devices = len(sriov_nets)
4932 if no_of_sriov_devices > 0:
4933 #Get VM and its host
4934 host_obj, vm_obj = self.get_vm_obj(content, vm_moref_id)
4935 self.logger.info("VM {} is currently on host {}".format(vm_obj, host_obj))
4936 if host_obj and vm_obj:
4937 #get SRIOV devies from host on which vapp is currently installed
4938 avilable_sriov_devices = self.get_sriov_devices(host_obj,
4939 no_of_sriov_devices,
4940 )
4941
4942 if len(avilable_sriov_devices) == 0:
4943 #find other hosts with active pci devices
4944 new_host_obj , avilable_sriov_devices = self.get_host_and_sriov_devices(
4945 content,
4946 no_of_sriov_devices,
4947 )
4948
4949 if new_host_obj is not None and len(avilable_sriov_devices)> 0:
4950 #Migrate vm to the host where SRIOV devices are available
4951 self.logger.info("Relocate VM {} on new host {}".format(vm_obj,
4952 new_host_obj))
4953 task = self.relocate_vm(new_host_obj, vm_obj)
4954 if task is not None:
4955 result = self.wait_for_vcenter_task(task, vcenter_conect)
4956 self.logger.info("Migrate VM status: {}".format(result))
4957 host_obj = new_host_obj
4958 else:
4959 self.logger.info("Fail to migrate VM : {}".format(result))
4960 raise vimconn.vimconnNotFoundException(
4961 "Fail to migrate VM : {} to host {}".format(
4962 vmname_andid,
4963 new_host_obj)
4964 )
4965
4966 if host_obj is not None and avilable_sriov_devices is not None and len(avilable_sriov_devices)> 0:
4967 #Add SRIOV devices one by one
4968 for sriov_net in sriov_nets:
4969 network_name = sriov_net.get('net_id')
4970 dvs_portgr_name = self.create_dvPort_group(network_name)
tierno66eba6e2017-11-10 17:09:18 +01004971 if sriov_net.get('type') == "VF" or sriov_net.get('type') == "SR-IOV":
kateac1e3792017-04-01 02:16:39 -07004972 #add vlan ID ,Modify portgroup for vlan ID
4973 self.configure_vlanID(content, vcenter_conect, network_name)
4974
4975 task = self.add_sriov_to_vm(content,
4976 vm_obj,
4977 host_obj,
4978 network_name,
4979 avilable_sriov_devices[0]
4980 )
4981 if task:
4982 status= self.wait_for_vcenter_task(task, vcenter_conect)
4983 if status:
4984 self.logger.info("Added SRIOV {} to VM {}".format(
4985 no_of_sriov_devices,
4986 str(vm_obj)))
4987 else:
4988 self.logger.error("Fail to add SRIOV {} to VM {}".format(
4989 no_of_sriov_devices,
4990 str(vm_obj)))
4991 raise vimconn.vimconnUnexpectedResponse(
4992 "Fail to add SRIOV adapter in VM ".format(str(vm_obj))
4993 )
4994 return True, vm_obj, vcenter_conect
4995 else:
4996 self.logger.error("Currently there is no host with"\
4997 " {} number of avaialble SRIOV "\
4998 "VFs required for VM {}".format(
4999 no_of_sriov_devices,
5000 vmname_andid)
5001 )
5002 raise vimconn.vimconnNotFoundException(
5003 "Currently there is no host with {} "\
5004 "number of avaialble SRIOV devices required for VM {}".format(
5005 no_of_sriov_devices,
5006 vmname_andid))
5007 else:
5008 self.logger.debug("No infromation about SRIOV devices {} ",sriov_nets)
5009
5010 except vmodl.MethodFault as error:
5011 self.logger.error("Error occurred while adding SRIOV {} ",error)
5012 return None, vm_obj, vcenter_conect
5013
5014
5015 def get_sriov_devices(self,host, no_of_vfs):
5016 """
5017 Method to get the details of SRIOV devices on given host
5018 Args:
5019 host - vSphere host object
5020 no_of_vfs - number of VFs needed on host
5021
5022 Returns:
5023 array of SRIOV devices
5024 """
5025 sriovInfo=[]
5026 if host:
5027 for device in host.config.pciPassthruInfo:
5028 if isinstance(device,vim.host.SriovInfo) and device.sriovActive:
5029 if device.numVirtualFunction >= no_of_vfs:
5030 sriovInfo.append(device)
5031 break
5032 return sriovInfo
5033
5034
5035 def get_host_and_sriov_devices(self, content, no_of_vfs):
5036 """
5037 Method to get the details of SRIOV devices infromation on all hosts
5038
5039 Args:
5040 content - vSphere host object
5041 no_of_vfs - number of pci VFs needed on host
5042
5043 Returns:
5044 array of SRIOV devices and host object
5045 """
5046 host_obj = None
5047 sriov_device_objs = None
5048 try:
5049 if content:
5050 container = content.viewManager.CreateContainerView(content.rootFolder,
5051 [vim.HostSystem], True)
5052 for host in container.view:
5053 devices = self.get_sriov_devices(host, no_of_vfs)
5054 if devices:
5055 host_obj = host
5056 sriov_device_objs = devices
5057 break
5058 except Exception as exp:
5059 self.logger.error("Error {} occurred while finding SRIOV devices on host: {}".format(exp, host_obj))
5060
5061 return host_obj,sriov_device_objs
5062
5063
5064 def add_sriov_to_vm(self,content, vm_obj, host_obj, network_name, sriov_device):
5065 """
5066 Method to add SRIOV adapter to vm
5067
5068 Args:
5069 host_obj - vSphere host object
5070 vm_obj - vSphere vm object
5071 content - vCenter content object
5072 network_name - name of distributed virtaul portgroup
5073 sriov_device - SRIOV device info
5074
5075 Returns:
5076 task object
5077 """
5078 devices = []
5079 vnic_label = "sriov nic"
5080 try:
5081 dvs_portgr = self.get_dvport_group(network_name)
5082 network_name = dvs_portgr.name
5083 nic = vim.vm.device.VirtualDeviceSpec()
5084 # VM device
5085 nic.operation = vim.vm.device.VirtualDeviceSpec.Operation.add
5086 nic.device = vim.vm.device.VirtualSriovEthernetCard()
5087 nic.device.addressType = 'assigned'
5088 #nic.device.key = 13016
5089 nic.device.deviceInfo = vim.Description()
5090 nic.device.deviceInfo.label = vnic_label
5091 nic.device.deviceInfo.summary = network_name
5092 nic.device.backing = vim.vm.device.VirtualEthernetCard.NetworkBackingInfo()
5093
5094 nic.device.backing.network = self.get_obj(content, [vim.Network], network_name)
5095 nic.device.backing.deviceName = network_name
5096 nic.device.backing.useAutoDetect = False
5097 nic.device.connectable = vim.vm.device.VirtualDevice.ConnectInfo()
5098 nic.device.connectable.startConnected = True
5099 nic.device.connectable.allowGuestControl = True
5100
5101 nic.device.sriovBacking = vim.vm.device.VirtualSriovEthernetCard.SriovBackingInfo()
5102 nic.device.sriovBacking.physicalFunctionBacking = vim.vm.device.VirtualPCIPassthrough.DeviceBackingInfo()
5103 nic.device.sriovBacking.physicalFunctionBacking.id = sriov_device.id
5104
5105 devices.append(nic)
5106 vmconf = vim.vm.ConfigSpec(deviceChange=devices)
5107 task = vm_obj.ReconfigVM_Task(vmconf)
5108 return task
5109 except Exception as exp:
5110 self.logger.error("Error {} occurred while adding SRIOV adapter in VM: {}".format(exp, vm_obj))
5111 return None
5112
5113
5114 def create_dvPort_group(self, network_name):
5115 """
5116 Method to create disributed virtual portgroup
5117
5118 Args:
5119 network_name - name of network/portgroup
5120
5121 Returns:
5122 portgroup key
5123 """
5124 try:
5125 new_network_name = [network_name, '-', str(uuid.uuid4())]
5126 network_name=''.join(new_network_name)
5127 vcenter_conect, content = self.get_vcenter_content()
5128
5129 dv_switch = self.get_obj(content, [vim.DistributedVirtualSwitch], self.dvs_name)
5130 if dv_switch:
5131 dv_pg_spec = vim.dvs.DistributedVirtualPortgroup.ConfigSpec()
5132 dv_pg_spec.name = network_name
5133
5134 dv_pg_spec.type = vim.dvs.DistributedVirtualPortgroup.PortgroupType.earlyBinding
5135 dv_pg_spec.defaultPortConfig = vim.dvs.VmwareDistributedVirtualSwitch.VmwarePortConfigPolicy()
5136 dv_pg_spec.defaultPortConfig.securityPolicy = vim.dvs.VmwareDistributedVirtualSwitch.SecurityPolicy()
5137 dv_pg_spec.defaultPortConfig.securityPolicy.allowPromiscuous = vim.BoolPolicy(value=False)
5138 dv_pg_spec.defaultPortConfig.securityPolicy.forgedTransmits = vim.BoolPolicy(value=False)
5139 dv_pg_spec.defaultPortConfig.securityPolicy.macChanges = vim.BoolPolicy(value=False)
5140
5141 task = dv_switch.AddDVPortgroup_Task([dv_pg_spec])
5142 self.wait_for_vcenter_task(task, vcenter_conect)
5143
5144 dvPort_group = self.get_obj(content, [vim.dvs.DistributedVirtualPortgroup], network_name)
5145 if dvPort_group:
5146 self.logger.info("Created disributed virtaul port group: {}".format(dvPort_group))
5147 return dvPort_group.key
5148 else:
5149 self.logger.debug("No disributed virtual switch found with name {}".format(network_name))
5150
5151 except Exception as exp:
5152 self.logger.error("Error occurred while creating disributed virtaul port group {}"\
5153 " : {}".format(network_name, exp))
5154 return None
5155
5156 def reconfig_portgroup(self, content, dvPort_group_name , config_info={}):
5157 """
5158 Method to reconfigure disributed virtual portgroup
5159
5160 Args:
5161 dvPort_group_name - name of disributed virtual portgroup
5162 content - vCenter content object
5163 config_info - disributed virtual portgroup configuration
5164
5165 Returns:
5166 task object
5167 """
5168 try:
5169 dvPort_group = self.get_dvport_group(dvPort_group_name)
5170 if dvPort_group:
5171 dv_pg_spec = vim.dvs.DistributedVirtualPortgroup.ConfigSpec()
5172 dv_pg_spec.configVersion = dvPort_group.config.configVersion
5173 dv_pg_spec.defaultPortConfig = vim.dvs.VmwareDistributedVirtualSwitch.VmwarePortConfigPolicy()
5174 if "vlanID" in config_info:
5175 dv_pg_spec.defaultPortConfig.vlan = vim.dvs.VmwareDistributedVirtualSwitch.VlanIdSpec()
5176 dv_pg_spec.defaultPortConfig.vlan.vlanId = config_info.get('vlanID')
5177
5178 task = dvPort_group.ReconfigureDVPortgroup_Task(spec=dv_pg_spec)
5179 return task
5180 else:
5181 return None
5182 except Exception as exp:
5183 self.logger.error("Error occurred while reconfiguraing disributed virtaul port group {}"\
5184 " : {}".format(dvPort_group_name, exp))
5185 return None
5186
5187
5188 def destroy_dvport_group(self , dvPort_group_name):
5189 """
5190 Method to destroy disributed virtual portgroup
5191
5192 Args:
5193 network_name - name of network/portgroup
5194
5195 Returns:
5196 True if portgroup successfully got deleted else false
5197 """
5198 vcenter_conect, content = self.get_vcenter_content()
5199 try:
5200 status = None
5201 dvPort_group = self.get_dvport_group(dvPort_group_name)
5202 if dvPort_group:
5203 task = dvPort_group.Destroy_Task()
5204 status = self.wait_for_vcenter_task(task, vcenter_conect)
5205 return status
5206 except vmodl.MethodFault as exp:
5207 self.logger.error("Caught vmodl fault {} while deleting disributed virtaul port group {}".format(
5208 exp, dvPort_group_name))
5209 return None
5210
5211
5212 def get_dvport_group(self, dvPort_group_name):
5213 """
5214 Method to get disributed virtual portgroup
5215
5216 Args:
5217 network_name - name of network/portgroup
5218
5219 Returns:
5220 portgroup object
5221 """
5222 vcenter_conect, content = self.get_vcenter_content()
5223 dvPort_group = None
5224 try:
5225 container = content.viewManager.CreateContainerView(content.rootFolder, [vim.dvs.DistributedVirtualPortgroup], True)
5226 for item in container.view:
5227 if item.key == dvPort_group_name:
5228 dvPort_group = item
5229 break
5230 return dvPort_group
5231 except vmodl.MethodFault as exp:
5232 self.logger.error("Caught vmodl fault {} for disributed virtaul port group {}".format(
5233 exp, dvPort_group_name))
5234 return None
5235
5236 def get_vlanID_from_dvs_portgr(self, dvPort_group_name):
5237 """
5238 Method to get disributed virtual portgroup vlanID
5239
5240 Args:
5241 network_name - name of network/portgroup
5242
5243 Returns:
5244 vlan ID
5245 """
5246 vlanId = None
5247 try:
5248 dvPort_group = self.get_dvport_group(dvPort_group_name)
5249 if dvPort_group:
5250 vlanId = dvPort_group.config.defaultPortConfig.vlan.vlanId
5251 except vmodl.MethodFault as exp:
5252 self.logger.error("Caught vmodl fault {} for disributed virtaul port group {}".format(
5253 exp, dvPort_group_name))
5254 return vlanId
5255
5256
5257 def configure_vlanID(self, content, vcenter_conect, dvPort_group_name):
5258 """
5259 Method to configure vlanID in disributed virtual portgroup vlanID
5260
5261 Args:
5262 network_name - name of network/portgroup
5263
5264 Returns:
5265 None
5266 """
5267 vlanID = self.get_vlanID_from_dvs_portgr(dvPort_group_name)
5268 if vlanID == 0:
5269 #configure vlanID
5270 vlanID = self.genrate_vlanID(dvPort_group_name)
5271 config = {"vlanID":vlanID}
5272 task = self.reconfig_portgroup(content, dvPort_group_name,
5273 config_info=config)
5274 if task:
5275 status= self.wait_for_vcenter_task(task, vcenter_conect)
5276 if status:
5277 self.logger.info("Reconfigured Port group {} for vlan ID {}".format(
5278 dvPort_group_name,vlanID))
5279 else:
5280 self.logger.error("Fail reconfigure portgroup {} for vlanID{}".format(
5281 dvPort_group_name, vlanID))
5282
5283
5284 def genrate_vlanID(self, network_name):
5285 """
5286 Method to get unused vlanID
5287 Args:
5288 network_name - name of network/portgroup
5289 Returns:
5290 vlanID
5291 """
5292 vlan_id = None
5293 used_ids = []
5294 if self.config.get('vlanID_range') == None:
5295 raise vimconn.vimconnConflictException("You must provide a 'vlanID_range' "\
5296 "at config value before creating sriov network with vlan tag")
5297 if "used_vlanIDs" not in self.persistent_info:
5298 self.persistent_info["used_vlanIDs"] = {}
5299 else:
5300 used_ids = self.persistent_info["used_vlanIDs"].values()
kasarc5bf2932018-03-09 04:15:22 -08005301 #For python3
5302 #used_ids = list(self.persistent_info["used_vlanIDs"].values())
kateac1e3792017-04-01 02:16:39 -07005303
5304 for vlanID_range in self.config.get('vlanID_range'):
5305 start_vlanid , end_vlanid = vlanID_range.split("-")
5306 if start_vlanid > end_vlanid:
5307 raise vimconn.vimconnConflictException("Invalid vlan ID range {}".format(
5308 vlanID_range))
5309
5310 for id in xrange(int(start_vlanid), int(end_vlanid) + 1):
kasarc5bf2932018-03-09 04:15:22 -08005311 #For python3
5312 #for id in range(int(start_vlanid), int(end_vlanid) + 1):
kateac1e3792017-04-01 02:16:39 -07005313 if id not in used_ids:
5314 vlan_id = id
5315 self.persistent_info["used_vlanIDs"][network_name] = vlan_id
5316 return vlan_id
5317 if vlan_id is None:
5318 raise vimconn.vimconnConflictException("All Vlan IDs are in use")
5319
5320
5321 def get_obj(self, content, vimtype, name):
5322 """
5323 Get the vsphere object associated with a given text name
5324 """
5325 obj = None
5326 container = content.viewManager.CreateContainerView(content.rootFolder, vimtype, True)
5327 for item in container.view:
5328 if item.name == name:
5329 obj = item
5330 break
5331 return obj
5332
kasar0c007d62017-05-19 03:13:57 -07005333
5334 def insert_media_to_vm(self, vapp, image_id):
5335 """
5336 Method to insert media CD-ROM (ISO image) from catalog to vm.
5337 vapp - vapp object to get vm id
5338 Image_id - image id for cdrom to be inerted to vm
5339 """
5340 # create connection object
5341 vca = self.connect()
5342 try:
5343 # fetching catalog details
kasarc5bf2932018-03-09 04:15:22 -08005344 rest_url = "{}/api/catalog/{}".format(self.url, image_id)
5345 if vca._session:
5346 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
5347 'x-vcloud-authorization': vca._session.headers['x-vcloud-authorization']}
5348 response = self.perform_request(req_type='GET',
5349 url=rest_url,
5350 headers=headers)
kasar0c007d62017-05-19 03:13:57 -07005351
5352 if response.status_code != 200:
5353 self.logger.error("REST call {} failed reason : {}"\
5354 "status code : {}".format(url_rest_call,
5355 response.content,
5356 response.status_code))
5357 raise vimconn.vimconnException("insert_media_to_vm(): Failed to get "\
5358 "catalog details")
5359 # searching iso name and id
5360 iso_name,media_id = self.get_media_details(vca, response.content)
5361
5362 if iso_name and media_id:
5363 data ="""<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
5364 <ns6:MediaInsertOrEjectParams
5365 xmlns="http://www.vmware.com/vcloud/versions" xmlns:ns2="http://schemas.dmtf.org/ovf/envelope/1" xmlns:ns3="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData" xmlns:ns4="http://schemas.dmtf.org/wbem/wscim/1/common" xmlns:ns5="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData" xmlns:ns6="http://www.vmware.com/vcloud/v1.5" xmlns:ns7="http://www.vmware.com/schema/ovf" xmlns:ns8="http://schemas.dmtf.org/ovf/environment/1" xmlns:ns9="http://www.vmware.com/vcloud/extension/v1.5">
5366 <ns6:Media
5367 type="application/vnd.vmware.vcloud.media+xml"
5368 name="{}.iso"
5369 id="urn:vcloud:media:{}"
5370 href="https://{}/api/media/{}"/>
5371 </ns6:MediaInsertOrEjectParams>""".format(iso_name, media_id,
kasarc5bf2932018-03-09 04:15:22 -08005372 self.url,media_id)
kasar0c007d62017-05-19 03:13:57 -07005373
kasarc5bf2932018-03-09 04:15:22 -08005374 for vms in vapp.get_all_vms():
5375 vm_id = vms.get('id').split(':')[-1]
kasar0c007d62017-05-19 03:13:57 -07005376
kasar0c007d62017-05-19 03:13:57 -07005377 headers['Content-Type'] = 'application/vnd.vmware.vcloud.mediaInsertOrEjectParams+xml'
kasarc5bf2932018-03-09 04:15:22 -08005378 rest_url = "{}/api/vApp/vm-{}/media/action/insertMedia".format(self.url,vm_id)
kasar0c007d62017-05-19 03:13:57 -07005379
kasarc5bf2932018-03-09 04:15:22 -08005380 response = self.perform_request(req_type='POST',
5381 url=rest_url,
5382 data=data,
5383 headers=headers)
kasar0c007d62017-05-19 03:13:57 -07005384
5385 if response.status_code != 202:
5386 self.logger.error("Failed to insert CD-ROM to vm")
5387 raise vimconn.vimconnException("insert_media_to_vm() : Failed to insert"\
5388 "ISO image to vm")
5389 else:
kasarc5bf2932018-03-09 04:15:22 -08005390 task = self.get_task_from_response(response.content)
5391 result = self.client.get_task_monitor().wait_for_success(task=task)
5392 if result.get('status') == 'success':
kasar0c007d62017-05-19 03:13:57 -07005393 self.logger.info("insert_media_to_vm(): Sucessfully inserted media ISO"\
5394 " image to vm {}".format(vm_id))
kasarc5bf2932018-03-09 04:15:22 -08005395
kasar0c007d62017-05-19 03:13:57 -07005396 except Exception as exp:
5397 self.logger.error("insert_media_to_vm() : exception occurred "\
5398 "while inserting media CD-ROM")
5399 raise vimconn.vimconnException(message=exp)
5400
5401
5402 def get_media_details(self, vca, content):
5403 """
5404 Method to get catalog item details
5405 vca - connection object
5406 content - Catalog details
5407 Return - Media name, media id
5408 """
5409 cataloghref_list = []
5410 try:
5411 if content:
5412 vm_list_xmlroot = XmlElementTree.fromstring(content)
5413 for child in vm_list_xmlroot.iter():
5414 if 'CatalogItem' in child.tag:
5415 cataloghref_list.append(child.attrib.get('href'))
5416 if cataloghref_list is not None:
5417 for href in cataloghref_list:
5418 if href:
kasarc5bf2932018-03-09 04:15:22 -08005419 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
5420 'x-vcloud-authorization': vca._session.headers['x-vcloud-authorization']}
5421 response = self.perform_request(req_type='GET',
5422 url=href,
5423 headers=headers)
kasar0c007d62017-05-19 03:13:57 -07005424 if response.status_code != 200:
5425 self.logger.error("REST call {} failed reason : {}"\
5426 "status code : {}".format(href,
5427 response.content,
5428 response.status_code))
5429 raise vimconn.vimconnException("get_media_details : Failed to get "\
5430 "catalogitem details")
5431 list_xmlroot = XmlElementTree.fromstring(response.content)
5432 for child in list_xmlroot.iter():
5433 if 'Entity' in child.tag:
5434 if 'media' in child.attrib.get('href'):
5435 name = child.attrib.get('name')
5436 media_id = child.attrib.get('href').split('/').pop()
5437 return name,media_id
5438 else:
5439 self.logger.debug("Media name and id not found")
5440 return False,False
5441 except Exception as exp:
5442 self.logger.error("get_media_details : exception occurred "\
5443 "getting media details")
5444 raise vimconn.vimconnException(message=exp)
5445
bhangare1a0b97c2017-06-21 02:20:15 -07005446
kated47ad5f2017-08-03 02:16:13 -07005447 def retry_rest(self, method, url, add_headers=None, data=None):
bhangare1a0b97c2017-06-21 02:20:15 -07005448 """ Method to get Token & retry respective REST request
5449 Args:
5450 api - REST API - Can be one of 'GET' or 'PUT' or 'POST'
5451 url - request url to be used
5452 add_headers - Additional headers (optional)
5453 data - Request payload data to be passed in request
5454 Returns:
5455 response - Response of request
5456 """
5457 response = None
5458
5459 #Get token
5460 self.get_token()
5461
kasarc5bf2932018-03-09 04:15:22 -08005462 if self.client._session:
5463 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
5464 'x-vcloud-authorization': self.client._session.headers['x-vcloud-authorization']}
bhangare1a0b97c2017-06-21 02:20:15 -07005465
5466 if add_headers:
5467 headers.update(add_headers)
5468
kated47ad5f2017-08-03 02:16:13 -07005469 if method == 'GET':
kasarc5bf2932018-03-09 04:15:22 -08005470 response = self.perform_request(req_type='GET',
5471 url=url,
5472 headers=headers)
kated47ad5f2017-08-03 02:16:13 -07005473 elif method == 'PUT':
kasarc5bf2932018-03-09 04:15:22 -08005474 response = self.perform_request(req_type='PUT',
5475 url=url,
5476 headers=headers,
5477 data=data)
kated47ad5f2017-08-03 02:16:13 -07005478 elif method == 'POST':
kasarc5bf2932018-03-09 04:15:22 -08005479 response = self.perform_request(req_type='POST',
5480 url=url,
5481 headers=headers,
5482 data=data)
kated47ad5f2017-08-03 02:16:13 -07005483 elif method == 'DELETE':
kasarc5bf2932018-03-09 04:15:22 -08005484 response = self.perform_request(req_type='DELETE',
5485 url=url,
5486 headers=headers)
kated47ad5f2017-08-03 02:16:13 -07005487 return response
5488
bhangare1a0b97c2017-06-21 02:20:15 -07005489
5490 def get_token(self):
5491 """ Generate a new token if expired
5492
5493 Returns:
kasarc5bf2932018-03-09 04:15:22 -08005494 The return client object that letter can be used to connect to vCloud director as admin for VDC
bhangare1a0b97c2017-06-21 02:20:15 -07005495 """
bhangare1a0b97c2017-06-21 02:20:15 -07005496 try:
5497 self.logger.debug("Generate token for vca {} as {} to datacenter {}.".format(self.org_name,
5498 self.user,
5499 self.org_name))
kasarc5bf2932018-03-09 04:15:22 -08005500 host = self.url
5501 client = Client(host, verify_ssl_certs=False)
5502 client.set_credentials(BasicLoginCredentials(self.user, self.org_name, self.passwd))
5503 # connection object
5504 self.client = client
bhangare1a0b97c2017-06-21 02:20:15 -07005505
5506 except:
5507 raise vimconn.vimconnConnectionException("Can't connect to a vCloud director org: "
5508 "{} as user: {}".format(self.org_name, self.user))
5509
kasarc5bf2932018-03-09 04:15:22 -08005510 if not client:
5511 raise vimconn.vimconnConnectionException("Failed while reconnecting vCD")
bhangare1a0b97c2017-06-21 02:20:15 -07005512
bhangare1a0b97c2017-06-21 02:20:15 -07005513
5514 def get_vdc_details(self):
5515 """ Get VDC details using pyVcloud Lib
5516
kasarc5bf2932018-03-09 04:15:22 -08005517 Returns org and vdc object
bhangare1a0b97c2017-06-21 02:20:15 -07005518 """
kasarc5bf2932018-03-09 04:15:22 -08005519 org = Org(self.client, resource=self.client.get_org())
5520 vdc = org.get_vdc(self.tenant_name)
bhangare1a0b97c2017-06-21 02:20:15 -07005521
5522 #Retry once, if failed by refreshing token
5523 if vdc is None:
5524 self.get_token()
kasarc5bf2932018-03-09 04:15:22 -08005525 vdc = org.get_vdc(self.tenant_name)
bhangare1a0b97c2017-06-21 02:20:15 -07005526
kasarc5bf2932018-03-09 04:15:22 -08005527 return org, vdc
5528
5529
5530 def perform_request(self, req_type, url, headers=None, data=None):
5531 """Perform the POST/PUT/GET/DELETE request."""
5532
5533 #Log REST request details
5534 self.log_request(req_type, url=url, headers=headers, data=data)
5535 # perform request and return its result
5536 if req_type == 'GET':
5537 response = requests.get(url=url,
5538 headers=headers,
5539 verify=False)
5540 elif req_type == 'PUT':
5541 response = requests.put(url=url,
5542 headers=headers,
5543 data=data,
5544 verify=False)
5545 elif req_type == 'POST':
5546 response = requests.post(url=url,
5547 headers=headers,
5548 data=data,
5549 verify=False)
5550 elif req_type == 'DELETE':
5551 response = requests.delete(url=url,
5552 headers=headers,
5553 verify=False)
5554 #Log the REST response
5555 self.log_response(response)
5556
5557 return response
5558
5559
5560 def log_request(self, req_type, url=None, headers=None, data=None):
5561 """Logs REST request details"""
5562
5563 if req_type is not None:
5564 self.logger.debug("Request type: {}".format(req_type))
5565
5566 if url is not None:
5567 self.logger.debug("Request url: {}".format(url))
5568
5569 if headers is not None:
5570 for header in headers:
5571 self.logger.debug("Request header: {}: {}".format(header, headers[header]))
5572
5573 if data is not None:
5574 self.logger.debug("Request data: {}".format(data))
5575
5576
5577 def log_response(self, response):
5578 """Logs REST response details"""
5579
5580 self.logger.debug("Response status code: {} ".format(response.status_code))
5581
5582
5583 def get_task_from_response(self, content):
5584 """
5585 content - API response content(response.content)
5586 return task object
5587 """
5588 xmlroot = XmlElementTree.fromstring(content)
5589 if xmlroot.tag.split('}')[1] == "Task":
5590 return xmlroot
5591 else:
5592 for ele in xmlroot:
5593 if ele.tag.split("}")[1] == "Tasks":
5594 task = ele[0]
5595 break
5596 return task
5597
5598
5599 def power_on_vapp(self,vapp_id, vapp_name):
5600 """
5601 vapp_id - vApp uuid
5602 vapp_name - vAapp name
5603 return - Task object
5604 """
5605 headers = {'Accept':'application/*+xml;version=' + API_VERSION,
5606 'x-vcloud-authorization': self.client._session.headers['x-vcloud-authorization']}
5607
5608 poweron_href = "{}/api/vApp/vapp-{}/power/action/powerOn".format(self.url,
5609 vapp_id)
5610 response = self.perform_request(req_type='POST',
5611 url=poweron_href,
5612 headers=headers)
5613
5614 if response.status_code != 202:
5615 self.logger.error("REST call {} failed reason : {}"\
5616 "status code : {} ".format(poweron_href,
5617 response.content,
5618 response.status_code))
5619 raise vimconn.vimconnException("power_on_vapp() : Failed to power on "\
5620 "vApp {}".format(vapp_name))
5621 else:
5622 poweron_task = self.get_task_from_response(response.content)
5623 return poweron_task
bhangare1a0b97c2017-06-21 02:20:15 -07005624
kated47ad5f2017-08-03 02:16:13 -07005625