1 # -*- coding: utf-8 -*-
4 # Copyright 2016-2017 VMware Inc.
5 # This file is part of ETSI OSM
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
12 # http://www.apache.org/licenses/LICENSE-2.0
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
20 # For those usages not covered by the Apache License, Version 2.0 please
21 # contact: osslegalrouting@vmware.com
25 vimconn_vmware implementation an Abstract class in order to interact with VMware vCloud Director.
28 from progressbar
import Percentage
, Bar
, ETA
, FileTransferSpeed
, ProgressBar
38 from pyVmomi
import vim
, vmodl
39 from pyVim
.connect
import SmartConnect
, Disconnect
41 from xml
.etree
import ElementTree
as XmlElementTree
42 from lxml
import etree
as lxmlElementTree
45 from pyvcloud
.vcd
.client
import BasicLoginCredentials
,Client
,VcdTaskException
46 from pyvcloud
.vcd
.vdc
import VDC
47 from pyvcloud
.vcd
.org
import Org
49 from pyvcloud
.vcd
.vapp
import VApp
50 from xml
.sax
.saxutils
import escape
64 # global variable for vcd connector type
65 STANDALONE
= 'standalone'
67 # key for flavor dicts
68 FLAVOR_RAM_KEY
= 'ram'
69 FLAVOR_VCPUS_KEY
= 'vcpus'
70 FLAVOR_DISK_KEY
= 'disk'
71 DEFAULT_IP_PROFILE
= {'dhcp_count':50,
75 # global variable for wait time
81 __author__
= "Mustafa Bayramov, Arpita Kate, Sachin Bhangare, Prakash Kasar"
82 __date__
= "$09-Mar-2018 11:09:29$"
85 # -1: "Could not be created",
91 # 5: "Waiting for user input",
93 # 7: "Unrecognized state",
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"
103 # mapping vCD status to MANO
104 vcdStatusCode2manoFormat
= {4: 'ACTIVE',
113 netStatus2manoFormat
= {'ACTIVE': 'ACTIVE', 'PAUSED': 'PAUSED', 'INACTIVE': 'INACTIVE', 'BUILD': 'BUILD',
114 'ERROR': 'ERROR', 'DELETED': 'DELETED'
117 class vimconnector(vimconn
.vimconnector
):
118 # dict used to store flavor in memory
121 def __init__(self
, uuid
=None, name
=None, tenant_id
=None, tenant_name
=None,
122 url
=None, url_admin
=None, user
=None, passwd
=None, log_level
=None, config
={}, persistent_info
={}):
124 Constructor create vmware connector to vCloud director.
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.
129 a) It initialize organization UUID
130 b) Initialize tenant_id/vdc ID. (This information derived from tenant name)
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.
142 password - is password for a user.
144 VMware connector also requires PVDC administrative privileges and separate account.
145 This variables must be passed via config argument dict contains keys
147 dict['admin_username']
148 dict['admin_password']
149 config - Provide NSX and vCenter information
155 vimconn
.vimconnector
.__init
__(self
, uuid
, name
, tenant_id
, tenant_name
, url
,
156 url_admin
, user
, passwd
, log_level
, config
)
158 self
.logger
= logging
.getLogger('openmano.vim.vmware')
159 self
.logger
.setLevel(10)
160 self
.persistent_info
= persistent_info
165 self
.url_admin
= url_admin
166 self
.tenant_id
= tenant_id
167 self
.tenant_name
= tenant_name
171 self
.admin_password
= None
172 self
.admin_user
= None
174 self
.nsx_manager
= None
176 self
.nsx_password
= None
177 self
.availability_zone
= None
179 # Disable warnings from self-signed certificates.
180 requests
.packages
.urllib3
.disable_warnings()
182 if tenant_name
is not None:
183 orgnameandtenant
= tenant_name
.split(":")
184 if len(orgnameandtenant
) == 2:
185 self
.tenant_name
= orgnameandtenant
[1]
186 self
.org_name
= orgnameandtenant
[0]
188 self
.tenant_name
= tenant_name
189 if "orgname" in config
:
190 self
.org_name
= config
['orgname']
193 self
.logger
.setLevel(getattr(logging
, log_level
))
196 self
.admin_user
= config
['admin_username']
197 self
.admin_password
= config
['admin_password']
199 raise vimconn
.vimconnException(message
="Error admin username or admin password is empty.")
202 self
.nsx_manager
= config
['nsx_manager']
203 self
.nsx_user
= config
['nsx_user']
204 self
.nsx_password
= config
['nsx_password']
206 raise vimconn
.vimconnException(message
="Error: nsx manager or nsx user or nsx password is empty in Config")
208 self
.vcenter_ip
= config
.get("vcenter_ip", None)
209 self
.vcenter_port
= config
.get("vcenter_port", None)
210 self
.vcenter_user
= config
.get("vcenter_user", None)
211 self
.vcenter_password
= config
.get("vcenter_password", None)
213 #Set availability zone for Affinity rules
214 self
.availability_zone
= self
.set_availability_zones()
216 # ############# Stub code for SRIOV #################
218 # self.dvs_name = config['dv_switch_name']
220 # raise vimconn.vimconnException(message="Error: distributed virtaul switch name is empty in Config")
222 # self.vlanID_range = config.get("vlanID_range", None)
228 raise vimconn
.vimconnException('url param can not be NoneType')
230 if not self
.url_admin
: # try to use normal url
231 self
.url_admin
= self
.url
233 logging
.debug("UUID: {} name: {} tenant_id: {} tenant name {}".format(self
.id, self
.org_name
,
234 self
.tenant_id
, self
.tenant_name
))
235 logging
.debug("vcd url {} vcd username: {} vcd password: {}".format(self
.url
, self
.user
, self
.passwd
))
236 logging
.debug("vcd admin username {} vcd admin passowrd {}".format(self
.admin_user
, self
.admin_password
))
238 # initialize organization
239 if self
.user
is not None and self
.passwd
is not None and self
.url
:
240 self
.init_organization()
242 def __getitem__(self
, index
):
245 if index
== 'tenant_id':
246 return self
.tenant_id
247 if index
== 'tenant_name':
248 return self
.tenant_name
251 elif index
== 'org_name':
253 elif index
== 'org_uuid':
255 elif index
== 'user':
257 elif index
== 'passwd':
261 elif index
== 'url_admin':
262 return self
.url_admin
263 elif index
== "config":
266 raise KeyError("Invalid key '%s'" % str(index
))
268 def __setitem__(self
, index
, value
):
271 if index
== 'tenant_id':
272 self
.tenant_id
= value
273 if index
== 'tenant_name':
274 self
.tenant_name
= value
277 elif index
== 'org_name':
278 self
.org_name
= value
279 elif index
== 'org_uuid':
280 self
.org_uuid
= value
281 elif index
== 'user':
283 elif index
== 'passwd':
287 elif index
== 'url_admin':
288 self
.url_admin
= value
290 raise KeyError("Invalid key '%s'" % str(index
))
292 def connect_as_admin(self
):
293 """ Method connect as pvdc admin user to vCloud director.
294 There are certain action that can be done only by provider vdc admin user.
295 Organization creation / provider network creation etc.
298 The return client object that latter can be used to connect to vcloud director as admin for provider vdc
301 self
.logger
.debug("Logging into vCD {} as admin.".format(self
.org_name
))
306 client_as_admin
= Client(host
, verify_ssl_certs
=False)
307 client_as_admin
.set_credentials(BasicLoginCredentials(self
.admin_user
, org
, self
.admin_password
))
308 except Exception as e
:
309 raise vimconn
.vimconnException(
310 "Can't connect to a vCloud director as: {} with exception {}".format(self
.admin_user
, e
))
312 return client_as_admin
315 """ Method connect as normal user to vCloud director.
318 The return client object that latter can be used to connect to vCloud director as admin for VDC
322 self
.logger
.debug("Logging into vCD {} as {} to datacenter {}.".format(self
.org_name
,
326 client
= Client(host
, verify_ssl_certs
=False)
327 client
.set_credentials(BasicLoginCredentials(self
.user
, self
.org_name
, self
.passwd
))
329 raise vimconn
.vimconnConnectionException("Can't connect to a vCloud director org: "
330 "{} as user: {}".format(self
.org_name
, self
.user
))
334 def init_organization(self
):
335 """ Method initialize organization UUID and VDC parameters.
337 At bare minimum client must provide organization name that present in vCloud director and VDC.
339 The VDC - UUID ( tenant_id) will be initialized at the run time if client didn't call constructor.
340 The Org - UUID will be initialized at the run time if data center present in vCloud director.
343 The return vca object that letter can be used to connect to vcloud direct as admin
345 client
= self
.connect()
347 raise vimconn
.vimconnConnectionException("Failed to connect vCD.")
351 if self
.org_uuid
is None:
352 org_list
= client
.get_org_list()
353 for org
in org_list
.Org
:
354 # we set org UUID at the init phase but we can do it only when we have valid credential.
355 if org
.get('name') == self
.org_name
:
356 self
.org_uuid
= org
.get('href').split('/')[-1]
357 self
.logger
.debug("Setting organization UUID {}".format(self
.org_uuid
))
360 raise vimconn
.vimconnException("Vcloud director organization {} not found".format(self
.org_name
))
362 # if well good we require for org details
363 org_details_dict
= self
.get_org(org_uuid
=self
.org_uuid
)
365 # we have two case if we want to initialize VDC ID or VDC name at run time
366 # tenant_name provided but no tenant id
367 if self
.tenant_id
is None and self
.tenant_name
is not None and 'vdcs' in org_details_dict
:
368 vdcs_dict
= org_details_dict
['vdcs']
369 for vdc
in vdcs_dict
:
370 if vdcs_dict
[vdc
] == self
.tenant_name
:
372 self
.logger
.debug("Setting vdc uuid {} for organization UUID {}".format(self
.tenant_id
,
376 raise vimconn
.vimconnException("Tenant name indicated but not present in vcloud director.")
377 # case two we have tenant_id but we don't have tenant name so we find and set it.
378 if self
.tenant_id
is not None and self
.tenant_name
is None and 'vdcs' in org_details_dict
:
379 vdcs_dict
= org_details_dict
['vdcs']
380 for vdc
in vdcs_dict
:
381 if vdc
== self
.tenant_id
:
382 self
.tenant_name
= vdcs_dict
[vdc
]
383 self
.logger
.debug("Setting vdc uuid {} for organization UUID {}".format(self
.tenant_id
,
387 raise vimconn
.vimconnException("Tenant id indicated but not present in vcloud director")
388 self
.logger
.debug("Setting organization uuid {}".format(self
.org_uuid
))
390 self
.logger
.debug("Failed initialize organization UUID for org {}".format(self
.org_name
))
391 self
.logger
.debug(traceback
.format_exc())
394 def new_tenant(self
, tenant_name
=None, tenant_description
=None):
395 """ Method adds a new tenant to VIM with this name.
396 This action requires access to create VDC action in vCloud director.
399 tenant_name is tenant_name to be created.
400 tenant_description not used for this call
403 returns the tenant identifier in UUID format.
404 If action is failed method will throw vimconn.vimconnException method
406 vdc_task
= self
.create_vdc(vdc_name
=tenant_name
)
407 if vdc_task
is not None:
408 vdc_uuid
, value
= vdc_task
.popitem()
409 self
.logger
.info("Created new vdc {} and uuid: {}".format(tenant_name
, vdc_uuid
))
412 raise vimconn
.vimconnException("Failed create tenant {}".format(tenant_name
))
414 def delete_tenant(self
, tenant_id
=None):
415 """ Delete a tenant from VIM
417 tenant_id is tenant_id to be deleted.
420 returns the tenant identifier in UUID format.
421 If action is failed method will throw exception
423 vca
= self
.connect_as_admin()
425 raise vimconn
.vimconnConnectionException("Failed to connect vCD")
427 if tenant_id
is not None:
430 url_list
= [self
.url
, '/api/vdc/', tenant_id
]
431 orgvdc_herf
= ''.join(url_list
)
433 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
434 'x-vcloud-authorization': vca
._session
.headers
['x-vcloud-authorization']}
435 response
= self
.perform_request(req_type
='GET',
439 if response
.status_code
!= requests
.codes
.ok
:
440 self
.logger
.debug("delete_tenant():GET REST API call {} failed. "\
441 "Return status code {}".format(orgvdc_herf
,
442 response
.status_code
))
443 raise vimconn
.vimconnNotFoundException("Fail to get tenant {}".format(tenant_id
))
445 lxmlroot_respond
= lxmlElementTree
.fromstring(response
.content
)
446 namespaces
= {prefix
:uri
for prefix
,uri
in lxmlroot_respond
.nsmap
.iteritems() if prefix
}
448 #namespaces = {prefix:uri for prefix,uri in lxmlroot_respond.nsmap.items() if prefix}
449 namespaces
["xmlns"]= "http://www.vmware.com/vcloud/v1.5"
450 vdc_remove_href
= lxmlroot_respond
.find("xmlns:Link[@rel='remove']",namespaces
).attrib
['href']
451 vdc_remove_href
= vdc_remove_href
+ '?recursive=true&force=true'
453 response
= self
.perform_request(req_type
='DELETE',
457 if response
.status_code
== 202:
461 self
.logger
.debug("delete_tenant(): DELETE REST API call {} failed. "\
462 "Return status code {}".format(vdc_remove_href
,
463 response
.status_code
))
464 raise vimconn
.vimconnException("Fail to delete tenant with ID {}".format(tenant_id
))
466 self
.logger
.debug("delete_tenant():Incorrect tenant ID {}".format(tenant_id
))
467 raise vimconn
.vimconnNotFoundException("Fail to get tenant {}".format(tenant_id
))
470 def get_tenant_list(self
, filter_dict
={}):
471 """Obtain tenants of VIM
472 filter_dict can contain the following keys:
473 name: filter by tenant name
474 id: filter by tenant uuid/id
476 Returns the tenant list of dictionaries:
477 [{'name':'<name>, 'id':'<id>, ...}, ...]
480 org_dict
= self
.get_org(self
.org_uuid
)
481 vdcs_dict
= org_dict
['vdcs']
486 entry
= {'name': vdcs_dict
[k
], 'id': k
}
487 # if caller didn't specify dictionary we return all tenants.
488 if filter_dict
is not None and filter_dict
:
489 filtered_entry
= entry
.copy()
490 filtered_dict
= set(entry
.keys()) - set(filter_dict
)
491 for unwanted_key
in filtered_dict
: del entry
[unwanted_key
]
492 if filter_dict
== entry
:
493 vdclist
.append(filtered_entry
)
495 vdclist
.append(entry
)
497 self
.logger
.debug("Error in get_tenant_list()")
498 self
.logger
.debug(traceback
.format_exc())
499 raise vimconn
.vimconnException("Incorrect state. {}")
503 def new_network(self
, net_name
, net_type
, ip_profile
=None, shared
=False):
504 """Adds a tenant network to VIM
506 net_type can be 'bridge','data'.'ptp'.
507 ip_profile is a dict containing the IP parameters of the network
509 Returns the network identifier"""
511 self
.logger
.debug("new_network tenant {} net_type {} ip_profile {} shared {}"
512 .format(net_name
, net_type
, ip_profile
, shared
))
518 # ############# Stub code for SRIOV #################
519 # if net_type == "data" or net_type == "ptp":
520 # if self.config.get('dv_switch_name') == None:
521 # raise vimconn.vimconnConflictException("You must provide 'dv_switch_name' at config value")
522 # network_uuid = self.create_dvPort_group(net_name)
524 network_uuid
= self
.create_network(network_name
=net_name
, net_type
=net_type
,
525 ip_profile
=ip_profile
, isshared
=isshared
)
526 if network_uuid
is not None:
529 raise vimconn
.vimconnUnexpectedResponse("Failed create a new network {}".format(net_name
))
531 def get_vcd_network_list(self
):
532 """ Method available organization for a logged in tenant
535 The return vca object that letter can be used to connect to vcloud direct as admin
538 self
.logger
.debug("get_vcd_network_list(): retrieving network list for vcd {}".format(self
.tenant_name
))
540 if not self
.tenant_name
:
541 raise vimconn
.vimconnConnectionException("Tenant name is empty.")
543 org
, vdc
= self
.get_vdc_details()
545 raise vimconn
.vimconnConnectionException("Can't retrieve information for a VDC {}".format(self
.tenant_name
))
547 vdc_uuid
= vdc
.get('id').split(":")[3]
548 if self
.client
._session
:
549 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
550 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
551 response
= self
.perform_request(req_type
='GET',
554 if response
.status_code
!= 200:
555 self
.logger
.error("Failed to get vdc content")
556 raise vimconn
.vimconnNotFoundException("Failed to get vdc content")
558 content
= XmlElementTree
.fromstring(response
.content
)
563 if item
.tag
.split('}')[-1] == 'AvailableNetworks':
565 response
= self
.perform_request(req_type
='GET',
569 if response
.status_code
!= 200:
570 self
.logger
.error("Failed to get network content")
571 raise vimconn
.vimconnNotFoundException("Failed to get network content")
573 net_details
= XmlElementTree
.fromstring(response
.content
)
576 net_uuid
= net_details
.get('id').split(":")
577 if len(net_uuid
) != 4:
580 net_uuid
= net_uuid
[3]
582 self
.logger
.debug("get_vcd_network_list(): Adding network {} "
583 "to a list vcd id {} network {}".format(net_uuid
,
585 net_details
.get('name')))
586 filter_dict
["name"] = net_details
.get('name')
587 filter_dict
["id"] = net_uuid
588 if [i
.text
for i
in net_details
if i
.tag
.split('}')[-1] == 'IsShared'][0] == 'true':
592 filter_dict
["shared"] = shared
593 filter_dict
["tenant_id"] = vdc_uuid
594 if int(net_details
.get('status')) == 1:
595 filter_dict
["admin_state_up"] = True
597 filter_dict
["admin_state_up"] = False
598 filter_dict
["status"] = "ACTIVE"
599 filter_dict
["type"] = "bridge"
600 network_list
.append(filter_dict
)
601 self
.logger
.debug("get_vcd_network_list adding entry {}".format(filter_dict
))
603 self
.logger
.debug("Error in get_vcd_network_list", exc_info
=True)
606 self
.logger
.debug("get_vcd_network_list returning {}".format(network_list
))
609 def get_network_list(self
, filter_dict
={}):
610 """Obtain tenant networks of VIM
612 name: network name OR/AND
613 id: network uuid OR/AND
614 shared: boolean OR/AND
615 tenant_id: tenant OR/AND
616 admin_state_up: boolean
619 [{key : value , key : value}]
621 Returns the network list of dictionaries:
622 [{<the fields at Filter_dict plus some VIM specific>}, ...]
626 self
.logger
.debug("get_network_list(): retrieving network list for vcd {}".format(self
.tenant_name
))
628 if not self
.tenant_name
:
629 raise vimconn
.vimconnConnectionException("Tenant name is empty.")
631 org
, vdc
= self
.get_vdc_details()
633 raise vimconn
.vimconnConnectionException("Can't retrieve information for a VDC {}.".format(self
.tenant_name
))
636 vdcid
= vdc
.get('id').split(":")[3]
638 if self
.client
._session
:
639 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
640 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
641 response
= self
.perform_request(req_type
='GET',
644 if response
.status_code
!= 200:
645 self
.logger
.error("Failed to get vdc content")
646 raise vimconn
.vimconnNotFoundException("Failed to get vdc content")
648 content
= XmlElementTree
.fromstring(response
.content
)
652 if item
.tag
.split('}')[-1] == 'AvailableNetworks':
654 response
= self
.perform_request(req_type
='GET',
658 if response
.status_code
!= 200:
659 self
.logger
.error("Failed to get network content")
660 raise vimconn
.vimconnNotFoundException("Failed to get network content")
662 net_details
= XmlElementTree
.fromstring(response
.content
)
665 net_uuid
= net_details
.get('id').split(":")
666 if len(net_uuid
) != 4:
669 net_uuid
= net_uuid
[3]
671 self
.logger
.debug("get_network_list(): Adding net {}"
672 " to a list vcd id {} network {}".format(net_uuid
,
674 net_details
.get('name')))
675 filter_entry
["name"] = net_details
.get('name')
676 filter_entry
["id"] = net_uuid
677 if [i
.text
for i
in net_details
if i
.tag
.split('}')[-1] == 'IsShared'][0] == 'true':
681 filter_entry
["shared"] = shared
682 filter_entry
["tenant_id"] = vdcid
683 if int(net_details
.get('status')) == 1:
684 filter_entry
["admin_state_up"] = True
686 filter_entry
["admin_state_up"] = False
687 filter_entry
["status"] = "ACTIVE"
688 filter_entry
["type"] = "bridge"
689 filtered_entry
= filter_entry
.copy()
691 if filter_dict
is not None and filter_dict
:
692 # we remove all the key : value we don't care and match only
694 filtered_dict
= set(filter_entry
.keys()) - set(filter_dict
)
695 for unwanted_key
in filtered_dict
: del filter_entry
[unwanted_key
]
696 if filter_dict
== filter_entry
:
697 network_list
.append(filtered_entry
)
699 network_list
.append(filtered_entry
)
700 except Exception as e
:
701 self
.logger
.debug("Error in get_network_list",exc_info
=True)
702 if isinstance(e
, vimconn
.vimconnException
):
705 raise vimconn
.vimconnNotFoundException("Failed : Networks list not found {} ".format(e
))
707 self
.logger
.debug("Returning {}".format(network_list
))
710 def get_network(self
, net_id
):
711 """Method obtains network details of net_id VIM network
712 Return a dict with the fields at filter_dict (see get_network_list) plus some VIM specific>}, ...]"""
715 org
, vdc
= self
.get_vdc_details()
716 vdc_id
= vdc
.get('id').split(":")[3]
717 if self
.client
._session
:
718 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
719 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
720 response
= self
.perform_request(req_type
='GET',
723 if response
.status_code
!= 200:
724 self
.logger
.error("Failed to get vdc content")
725 raise vimconn
.vimconnNotFoundException("Failed to get vdc content")
727 content
= XmlElementTree
.fromstring(response
.content
)
732 if item
.tag
.split('}')[-1] == 'AvailableNetworks':
734 response
= self
.perform_request(req_type
='GET',
738 if response
.status_code
!= 200:
739 self
.logger
.error("Failed to get network content")
740 raise vimconn
.vimconnNotFoundException("Failed to get network content")
742 net_details
= XmlElementTree
.fromstring(response
.content
)
744 vdc_network_id
= net_details
.get('id').split(":")
745 if len(vdc_network_id
) == 4 and vdc_network_id
[3] == net_id
:
746 filter_dict
["name"] = net_details
.get('name')
747 filter_dict
["id"] = vdc_network_id
[3]
748 if [i
.text
for i
in net_details
if i
.tag
.split('}')[-1] == 'IsShared'][0] == 'true':
752 filter_dict
["shared"] = shared
753 filter_dict
["tenant_id"] = vdc_id
754 if int(net_details
.get('status')) == 1:
755 filter_dict
["admin_state_up"] = True
757 filter_dict
["admin_state_up"] = False
758 filter_dict
["status"] = "ACTIVE"
759 filter_dict
["type"] = "bridge"
760 self
.logger
.debug("Returning {}".format(filter_dict
))
763 raise vimconn
.vimconnNotFoundException("Network {} not found".format(net_id
))
764 except Exception as e
:
765 self
.logger
.debug("Error in get_network")
766 self
.logger
.debug(traceback
.format_exc())
767 if isinstance(e
, vimconn
.vimconnException
):
770 raise vimconn
.vimconnNotFoundException("Failed : Network not found {} ".format(e
))
774 def delete_network(self
, net_id
):
776 Method Deletes a tenant network from VIM, provide the network id.
778 Returns the network identifier or raise an exception
781 # ############# Stub code for SRIOV #################
782 # dvport_group = self.get_dvport_group(net_id)
785 # status = self.destroy_dvport_group(net_id)
787 # # Remove vlanID from persistent info
788 # if net_id in self.persistent_info["used_vlanIDs"]:
789 # del self.persistent_info["used_vlanIDs"][net_id]
793 vcd_network
= self
.get_vcd_network(network_uuid
=net_id
)
794 if vcd_network
is not None and vcd_network
:
795 if self
.delete_network_action(network_uuid
=net_id
):
798 raise vimconn
.vimconnNotFoundException("Network {} not found".format(net_id
))
800 def refresh_nets_status(self
, net_list
):
801 """Get the status of the networks
802 Params: the list of network identifiers
803 Returns a dictionary with:
804 net_id: #VIM id of this network
805 status: #Mandatory. Text with one of:
806 # DELETED (not found at vim)
807 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
808 # OTHER (Vim reported other status not understood)
809 # ERROR (VIM indicates an ERROR status)
810 # ACTIVE, INACTIVE, DOWN (admin down),
811 # BUILD (on building process)
813 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
814 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
822 vcd_network
= self
.get_vcd_network(network_uuid
=net
)
823 if vcd_network
is not None and vcd_network
:
824 if vcd_network
['status'] == '1':
830 errormsg
= 'Network not found.'
832 dict_entry
[net
] = {'status': status
, 'error_msg': errormsg
,
833 'vim_info': yaml
.safe_dump(vcd_network
)}
835 self
.logger
.debug("Error in refresh_nets_status")
836 self
.logger
.debug(traceback
.format_exc())
840 def get_flavor(self
, flavor_id
):
841 """Obtain flavor details from the VIM
842 Returns the flavor dict details {'id':<>, 'name':<>, other vim specific } #TODO to concrete
844 if flavor_id
not in vimconnector
.flavorlist
:
845 raise vimconn
.vimconnNotFoundException("Flavor not found.")
846 return vimconnector
.flavorlist
[flavor_id
]
848 def new_flavor(self
, flavor_data
):
849 """Adds a tenant flavor to VIM
850 flavor_data contains a dictionary with information, keys:
852 ram: memory (cloud type) in MBytes
853 vpcus: cpus (cloud type)
854 extended: EPA parameters
855 - numas: #items requested in same NUMA
856 memory: number of 1G huge pages memory
857 paired-threads|cores|threads: number of paired hyperthreads, complete cores OR individual threads
858 interfaces: # passthrough(PT) or SRIOV interfaces attached to this numa
859 - name: interface name
860 dedicated: yes|no|yes:sriov; for PT, SRIOV or only one SRIOV for the physical NIC
861 bandwidth: X Gbps; requested guarantee bandwidth
862 vpci: requested virtual PCI address
866 Returns the flavor identifier"""
868 # generate a new uuid put to internal dict and return it.
869 self
.logger
.debug("Creating new flavor - flavor_data: {}".format(flavor_data
))
870 new_flavor
=flavor_data
871 ram
= flavor_data
.get(FLAVOR_RAM_KEY
, 1024)
872 cpu
= flavor_data
.get(FLAVOR_VCPUS_KEY
, 1)
873 disk
= flavor_data
.get(FLAVOR_DISK_KEY
, 0)
875 if not isinstance(ram
, int):
876 raise vimconn
.vimconnException("Non-integer value for ram")
877 elif not isinstance(cpu
, int):
878 raise vimconn
.vimconnException("Non-integer value for cpu")
879 elif not isinstance(disk
, int):
880 raise vimconn
.vimconnException("Non-integer value for disk")
882 extended_flv
= flavor_data
.get("extended")
884 numas
=extended_flv
.get("numas")
887 #overwrite ram and vcpus
889 ram
= numa
['memory']*1024
890 if 'paired-threads' in numa
:
891 cpu
= numa
['paired-threads']*2
892 elif 'cores' in numa
:
894 elif 'threads' in numa
:
895 cpu
= numa
['threads']
897 new_flavor
[FLAVOR_RAM_KEY
] = ram
898 new_flavor
[FLAVOR_VCPUS_KEY
] = cpu
899 new_flavor
[FLAVOR_DISK_KEY
] = disk
900 # generate a new uuid put to internal dict and return it.
901 flavor_id
= uuid
.uuid4()
902 vimconnector
.flavorlist
[str(flavor_id
)] = new_flavor
903 self
.logger
.debug("Created flavor - {} : {}".format(flavor_id
, new_flavor
))
905 return str(flavor_id
)
907 def delete_flavor(self
, flavor_id
):
908 """Deletes a tenant flavor from VIM identify by its id
910 Returns the used id or raise an exception
912 if flavor_id
not in vimconnector
.flavorlist
:
913 raise vimconn
.vimconnNotFoundException("Flavor not found.")
915 vimconnector
.flavorlist
.pop(flavor_id
, None)
918 def new_image(self
, image_dict
):
920 Adds a tenant image to VIM
922 200, image-id if the image is created
923 <0, message if there is an error
926 return self
.get_image_id_from_path(image_dict
['location'])
928 def delete_image(self
, image_id
):
930 Deletes a tenant image from VIM
932 image_id is ID of Image to be deleted
934 returns the image identifier in UUID format or raises an exception on error
936 conn
= self
.connect_as_admin()
938 raise vimconn
.vimconnConnectionException("Failed to connect vCD")
939 # Get Catalog details
940 url_list
= [self
.url
, '/api/catalog/', image_id
]
941 catalog_herf
= ''.join(url_list
)
943 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
944 'x-vcloud-authorization': conn
._session
.headers
['x-vcloud-authorization']}
946 response
= self
.perform_request(req_type
='GET',
950 if response
.status_code
!= requests
.codes
.ok
:
951 self
.logger
.debug("delete_image():GET REST API call {} failed. "\
952 "Return status code {}".format(catalog_herf
,
953 response
.status_code
))
954 raise vimconn
.vimconnNotFoundException("Fail to get image {}".format(image_id
))
956 lxmlroot_respond
= lxmlElementTree
.fromstring(response
.content
)
957 namespaces
= {prefix
:uri
for prefix
,uri
in lxmlroot_respond
.nsmap
.iteritems() if prefix
}
959 #namespaces = {prefix:uri for prefix,uri in lxmlroot_respond.nsmap.items() if prefix}
960 namespaces
["xmlns"]= "http://www.vmware.com/vcloud/v1.5"
962 catalogItems_section
= lxmlroot_respond
.find("xmlns:CatalogItems",namespaces
)
963 catalogItems
= catalogItems_section
.iterfind("xmlns:CatalogItem",namespaces
)
964 for catalogItem
in catalogItems
:
965 catalogItem_href
= catalogItem
.attrib
['href']
967 response
= self
.perform_request(req_type
='GET',
968 url
=catalogItem_href
,
971 if response
.status_code
!= requests
.codes
.ok
:
972 self
.logger
.debug("delete_image():GET REST API call {} failed. "\
973 "Return status code {}".format(catalog_herf
,
974 response
.status_code
))
975 raise vimconn
.vimconnNotFoundException("Fail to get catalogItem {} for catalog {}".format(
979 lxmlroot_respond
= lxmlElementTree
.fromstring(response
.content
)
980 namespaces
= {prefix
:uri
for prefix
,uri
in lxmlroot_respond
.nsmap
.iteritems() if prefix
}
982 #namespaces = {prefix:uri for prefix,uri in lxmlroot_respond.nsmap.items() if prefix}
983 namespaces
["xmlns"]= "http://www.vmware.com/vcloud/v1.5"
984 catalogitem_remove_href
= lxmlroot_respond
.find("xmlns:Link[@rel='remove']",namespaces
).attrib
['href']
987 response
= self
.perform_request(req_type
='DELETE',
988 url
=catalogitem_remove_href
,
990 if response
.status_code
== requests
.codes
.no_content
:
991 self
.logger
.debug("Deleted Catalog item {}".format(catalogItem
))
993 raise vimconn
.vimconnException("Fail to delete Catalog Item {}".format(catalogItem
))
996 url_list
= [self
.url
, '/api/admin/catalog/', image_id
]
997 catalog_remove_herf
= ''.join(url_list
)
998 response
= self
.perform_request(req_type
='DELETE',
999 url
=catalog_remove_herf
,
1002 if response
.status_code
== requests
.codes
.no_content
:
1003 self
.logger
.debug("Deleted Catalog {}".format(image_id
))
1006 raise vimconn
.vimconnException("Fail to delete Catalog {}".format(image_id
))
1009 def catalog_exists(self
, catalog_name
, catalogs
):
1012 :param catalog_name:
1016 for catalog
in catalogs
:
1017 if catalog
['name'] == catalog_name
:
1021 def create_vimcatalog(self
, vca
=None, catalog_name
=None):
1022 """ Create new catalog entry in vCloud director.
1025 vca: vCloud director.
1026 catalog_name catalog that client wish to create. Note no validation done for a name.
1027 Client must make sure that provide valid string representation.
1029 Return (bool) True if catalog created.
1033 result
= vca
.create_catalog(catalog_name
, catalog_name
)
1034 if result
is not None:
1036 catalogs
= vca
.list_catalogs()
1039 return self
.catalog_exists(catalog_name
, catalogs
)
1041 # noinspection PyIncorrectDocstring
1042 def upload_ovf(self
, vca
=None, catalog_name
=None, image_name
=None, media_file_name
=None,
1043 description
='', progress
=False, chunk_bytes
=128 * 1024):
1045 Uploads a OVF file to a vCloud catalog
1052 :param catalog_name: (str): The name of the catalog to upload the media.
1053 :param media_file_name: (str): The name of the local media file to upload.
1054 :return: (bool) True if the media file was successfully uploaded, false otherwise.
1056 os
.path
.isfile(media_file_name
)
1057 statinfo
= os
.stat(media_file_name
)
1059 # find a catalog entry where we upload OVF.
1060 # create vApp Template and check the status if vCD able to read OVF it will respond with appropirate
1062 # if VCD can parse OVF we upload VMDK file
1064 for catalog
in vca
.list_catalogs():
1065 if catalog_name
!= catalog
['name']:
1067 catalog_href
= "{}/api/catalog/{}/action/upload".format(self
.url
, catalog
['id'])
1069 <UploadVAppTemplateParams name="{}" xmlns="http://www.vmware.com/vcloud/v1.5" xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"><Description>{} vApp Template</Description></UploadVAppTemplateParams>
1070 """.format(catalog_name
, description
)
1073 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
1074 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
1075 headers
['Content-Type'] = 'application/vnd.vmware.vcloud.uploadVAppTemplateParams+xml'
1077 response
= self
.perform_request(req_type
='POST',
1082 if response
.status_code
== requests
.codes
.created
:
1083 catalogItem
= XmlElementTree
.fromstring(response
.content
)
1084 entity
= [child
for child
in catalogItem
if
1085 child
.get("type") == "application/vnd.vmware.vcloud.vAppTemplate+xml"][0]
1086 href
= entity
.get('href')
1089 response
= self
.perform_request(req_type
='GET',
1093 if response
.status_code
== requests
.codes
.ok
:
1094 headers
['Content-Type'] = 'Content-Type text/xml'
1095 result
= re
.search('rel="upload:default"\shref="(.*?\/descriptor.ovf)"',response
.content
)
1097 transfer_href
= result
.group(1)
1099 response
= self
.perform_request(req_type
='PUT',
1102 data
=open(media_file_name
, 'rb'))
1103 if response
.status_code
!= requests
.codes
.ok
:
1105 "Failed create vApp template for catalog name {} and image {}".format(catalog_name
,
1109 # TODO fix this with aync block
1112 self
.logger
.debug("vApp template for catalog name {} and image {}".format(catalog_name
, media_file_name
))
1114 # uploading VMDK file
1115 # check status of OVF upload and upload remaining files.
1116 response
= self
.perform_request(req_type
='GET',
1120 if response
.status_code
== requests
.codes
.ok
:
1121 result
= re
.search('rel="upload:default"\s*href="(.*?vmdk)"',response
.content
)
1123 link_href
= result
.group(1)
1124 # we skip ovf since it already uploaded.
1125 if 'ovf' in link_href
:
1127 # The OVF file and VMDK must be in a same directory
1128 head
, tail
= os
.path
.split(media_file_name
)
1129 file_vmdk
= head
+ '/' + link_href
.split("/")[-1]
1130 if not os
.path
.isfile(file_vmdk
):
1132 statinfo
= os
.stat(file_vmdk
)
1133 if statinfo
.st_size
== 0:
1135 hrefvmdk
= link_href
1138 widgets
= ['Uploading file: ', Percentage(), ' ', Bar(), ' ', ETA(), ' ',
1139 FileTransferSpeed()]
1140 progress_bar
= ProgressBar(widgets
=widgets
, maxval
=statinfo
.st_size
).start()
1142 bytes_transferred
= 0
1143 f
= open(file_vmdk
, 'rb')
1144 while bytes_transferred
< statinfo
.st_size
:
1145 my_bytes
= f
.read(chunk_bytes
)
1146 if len(my_bytes
) <= chunk_bytes
:
1147 headers
['Content-Range'] = 'bytes %s-%s/%s' % (
1148 bytes_transferred
, len(my_bytes
) - 1, statinfo
.st_size
)
1149 headers
['Content-Length'] = str(len(my_bytes
))
1150 response
= requests
.put(url
=hrefvmdk
,
1154 if response
.status_code
== requests
.codes
.ok
:
1155 bytes_transferred
+= len(my_bytes
)
1157 progress_bar
.update(bytes_transferred
)
1160 'file upload failed with error: [%s] %s' % (response
.status_code
,
1167 progress_bar
.finish()
1171 self
.logger
.debug("Failed retrieve vApp template for catalog name {} for OVF {}".
1172 format(catalog_name
, media_file_name
))
1174 except Exception as exp
:
1175 self
.logger
.debug("Failed while uploading OVF to catalog {} for OVF file {} with Exception {}"
1176 .format(catalog_name
,media_file_name
, exp
))
1177 raise vimconn
.vimconnException(
1178 "Failed while uploading OVF to catalog {} for OVF file {} with Exception {}"
1179 .format(catalog_name
,media_file_name
, exp
))
1181 self
.logger
.debug("Failed retrieve catalog name {} for OVF file {}".format(catalog_name
, media_file_name
))
1184 def upload_vimimage(self
, vca
=None, catalog_name
=None, media_name
=None, medial_file_name
=None, progress
=False):
1185 """Upload media file"""
1186 # TODO add named parameters for readability
1188 return self
.upload_ovf(vca
=vca
, catalog_name
=catalog_name
, image_name
=media_name
.split(".")[0],
1189 media_file_name
=medial_file_name
, description
='medial_file_name', progress
=progress
)
1191 def validate_uuid4(self
, uuid_string
=None):
1192 """ Method validate correct format of UUID.
1194 Return: true if string represent valid uuid
1197 val
= uuid
.UUID(uuid_string
, version
=4)
1202 def get_catalogid(self
, catalog_name
=None, catalogs
=None):
1203 """ Method check catalog and return catalog ID in UUID format.
1206 catalog_name: catalog name as string
1207 catalogs: list of catalogs.
1209 Return: catalogs uuid
1212 for catalog
in catalogs
:
1213 if catalog
['name'] == catalog_name
:
1214 catalog_id
= catalog
['id']
1218 def get_catalogbyid(self
, catalog_uuid
=None, catalogs
=None):
1219 """ Method check catalog and return catalog name lookup done by catalog UUID.
1222 catalog_name: catalog name as string
1223 catalogs: list of catalogs.
1225 Return: catalogs name or None
1228 if not self
.validate_uuid4(uuid_string
=catalog_uuid
):
1231 for catalog
in catalogs
:
1232 catalog_id
= catalog
.get('id')
1233 if catalog_id
== catalog_uuid
:
1234 return catalog
.get('name')
1237 def get_catalog_obj(self
, catalog_uuid
=None, catalogs
=None):
1238 """ Method check catalog and return catalog name lookup done by catalog UUID.
1241 catalog_name: catalog name as string
1242 catalogs: list of catalogs.
1244 Return: catalogs name or None
1247 if not self
.validate_uuid4(uuid_string
=catalog_uuid
):
1250 for catalog
in catalogs
:
1251 catalog_id
= catalog
.get('id')
1252 if catalog_id
== catalog_uuid
:
1256 def get_image_id_from_path(self
, path
=None, progress
=False):
1257 """ Method upload OVF image to vCloud director.
1259 Each OVF image represented as single catalog entry in vcloud director.
1260 The method check for existing catalog entry. The check done by file name without file extension.
1262 if given catalog name already present method will respond with existing catalog uuid otherwise
1263 it will create new catalog entry and upload OVF file to newly created catalog.
1265 If method can't create catalog entry or upload a file it will throw exception.
1267 Method accept boolean flag progress that will output progress bar. It useful method
1268 for standalone upload use case. In case to test large file upload.
1271 path: - valid path to OVF file.
1272 progress - boolean progress bar show progress bar.
1274 Return: if image uploaded correct method will provide image catalog UUID.
1278 raise vimconn
.vimconnException("Image path can't be None.")
1280 if not os
.path
.isfile(path
):
1281 raise vimconn
.vimconnException("Can't read file. File not found.")
1283 if not os
.access(path
, os
.R_OK
):
1284 raise vimconn
.vimconnException("Can't read file. Check file permission to read.")
1286 self
.logger
.debug("get_image_id_from_path() client requesting {} ".format(path
))
1288 dirpath
, filename
= os
.path
.split(path
)
1289 flname
, file_extension
= os
.path
.splitext(path
)
1290 if file_extension
!= '.ovf':
1291 self
.logger
.debug("Wrong file extension {} connector support only OVF container.".format(file_extension
))
1292 raise vimconn
.vimconnException("Wrong container. vCloud director supports only OVF.")
1294 catalog_name
= os
.path
.splitext(filename
)[0]
1295 catalog_md5_name
= hashlib
.md5(path
).hexdigest()
1296 self
.logger
.debug("File name {} Catalog Name {} file path {} "
1297 "vdc catalog name {}".format(filename
, catalog_name
, path
, catalog_md5_name
))
1300 org
,vdc
= self
.get_vdc_details()
1301 catalogs
= org
.list_catalogs()
1302 except Exception as exp
:
1303 self
.logger
.debug("Failed get catalogs() with Exception {} ".format(exp
))
1304 raise vimconn
.vimconnException("Failed get catalogs() with Exception {} ".format(exp
))
1306 if len(catalogs
) == 0:
1307 self
.logger
.info("Creating a new catalog entry {} in vcloud director".format(catalog_name
))
1308 result
= self
.create_vimcatalog(org
, catalog_md5_name
)
1310 raise vimconn
.vimconnException("Failed create new catalog {} ".format(catalog_md5_name
))
1312 result
= self
.upload_vimimage(vca
=org
, catalog_name
=catalog_md5_name
,
1313 media_name
=filename
, medial_file_name
=path
, progress
=progress
)
1315 raise vimconn
.vimconnException("Failed create vApp template for catalog {} ".format(catalog_name
))
1316 return self
.get_catalogid(catalog_name
, catalogs
)
1318 for catalog
in catalogs
:
1319 # search for existing catalog if we find same name we return ID
1320 # TODO optimize this
1321 if catalog
['name'] == catalog_md5_name
:
1322 self
.logger
.debug("Found existing catalog entry for {} "
1323 "catalog id {}".format(catalog_name
,
1324 self
.get_catalogid(catalog_md5_name
, catalogs
)))
1325 return self
.get_catalogid(catalog_md5_name
, catalogs
)
1327 # if we didn't find existing catalog we create a new one and upload image.
1328 self
.logger
.debug("Creating new catalog entry {} - {}".format(catalog_name
, catalog_md5_name
))
1329 result
= self
.create_vimcatalog(org
, catalog_md5_name
)
1331 raise vimconn
.vimconnException("Failed create new catalog {} ".format(catalog_md5_name
))
1333 result
= self
.upload_vimimage(vca
=org
, catalog_name
=catalog_md5_name
,
1334 media_name
=filename
, medial_file_name
=path
, progress
=progress
)
1336 raise vimconn
.vimconnException("Failed create vApp template for catalog {} ".format(catalog_md5_name
))
1338 return self
.get_catalogid(catalog_md5_name
, org
.list_catalogs())
1340 def get_image_list(self
, filter_dict
={}):
1341 '''Obtain tenant images from VIM
1345 checksum: image checksum
1346 location: image path
1347 Returns the image list of dictionaries:
1348 [{<the fields at Filter_dict plus some VIM specific>}, ...]
1353 org
, vdc
= self
.get_vdc_details()
1355 catalogs
= org
.list_catalogs()
1356 if len(catalogs
) == 0:
1359 for catalog
in catalogs
:
1360 catalog_uuid
= catalog
.get('id')
1361 name
= catalog
.get('name')
1363 if filter_dict
.get("name") and filter_dict
["name"] != name
:
1365 if filter_dict
.get("id") and filter_dict
["id"] != catalog_uuid
:
1367 filtered_dict
["name"] = name
1368 filtered_dict
["id"] = catalog_uuid
1369 image_list
.append(filtered_dict
)
1371 self
.logger
.debug("List of already created catalog items: {}".format(image_list
))
1373 except Exception as exp
:
1374 raise vimconn
.vimconnException("Exception occured while retriving catalog items {}".format(exp
))
1376 def get_vappid(self
, vdc
=None, vapp_name
=None):
1377 """ Method takes vdc object and vApp name and returns vapp uuid or None
1380 vdc: The VDC object.
1381 vapp_name: is application vappp name identifier
1384 The return vApp name otherwise None
1386 if vdc
is None or vapp_name
is None:
1388 # UUID has following format https://host/api/vApp/vapp-30da58a3-e7c7-4d09-8f68-d4c8201169cf
1390 refs
= filter(lambda ref
: ref
.name
== vapp_name
and ref
.type_
== 'application/vnd.vmware.vcloud.vApp+xml',
1391 vdc
.ResourceEntities
.ResourceEntity
)
1393 #refs = [ref for ref in vdc.ResourceEntities.ResourceEntity\
1394 # if ref.name == vapp_name and ref.type_ == 'application/vnd.vmware.vcloud.vApp+xml']
1396 return refs
[0].href
.split("vapp")[1][1:]
1397 except Exception as e
:
1398 self
.logger
.exception(e
)
1402 def check_vapp(self
, vdc
=None, vapp_uuid
=None):
1403 """ Method Method returns True or False if vapp deployed in vCloud director
1406 vca: Connector to VCA
1407 vdc: The VDC object.
1408 vappid: vappid is application identifier
1411 The return True if vApp deployed
1416 refs
= filter(lambda ref
:
1417 ref
.type_
== 'application/vnd.vmware.vcloud.vApp+xml',
1418 vdc
.ResourceEntities
.ResourceEntity
)
1420 #refs = [ref for ref in vdc.ResourceEntities.ResourceEntity\
1421 # if ref.type_ == 'application/vnd.vmware.vcloud.vApp+xml']
1423 vappid
= ref
.href
.split("vapp")[1][1:]
1424 # find vapp with respected vapp uuid
1425 if vappid
== vapp_uuid
:
1427 except Exception as e
:
1428 self
.logger
.exception(e
)
1432 def get_namebyvappid(self
, vapp_uuid
=None):
1433 """Method returns vApp name from vCD and lookup done by vapp_id.
1436 vapp_uuid: vappid is application identifier
1439 The return vApp name otherwise None
1442 if self
.client
and vapp_uuid
:
1443 vapp_call
= "{}/api/vApp/vapp-{}".format(self
.url
, vapp_uuid
)
1444 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
1445 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
1447 response
= self
.perform_request(req_type
='GET',
1450 #Retry login if session expired & retry sending request
1451 if response
.status_code
== 403:
1452 response
= self
.retry_rest('GET', vapp_call
)
1454 tree
= XmlElementTree
.fromstring(response
.content
)
1455 return tree
.attrib
['name']
1456 except Exception as e
:
1457 self
.logger
.exception(e
)
1461 def new_vminstance(self
, name
=None, description
="", start
=False, image_id
=None, flavor_id
=None, net_list
=[],
1462 cloud_config
=None, disk_list
=None, availability_zone_index
=None, availability_zone_list
=None):
1463 """Adds a VM instance to VIM
1465 'start': (boolean) indicates if VM must start or created in pause mode.
1466 'image_id','flavor_id': image and flavor VIM id to use for the VM
1467 'net_list': list of interfaces, each one is a dictionary with:
1468 'name': (optional) name for the interface.
1469 'net_id': VIM network id where this interface must be connect to. Mandatory for type==virtual
1470 'vpci': (optional) virtual vPCI address to assign at the VM. Can be ignored depending on VIM capabilities
1471 'model': (optional and only have sense for type==virtual) interface model: virtio, e2000, ...
1472 'mac_address': (optional) mac address to assign to this interface
1473 #TODO: CHECK if an optional 'vlan' parameter is needed for VIMs when type if VF and net_id is not provided,
1474 the VLAN tag to be used. In case net_id is provided, the internal network vlan is used for tagging VF
1475 'type': (mandatory) can be one of:
1476 'virtual', in this case always connected to a network of type 'net_type=bridge'
1477 'PCI-PASSTHROUGH' or 'PF' (passthrough): depending on VIM capabilities it can be connected to a data/ptp network ot it
1478 can created unconnected
1479 'SR-IOV' or 'VF' (SRIOV with VLAN tag): same as PF for network connectivity.
1480 'VFnotShared'(SRIOV without VLAN tag) same as PF for network connectivity. VF where no other VFs
1481 are allocated on the same physical NIC
1482 'bw': (optional) only for PF/VF/VFnotShared. Minimal Bandwidth required for the interface in GBPS
1483 'port_security': (optional) If False it must avoid any traffic filtering at this interface. If missing
1484 or True, it must apply the default VIM behaviour
1485 After execution the method will add the key:
1486 'vim_id': must be filled/added by this method with the VIM identifier generated by the VIM for this
1487 interface. 'net_list' is modified
1488 'cloud_config': (optional) dictionary with:
1489 'key-pairs': (optional) list of strings with the public key to be inserted to the default user
1490 'users': (optional) list of users to be inserted, each item is a dict with:
1491 'name': (mandatory) user name,
1492 'key-pairs': (optional) list of strings with the public key to be inserted to the user
1493 'user-data': (optional) can be a string with the text script to be passed directly to cloud-init,
1494 or a list of strings, each one contains a script to be passed, usually with a MIMEmultipart file
1495 'config-files': (optional). List of files to be transferred. Each item is a dict with:
1496 'dest': (mandatory) string with the destination absolute path
1497 'encoding': (optional, by default text). Can be one of:
1498 'b64', 'base64', 'gz', 'gz+b64', 'gz+base64', 'gzip+b64', 'gzip+base64'
1499 'content' (mandatory): string with the content of the file
1500 'permissions': (optional) string with file permissions, typically octal notation '0644'
1501 'owner': (optional) file owner, string with the format 'owner:group'
1502 'boot-data-drive': boolean to indicate if user-data must be passed using a boot drive (hard disk)
1503 'disk_list': (optional) list with additional disks to the VM. Each item is a dict with:
1504 'image_id': (optional). VIM id of an existing image. If not provided an empty disk must be mounted
1505 'size': (mandatory) string with the size of the disk in GB
1506 availability_zone_index: Index of availability_zone_list to use for this this VM. None if not AV required
1507 availability_zone_list: list of availability zones given by user in the VNFD descriptor. Ignore if
1508 availability_zone_index is None
1509 Returns a tuple with the instance identifier and created_items or raises an exception on error
1510 created_items can be None or a dictionary where this method can include key-values that will be passed to
1511 the method delete_vminstance and action_vminstance. Can be used to store created ports, volumes, etc.
1512 Format is vimconnector dependent, but do not use nested dictionaries and a value of None should be the same
1515 self
.logger
.info("Creating new instance for entry {}".format(name
))
1516 self
.logger
.debug("desc {} boot {} image_id: {} flavor_id: {} net_list: {} cloud_config {} disk_list {} "\
1517 "availability_zone_index {} availability_zone_list {}"\
1518 .format(description
, start
, image_id
, flavor_id
, net_list
, cloud_config
, disk_list
,\
1519 availability_zone_index
, availability_zone_list
))
1521 #new vm name = vmname + tenant_id + uuid
1522 new_vm_name
= [name
, '-', str(uuid
.uuid4())]
1523 vmname_andid
= ''.join(new_vm_name
)
1525 for net
in net_list
:
1526 if net
['type'] == "SR-IOV" or net
['type'] == "PCI-PASSTHROUGH":
1527 raise vimconn
.vimconnNotSupportedException(
1528 "Current vCD version does not support type : {}".format(net
['type']))
1530 if len(net_list
) > 10:
1531 raise vimconn
.vimconnNotSupportedException(
1532 "The VM hardware versions 7 and above support upto 10 NICs only")
1534 # if vm already deployed we return existing uuid
1535 # we check for presence of VDC, Catalog entry and Flavor.
1536 org
, vdc
= self
.get_vdc_details()
1538 raise vimconn
.vimconnNotFoundException(
1539 "new_vminstance(): Failed create vApp {}: (Failed retrieve VDC information)".format(name
))
1540 catalogs
= org
.list_catalogs()
1541 if catalogs
is None:
1542 #Retry once, if failed by refreshing token
1544 org
= Org(self
.client
, resource
=self
.client
.get_org())
1545 catalogs
= org
.list_catalogs()
1546 if catalogs
is None:
1547 raise vimconn
.vimconnNotFoundException(
1548 "new_vminstance(): Failed create vApp {}: (Failed retrieve catalogs list)".format(name
))
1550 catalog_hash_name
= self
.get_catalogbyid(catalog_uuid
=image_id
, catalogs
=catalogs
)
1551 if catalog_hash_name
:
1552 self
.logger
.info("Found catalog entry {} for image id {}".format(catalog_hash_name
, image_id
))
1554 raise vimconn
.vimconnNotFoundException("new_vminstance(): Failed create vApp {}: "
1555 "(Failed retrieve catalog information {})".format(name
, image_id
))
1558 # Set vCPU and Memory based on flavor.
1564 if flavor_id
is not None:
1565 if flavor_id
not in vimconnector
.flavorlist
:
1566 raise vimconn
.vimconnNotFoundException("new_vminstance(): Failed create vApp {}: "
1567 "Failed retrieve flavor information "
1568 "flavor id {}".format(name
, flavor_id
))
1571 flavor
= vimconnector
.flavorlist
[flavor_id
]
1572 vm_cpus
= flavor
[FLAVOR_VCPUS_KEY
]
1573 vm_memory
= flavor
[FLAVOR_RAM_KEY
]
1574 vm_disk
= flavor
[FLAVOR_DISK_KEY
]
1575 extended
= flavor
.get("extended", None)
1577 numas
=extended
.get("numas", None)
1579 except Exception as exp
:
1580 raise vimconn
.vimconnException("Corrupted flavor. {}.Exception: {}".format(flavor_id
, exp
))
1582 # image upload creates template name as catalog name space Template.
1583 templateName
= self
.get_catalogbyid(catalog_uuid
=image_id
, catalogs
=catalogs
)
1588 # client must provide at least one entry in net_list if not we report error
1589 #If net type is mgmt, then configure it as primary net & use its NIC index as primary NIC
1590 #If no mgmt, then the 1st NN in netlist is considered as primary net.
1592 primary_netname
= None
1593 primary_net_href
= None
1594 network_mode
= 'bridged'
1595 if net_list
is not None and len(net_list
) > 0:
1596 for net
in net_list
:
1597 if 'use' in net
and net
['use'] == 'mgmt' and not primary_net
:
1599 if primary_net
is None:
1600 primary_net
= net_list
[0]
1603 primary_net_id
= primary_net
['net_id']
1604 url_list
= [self
.url
, '/api/network/', primary_net_id
]
1605 primary_net_href
= ''.join(url_list
)
1606 network_dict
= self
.get_vcd_network(network_uuid
=primary_net_id
)
1607 if 'name' in network_dict
:
1608 primary_netname
= network_dict
['name']
1611 raise vimconn
.vimconnException("Corrupted flavor. {}".format(primary_net
))
1613 raise vimconn
.vimconnUnexpectedResponse("new_vminstance(): Failed network list is empty.".format(name
))
1615 # use: 'data', 'bridge', 'mgmt'
1616 # create vApp. Set vcpu and ram based on flavor id.
1618 vdc_obj
= VDC(self
.client
, resource
=org
.get_vdc(self
.tenant_name
))
1620 raise vimconn
.vimconnNotFoundException("new_vminstance(): Failed to get VDC object")
1623 items
= org
.get_catalog_item(catalog_hash_name
, catalog_hash_name
)
1624 catalog_items
= [items
.attrib
]
1626 if len(catalog_items
) == 1:
1628 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
1629 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
1631 response
= self
.perform_request(req_type
='GET',
1632 url
=catalog_items
[0].get('href'),
1634 catalogItem
= XmlElementTree
.fromstring(response
.content
)
1635 entity
= [child
for child
in catalogItem
if child
.get("type") == "application/vnd.vmware.vcloud.vAppTemplate+xml"][0]
1636 vapp_tempalte_href
= entity
.get("href")
1638 response
= self
.perform_request(req_type
='GET',
1639 url
=vapp_tempalte_href
,
1641 if response
.status_code
!= requests
.codes
.ok
:
1642 self
.logger
.debug("REST API call {} failed. Return status code {}".format(vapp_tempalte_href
,
1643 response
.status_code
))
1645 result
= (response
.content
).replace("\n"," ")
1647 src
= re
.search('<Vm goldMaster="false"\sstatus="\d+"\sname="(.*?)"\s'
1648 'id="(\w+:\w+:vm:.*?)"\shref="(.*?)"\s'
1649 'type="application/vnd\.vmware\.vcloud\.vm\+xml',result
)
1651 vm_name
= src
.group(1)
1652 vm_id
= src
.group(2)
1653 vm_href
= src
.group(3)
1655 cpus
= re
.search('<rasd:Description>Number of Virtual CPUs</.*?>(\d+)</rasd:VirtualQuantity>',result
).group(1)
1656 memory_mb
= re
.search('<rasd:Description>Memory Size</.*?>(\d+)</rasd:VirtualQuantity>',result
).group(1)
1657 cores
= re
.search('<vmw:CoresPerSocket ovf:required.*?>(\d+)</vmw:CoresPerSocket>',result
).group(1)
1659 headers
['Content-Type'] = 'application/vnd.vmware.vcloud.instantiateVAppTemplateParams+xml'
1660 vdc_id
= vdc
.get('id').split(':')[-1]
1661 instantiate_vapp_href
= "{}/api/vdc/{}/action/instantiateVAppTemplate".format(self
.url
,
1663 data
= """<?xml version="1.0" encoding="UTF-8"?>
1664 <InstantiateVAppTemplateParams
1665 xmlns="http://www.vmware.com/vcloud/v1.5"
1669 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
1670 xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1">
1671 <Description>Vapp instantiation</Description>
1672 <InstantiationParams>
1673 <NetworkConfigSection>
1674 <ovf:Info>Configuration parameters for logical networks</ovf:Info>
1675 <NetworkConfig networkName="{}">
1677 <ParentNetwork href="{}" />
1678 <FenceMode>bridged</FenceMode>
1681 </NetworkConfigSection>
1682 <LeaseSettingsSection
1683 type="application/vnd.vmware.vcloud.leaseSettingsSection+xml">
1684 <ovf:Info>Lease Settings</ovf:Info>
1685 <StorageLeaseInSeconds>172800</StorageLeaseInSeconds>
1686 <StorageLeaseExpiration>2014-04-25T08:08:16.438-07:00</StorageLeaseExpiration>
1687 </LeaseSettingsSection>
1688 </InstantiationParams>
1691 <Source href="{}" id="{}" name="{}"
1692 type="application/vnd.vmware.vcloud.vm+xml"/>
1694 <NeedsCustomization>false</NeedsCustomization>
1696 <InstantiationParams>
1697 <NetworkConnectionSection>
1698 <ovf:Info>Specifies the available VM network connections</ovf:Info>
1699 <NetworkConnection network="{}">
1700 <NetworkConnectionIndex>0</NetworkConnectionIndex>
1701 <IsConnected>true</IsConnected>
1702 <IpAddressAllocationMode>DHCP</IpAddressAllocationMode>
1703 </NetworkConnection>
1704 </NetworkConnectionSection><ovf:VirtualHardwareSection>
1705 <ovf:Info>Virtual hardware requirements</ovf:Info>
1706 <ovf:Item xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData"
1707 xmlns:vmw="http://www.vmware.com/schema/ovf">
1708 <rasd:AllocationUnits>hertz * 10^6</rasd:AllocationUnits>
1709 <rasd:Description>Number of Virtual CPUs</rasd:Description>
1710 <rasd:ElementName xmlns:py="http://codespeak.net/lxml/objectify/pytype" py:pytype="str">{cpu} virtual CPU(s)</rasd:ElementName>
1711 <rasd:InstanceID>4</rasd:InstanceID>
1712 <rasd:Reservation>0</rasd:Reservation>
1713 <rasd:ResourceType>3</rasd:ResourceType>
1714 <rasd:VirtualQuantity xmlns:py="http://codespeak.net/lxml/objectify/pytype" py:pytype="int">{cpu}</rasd:VirtualQuantity>
1715 <rasd:Weight>0</rasd:Weight>
1716 <vmw:CoresPerSocket ovf:required="false">{core}</vmw:CoresPerSocket>
1717 </ovf:Item><ovf:Item xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData">
1718 <rasd:AllocationUnits>byte * 2^20</rasd:AllocationUnits>
1719 <rasd:Description>Memory Size</rasd:Description>
1720 <rasd:ElementName xmlns:py="http://codespeak.net/lxml/objectify/pytype" py:pytype="str">{memory} MB of memory</rasd:ElementName>
1721 <rasd:InstanceID>5</rasd:InstanceID>
1722 <rasd:Reservation>0</rasd:Reservation>
1723 <rasd:ResourceType>4</rasd:ResourceType>
1724 <rasd:VirtualQuantity xmlns:py="http://codespeak.net/lxml/objectify/pytype" py:pytype="int">{memory}</rasd:VirtualQuantity>
1725 <rasd:Weight>0</rasd:Weight>
1727 </ovf:VirtualHardwareSection>
1728 </InstantiationParams>
1730 <AllEULAsAccepted>false</AllEULAsAccepted>
1731 </InstantiateVAppTemplateParams>""".format(vmname_andid
,
1743 response
= self
.perform_request(req_type
='POST',
1744 url
=instantiate_vapp_href
,
1748 if response
.status_code
!= 201:
1749 self
.logger
.error("REST call {} failed reason : {}"\
1750 "status code : {}".format(instantiate_vapp_href
,
1752 response
.status_code
))
1753 raise vimconn
.vimconnException("new_vminstance(): Failed to create"\
1754 "vAapp {}".format(vmname_andid
))
1756 vapptask
= self
.get_task_from_response(response
.content
)
1758 if vapptask
is None and retry
==1:
1759 self
.get_token() # Retry getting token
1764 if vapptask
is None or vapptask
is False:
1765 raise vimconn
.vimconnUnexpectedResponse(
1766 "new_vminstance(): failed to create vApp {}".format(vmname_andid
))
1768 # wait for task to complete
1769 result
= self
.client
.get_task_monitor().wait_for_success(task
=vapptask
)
1771 if result
.get('status') == 'success':
1772 self
.logger
.debug("new_vminstance(): Sucessfully created Vapp {}".format(vmname_andid
))
1774 raise vimconn
.vimconnUnexpectedResponse(
1775 "new_vminstance(): failed to create vApp {}".format(vmname_andid
))
1777 except Exception as exp
:
1778 raise vimconn
.vimconnUnexpectedResponse(
1779 "new_vminstance(): failed to create vApp {} with Exception:{}".format(vmname_andid
, exp
))
1781 # we should have now vapp in undeployed state.
1783 vdc_obj
= VDC(self
.client
, href
=vdc
.get('href'))
1784 vapp_resource
= vdc_obj
.get_vapp(vmname_andid
)
1785 vapp_uuid
= vapp_resource
.get('id').split(':')[-1]
1786 vapp
= VApp(self
.client
, resource
=vapp_resource
)
1788 except Exception as exp
:
1789 raise vimconn
.vimconnUnexpectedResponse(
1790 "new_vminstance(): Failed to retrieve vApp {} after creation: Exception:{}"
1791 .format(vmname_andid
, exp
))
1793 if vapp_uuid
is None:
1794 raise vimconn
.vimconnUnexpectedResponse(
1795 "new_vminstance(): Failed to retrieve vApp {} after creation".format(
1798 #Add PCI passthrough/SRIOV configrations
1800 pci_devices_info
= []
1802 reserve_memory
= False
1804 for net
in net_list
:
1805 if net
["type"] == "PF" or net
["type"] == "PCI-PASSTHROUGH":
1806 pci_devices_info
.append(net
)
1807 elif (net
["type"] == "VF" or net
["type"] == "SR-IOV" or net
["type"] == "VFnotShared") and 'net_id'in net
:
1808 sriov_net_info
.append(net
)
1811 if len(pci_devices_info
) > 0:
1812 self
.logger
.info("Need to add PCI devices {} into VM {}".format(pci_devices_info
,
1814 PCI_devices_status
, vm_obj
, vcenter_conect
= self
.add_pci_devices(vapp_uuid
,
1817 if PCI_devices_status
:
1818 self
.logger
.info("Added PCI devives {} to VM {}".format(
1822 reserve_memory
= True
1824 self
.logger
.info("Fail to add PCI devives {} to VM {}".format(
1831 #Assuming there is only one disk in ovf and fast provisioning in organization vDC is disabled
1832 result
= self
.modify_vm_disk(vapp_uuid
, vm_disk
)
1834 self
.logger
.debug("Modified Disk size of VM {} ".format(vmname_andid
))
1836 #Add new or existing disks to vApp
1838 added_existing_disk
= False
1839 for disk
in disk_list
:
1840 if 'device_type' in disk
and disk
['device_type'] == 'cdrom':
1841 image_id
= disk
['image_id']
1842 # Adding CD-ROM to VM
1843 # will revisit code once specification ready to support this feature
1844 self
.insert_media_to_vm(vapp
, image_id
)
1845 elif "image_id" in disk
and disk
["image_id"] is not None:
1846 self
.logger
.debug("Adding existing disk from image {} to vm {} ".format(
1847 disk
["image_id"] , vapp_uuid
))
1848 self
.add_existing_disk(catalogs
=catalogs
,
1849 image_id
=disk
["image_id"],
1850 size
= disk
["size"],
1851 template_name
=templateName
,
1854 added_existing_disk
= True
1856 #Wait till added existing disk gets reflected into vCD database/API
1857 if added_existing_disk
:
1859 added_existing_disk
= False
1860 self
.add_new_disk(vapp_uuid
, disk
['size'])
1863 # Assigning numa affinity setting
1865 if 'paired-threads-id' in numa
:
1866 paired_threads_id
= numa
['paired-threads-id']
1867 self
.set_numa_affinity(vapp_uuid
, paired_threads_id
)
1869 # add NICs & connect to networks in netlist
1871 vdc_obj
= VDC(self
.client
, href
=vdc
.get('href'))
1872 vapp_resource
= vdc_obj
.get_vapp(vmname_andid
)
1873 vapp
= VApp(self
.client
, resource
=vapp_resource
)
1875 self
.logger
.info("Removing primary NIC: ")
1876 # First remove all NICs so that NIC properties can be adjusted as needed
1877 self
.remove_primary_network_adapter_from_all_vms(vapp
)
1879 self
.logger
.info("Request to connect VM to a network: {}".format(net_list
))
1880 primary_nic_index
= 0
1882 for net
in net_list
:
1883 # openmano uses network id in UUID format.
1884 # vCloud Director need a name so we do reverse operation from provided UUID we lookup a name
1885 # [{'use': 'bridge', 'net_id': '527d4bf7-566a-41e7-a9e7-ca3cdd9cef4f', 'type': 'virtual',
1886 # 'vpci': '0000:00:11.0', 'name': 'eth0'}]
1888 if 'net_id' not in net
:
1891 #Using net_id as a vim_id i.e. vim interface id, as do not have saperate vim interface id
1892 #Same will be returned in refresh_vms_status() as vim_interface_id
1893 net
['vim_id'] = net
['net_id'] # Provide the same VIM identifier as the VIM network
1895 interface_net_id
= net
['net_id']
1896 interface_net_name
= self
.get_network_name_by_id(network_uuid
=interface_net_id
)
1897 interface_network_mode
= net
['use']
1899 if interface_network_mode
== 'mgmt':
1900 primary_nic_index
= nicIndex
1902 """- POOL (A static IP address is allocated automatically from a pool of addresses.)
1903 - DHCP (The IP address is obtained from a DHCP service.)
1904 - MANUAL (The IP address is assigned manually in the IpAddress element.)
1905 - NONE (No IP addressing mode specified.)"""
1907 if primary_netname
is not None:
1908 self
.logger
.debug("new_vminstance(): Filtering by net name {}".format(interface_net_name
))
1909 nets
= filter(lambda n
: n
.get('name') == interface_net_name
, self
.get_network_list())
1911 #nets = [n for n in self.get_network_list() if n.get('name') == interface_net_name]
1913 self
.logger
.info("new_vminstance(): Found requested network: {}".format(nets
[0].get('name')))
1915 if interface_net_name
!= primary_netname
:
1916 # connect network to VM - with all DHCP by default
1917 self
.logger
.info("new_vminstance(): Attaching net {} to vapp".format(interface_net_name
))
1918 task
= vapp
.connect_org_vdc_network(nets
[0].get('name'))
1919 self
.client
.get_task_monitor().wait_for_success(task
=task
)
1921 type_list
= ('PF', 'PCI-PASSTHROUGH', 'VF', 'SR-IOV', 'VFnotShared')
1922 if 'type' in net
and net
['type'] not in type_list
:
1923 # fetching nic type from vnf
1925 if net
['model'] is not None and net
['model'].lower() == 'virtio':
1926 nic_type
= 'VMXNET3'
1928 nic_type
= net
['model']
1930 self
.logger
.info("new_vminstance(): adding network adapter "\
1931 "to a network {}".format(nets
[0].get('name')))
1932 self
.add_network_adapter_to_vms(vapp
, nets
[0].get('name'),
1938 self
.logger
.info("new_vminstance(): adding network adapter "\
1939 "to a network {}".format(nets
[0].get('name')))
1940 self
.add_network_adapter_to_vms(vapp
, nets
[0].get('name'),
1946 # cloud-init for ssh-key injection
1948 self
.cloud_init(vapp
,cloud_config
)
1950 # ############# Stub code for SRIOV #################
1952 # if len(sriov_net_info) > 0:
1953 # self.logger.info("Need to add SRIOV adapters {} into VM {}".format(sriov_net_info,
1955 # sriov_status, vm_obj, vcenter_conect = self.add_sriov(vapp_uuid,
1959 # self.logger.info("Added SRIOV {} to VM {}".format(
1963 # reserve_memory = True
1965 # self.logger.info("Fail to add SRIOV {} to VM {}".format(
1970 # If VM has PCI devices or SRIOV reserve memory for VM
1972 memReserve
= vm_obj
.config
.hardware
.memoryMB
1973 spec
= vim
.vm
.ConfigSpec()
1974 spec
.memoryAllocation
= vim
.ResourceAllocationInfo(reservation
=memReserve
)
1975 task
= vm_obj
.ReconfigVM_Task(spec
=spec
)
1977 result
= self
.wait_for_vcenter_task(task
, vcenter_conect
)
1978 self
.logger
.info("Reserved memory {} MB for "
1979 "VM VM status: {}".format(str(memReserve
), result
))
1981 self
.logger
.info("Fail to reserved memory {} to VM {}".format(
1982 str(memReserve
), str(vm_obj
)))
1984 self
.logger
.debug("new_vminstance(): starting power on vApp {} ".format(vmname_andid
))
1986 vapp_id
= vapp_resource
.get('id').split(':')[-1]
1987 poweron_task
= self
.power_on_vapp(vapp_id
, vmname_andid
)
1988 result
= self
.client
.get_task_monitor().wait_for_success(task
=poweron_task
)
1989 if result
.get('status') == 'success':
1990 self
.logger
.info("new_vminstance(): Successfully power on "\
1991 "vApp {}".format(vmname_andid
))
1993 self
.logger
.error("new_vminstance(): failed to power on vApp "\
1994 "{}".format(vmname_andid
))
1996 except Exception as exp
:
1997 # it might be a case if specific mandatory entry in dict is empty or some other pyVcloud exception
1998 self
.logger
.error("new_vminstance(): Failed create new vm instance {} with exception {}"
2000 raise vimconn
.vimconnException("new_vminstance(): Failed create new vm instance {} with exception {}"
2003 # check if vApp deployed and if that the case return vApp UUID otherwise -1
2006 while wait_time
<= MAX_WAIT_TIME
:
2008 vapp_resource
= vdc_obj
.get_vapp(vmname_andid
)
2009 vapp
= VApp(self
.client
, resource
=vapp_resource
)
2010 except Exception as exp
:
2011 raise vimconn
.vimconnUnexpectedResponse(
2012 "new_vminstance(): Failed to retrieve vApp {} after creation: Exception:{}"
2013 .format(vmname_andid
, exp
))
2015 #if vapp and vapp.me.deployed:
2016 if vapp
and vapp_resource
.get('deployed') == 'true':
2017 vapp_uuid
= vapp_resource
.get('id').split(':')[-1]
2020 self
.logger
.debug("new_vminstance(): Wait for vApp {} to deploy".format(name
))
2021 time
.sleep(INTERVAL_TIME
)
2023 wait_time
+=INTERVAL_TIME
2025 #SET Affinity Rule for VM
2026 #Pre-requisites: User has created Hosh Groups in vCenter with respective Hosts to be used
2027 #While creating VIM account user has to pass the Host Group names in availability_zone list
2028 #"availability_zone" is a part of VIM "config" parameters
2029 #For example, in VIM config: "availability_zone":["HG_170","HG_174","HG_175"]
2030 #Host groups are referred as availability zones
2031 #With following procedure, deployed VM will be added into a VM group.
2032 #Then A VM to Host Affinity rule will be created using the VM group & Host group.
2033 if(availability_zone_list
):
2034 self
.logger
.debug("Existing Host Groups in VIM {}".format(self
.config
.get('availability_zone')))
2035 #Admin access required for creating Affinity rules
2036 client
= self
.connect_as_admin()
2038 raise vimconn
.vimconnConnectionException("Failed to connect vCD as admin")
2040 self
.client
= client
2042 headers
= {'Accept':'application/*+xml;version=27.0',
2043 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
2044 #Step1: Get provider vdc details from organization
2045 pvdc_href
= self
.get_pvdc_for_org(self
.tenant_name
, headers
)
2046 if pvdc_href
is not None:
2047 #Step2: Found required pvdc, now get resource pool information
2048 respool_href
= self
.get_resource_pool_details(pvdc_href
, headers
)
2049 if respool_href
is None:
2050 #Raise error if respool_href not found
2051 msg
= "new_vminstance():Error in finding resource pool details in pvdc {}"\
2053 self
.log_message(msg
)
2055 #Step3: Verify requested availability zone(hostGroup) is present in vCD
2056 # get availability Zone
2057 vm_az
= self
.get_vm_availability_zone(availability_zone_index
, availability_zone_list
)
2058 # check if provided av zone(hostGroup) is present in vCD VIM
2059 status
= self
.check_availibility_zone(vm_az
, respool_href
, headers
)
2061 msg
= "new_vminstance(): Error in finding availability zone(Host Group): {} in "\
2062 "resource pool {} status: {}".format(vm_az
,respool_href
,status
)
2063 self
.log_message(msg
)
2065 self
.logger
.debug ("new_vminstance(): Availability zone {} found in VIM".format(vm_az
))
2067 #Step4: Find VM group references to create vm group
2068 vmgrp_href
= self
.find_vmgroup_reference(respool_href
, headers
)
2069 if vmgrp_href
== None:
2070 msg
= "new_vminstance(): No reference to VmGroup found in resource pool"
2071 self
.log_message(msg
)
2073 #Step5: Create a VmGroup with name az_VmGroup
2074 vmgrp_name
= vm_az
+ "_" + name
#Formed VM Group name = Host Group name + VM name
2075 status
= self
.create_vmgroup(vmgrp_name
, vmgrp_href
, headers
)
2076 if status
is not True:
2077 msg
= "new_vminstance(): Error in creating VM group {}".format(vmgrp_name
)
2078 self
.log_message(msg
)
2080 #VM Group url to add vms to vm group
2081 vmgrpname_url
= self
.url
+ "/api/admin/extension/vmGroup/name/"+ vmgrp_name
2083 #Step6: Add VM to VM Group
2084 #Find VM uuid from vapp_uuid
2085 vm_details
= self
.get_vapp_details_rest(vapp_uuid
)
2086 vm_uuid
= vm_details
['vmuuid']
2088 status
= self
.add_vm_to_vmgroup(vm_uuid
, vmgrpname_url
, vmgrp_name
, headers
)
2089 if status
is not True:
2090 msg
= "new_vminstance(): Error in adding VM to VM group {}".format(vmgrp_name
)
2091 self
.log_message(msg
)
2093 #Step7: Create VM to Host affinity rule
2094 addrule_href
= self
.get_add_rule_reference (respool_href
, headers
)
2095 if addrule_href
is None:
2096 msg
= "new_vminstance(): Error in finding href to add rule in resource pool: {}"\
2097 .format(respool_href
)
2098 self
.log_message(msg
)
2100 status
= self
.create_vm_to_host_affinity_rule(addrule_href
, vmgrp_name
, vm_az
, "Affinity", headers
)
2102 msg
= "new_vminstance(): Error in creating affinity rule for VM {} in Host group {}"\
2103 .format(name
, vm_az
)
2104 self
.log_message(msg
)
2106 self
.logger
.debug("new_vminstance(): Affinity rule created successfully. Added {} in Host group {}"\
2107 .format(name
, vm_az
))
2108 #Reset token to a normal user to perform other operations
2111 if vapp_uuid
is not None:
2112 return vapp_uuid
, None
2114 raise vimconn
.vimconnUnexpectedResponse("new_vminstance(): Failed create new vm instance {}".format(name
))
2117 def get_vcd_availibility_zones(self
,respool_href
, headers
):
2118 """ Method to find presence of av zone is VIM resource pool
2121 respool_href - resource pool href
2122 headers - header information
2125 vcd_az - list of azone present in vCD
2129 resp
= self
.perform_request(req_type
='GET',url
=respool_href
, headers
=headers
)
2131 if resp
.status_code
!= requests
.codes
.ok
:
2132 self
.logger
.debug ("REST API call {} failed. Return status code {}".format(url
, resp
.status_code
))
2134 #Get the href to hostGroups and find provided hostGroup is present in it
2135 resp_xml
= XmlElementTree
.fromstring(resp
.content
)
2136 for child
in resp_xml
:
2137 if 'VMWProviderVdcResourcePool' in child
.tag
:
2138 for schild
in child
:
2139 if 'Link' in schild
.tag
:
2140 if schild
.attrib
.get('type') == "application/vnd.vmware.admin.vmwHostGroupsType+xml":
2141 hostGroup
= schild
.attrib
.get('href')
2142 hg_resp
= self
.perform_request(req_type
='GET',url
=hostGroup
, headers
=headers
)
2143 if hg_resp
.status_code
!= requests
.codes
.ok
:
2144 self
.logger
.debug ("REST API call {} failed. Return status code {}".format(hostGroup
, hg_resp
.status_code
))
2146 hg_resp_xml
= XmlElementTree
.fromstring(hg_resp
.content
)
2147 for hostGroup
in hg_resp_xml
:
2148 if 'HostGroup' in hostGroup
.tag
:
2149 #append host group name to the list
2150 vcd_az
.append(hostGroup
.attrib
.get("name"))
2154 def set_availability_zones(self
):
2156 Set vim availability zone
2159 vim_availability_zones
= None
2160 availability_zone
= None
2161 if 'availability_zone' in self
.config
:
2162 vim_availability_zones
= self
.config
.get('availability_zone')
2163 if isinstance(vim_availability_zones
, str):
2164 availability_zone
= [vim_availability_zones
]
2165 elif isinstance(vim_availability_zones
, list):
2166 availability_zone
= vim_availability_zones
2168 return availability_zone
2170 return availability_zone
2173 def get_vm_availability_zone(self
, availability_zone_index
, availability_zone_list
):
2175 Return the availability zone to be used by the created VM.
2176 returns: The VIM availability zone to be used or None
2178 if availability_zone_index
is None:
2179 if not self
.config
.get('availability_zone'):
2181 elif isinstance(self
.config
.get('availability_zone'), str):
2182 return self
.config
['availability_zone']
2184 return self
.config
['availability_zone'][0]
2186 vim_availability_zones
= self
.availability_zone
2188 # check if VIM offer enough availability zones describe in the VNFD
2189 if vim_availability_zones
and len(availability_zone_list
) <= len(vim_availability_zones
):
2190 # check if all the names of NFV AV match VIM AV names
2191 match_by_index
= False
2192 for av
in availability_zone_list
:
2193 if av
not in vim_availability_zones
:
2194 match_by_index
= True
2197 self
.logger
.debug("Required Availability zone or Host Group not found in VIM config")
2198 self
.logger
.debug("Input Availability zone list: {}".format(availability_zone_list
))
2199 self
.logger
.debug("VIM configured Availability zones: {}".format(vim_availability_zones
))
2200 self
.logger
.debug("VIM Availability zones will be used by index")
2201 return vim_availability_zones
[availability_zone_index
]
2203 return availability_zone_list
[availability_zone_index
]
2205 raise vimconn
.vimconnConflictException("No enough availability zones at VIM for this deployment")
2208 def create_vm_to_host_affinity_rule(self
, addrule_href
, vmgrpname
, hostgrpname
, polarity
, headers
):
2209 """ Method to create VM to Host Affinity rule in vCD
2212 addrule_href - href to make a POST request
2213 vmgrpname - name of the VM group created
2214 hostgrpnmae - name of the host group created earlier
2215 polarity - Affinity or Anti-affinity (default: Affinity)
2216 headers - headers to make REST call
2219 True- if rule is created
2220 False- Failed to create rule due to some error
2224 rule_name
= polarity
+ "_" + vmgrpname
2225 payload
= """<?xml version="1.0" encoding="UTF-8"?>
2226 <vmext:VMWVmHostAffinityRule
2227 xmlns:vmext="http://www.vmware.com/vcloud/extension/v1.5"
2228 xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
2229 type="application/vnd.vmware.admin.vmwVmHostAffinityRule+xml">
2230 <vcloud:Name>{}</vcloud:Name>
2231 <vcloud:IsEnabled>true</vcloud:IsEnabled>
2232 <vcloud:IsMandatory>true</vcloud:IsMandatory>
2233 <vcloud:Polarity>{}</vcloud:Polarity>
2234 <vmext:HostGroupName>{}</vmext:HostGroupName>
2235 <vmext:VmGroupName>{}</vmext:VmGroupName>
2236 </vmext:VMWVmHostAffinityRule>""".format(rule_name
, polarity
, hostgrpname
, vmgrpname
)
2238 resp
= self
.perform_request(req_type
='POST',url
=addrule_href
, headers
=headers
, data
=payload
)
2240 if resp
.status_code
!= requests
.codes
.accepted
:
2241 self
.logger
.debug ("REST API call {} failed. Return status code {}".format(addrule_href
, resp
.status_code
))
2245 affinity_task
= self
.get_task_from_response(resp
.content
)
2246 self
.logger
.debug ("affinity_task: {}".format(affinity_task
))
2247 if affinity_task
is None or affinity_task
is False:
2248 raise vimconn
.vimconnUnexpectedResponse("failed to find affinity task")
2249 # wait for task to complete
2250 result
= self
.client
.get_task_monitor().wait_for_success(task
=affinity_task
)
2251 if result
.get('status') == 'success':
2252 self
.logger
.debug("Successfully created affinity rule {}".format(rule_name
))
2255 raise vimconn
.vimconnUnexpectedResponse(
2256 "failed to create affinity rule {}".format(rule_name
))
2259 def get_add_rule_reference (self
, respool_href
, headers
):
2260 """ This method finds href to add vm to host affinity rule to vCD
2263 respool_href- href to resource pool
2264 headers- header information to make REST call
2267 None - if no valid href to add rule found or
2268 addrule_href - href to add vm to host affinity rule of resource pool
2271 resp
= self
.perform_request(req_type
='GET',url
=respool_href
, headers
=headers
)
2273 if resp
.status_code
!= requests
.codes
.ok
:
2274 self
.logger
.debug ("REST API call {} failed. Return status code {}".format(respool_href
, resp
.status_code
))
2277 resp_xml
= XmlElementTree
.fromstring(resp
.content
)
2278 for child
in resp_xml
:
2279 if 'VMWProviderVdcResourcePool' in child
.tag
:
2280 for schild
in child
:
2281 if 'Link' in schild
.tag
:
2282 if schild
.attrib
.get('type') == "application/vnd.vmware.admin.vmwVmHostAffinityRule+xml" and \
2283 schild
.attrib
.get('rel') == "add":
2284 addrule_href
= schild
.attrib
.get('href')
2290 def add_vm_to_vmgroup(self
, vm_uuid
, vmGroupNameURL
, vmGroup_name
, headers
):
2291 """ Method to add deployed VM to newly created VM Group.
2292 This is required to create VM to Host affinity in vCD
2295 vm_uuid- newly created vm uuid
2296 vmGroupNameURL- URL to VM Group name
2297 vmGroup_name- Name of VM group created
2298 headers- Headers for REST request
2301 True- if VM added to VM group successfully
2302 False- if any error encounter
2305 addvm_resp
= self
.perform_request(req_type
='GET',url
=vmGroupNameURL
, headers
=headers
)#, data=payload)
2307 if addvm_resp
.status_code
!= requests
.codes
.ok
:
2308 self
.logger
.debug ("REST API call to get VM Group Name url {} failed. Return status code {}"\
2309 .format(vmGroupNameURL
, addvm_resp
.status_code
))
2312 resp_xml
= XmlElementTree
.fromstring(addvm_resp
.content
)
2313 for child
in resp_xml
:
2314 if child
.tag
.split('}')[1] == 'Link':
2315 if child
.attrib
.get("rel") == "addVms":
2316 addvmtogrpURL
= child
.attrib
.get("href")
2319 url_list
= [self
.url
, '/api/vApp/vm-',vm_uuid
]
2320 vmdetailsURL
= ''.join(url_list
)
2322 resp
= self
.perform_request(req_type
='GET',url
=vmdetailsURL
, headers
=headers
)
2324 if resp
.status_code
!= requests
.codes
.ok
:
2325 self
.logger
.debug ("REST API call {} failed. Return status code {}".format(vmdetailsURL
, resp
.status_code
))
2329 resp_xml
= XmlElementTree
.fromstring(resp
.content
)
2330 if resp_xml
.tag
.split('}')[1] == "Vm":
2331 vm_id
= resp_xml
.attrib
.get("id")
2332 vm_name
= resp_xml
.attrib
.get("name")
2333 vm_href
= resp_xml
.attrib
.get("href")
2334 #print vm_id, vm_name, vm_href
2335 #Add VM into VMgroup
2336 payload
= """<?xml version="1.0" encoding="UTF-8"?>\
2337 <ns2:Vms xmlns:ns2="http://www.vmware.com/vcloud/v1.5" \
2338 xmlns="http://www.vmware.com/vcloud/versions" \
2339 xmlns:ns3="http://schemas.dmtf.org/ovf/envelope/1" \
2340 xmlns:ns4="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData" \
2341 xmlns:ns5="http://schemas.dmtf.org/wbem/wscim/1/common" \
2342 xmlns:ns6="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData" \
2343 xmlns:ns7="http://www.vmware.com/schema/ovf" \
2344 xmlns:ns8="http://schemas.dmtf.org/ovf/environment/1" \
2345 xmlns:ns9="http://www.vmware.com/vcloud/extension/v1.5">\
2346 <ns2:VmReference href="{}" id="{}" name="{}" \
2347 type="application/vnd.vmware.vcloud.vm+xml" />\
2348 </ns2:Vms>""".format(vm_href
, vm_id
, vm_name
)
2350 addvmtogrp_resp
= self
.perform_request(req_type
='POST',url
=addvmtogrpURL
, headers
=headers
, data
=payload
)
2352 if addvmtogrp_resp
.status_code
!= requests
.codes
.accepted
:
2353 self
.logger
.debug ("REST API call {} failed. Return status code {}".format(addvmtogrpURL
, addvmtogrp_resp
.status_code
))
2356 self
.logger
.debug ("Done adding VM {} to VMgroup {}".format(vm_name
, vmGroup_name
))
2360 def create_vmgroup(self
, vmgroup_name
, vmgroup_href
, headers
):
2361 """Method to create a VM group in vCD
2364 vmgroup_name : Name of VM group to be created
2365 vmgroup_href : href for vmgroup
2366 headers- Headers for REST request
2368 #POST to add URL with required data
2369 vmgroup_status
= False
2370 payload
= """<VMWVmGroup xmlns="http://www.vmware.com/vcloud/extension/v1.5" \
2371 xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5" name="{}">\
2372 <vmCount>1</vmCount>\
2373 </VMWVmGroup>""".format(vmgroup_name
)
2374 resp
= self
.perform_request(req_type
='POST',url
=vmgroup_href
, headers
=headers
, data
=payload
)
2376 if resp
.status_code
!= requests
.codes
.accepted
:
2377 self
.logger
.debug ("REST API call {} failed. Return status code {}".format(vmgroup_href
, resp
.status_code
))
2378 return vmgroup_status
2380 vmgroup_task
= self
.get_task_from_response(resp
.content
)
2381 if vmgroup_task
is None or vmgroup_task
is False:
2382 raise vimconn
.vimconnUnexpectedResponse(
2383 "create_vmgroup(): failed to create VM group {}".format(vmgroup_name
))
2385 # wait for task to complete
2386 result
= self
.client
.get_task_monitor().wait_for_success(task
=vmgroup_task
)
2388 if result
.get('status') == 'success':
2389 self
.logger
.debug("create_vmgroup(): Successfully created VM group {}".format(vmgroup_name
))
2391 vmgroup_status
= True
2392 return vmgroup_status
2394 raise vimconn
.vimconnUnexpectedResponse(\
2395 "create_vmgroup(): failed to create VM group {}".format(vmgroup_name
))
2398 def find_vmgroup_reference(self
, url
, headers
):
2399 """ Method to create a new VMGroup which is required to add created VM
2401 url- resource pool href
2402 headers- header information
2405 returns href to VM group to create VM group
2407 #Perform GET on resource pool to find 'add' link to create VMGroup
2408 #https://vcd-ip/api/admin/extension/providervdc/<providervdc id>/resourcePools
2410 resp
= self
.perform_request(req_type
='GET',url
=url
, headers
=headers
)
2412 if resp
.status_code
!= requests
.codes
.ok
:
2413 self
.logger
.debug ("REST API call {} failed. Return status code {}".format(url
, resp
.status_code
))
2415 #Get the href to add vmGroup to vCD
2416 resp_xml
= XmlElementTree
.fromstring(resp
.content
)
2417 for child
in resp_xml
:
2418 if 'VMWProviderVdcResourcePool' in child
.tag
:
2419 for schild
in child
:
2420 if 'Link' in schild
.tag
:
2421 #Find href with type VMGroup and rel with add
2422 if schild
.attrib
.get('type') == "application/vnd.vmware.admin.vmwVmGroupType+xml"\
2423 and schild
.attrib
.get('rel') == "add":
2424 vmgrp_href
= schild
.attrib
.get('href')
2428 def check_availibility_zone(self
, az
, respool_href
, headers
):
2429 """ Method to verify requested av zone is present or not in provided
2433 az - name of hostgroup (availibility_zone)
2434 respool_href - Resource Pool href
2435 headers - Headers to make REST call
2437 az_found - True if availibility_zone is found else False
2440 headers
['Accept']='application/*+xml;version=27.0'
2441 resp
= self
.perform_request(req_type
='GET',url
=respool_href
, headers
=headers
)
2443 if resp
.status_code
!= requests
.codes
.ok
:
2444 self
.logger
.debug ("REST API call {} failed. Return status code {}".format(respool_href
, resp
.status_code
))
2446 #Get the href to hostGroups and find provided hostGroup is present in it
2447 resp_xml
= XmlElementTree
.fromstring(resp
.content
)
2449 for child
in resp_xml
:
2450 if 'VMWProviderVdcResourcePool' in child
.tag
:
2451 for schild
in child
:
2452 if 'Link' in schild
.tag
:
2453 if schild
.attrib
.get('type') == "application/vnd.vmware.admin.vmwHostGroupsType+xml":
2454 hostGroup_href
= schild
.attrib
.get('href')
2455 hg_resp
= self
.perform_request(req_type
='GET',url
=hostGroup_href
, headers
=headers
)
2456 if hg_resp
.status_code
!= requests
.codes
.ok
:
2457 self
.logger
.debug ("REST API call {} failed. Return status code {}".format(hostGroup_href
, hg_resp
.status_code
))
2459 hg_resp_xml
= XmlElementTree
.fromstring(hg_resp
.content
)
2460 for hostGroup
in hg_resp_xml
:
2461 if 'HostGroup' in hostGroup
.tag
:
2462 if hostGroup
.attrib
.get("name") == az
:
2468 def get_pvdc_for_org(self
, org_vdc
, headers
):
2469 """ This method gets provider vdc references from organisation
2472 org_vdc - name of the organisation VDC to find pvdc
2473 headers - headers to make REST call
2476 None - if no pvdc href found else
2477 pvdc_href - href to pvdc
2480 #Get provider VDC references from vCD
2482 #url = '<vcd url>/api/admin/extension/providerVdcReferences'
2483 url_list
= [self
.url
, '/api/admin/extension/providerVdcReferences']
2484 url
= ''.join(url_list
)
2486 response
= self
.perform_request(req_type
='GET',url
=url
, headers
=headers
)
2487 if response
.status_code
!= requests
.codes
.ok
:
2488 self
.logger
.debug ("REST API call {} failed. Return status code {}"\
2489 .format(url
, response
.status_code
))
2491 xmlroot_response
= XmlElementTree
.fromstring(response
.content
)
2492 for child
in xmlroot_response
:
2493 if 'ProviderVdcReference' in child
.tag
:
2494 pvdc_href
= child
.attrib
.get('href')
2495 #Get vdcReferences to find org
2496 pvdc_resp
= self
.perform_request(req_type
='GET',url
=pvdc_href
, headers
=headers
)
2497 if pvdc_resp
.status_code
!= requests
.codes
.ok
:
2498 raise vimconn
.vimconnException("REST API call {} failed. "\
2499 "Return status code {}"\
2500 .format(url
, pvdc_resp
.status_code
))
2502 pvdc_resp_xml
= XmlElementTree
.fromstring(pvdc_resp
.content
)
2503 for child
in pvdc_resp_xml
:
2504 if 'Link' in child
.tag
:
2505 if child
.attrib
.get('type') == "application/vnd.vmware.admin.vdcReferences+xml":
2506 vdc_href
= child
.attrib
.get('href')
2508 #Check if provided org is present in vdc
2509 vdc_resp
= self
.perform_request(req_type
='GET',
2512 if vdc_resp
.status_code
!= requests
.codes
.ok
:
2513 raise vimconn
.vimconnException("REST API call {} failed. "\
2514 "Return status code {}"\
2515 .format(url
, vdc_resp
.status_code
))
2516 vdc_resp_xml
= XmlElementTree
.fromstring(vdc_resp
.content
)
2517 for child
in vdc_resp_xml
:
2518 if 'VdcReference' in child
.tag
:
2519 if child
.attrib
.get('name') == org_vdc
:
2523 def get_resource_pool_details(self
, pvdc_href
, headers
):
2524 """ Method to get resource pool information.
2525 Host groups are property of resource group.
2526 To get host groups, we need to GET details of resource pool.
2529 pvdc_href: href to pvdc details
2533 respool_href - Returns href link reference to resource pool
2536 resp
= self
.perform_request(req_type
='GET',url
=pvdc_href
, headers
=headers
)
2538 if resp
.status_code
!= requests
.codes
.ok
:
2539 self
.logger
.debug ("REST API call {} failed. Return status code {}"\
2540 .format(pvdc_href
, resp
.status_code
))
2542 respool_resp_xml
= XmlElementTree
.fromstring(resp
.content
)
2543 for child
in respool_resp_xml
:
2544 if 'Link' in child
.tag
:
2545 if child
.attrib
.get('type') == "application/vnd.vmware.admin.vmwProviderVdcResourcePoolSet+xml":
2546 respool_href
= child
.attrib
.get("href")
2551 def log_message(self
, msg
):
2553 Method to log error messages related to Affinity rule creation
2554 in new_vminstance & raise Exception
2556 msg - Error message to be logged
2559 #get token to connect vCD as a normal user
2561 self
.logger
.debug(msg
)
2562 raise vimconn
.vimconnException(msg
)
2567 ## based on current discussion
2571 # created: '2016-09-08T11:51:58'
2572 # description: simple-instance.linux1.1
2573 # flavor: ddc6776e-75a9-11e6-ad5f-0800273e724c
2574 # hostId: e836c036-74e7-11e6-b249-0800273e724c
2575 # image: dde30fe6-75a9-11e6-ad5f-0800273e724c
2580 def get_vminstance(self
, vim_vm_uuid
=None):
2581 """Returns the VM instance information from VIM"""
2583 self
.logger
.debug("Client requesting vm instance {} ".format(vim_vm_uuid
))
2585 org
, vdc
= self
.get_vdc_details()
2587 raise vimconn
.vimconnConnectionException(
2588 "Failed to get a reference of VDC for a tenant {}".format(self
.tenant_name
))
2590 vm_info_dict
= self
.get_vapp_details_rest(vapp_uuid
=vim_vm_uuid
)
2591 if not vm_info_dict
:
2592 self
.logger
.debug("get_vminstance(): Failed to get vApp name by UUID {}".format(vim_vm_uuid
))
2593 raise vimconn
.vimconnNotFoundException("Failed to get vApp name by UUID {}".format(vim_vm_uuid
))
2595 status_key
= vm_info_dict
['status']
2598 vm_dict
= {'created': vm_info_dict
['created'],
2599 'description': vm_info_dict
['name'],
2600 'status': vcdStatusCode2manoFormat
[int(status_key
)],
2601 'hostId': vm_info_dict
['vmuuid'],
2603 'vim_info': yaml
.safe_dump(vm_info_dict
), 'interfaces': []}
2605 if 'interfaces' in vm_info_dict
:
2606 vm_dict
['interfaces'] = vm_info_dict
['interfaces']
2608 vm_dict
['interfaces'] = []
2610 vm_dict
= {'created': '',
2612 'status': vcdStatusCode2manoFormat
[int(-1)],
2613 'hostId': vm_info_dict
['vmuuid'],
2614 'error_msg': "Inconsistency state",
2615 'vim_info': yaml
.safe_dump(vm_info_dict
), 'interfaces': []}
2619 def delete_vminstance(self
, vm__vim_uuid
, created_items
=None):
2620 """Method poweroff and remove VM instance from vcloud director network.
2623 vm__vim_uuid: VM UUID
2626 Returns the instance identifier
2629 self
.logger
.debug("Client requesting delete vm instance {} ".format(vm__vim_uuid
))
2631 org
, vdc
= self
.get_vdc_details()
2632 vdc_obj
= VDC(self
.client
, href
=vdc
.get('href'))
2634 self
.logger
.debug("delete_vminstance(): Failed to get a reference of VDC for a tenant {}".format(
2636 raise vimconn
.vimconnException(
2637 "delete_vminstance(): Failed to get a reference of VDC for a tenant {}".format(self
.tenant_name
))
2640 vapp_name
= self
.get_namebyvappid(vm__vim_uuid
)
2641 vapp_resource
= vdc_obj
.get_vapp(vapp_name
)
2642 vapp
= VApp(self
.client
, resource
=vapp_resource
)
2643 if vapp_name
is None:
2644 self
.logger
.debug("delete_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid
))
2645 return -1, "delete_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid
)
2647 self
.logger
.info("Deleting vApp {} and UUID {}".format(vapp_name
, vm__vim_uuid
))
2649 # Delete vApp and wait for status change if task executed and vApp is None.
2652 if vapp_resource
.get('deployed') == 'true':
2653 self
.logger
.info("Powering off vApp {}".format(vapp_name
))
2657 while wait_time
<= MAX_WAIT_TIME
:
2658 power_off_task
= vapp
.power_off()
2659 result
= self
.client
.get_task_monitor().wait_for_success(task
=power_off_task
)
2661 if result
.get('status') == 'success':
2665 self
.logger
.info("Wait for vApp {} to power off".format(vapp_name
))
2666 time
.sleep(INTERVAL_TIME
)
2668 wait_time
+=INTERVAL_TIME
2670 self
.logger
.debug("delete_vminstance(): Failed to power off VM instance {} ".format(vm__vim_uuid
))
2672 self
.logger
.info("delete_vminstance(): Powered off VM instance {} ".format(vm__vim_uuid
))
2675 self
.logger
.info("Undeploy vApp {}".format(vapp_name
))
2678 while wait_time
<= MAX_WAIT_TIME
:
2679 vapp
= VApp(self
.client
, resource
=vapp_resource
)
2681 self
.logger
.debug("delete_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid
))
2682 return -1, "delete_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid
)
2683 undeploy_task
= vapp
.undeploy()
2685 result
= self
.client
.get_task_monitor().wait_for_success(task
=undeploy_task
)
2686 if result
.get('status') == 'success':
2690 self
.logger
.debug("Wait for vApp {} to undeploy".format(vapp_name
))
2691 time
.sleep(INTERVAL_TIME
)
2693 wait_time
+=INTERVAL_TIME
2696 self
.logger
.debug("delete_vminstance(): Failed to undeploy vApp {} ".format(vm__vim_uuid
))
2699 self
.logger
.info("Start deletion of vApp {} ".format(vapp_name
))
2701 if vapp
is not None:
2705 while wait_time
<= MAX_WAIT_TIME
:
2706 vapp
= VApp(self
.client
, resource
=vapp_resource
)
2708 self
.logger
.debug("delete_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid
))
2709 return -1, "delete_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid
)
2711 delete_task
= vdc_obj
.delete_vapp(vapp
.name
, force
=True)
2713 result
= self
.client
.get_task_monitor().wait_for_success(task
=delete_task
)
2714 if result
.get('status') == 'success':
2717 self
.logger
.debug("Wait for vApp {} to delete".format(vapp_name
))
2718 time
.sleep(INTERVAL_TIME
)
2720 wait_time
+=INTERVAL_TIME
2723 self
.logger
.debug("delete_vminstance(): Failed delete uuid {} ".format(vm__vim_uuid
))
2725 self
.logger
.info("Deleted vm instance {} sccessfully".format(vm__vim_uuid
))
2728 self
.logger
.debug(traceback
.format_exc())
2729 raise vimconn
.vimconnException("delete_vminstance(): Failed delete vm instance {}".format(vm__vim_uuid
))
2732 def refresh_vms_status(self
, vm_list
):
2733 """Get the status of the virtual machines and their interfaces/ports
2734 Params: the list of VM identifiers
2735 Returns a dictionary with:
2736 vm_id: #VIM id of this Virtual Machine
2737 status: #Mandatory. Text with one of:
2738 # DELETED (not found at vim)
2739 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
2740 # OTHER (Vim reported other status not understood)
2741 # ERROR (VIM indicates an ERROR status)
2742 # ACTIVE, PAUSED, SUSPENDED, INACTIVE (not running),
2743 # CREATING (on building process), ERROR
2744 # ACTIVE:NoMgmtIP (Active but any of its interface has an IP address
2746 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
2747 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
2749 - vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
2750 mac_address: #Text format XX:XX:XX:XX:XX:XX
2751 vim_net_id: #network id where this interface is connected
2752 vim_interface_id: #interface/port VIM id
2753 ip_address: #null, or text with IPv4, IPv6 address
2756 self
.logger
.debug("Client requesting refresh vm status for {} ".format(vm_list
))
2758 org
,vdc
= self
.get_vdc_details()
2760 raise vimconn
.vimconnException("Failed to get a reference of VDC for a tenant {}".format(self
.tenant_name
))
2764 for vmuuid
in vm_list
:
2765 vapp_name
= self
.get_namebyvappid(vmuuid
)
2766 if vapp_name
is not None:
2769 vm_pci_details
= self
.get_vm_pci_details(vmuuid
)
2770 vdc_obj
= VDC(self
.client
, href
=vdc
.get('href'))
2771 vapp_resource
= vdc_obj
.get_vapp(vapp_name
)
2772 the_vapp
= VApp(self
.client
, resource
=vapp_resource
)
2775 for vm
in the_vapp
.get_all_vms():
2776 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
2777 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
2778 response
= self
.perform_request(req_type
='GET',
2782 if response
.status_code
!= 200:
2783 self
.logger
.error("refresh_vms_status : REST call {} failed reason : {}"\
2784 "status code : {}".format(vm
.get('href'),
2786 response
.status_code
))
2787 raise vimconn
.vimconnException("refresh_vms_status : Failed to get "\
2789 xmlroot
= XmlElementTree
.fromstring(response
.content
)
2792 result
= response
.content
.replace("\n"," ")
2793 hdd_match
= re
.search('vcloud:capacity="(\d+)"\svcloud:storageProfileOverrideVmDefault=',result
)
2795 hdd_mb
= hdd_match
.group(1)
2796 vm_details
['hdd_mb'] = int(hdd_mb
) if hdd_mb
else None
2797 cpus_match
= re
.search('<rasd:Description>Number of Virtual CPUs</.*?>(\d+)</rasd:VirtualQuantity>',result
)
2799 cpus
= cpus_match
.group(1)
2800 vm_details
['cpus'] = int(cpus
) if cpus
else None
2801 memory_mb
= re
.search('<rasd:Description>Memory Size</.*?>(\d+)</rasd:VirtualQuantity>',result
).group(1)
2802 vm_details
['memory_mb'] = int(memory_mb
) if memory_mb
else None
2803 vm_details
['status'] = vcdStatusCode2manoFormat
[int(xmlroot
.get('status'))]
2804 vm_details
['id'] = xmlroot
.get('id')
2805 vm_details
['name'] = xmlroot
.get('name')
2806 vm_info
= [vm_details
]
2808 vm_info
[0].update(vm_pci_details
)
2810 vm_dict
= {'status': vcdStatusCode2manoFormat
[int(vapp_resource
.get('status'))],
2811 'error_msg': vcdStatusCode2manoFormat
[int(vapp_resource
.get('status'))],
2812 'vim_info': yaml
.safe_dump(vm_info
), 'interfaces': []}
2817 networks
= re
.findall('<NetworkConnection needsCustomization=.*?</NetworkConnection>',result
)
2818 for network
in networks
:
2819 mac_s
= re
.search('<MACAddress>(.*?)</MACAddress>',network
)
2820 vm_mac
= mac_s
.group(1) if mac_s
else None
2821 ip_s
= re
.search('<IpAddress>(.*?)</IpAddress>',network
)
2822 vm_ip
= ip_s
.group(1) if ip_s
else None
2825 if not nsx_edge_list
:
2826 nsx_edge_list
= self
.get_edge_details()
2827 if nsx_edge_list
is None:
2828 raise vimconn
.vimconnException("refresh_vms_status:"\
2829 "Failed to get edge details from NSX Manager")
2830 if vm_mac
is not None:
2831 vm_ip
= self
.get_ipaddr_from_NSXedge(nsx_edge_list
, vm_mac
)
2833 net_s
= re
.search('network="(.*?)"',network
)
2834 network_name
= net_s
.group(1) if net_s
else None
2836 vm_net_id
= self
.get_network_id_by_name(network_name
)
2837 interface
= {"mac_address": vm_mac
,
2838 "vim_net_id": vm_net_id
,
2839 "vim_interface_id": vm_net_id
,
2840 "ip_address": vm_ip
}
2842 vm_dict
["interfaces"].append(interface
)
2844 # add a vm to vm dict
2845 vms_dict
.setdefault(vmuuid
, vm_dict
)
2846 self
.logger
.debug("refresh_vms_status : vm info {}".format(vm_dict
))
2847 except Exception as exp
:
2848 self
.logger
.debug("Error in response {}".format(exp
))
2849 self
.logger
.debug(traceback
.format_exc())
2854 def get_edge_details(self
):
2855 """Get the NSX edge list from NSX Manager
2856 Returns list of NSX edges
2859 rheaders
= {'Content-Type': 'application/xml'}
2860 nsx_api_url
= '/api/4.0/edges'
2862 self
.logger
.debug("Get edge details from NSX Manager {} {}".format(self
.nsx_manager
, nsx_api_url
))
2865 resp
= requests
.get(self
.nsx_manager
+ nsx_api_url
,
2866 auth
= (self
.nsx_user
, self
.nsx_password
),
2867 verify
= False, headers
= rheaders
)
2868 if resp
.status_code
== requests
.codes
.ok
:
2869 paged_Edge_List
= XmlElementTree
.fromstring(resp
.text
)
2870 for edge_pages
in paged_Edge_List
:
2871 if edge_pages
.tag
== 'edgePage':
2872 for edge_summary
in edge_pages
:
2873 if edge_summary
.tag
== 'pagingInfo':
2874 for element
in edge_summary
:
2875 if element
.tag
== 'totalCount' and element
.text
== '0':
2876 raise vimconn
.vimconnException("get_edge_details: No NSX edges details found: {}"
2877 .format(self
.nsx_manager
))
2879 if edge_summary
.tag
== 'edgeSummary':
2880 for element
in edge_summary
:
2881 if element
.tag
== 'id':
2882 edge_list
.append(element
.text
)
2884 raise vimconn
.vimconnException("get_edge_details: No NSX edge details found: {}"
2885 .format(self
.nsx_manager
))
2888 raise vimconn
.vimconnException("get_edge_details: "\
2889 "No NSX edge details found: {}"
2890 .format(self
.nsx_manager
))
2892 self
.logger
.debug("get_edge_details: Found NSX edges {}".format(edge_list
))
2895 self
.logger
.debug("get_edge_details: "
2896 "Failed to get NSX edge details from NSX Manager: {}"
2897 .format(resp
.content
))
2900 except Exception as exp
:
2901 self
.logger
.debug("get_edge_details: "\
2902 "Failed to get NSX edge details from NSX Manager: {}"
2904 raise vimconn
.vimconnException("get_edge_details: "\
2905 "Failed to get NSX edge details from NSX Manager: {}"
2909 def get_ipaddr_from_NSXedge(self
, nsx_edges
, mac_address
):
2910 """Get IP address details from NSX edges, using the MAC address
2911 PARAMS: nsx_edges : List of NSX edges
2912 mac_address : Find IP address corresponding to this MAC address
2913 Returns: IP address corrresponding to the provided MAC address
2917 rheaders
= {'Content-Type': 'application/xml'}
2919 self
.logger
.debug("get_ipaddr_from_NSXedge: Finding IP addr from NSX edge")
2922 for edge
in nsx_edges
:
2923 nsx_api_url
= '/api/4.0/edges/'+ edge
+'/dhcp/leaseInfo'
2925 resp
= requests
.get(self
.nsx_manager
+ nsx_api_url
,
2926 auth
= (self
.nsx_user
, self
.nsx_password
),
2927 verify
= False, headers
= rheaders
)
2929 if resp
.status_code
== requests
.codes
.ok
:
2930 dhcp_leases
= XmlElementTree
.fromstring(resp
.text
)
2931 for child
in dhcp_leases
:
2932 if child
.tag
== 'dhcpLeaseInfo':
2933 dhcpLeaseInfo
= child
2934 for leaseInfo
in dhcpLeaseInfo
:
2935 for elem
in leaseInfo
:
2936 if (elem
.tag
)=='macAddress':
2937 edge_mac_addr
= elem
.text
2938 if (elem
.tag
)=='ipAddress':
2940 if edge_mac_addr
is not None:
2941 if edge_mac_addr
== mac_address
:
2942 self
.logger
.debug("Found ip addr {} for mac {} at NSX edge {}"
2943 .format(ip_addr
, mac_address
,edge
))
2946 self
.logger
.debug("get_ipaddr_from_NSXedge: "\
2947 "Error occurred while getting DHCP lease info from NSX Manager: {}"
2948 .format(resp
.content
))
2950 self
.logger
.debug("get_ipaddr_from_NSXedge: No IP addr found in any NSX edge")
2953 except XmlElementTree
.ParseError
as Err
:
2954 self
.logger
.debug("ParseError in response from NSX Manager {}".format(Err
.message
), exc_info
=True)
2957 def action_vminstance(self
, vm__vim_uuid
=None, action_dict
=None, created_items
={}):
2958 """Send and action over a VM instance from VIM
2959 Returns the vm_id if the action was successfully sent to the VIM"""
2961 self
.logger
.debug("Received action for vm {} and action dict {}".format(vm__vim_uuid
, action_dict
))
2962 if vm__vim_uuid
is None or action_dict
is None:
2963 raise vimconn
.vimconnException("Invalid request. VM id or action is None.")
2965 org
, vdc
= self
.get_vdc_details()
2967 raise vimconn
.vimconnException("Failed to get a reference of VDC for a tenant {}".format(self
.tenant_name
))
2969 vapp_name
= self
.get_namebyvappid(vm__vim_uuid
)
2970 if vapp_name
is None:
2971 self
.logger
.debug("action_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid
))
2972 raise vimconn
.vimconnException("Failed to get vm by given {} vm uuid".format(vm__vim_uuid
))
2974 self
.logger
.info("Action_vminstance vApp {} and UUID {}".format(vapp_name
, vm__vim_uuid
))
2977 vdc_obj
= VDC(self
.client
, href
=vdc
.get('href'))
2978 vapp_resource
= vdc_obj
.get_vapp(vapp_name
)
2979 vapp
= VApp(self
.client
, resource
=vapp_resource
)
2980 if "start" in action_dict
:
2981 self
.logger
.info("action_vminstance: Power on vApp: {}".format(vapp_name
))
2982 poweron_task
= self
.power_on_vapp(vm__vim_uuid
, vapp_name
)
2983 result
= self
.client
.get_task_monitor().wait_for_success(task
=poweron_task
)
2984 self
.instance_actions_result("start", result
, vapp_name
)
2985 elif "rebuild" in action_dict
:
2986 self
.logger
.info("action_vminstance: Rebuild vApp: {}".format(vapp_name
))
2987 rebuild_task
= vapp
.deploy(power_on
=True)
2988 result
= self
.client
.get_task_monitor().wait_for_success(task
=rebuild_task
)
2989 self
.instance_actions_result("rebuild", result
, vapp_name
)
2990 elif "pause" in action_dict
:
2991 self
.logger
.info("action_vminstance: pause vApp: {}".format(vapp_name
))
2992 pause_task
= vapp
.undeploy(action
='suspend')
2993 result
= self
.client
.get_task_monitor().wait_for_success(task
=pause_task
)
2994 self
.instance_actions_result("pause", result
, vapp_name
)
2995 elif "resume" in action_dict
:
2996 self
.logger
.info("action_vminstance: resume vApp: {}".format(vapp_name
))
2997 poweron_task
= self
.power_on_vapp(vm__vim_uuid
, vapp_name
)
2998 result
= self
.client
.get_task_monitor().wait_for_success(task
=poweron_task
)
2999 self
.instance_actions_result("resume", result
, vapp_name
)
3000 elif "shutoff" in action_dict
or "shutdown" in action_dict
:
3001 action_name
, value
= action_dict
.items()[0]
3003 #action_name , value = list(action_dict.items())[0]
3004 self
.logger
.info("action_vminstance: {} vApp: {}".format(action_name
, vapp_name
))
3005 shutdown_task
= vapp
.shutdown()
3006 result
= self
.client
.get_task_monitor().wait_for_success(task
=shutdown_task
)
3007 if action_name
== "shutdown":
3008 self
.instance_actions_result("shutdown", result
, vapp_name
)
3010 self
.instance_actions_result("shutoff", result
, vapp_name
)
3011 elif "forceOff" in action_dict
:
3012 result
= vapp
.undeploy(action
='powerOff')
3013 self
.instance_actions_result("forceOff", result
, vapp_name
)
3014 elif "reboot" in action_dict
:
3015 self
.logger
.info("action_vminstance: reboot vApp: {}".format(vapp_name
))
3016 reboot_task
= vapp
.reboot()
3017 self
.client
.get_task_monitor().wait_for_success(task
=reboot_task
)
3019 raise vimconn
.vimconnException("action_vminstance: Invalid action {} or action is None.".format(action_dict
))
3021 except Exception as exp
:
3022 self
.logger
.debug("action_vminstance: Failed with Exception {}".format(exp
))
3023 raise vimconn
.vimconnException("action_vminstance: Failed with Exception {}".format(exp
))
3025 def instance_actions_result(self
, action
, result
, vapp_name
):
3026 if result
.get('status') == 'success':
3027 self
.logger
.info("action_vminstance: Sucessfully {} the vApp: {}".format(action
, vapp_name
))
3029 self
.logger
.error("action_vminstance: Failed to {} vApp: {}".format(action
, vapp_name
))
3031 def get_vminstance_console(self
, vm_id
, console_type
="vnc"):
3033 Get a console for the virtual machine
3035 vm_id: uuid of the VM
3036 console_type, can be:
3037 "novnc" (by default), "xvpvnc" for VNC types,
3038 "rdp-html5" for RDP types, "spice-html5" for SPICE types
3039 Returns dict with the console parameters:
3040 protocol: ssh, ftp, http, https, ...
3041 server: usually ip address
3042 port: the http, ssh, ... port
3043 suffix: extra text, e.g. the http path and query string
3045 raise vimconn
.vimconnNotImplemented("Should have implemented this")
3047 # NOT USED METHODS in current version
3049 def host_vim2gui(self
, host
, server_dict
):
3050 """Transform host dictionary from VIM format to GUI format,
3051 and append to the server_dict
3053 raise vimconn
.vimconnNotImplemented("Should have implemented this")
3055 def get_hosts_info(self
):
3056 """Get the information of deployed hosts
3057 Returns the hosts content"""
3058 raise vimconn
.vimconnNotImplemented("Should have implemented this")
3060 def get_hosts(self
, vim_tenant
):
3061 """Get the hosts and deployed instances
3062 Returns the hosts content"""
3063 raise vimconn
.vimconnNotImplemented("Should have implemented this")
3065 def get_processor_rankings(self
):
3066 """Get the processor rankings in the VIM database"""
3067 raise vimconn
.vimconnNotImplemented("Should have implemented this")
3069 def new_host(self
, host_data
):
3070 """Adds a new host to VIM"""
3071 '''Returns status code of the VIM response'''
3072 raise vimconn
.vimconnNotImplemented("Should have implemented this")
3074 def new_external_port(self
, port_data
):
3075 """Adds a external port to VIM"""
3076 '''Returns the port identifier'''
3077 raise vimconn
.vimconnNotImplemented("Should have implemented this")
3079 def new_external_network(self
, net_name
, net_type
):
3080 """Adds a external network to VIM (shared)"""
3081 '''Returns the network identifier'''
3082 raise vimconn
.vimconnNotImplemented("Should have implemented this")
3084 def connect_port_network(self
, port_id
, network_id
, admin
=False):
3085 """Connects a external port to a network"""
3086 '''Returns status code of the VIM response'''
3087 raise vimconn
.vimconnNotImplemented("Should have implemented this")
3089 def new_vminstancefromJSON(self
, vm_data
):
3090 """Adds a VM instance to VIM"""
3091 '''Returns the instance identifier'''
3092 raise vimconn
.vimconnNotImplemented("Should have implemented this")
3094 def get_network_name_by_id(self
, network_uuid
=None):
3095 """Method gets vcloud director network named based on supplied uuid.
3098 network_uuid: network_id
3101 The return network name.
3104 if not network_uuid
:
3108 org_dict
= self
.get_org(self
.org_uuid
)
3109 if 'networks' in org_dict
:
3110 org_network_dict
= org_dict
['networks']
3111 for net_uuid
in org_network_dict
:
3112 if net_uuid
== network_uuid
:
3113 return org_network_dict
[net_uuid
]
3115 self
.logger
.debug("Exception in get_network_name_by_id")
3116 self
.logger
.debug(traceback
.format_exc())
3120 def get_network_id_by_name(self
, network_name
=None):
3121 """Method gets vcloud director network uuid based on supplied name.
3124 network_name: network_name
3126 The return network uuid.
3127 network_uuid: network_id
3130 if not network_name
:
3131 self
.logger
.debug("get_network_id_by_name() : Network name is empty")
3135 org_dict
= self
.get_org(self
.org_uuid
)
3136 if org_dict
and 'networks' in org_dict
:
3137 org_network_dict
= org_dict
['networks']
3138 for net_uuid
,net_name
in org_network_dict
.iteritems():
3140 #for net_uuid,net_name in org_network_dict.items():
3141 if net_name
== network_name
:
3144 except KeyError as exp
:
3145 self
.logger
.debug("get_network_id_by_name() : KeyError- {} ".format(exp
))
3149 def list_org_action(self
):
3151 Method leverages vCloud director and query for available organization for particular user
3154 vca - is active VCA connection.
3155 vdc_name - is a vdc name that will be used to query vms action
3158 The return XML respond
3160 url_list
= [self
.url
, '/api/org']
3161 vm_list_rest_call
= ''.join(url_list
)
3163 if self
.client
._session
:
3164 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
3165 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
3167 response
= self
.perform_request(req_type
='GET',
3168 url
=vm_list_rest_call
,
3171 if response
.status_code
== 403:
3172 response
= self
.retry_rest('GET', vm_list_rest_call
)
3174 if response
.status_code
== requests
.codes
.ok
:
3175 return response
.content
3179 def get_org_action(self
, org_uuid
=None):
3181 Method leverages vCloud director and retrieve available object for organization.
3184 org_uuid - vCD organization uuid
3185 self.client - is active connection.
3188 The return XML respond
3191 if org_uuid
is None:
3194 url_list
= [self
.url
, '/api/org/', org_uuid
]
3195 vm_list_rest_call
= ''.join(url_list
)
3197 if self
.client
._session
:
3198 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
3199 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
3201 #response = requests.get(vm_list_rest_call, headers=headers, verify=False)
3202 response
= self
.perform_request(req_type
='GET',
3203 url
=vm_list_rest_call
,
3205 if response
.status_code
== 403:
3206 response
= self
.retry_rest('GET', vm_list_rest_call
)
3208 if response
.status_code
== requests
.codes
.ok
:
3209 return response
.content
3212 def get_org(self
, org_uuid
=None):
3214 Method retrieves available organization in vCloud Director
3217 org_uuid - is a organization uuid.
3220 The return dictionary with following key
3221 "network" - for network list under the org
3222 "catalogs" - for network list under the org
3223 "vdcs" - for vdc list under org
3228 if org_uuid
is None:
3231 content
= self
.get_org_action(org_uuid
=org_uuid
)
3236 vm_list_xmlroot
= XmlElementTree
.fromstring(content
)
3237 for child
in vm_list_xmlroot
:
3238 if child
.attrib
['type'] == 'application/vnd.vmware.vcloud.vdc+xml':
3239 vdc_list
[child
.attrib
['href'].split("/")[-1:][0]] = child
.attrib
['name']
3240 org_dict
['vdcs'] = vdc_list
3241 if child
.attrib
['type'] == 'application/vnd.vmware.vcloud.orgNetwork+xml':
3242 network_list
[child
.attrib
['href'].split("/")[-1:][0]] = child
.attrib
['name']
3243 org_dict
['networks'] = network_list
3244 if child
.attrib
['type'] == 'application/vnd.vmware.vcloud.catalog+xml':
3245 catalog_list
[child
.attrib
['href'].split("/")[-1:][0]] = child
.attrib
['name']
3246 org_dict
['catalogs'] = catalog_list
3252 def get_org_list(self
):
3254 Method retrieves available organization in vCloud Director
3257 vca - is active VCA connection.
3260 The return dictionary and key for each entry VDC UUID
3265 content
= self
.list_org_action()
3267 vm_list_xmlroot
= XmlElementTree
.fromstring(content
)
3268 for vm_xml
in vm_list_xmlroot
:
3269 if vm_xml
.tag
.split("}")[1] == 'Org':
3270 org_uuid
= vm_xml
.attrib
['href'].split('/')[-1:]
3271 org_dict
[org_uuid
[0]] = vm_xml
.attrib
['name']
3277 def vms_view_action(self
, vdc_name
=None):
3278 """ Method leverages vCloud director vms query call
3281 vca - is active VCA connection.
3282 vdc_name - is a vdc name that will be used to query vms action
3285 The return XML respond
3287 vca
= self
.connect()
3288 if vdc_name
is None:
3291 url_list
= [vca
.host
, '/api/vms/query']
3292 vm_list_rest_call
= ''.join(url_list
)
3294 if not (not vca
.vcloud_session
or not vca
.vcloud_session
.organization
):
3295 refs
= filter(lambda ref
: ref
.name
== vdc_name
and ref
.type_
== 'application/vnd.vmware.vcloud.vdc+xml',
3296 vca
.vcloud_session
.organization
.Link
)
3298 #refs = [ref for ref in vca.vcloud_session.organization.Link if ref.name == vdc_name and\
3299 # ref.type_ == 'application/vnd.vmware.vcloud.vdc+xml']
3301 response
= Http
.get(url
=vm_list_rest_call
,
3302 headers
=vca
.vcloud_session
.get_vcloud_headers(),
3305 if response
.status_code
== requests
.codes
.ok
:
3306 return response
.content
3310 def get_vapp_list(self
, vdc_name
=None):
3312 Method retrieves vApp list deployed vCloud director and returns a dictionary
3313 contains a list of all vapp deployed for queried VDC.
3314 The key for a dictionary is vApp UUID
3318 vca - is active VCA connection.
3319 vdc_name - is a vdc name that will be used to query vms action
3322 The return dictionary and key for each entry vapp UUID
3326 if vdc_name
is None:
3329 content
= self
.vms_view_action(vdc_name
=vdc_name
)
3331 vm_list_xmlroot
= XmlElementTree
.fromstring(content
)
3332 for vm_xml
in vm_list_xmlroot
:
3333 if vm_xml
.tag
.split("}")[1] == 'VMRecord':
3334 if vm_xml
.attrib
['isVAppTemplate'] == 'true':
3335 rawuuid
= vm_xml
.attrib
['container'].split('/')[-1:]
3336 if 'vappTemplate-' in rawuuid
[0]:
3337 # vm in format vappTemplate-e63d40e7-4ff5-4c6d-851f-96c1e4da86a5 we remove
3338 # vm and use raw UUID as key
3339 vapp_dict
[rawuuid
[0][13:]] = vm_xml
.attrib
3345 def get_vm_list(self
, vdc_name
=None):
3347 Method retrieves VM's list deployed vCloud director. It returns a dictionary
3348 contains a list of all VM's deployed for queried VDC.
3349 The key for a dictionary is VM UUID
3353 vca - is active VCA connection.
3354 vdc_name - is a vdc name that will be used to query vms action
3357 The return dictionary and key for each entry vapp UUID
3361 if vdc_name
is None:
3364 content
= self
.vms_view_action(vdc_name
=vdc_name
)
3366 vm_list_xmlroot
= XmlElementTree
.fromstring(content
)
3367 for vm_xml
in vm_list_xmlroot
:
3368 if vm_xml
.tag
.split("}")[1] == 'VMRecord':
3369 if vm_xml
.attrib
['isVAppTemplate'] == 'false':
3370 rawuuid
= vm_xml
.attrib
['href'].split('/')[-1:]
3371 if 'vm-' in rawuuid
[0]:
3372 # vm in format vm-e63d40e7-4ff5-4c6d-851f-96c1e4da86a5 we remove
3373 # vm and use raw UUID as key
3374 vm_dict
[rawuuid
[0][3:]] = vm_xml
.attrib
3380 def get_vapp(self
, vdc_name
=None, vapp_name
=None, isuuid
=False):
3382 Method retrieves VM deployed vCloud director. It returns VM attribute as dictionary
3383 contains a list of all VM's deployed for queried VDC.
3384 The key for a dictionary is VM UUID
3388 vca - is active VCA connection.
3389 vdc_name - is a vdc name that will be used to query vms action
3392 The return dictionary and key for each entry vapp UUID
3395 vca
= self
.connect()
3397 raise vimconn
.vimconnConnectionException("self.connect() is failed")
3399 if vdc_name
is None:
3402 content
= self
.vms_view_action(vdc_name
=vdc_name
)
3404 vm_list_xmlroot
= XmlElementTree
.fromstring(content
)
3405 for vm_xml
in vm_list_xmlroot
:
3406 if vm_xml
.tag
.split("}")[1] == 'VMRecord' and vm_xml
.attrib
['isVAppTemplate'] == 'false':
3407 # lookup done by UUID
3409 if vapp_name
in vm_xml
.attrib
['container']:
3410 rawuuid
= vm_xml
.attrib
['href'].split('/')[-1:]
3411 if 'vm-' in rawuuid
[0]:
3412 vm_dict
[rawuuid
[0][3:]] = vm_xml
.attrib
3414 # lookup done by Name
3416 if vapp_name
in vm_xml
.attrib
['name']:
3417 rawuuid
= vm_xml
.attrib
['href'].split('/')[-1:]
3418 if 'vm-' in rawuuid
[0]:
3419 vm_dict
[rawuuid
[0][3:]] = vm_xml
.attrib
3426 def get_network_action(self
, network_uuid
=None):
3428 Method leverages vCloud director and query network based on network uuid
3431 vca - is active VCA connection.
3432 network_uuid - is a network uuid
3435 The return XML respond
3438 if network_uuid
is None:
3441 url_list
= [self
.url
, '/api/network/', network_uuid
]
3442 vm_list_rest_call
= ''.join(url_list
)
3444 if self
.client
._session
:
3445 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
3446 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
3448 response
= self
.perform_request(req_type
='GET',
3449 url
=vm_list_rest_call
,
3451 #Retry login if session expired & retry sending request
3452 if response
.status_code
== 403:
3453 response
= self
.retry_rest('GET', vm_list_rest_call
)
3455 if response
.status_code
== requests
.codes
.ok
:
3456 return response
.content
3460 def get_vcd_network(self
, network_uuid
=None):
3462 Method retrieves available network from vCloud Director
3465 network_uuid - is VCD network UUID
3467 Each element serialized as key : value pair
3469 Following keys available for access. network_configuration['Gateway'}
3473 <IsInherited>true</IsInherited>
3474 <Gateway>172.16.252.100</Gateway>
3475 <Netmask>255.255.255.0</Netmask>
3476 <Dns1>172.16.254.201</Dns1>
3477 <Dns2>172.16.254.202</Dns2>
3478 <DnsSuffix>vmwarelab.edu</DnsSuffix>
3479 <IsEnabled>true</IsEnabled>
3482 <StartAddress>172.16.252.1</StartAddress>
3483 <EndAddress>172.16.252.99</EndAddress>
3488 <FenceMode>bridged</FenceMode>
3491 The return dictionary and key for each entry vapp UUID
3494 network_configuration
= {}
3495 if network_uuid
is None:
3499 content
= self
.get_network_action(network_uuid
=network_uuid
)
3500 vm_list_xmlroot
= XmlElementTree
.fromstring(content
)
3502 network_configuration
['status'] = vm_list_xmlroot
.get("status")
3503 network_configuration
['name'] = vm_list_xmlroot
.get("name")
3504 network_configuration
['uuid'] = vm_list_xmlroot
.get("id").split(":")[3]
3506 for child
in vm_list_xmlroot
:
3507 if child
.tag
.split("}")[1] == 'IsShared':
3508 network_configuration
['isShared'] = child
.text
.strip()
3509 if child
.tag
.split("}")[1] == 'Configuration':
3510 for configuration
in child
.iter():
3511 tagKey
= configuration
.tag
.split("}")[1].strip()
3513 network_configuration
[tagKey
] = configuration
.text
.strip()
3514 return network_configuration
3515 except Exception as exp
:
3516 self
.logger
.debug("get_vcd_network: Failed with Exception {}".format(exp
))
3517 raise vimconn
.vimconnException("get_vcd_network: Failed with Exception {}".format(exp
))
3519 return network_configuration
3521 def delete_network_action(self
, network_uuid
=None):
3523 Method delete given network from vCloud director
3526 network_uuid - is a network uuid that client wish to delete
3529 The return None or XML respond or false
3531 client
= self
.connect_as_admin()
3533 raise vimconn
.vimconnConnectionException("Failed to connect vCD as admin")
3534 if network_uuid
is None:
3537 url_list
= [self
.url
, '/api/admin/network/', network_uuid
]
3538 vm_list_rest_call
= ''.join(url_list
)
3541 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
3542 'x-vcloud-authorization': client
._session
.headers
['x-vcloud-authorization']}
3543 response
= self
.perform_request(req_type
='DELETE',
3544 url
=vm_list_rest_call
,
3546 if response
.status_code
== 202:
3551 def create_network(self
, network_name
=None, net_type
='bridge', parent_network_uuid
=None,
3552 ip_profile
=None, isshared
='true'):
3554 Method create network in vCloud director
3557 network_name - is network name to be created.
3558 net_type - can be 'bridge','data','ptp','mgmt'.
3559 ip_profile is a dict containing the IP parameters of the network
3560 isshared - is a boolean
3561 parent_network_uuid - is parent provider vdc network that will be used for mapping.
3562 It optional attribute. by default if no parent network indicate the first available will be used.
3565 The return network uuid or return None
3568 new_network_name
= [network_name
, '-', str(uuid
.uuid4())]
3569 content
= self
.create_network_rest(network_name
=''.join(new_network_name
),
3570 ip_profile
=ip_profile
,
3572 parent_network_uuid
=parent_network_uuid
,
3575 self
.logger
.debug("Failed create network {}.".format(network_name
))
3579 vm_list_xmlroot
= XmlElementTree
.fromstring(content
)
3580 vcd_uuid
= vm_list_xmlroot
.get('id').split(":")
3581 if len(vcd_uuid
) == 4:
3582 self
.logger
.info("Created new network name: {} uuid: {}".format(network_name
, vcd_uuid
[3]))
3585 self
.logger
.debug("Failed create network {}".format(network_name
))
3588 def create_network_rest(self
, network_name
=None, net_type
='bridge', parent_network_uuid
=None,
3589 ip_profile
=None, isshared
='true'):
3591 Method create network in vCloud director
3594 network_name - is network name to be created.
3595 net_type - can be 'bridge','data','ptp','mgmt'.
3596 ip_profile is a dict containing the IP parameters of the network
3597 isshared - is a boolean
3598 parent_network_uuid - is parent provider vdc network that will be used for mapping.
3599 It optional attribute. by default if no parent network indicate the first available will be used.
3602 The return network uuid or return None
3604 client_as_admin
= self
.connect_as_admin()
3605 if not client_as_admin
:
3606 raise vimconn
.vimconnConnectionException("Failed to connect vCD.")
3607 if network_name
is None:
3610 url_list
= [self
.url
, '/api/admin/vdc/', self
.tenant_id
]
3611 vm_list_rest_call
= ''.join(url_list
)
3613 if client_as_admin
._session
:
3614 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
3615 'x-vcloud-authorization': client_as_admin
._session
.headers
['x-vcloud-authorization']}
3617 response
= self
.perform_request(req_type
='GET',
3618 url
=vm_list_rest_call
,
3621 provider_network
= None
3622 available_networks
= None
3623 add_vdc_rest_url
= None
3625 if response
.status_code
!= requests
.codes
.ok
:
3626 self
.logger
.debug("REST API call {} failed. Return status code {}".format(vm_list_rest_call
,
3627 response
.status_code
))
3631 vm_list_xmlroot
= XmlElementTree
.fromstring(response
.content
)
3632 for child
in vm_list_xmlroot
:
3633 if child
.tag
.split("}")[1] == 'ProviderVdcReference':
3634 provider_network
= child
.attrib
.get('href')
3635 # application/vnd.vmware.admin.providervdc+xml
3636 if child
.tag
.split("}")[1] == 'Link':
3637 if child
.attrib
.get('type') == 'application/vnd.vmware.vcloud.orgVdcNetwork+xml' \
3638 and child
.attrib
.get('rel') == 'add':
3639 add_vdc_rest_url
= child
.attrib
.get('href')
3641 self
.logger
.debug("Failed parse respond for rest api call {}".format(vm_list_rest_call
))
3642 self
.logger
.debug("Respond body {}".format(response
.content
))
3645 # find pvdc provided available network
3646 response
= self
.perform_request(req_type
='GET',
3647 url
=provider_network
,
3649 if response
.status_code
!= requests
.codes
.ok
:
3650 self
.logger
.debug("REST API call {} failed. Return status code {}".format(vm_list_rest_call
,
3651 response
.status_code
))
3654 if parent_network_uuid
is None:
3656 vm_list_xmlroot
= XmlElementTree
.fromstring(response
.content
)
3657 for child
in vm_list_xmlroot
.iter():
3658 if child
.tag
.split("}")[1] == 'AvailableNetworks':
3659 for networks
in child
.iter():
3660 # application/vnd.vmware.admin.network+xml
3661 if networks
.attrib
.get('href') is not None:
3662 available_networks
= networks
.attrib
.get('href')
3668 #Configure IP profile of the network
3669 ip_profile
= ip_profile
if ip_profile
is not None else DEFAULT_IP_PROFILE
3671 if 'subnet_address' not in ip_profile
or ip_profile
['subnet_address'] is None:
3672 subnet_rand
= random
.randint(0, 255)
3673 ip_base
= "192.168.{}.".format(subnet_rand
)
3674 ip_profile
['subnet_address'] = ip_base
+ "0/24"
3676 ip_base
= ip_profile
['subnet_address'].rsplit('.',1)[0] + '.'
3678 if 'gateway_address' not in ip_profile
or ip_profile
['gateway_address'] is None:
3679 ip_profile
['gateway_address']=ip_base
+ "1"
3680 if 'dhcp_count' not in ip_profile
or ip_profile
['dhcp_count'] is None:
3681 ip_profile
['dhcp_count']=DEFAULT_IP_PROFILE
['dhcp_count']
3682 if 'dhcp_enabled' not in ip_profile
or ip_profile
['dhcp_enabled'] is None:
3683 ip_profile
['dhcp_enabled']=DEFAULT_IP_PROFILE
['dhcp_enabled']
3684 if 'dhcp_start_address' not in ip_profile
or ip_profile
['dhcp_start_address'] is None:
3685 ip_profile
['dhcp_start_address']=ip_base
+ "3"
3686 if 'ip_version' not in ip_profile
or ip_profile
['ip_version'] is None:
3687 ip_profile
['ip_version']=DEFAULT_IP_PROFILE
['ip_version']
3688 if 'dns_address' not in ip_profile
or ip_profile
['dns_address'] is None:
3689 ip_profile
['dns_address']=ip_base
+ "2"
3691 gateway_address
=ip_profile
['gateway_address']
3692 dhcp_count
=int(ip_profile
['dhcp_count'])
3693 subnet_address
=self
.convert_cidr_to_netmask(ip_profile
['subnet_address'])
3695 if ip_profile
['dhcp_enabled']==True:
3698 dhcp_enabled
='false'
3699 dhcp_start_address
=ip_profile
['dhcp_start_address']
3701 #derive dhcp_end_address from dhcp_start_address & dhcp_count
3702 end_ip_int
= int(netaddr
.IPAddress(dhcp_start_address
))
3703 end_ip_int
+= dhcp_count
- 1
3704 dhcp_end_address
= str(netaddr
.IPAddress(end_ip_int
))
3706 ip_version
=ip_profile
['ip_version']
3707 dns_address
=ip_profile
['dns_address']
3708 except KeyError as exp
:
3709 self
.logger
.debug("Create Network REST: Key error {}".format(exp
))
3710 raise vimconn
.vimconnException("Create Network REST: Key error{}".format(exp
))
3712 # either use client provided UUID or search for a first available
3713 # if both are not defined we return none
3714 if parent_network_uuid
is not None:
3715 url_list
= [self
.url
, '/api/admin/network/', parent_network_uuid
]
3716 add_vdc_rest_url
= ''.join(url_list
)
3718 #Creating all networks as Direct Org VDC type networks.
3719 #Unused in case of Underlay (data/ptp) network interface.
3720 fence_mode
="bridged"
3721 is_inherited
='false'
3722 dns_list
= dns_address
.split(";")
3725 if len(dns_list
) >= 2:
3726 dns2_text
= "\n <Dns2>{}</Dns2>\n".format(dns_list
[1])
3727 data
= """ <OrgVdcNetwork name="{0:s}" xmlns="http://www.vmware.com/vcloud/v1.5">
3728 <Description>Openmano created</Description>
3732 <IsInherited>{1:s}</IsInherited>
3733 <Gateway>{2:s}</Gateway>
3734 <Netmask>{3:s}</Netmask>
3735 <Dns1>{4:s}</Dns1>{5:s}
3736 <IsEnabled>{6:s}</IsEnabled>
3739 <StartAddress>{7:s}</StartAddress>
3740 <EndAddress>{8:s}</EndAddress>
3745 <ParentNetwork href="{9:s}"/>
3746 <FenceMode>{10:s}</FenceMode>
3748 <IsShared>{11:s}</IsShared>
3749 </OrgVdcNetwork> """.format(escape(network_name
), is_inherited
, gateway_address
,
3750 subnet_address
, dns1
, dns2_text
, dhcp_enabled
,
3751 dhcp_start_address
, dhcp_end_address
, available_networks
,
3752 fence_mode
, isshared
)
3754 headers
['Content-Type'] = 'application/vnd.vmware.vcloud.orgVdcNetwork+xml'
3756 response
= self
.perform_request(req_type
='POST',
3757 url
=add_vdc_rest_url
,
3761 if response
.status_code
!= 201:
3762 self
.logger
.debug("Create Network POST REST API call failed. Return status code {}, Response content: {}"
3763 .format(response
.status_code
,response
.content
))
3765 network_task
= self
.get_task_from_response(response
.content
)
3766 self
.logger
.debug("Create Network REST : Waiting for Network creation complete")
3768 result
= self
.client
.get_task_monitor().wait_for_success(task
=network_task
)
3769 if result
.get('status') == 'success':
3770 return response
.content
3772 self
.logger
.debug("create_network_rest task failed. Network Create response : {}"
3773 .format(response
.content
))
3774 except Exception as exp
:
3775 self
.logger
.debug("create_network_rest : Exception : {} ".format(exp
))
3779 def convert_cidr_to_netmask(self
, cidr_ip
=None):
3781 Method sets convert CIDR netmask address to normal IP format
3783 cidr_ip : CIDR IP address
3785 netmask : Converted netmask
3787 if cidr_ip
is not None:
3789 network
, net_bits
= cidr_ip
.split('/')
3790 netmask
= socket
.inet_ntoa(struct
.pack(">I", (0xffffffff << (32 - int(net_bits
))) & 0xffffffff))
3796 def get_provider_rest(self
, vca
=None):
3798 Method gets provider vdc view from vcloud director
3801 network_name - is network name to be created.
3802 parent_network_uuid - is parent provider vdc network that will be used for mapping.
3803 It optional attribute. by default if no parent network indicate the first available will be used.
3806 The return xml content of respond or None
3809 url_list
= [self
.url
, '/api/admin']
3811 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
3812 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
3813 response
= self
.perform_request(req_type
='GET',
3814 url
=''.join(url_list
),
3817 if response
.status_code
== requests
.codes
.ok
:
3818 return response
.content
3821 def create_vdc(self
, vdc_name
=None):
3825 xml_content
= self
.create_vdc_from_tmpl_rest(vdc_name
=vdc_name
)
3826 if xml_content
is not None:
3828 task_resp_xmlroot
= XmlElementTree
.fromstring(xml_content
)
3829 for child
in task_resp_xmlroot
:
3830 if child
.tag
.split("}")[1] == 'Owner':
3831 vdc_id
= child
.attrib
.get('href').split("/")[-1]
3832 vdc_dict
[vdc_id
] = task_resp_xmlroot
.get('href')
3835 self
.logger
.debug("Respond body {}".format(xml_content
))
3839 def create_vdc_from_tmpl_rest(self
, vdc_name
=None):
3841 Method create vdc in vCloud director based on VDC template.
3842 it uses pre-defined template.
3845 vdc_name - name of a new vdc.
3848 The return xml content of respond or None
3850 # pre-requesite atleast one vdc template should be available in vCD
3851 self
.logger
.info("Creating new vdc {}".format(vdc_name
))
3852 vca
= self
.connect_as_admin()
3854 raise vimconn
.vimconnConnectionException("Failed to connect vCD")
3855 if vdc_name
is None:
3858 url_list
= [self
.url
, '/api/vdcTemplates']
3859 vm_list_rest_call
= ''.join(url_list
)
3861 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
3862 'x-vcloud-authorization': vca
._session
.headers
['x-vcloud-authorization']}
3863 response
= self
.perform_request(req_type
='GET',
3864 url
=vm_list_rest_call
,
3867 # container url to a template
3868 vdc_template_ref
= None
3870 vm_list_xmlroot
= XmlElementTree
.fromstring(response
.content
)
3871 for child
in vm_list_xmlroot
:
3872 # application/vnd.vmware.admin.providervdc+xml
3873 # we need find a template from witch we instantiate VDC
3874 if child
.tag
.split("}")[1] == 'VdcTemplate':
3875 if child
.attrib
.get('type') == 'application/vnd.vmware.admin.vdcTemplate+xml':
3876 vdc_template_ref
= child
.attrib
.get('href')
3878 self
.logger
.debug("Failed parse respond for rest api call {}".format(vm_list_rest_call
))
3879 self
.logger
.debug("Respond body {}".format(response
.content
))
3882 # if we didn't found required pre defined template we return None
3883 if vdc_template_ref
is None:
3888 url_list
= [self
.url
, '/api/org/', self
.org_uuid
, '/action/instantiate']
3889 vm_list_rest_call
= ''.join(url_list
)
3890 data
= """<InstantiateVdcTemplateParams name="{0:s}" xmlns="http://www.vmware.com/vcloud/v1.5">
3891 <Source href="{1:s}"></Source>
3892 <Description>opnemano</Description>
3893 </InstantiateVdcTemplateParams>""".format(vdc_name
, vdc_template_ref
)
3895 headers
['Content-Type'] = 'application/vnd.vmware.vcloud.instantiateVdcTemplateParams+xml'
3897 response
= self
.perform_request(req_type
='POST',
3898 url
=vm_list_rest_call
,
3902 vdc_task
= self
.get_task_from_response(response
.content
)
3903 self
.client
.get_task_monitor().wait_for_success(task
=vdc_task
)
3905 # if we all ok we respond with content otherwise by default None
3906 if response
.status_code
>= 200 and response
.status_code
< 300:
3907 return response
.content
3910 self
.logger
.debug("Failed parse respond for rest api call {}".format(vm_list_rest_call
))
3911 self
.logger
.debug("Respond body {}".format(response
.content
))
3915 def create_vdc_rest(self
, vdc_name
=None):
3917 Method create network in vCloud director
3920 vdc_name - vdc name to be created
3925 self
.logger
.info("Creating new vdc {}".format(vdc_name
))
3927 vca
= self
.connect_as_admin()
3929 raise vimconn
.vimconnConnectionException("Failed to connect vCD")
3930 if vdc_name
is None:
3933 url_list
= [self
.url
, '/api/admin/org/', self
.org_uuid
]
3934 vm_list_rest_call
= ''.join(url_list
)
3937 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
3938 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
3939 response
= self
.perform_request(req_type
='GET',
3940 url
=vm_list_rest_call
,
3943 provider_vdc_ref
= None
3944 add_vdc_rest_url
= None
3945 available_networks
= None
3947 if response
.status_code
!= requests
.codes
.ok
:
3948 self
.logger
.debug("REST API call {} failed. Return status code {}".format(vm_list_rest_call
,
3949 response
.status_code
))
3953 vm_list_xmlroot
= XmlElementTree
.fromstring(response
.content
)
3954 for child
in vm_list_xmlroot
:
3955 # application/vnd.vmware.admin.providervdc+xml
3956 if child
.tag
.split("}")[1] == 'Link':
3957 if child
.attrib
.get('type') == 'application/vnd.vmware.admin.createVdcParams+xml' \
3958 and child
.attrib
.get('rel') == 'add':
3959 add_vdc_rest_url
= child
.attrib
.get('href')
3961 self
.logger
.debug("Failed parse respond for rest api call {}".format(vm_list_rest_call
))
3962 self
.logger
.debug("Respond body {}".format(response
.content
))
3965 response
= self
.get_provider_rest(vca
=vca
)
3967 vm_list_xmlroot
= XmlElementTree
.fromstring(response
)
3968 for child
in vm_list_xmlroot
:
3969 if child
.tag
.split("}")[1] == 'ProviderVdcReferences':
3970 for sub_child
in child
:
3971 provider_vdc_ref
= sub_child
.attrib
.get('href')
3973 self
.logger
.debug("Failed parse respond for rest api call {}".format(vm_list_rest_call
))
3974 self
.logger
.debug("Respond body {}".format(response
))
3977 if add_vdc_rest_url
is not None and provider_vdc_ref
is not None:
3978 data
= """ <CreateVdcParams name="{0:s}" xmlns="http://www.vmware.com/vcloud/v1.5"><Description>{1:s}</Description>
3979 <AllocationModel>ReservationPool</AllocationModel>
3980 <ComputeCapacity><Cpu><Units>MHz</Units><Allocated>2048</Allocated><Limit>2048</Limit></Cpu>
3981 <Memory><Units>MB</Units><Allocated>2048</Allocated><Limit>2048</Limit></Memory>
3982 </ComputeCapacity><NicQuota>0</NicQuota><NetworkQuota>100</NetworkQuota>
3983 <VdcStorageProfile><Enabled>true</Enabled><Units>MB</Units><Limit>20480</Limit><Default>true</Default></VdcStorageProfile>
3984 <ProviderVdcReference
3985 name="Main Provider"
3987 <UsesFastProvisioning>true</UsesFastProvisioning></CreateVdcParams>""".format(escape(vdc_name
),
3991 headers
['Content-Type'] = 'application/vnd.vmware.admin.createVdcParams+xml'
3993 response
= self
.perform_request(req_type
='POST',
3994 url
=add_vdc_rest_url
,
3998 # if we all ok we respond with content otherwise by default None
3999 if response
.status_code
== 201:
4000 return response
.content
4003 def get_vapp_details_rest(self
, vapp_uuid
=None, need_admin_access
=False):
4005 Method retrieve vapp detail from vCloud director
4008 vapp_uuid - is vapp identifier.
4011 The return network uuid or return None
4017 if need_admin_access
:
4018 vca
= self
.connect_as_admin()
4023 raise vimconn
.vimconnConnectionException("Failed to connect vCD")
4024 if vapp_uuid
is None:
4027 url_list
= [self
.url
, '/api/vApp/vapp-', vapp_uuid
]
4028 get_vapp_restcall
= ''.join(url_list
)
4031 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
4032 'x-vcloud-authorization': vca
._session
.headers
['x-vcloud-authorization']}
4033 response
= self
.perform_request(req_type
='GET',
4034 url
=get_vapp_restcall
,
4037 if response
.status_code
== 403:
4038 if need_admin_access
== False:
4039 response
= self
.retry_rest('GET', get_vapp_restcall
)
4041 if response
.status_code
!= requests
.codes
.ok
:
4042 self
.logger
.debug("REST API call {} failed. Return status code {}".format(get_vapp_restcall
,
4043 response
.status_code
))
4044 return parsed_respond
4047 xmlroot_respond
= XmlElementTree
.fromstring(response
.content
)
4048 parsed_respond
['ovfDescriptorUploaded'] = xmlroot_respond
.attrib
['ovfDescriptorUploaded']
4050 namespaces
= {"vssd":"http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData" ,
4051 'ovf': 'http://schemas.dmtf.org/ovf/envelope/1',
4052 'vmw': 'http://www.vmware.com/schema/ovf',
4053 'vm': 'http://www.vmware.com/vcloud/v1.5',
4054 'rasd':"http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData",
4055 "vmext":"http://www.vmware.com/vcloud/extension/v1.5",
4056 "xmlns":"http://www.vmware.com/vcloud/v1.5"
4059 created_section
= xmlroot_respond
.find('vm:DateCreated', namespaces
)
4060 if created_section
is not None:
4061 parsed_respond
['created'] = created_section
.text
4063 network_section
= xmlroot_respond
.find('vm:NetworkConfigSection/vm:NetworkConfig', namespaces
)
4064 if network_section
is not None and 'networkName' in network_section
.attrib
:
4065 parsed_respond
['networkname'] = network_section
.attrib
['networkName']
4067 ipscopes_section
= \
4068 xmlroot_respond
.find('vm:NetworkConfigSection/vm:NetworkConfig/vm:Configuration/vm:IpScopes',
4070 if ipscopes_section
is not None:
4071 for ipscope
in ipscopes_section
:
4072 for scope
in ipscope
:
4073 tag_key
= scope
.tag
.split("}")[1]
4074 if tag_key
== 'IpRanges':
4075 ip_ranges
= scope
.getchildren()
4076 for ipblock
in ip_ranges
:
4077 for block
in ipblock
:
4078 parsed_respond
[block
.tag
.split("}")[1]] = block
.text
4080 parsed_respond
[tag_key
] = scope
.text
4082 # parse children section for other attrib
4083 children_section
= xmlroot_respond
.find('vm:Children/', namespaces
)
4084 if children_section
is not None:
4085 parsed_respond
['name'] = children_section
.attrib
['name']
4086 parsed_respond
['nestedHypervisorEnabled'] = children_section
.attrib
['nestedHypervisorEnabled'] \
4087 if "nestedHypervisorEnabled" in children_section
.attrib
else None
4088 parsed_respond
['deployed'] = children_section
.attrib
['deployed']
4089 parsed_respond
['status'] = children_section
.attrib
['status']
4090 parsed_respond
['vmuuid'] = children_section
.attrib
['id'].split(":")[-1]
4091 network_adapter
= children_section
.find('vm:NetworkConnectionSection', namespaces
)
4093 for adapters
in network_adapter
:
4094 adapter_key
= adapters
.tag
.split("}")[1]
4095 if adapter_key
== 'PrimaryNetworkConnectionIndex':
4096 parsed_respond
['primarynetwork'] = adapters
.text
4097 if adapter_key
== 'NetworkConnection':
4099 if 'network' in adapters
.attrib
:
4100 vnic
['network'] = adapters
.attrib
['network']
4101 for adapter
in adapters
:
4102 setting_key
= adapter
.tag
.split("}")[1]
4103 vnic
[setting_key
] = adapter
.text
4104 nic_list
.append(vnic
)
4106 for link
in children_section
:
4107 if link
.tag
.split("}")[1] == 'Link' and 'rel' in link
.attrib
:
4108 if link
.attrib
['rel'] == 'screen:acquireTicket':
4109 parsed_respond
['acquireTicket'] = link
.attrib
4110 if link
.attrib
['rel'] == 'screen:acquireMksTicket':
4111 parsed_respond
['acquireMksTicket'] = link
.attrib
4113 parsed_respond
['interfaces'] = nic_list
4114 vCloud_extension_section
= children_section
.find('xmlns:VCloudExtension', namespaces
)
4115 if vCloud_extension_section
is not None:
4116 vm_vcenter_info
= {}
4117 vim_info
= vCloud_extension_section
.find('vmext:VmVimInfo', namespaces
)
4118 vmext
= vim_info
.find('vmext:VmVimObjectRef', namespaces
)
4119 if vmext
is not None:
4120 vm_vcenter_info
["vm_moref_id"] = vmext
.find('vmext:MoRef', namespaces
).text
4121 parsed_respond
["vm_vcenter_info"]= vm_vcenter_info
4123 virtual_hardware_section
= children_section
.find('ovf:VirtualHardwareSection', namespaces
)
4124 vm_virtual_hardware_info
= {}
4125 if virtual_hardware_section
is not None:
4126 for item
in virtual_hardware_section
.iterfind('ovf:Item',namespaces
):
4127 if item
.find("rasd:Description",namespaces
).text
== "Hard disk":
4128 disk_size
= item
.find("rasd:HostResource" ,namespaces
4129 ).attrib
["{"+namespaces
['vm']+"}capacity"]
4131 vm_virtual_hardware_info
["disk_size"]= disk_size
4134 for link
in virtual_hardware_section
:
4135 if link
.tag
.split("}")[1] == 'Link' and 'rel' in link
.attrib
:
4136 if link
.attrib
['rel'] == 'edit' and link
.attrib
['href'].endswith("/disks"):
4137 vm_virtual_hardware_info
["disk_edit_href"] = link
.attrib
['href']
4140 parsed_respond
["vm_virtual_hardware"]= vm_virtual_hardware_info
4141 except Exception as exp
:
4142 self
.logger
.info("Error occurred calling rest api for getting vApp details {}".format(exp
))
4143 return parsed_respond
4145 def acquire_console(self
, vm_uuid
=None):
4149 if self
.client
._session
:
4150 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
4151 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
4152 vm_dict
= self
.get_vapp_details_rest(vapp_uuid
=vm_uuid
)
4153 console_dict
= vm_dict
['acquireTicket']
4154 console_rest_call
= console_dict
['href']
4156 response
= self
.perform_request(req_type
='POST',
4157 url
=console_rest_call
,
4160 if response
.status_code
== 403:
4161 response
= self
.retry_rest('POST', console_rest_call
)
4163 if response
.status_code
== requests
.codes
.ok
:
4164 return response
.content
4168 def modify_vm_disk(self
, vapp_uuid
, flavor_disk
):
4170 Method retrieve vm disk details
4173 vapp_uuid - is vapp identifier.
4174 flavor_disk - disk size as specified in VNFD (flavor)
4177 The return network uuid or return None
4181 #Flavor disk is in GB convert it into MB
4182 flavor_disk
= int(flavor_disk
) * 1024
4183 vm_details
= self
.get_vapp_details_rest(vapp_uuid
)
4185 vm_name
= vm_details
["name"]
4186 self
.logger
.info("VM: {} flavor_disk :{}".format(vm_name
, flavor_disk
))
4188 if vm_details
and "vm_virtual_hardware" in vm_details
:
4189 vm_disk
= int(vm_details
["vm_virtual_hardware"]["disk_size"])
4190 disk_edit_href
= vm_details
["vm_virtual_hardware"]["disk_edit_href"]
4192 self
.logger
.info("VM: {} VM_disk :{}".format(vm_name
, vm_disk
))
4194 if flavor_disk
> vm_disk
:
4195 status
= self
.modify_vm_disk_rest(disk_edit_href
,flavor_disk
)
4196 self
.logger
.info("Modify disk of VM {} from {} to {} MB".format(vm_name
,
4197 vm_disk
, flavor_disk
))
4200 self
.logger
.info("No need to modify disk of VM {}".format(vm_name
))
4203 except Exception as exp
:
4204 self
.logger
.info("Error occurred while modifing disk size {}".format(exp
))
4207 def modify_vm_disk_rest(self
, disk_href
, disk_size
):
4209 Method retrieve modify vm disk size
4212 disk_href - vCD API URL to GET and PUT disk data
4213 disk_size - disk size as specified in VNFD (flavor)
4216 The return network uuid or return None
4218 if disk_href
is None or disk_size
is None:
4221 if self
.client
._session
:
4222 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
4223 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
4224 response
= self
.perform_request(req_type
='GET',
4228 if response
.status_code
== 403:
4229 response
= self
.retry_rest('GET', disk_href
)
4231 if response
.status_code
!= requests
.codes
.ok
:
4232 self
.logger
.debug("GET REST API call {} failed. Return status code {}".format(disk_href
,
4233 response
.status_code
))
4236 lxmlroot_respond
= lxmlElementTree
.fromstring(response
.content
)
4237 namespaces
= {prefix
:uri
for prefix
,uri
in lxmlroot_respond
.nsmap
.iteritems() if prefix
}
4239 #namespaces = {prefix:uri for prefix,uri in lxmlroot_respond.nsmap.items() if prefix}
4240 namespaces
["xmlns"]= "http://www.vmware.com/vcloud/v1.5"
4242 for item
in lxmlroot_respond
.iterfind('xmlns:Item',namespaces
):
4243 if item
.find("rasd:Description",namespaces
).text
== "Hard disk":
4244 disk_item
= item
.find("rasd:HostResource" ,namespaces
)
4245 if disk_item
is not None:
4246 disk_item
.attrib
["{"+namespaces
['xmlns']+"}capacity"] = str(disk_size
)
4249 data
= lxmlElementTree
.tostring(lxmlroot_respond
, encoding
='utf8', method
='xml',
4250 xml_declaration
=True)
4252 #Send PUT request to modify disk size
4253 headers
['Content-Type'] = 'application/vnd.vmware.vcloud.rasdItemsList+xml; charset=ISO-8859-1'
4255 response
= self
.perform_request(req_type
='PUT',
4259 if response
.status_code
== 403:
4260 add_headers
= {'Content-Type': headers
['Content-Type']}
4261 response
= self
.retry_rest('PUT', disk_href
, add_headers
, data
)
4263 if response
.status_code
!= 202:
4264 self
.logger
.debug("PUT REST API call {} failed. Return status code {}".format(disk_href
,
4265 response
.status_code
))
4267 modify_disk_task
= self
.get_task_from_response(response
.content
)
4268 result
= self
.client
.get_task_monitor().wait_for_success(task
=modify_disk_task
)
4269 if result
.get('status') == 'success':
4275 except Exception as exp
:
4276 self
.logger
.info("Error occurred calling rest api for modifing disk size {}".format(exp
))
4279 def add_pci_devices(self
, vapp_uuid
, pci_devices
, vmname_andid
):
4281 Method to attach pci devices to VM
4284 vapp_uuid - uuid of vApp/VM
4285 pci_devices - pci devices infromation as specified in VNFD (flavor)
4288 The status of add pci device task , vm object and
4289 vcenter_conect object
4292 self
.logger
.info("Add pci devices {} into vApp {}".format(pci_devices
, vapp_uuid
))
4293 vcenter_conect
, content
= self
.get_vcenter_content()
4294 vm_moref_id
= self
.get_vm_moref_id(vapp_uuid
)
4298 no_of_pci_devices
= len(pci_devices
)
4299 if no_of_pci_devices
> 0:
4300 #Get VM and its host
4301 host_obj
, vm_obj
= self
.get_vm_obj(content
, vm_moref_id
)
4302 self
.logger
.info("VM {} is currently on host {}".format(vm_obj
, host_obj
))
4303 if host_obj
and vm_obj
:
4304 #get PCI devies from host on which vapp is currently installed
4305 avilable_pci_devices
= self
.get_pci_devices(host_obj
, no_of_pci_devices
)
4307 if avilable_pci_devices
is None:
4308 #find other hosts with active pci devices
4309 new_host_obj
, avilable_pci_devices
= self
.get_host_and_PCIdevices(
4314 if new_host_obj
is not None and avilable_pci_devices
is not None and len(avilable_pci_devices
)> 0:
4315 #Migrate vm to the host where PCI devices are availble
4316 self
.logger
.info("Relocate VM {} on new host {}".format(vm_obj
, new_host_obj
))
4317 task
= self
.relocate_vm(new_host_obj
, vm_obj
)
4318 if task
is not None:
4319 result
= self
.wait_for_vcenter_task(task
, vcenter_conect
)
4320 self
.logger
.info("Migrate VM status: {}".format(result
))
4321 host_obj
= new_host_obj
4323 self
.logger
.info("Fail to migrate VM : {}".format(result
))
4324 raise vimconn
.vimconnNotFoundException(
4325 "Fail to migrate VM : {} to host {}".format(
4330 if host_obj
is not None and avilable_pci_devices
is not None and len(avilable_pci_devices
)> 0:
4331 #Add PCI devices one by one
4332 for pci_device
in avilable_pci_devices
:
4333 task
= self
.add_pci_to_vm(host_obj
, vm_obj
, pci_device
)
4335 status
= self
.wait_for_vcenter_task(task
, vcenter_conect
)
4337 self
.logger
.info("Added PCI device {} to VM {}".format(pci_device
,str(vm_obj
)))
4339 self
.logger
.error("Fail to add PCI device {} to VM {}".format(pci_device
,str(vm_obj
)))
4340 return True, vm_obj
, vcenter_conect
4342 self
.logger
.error("Currently there is no host with"\
4343 " {} number of avaialble PCI devices required for VM {}".format(
4347 raise vimconn
.vimconnNotFoundException(
4348 "Currently there is no host with {} "\
4349 "number of avaialble PCI devices required for VM {}".format(
4353 self
.logger
.debug("No infromation about PCI devices {} ",pci_devices
)
4355 except vmodl
.MethodFault
as error
:
4356 self
.logger
.error("Error occurred while adding PCI devices {} ",error
)
4357 return None, vm_obj
, vcenter_conect
4359 def get_vm_obj(self
, content
, mob_id
):
4361 Method to get the vsphere VM object associated with a given morf ID
4363 vapp_uuid - uuid of vApp/VM
4364 content - vCenter content object
4365 mob_id - mob_id of VM
4373 container
= content
.viewManager
.CreateContainerView(content
.rootFolder
,
4374 [vim
.VirtualMachine
], True
4376 for vm
in container
.view
:
4377 mobID
= vm
._GetMoId
()
4380 host_obj
= vm_obj
.runtime
.host
4382 except Exception as exp
:
4383 self
.logger
.error("Error occurred while finding VM object : {}".format(exp
))
4384 return host_obj
, vm_obj
4386 def get_pci_devices(self
, host
, need_devices
):
4388 Method to get the details of pci devices on given host
4390 host - vSphere host object
4391 need_devices - number of pci devices needed on host
4394 array of pci devices
4398 used_devices_ids
= []
4402 pciPassthruInfo
= host
.config
.pciPassthruInfo
4403 pciDevies
= host
.hardware
.pciDevice
4405 for pci_status
in pciPassthruInfo
:
4406 if pci_status
.passthruActive
:
4407 for device
in pciDevies
:
4408 if device
.id == pci_status
.id:
4409 all_device_ids
.append(device
.id)
4410 all_devices
.append(device
)
4412 #check if devices are in use
4413 avalible_devices
= all_devices
4415 if vm
.runtime
.powerState
== vim
.VirtualMachinePowerState
.poweredOn
:
4416 vm_devices
= vm
.config
.hardware
.device
4417 for device
in vm_devices
:
4418 if type(device
) is vim
.vm
.device
.VirtualPCIPassthrough
:
4419 if device
.backing
.id in all_device_ids
:
4420 for use_device
in avalible_devices
:
4421 if use_device
.id == device
.backing
.id:
4422 avalible_devices
.remove(use_device
)
4423 used_devices_ids
.append(device
.backing
.id)
4424 self
.logger
.debug("Device {} from devices {}"\
4425 "is in use".format(device
.backing
.id,
4428 if len(avalible_devices
) < need_devices
:
4429 self
.logger
.debug("Host {} don't have {} number of active devices".format(host
,
4431 self
.logger
.debug("found only {} devives {}".format(len(avalible_devices
),
4435 required_devices
= avalible_devices
[:need_devices
]
4436 self
.logger
.info("Found {} PCI devivces on host {} but required only {}".format(
4437 len(avalible_devices
),
4440 self
.logger
.info("Retruning {} devices as {}".format(need_devices
,
4442 return required_devices
4444 except Exception as exp
:
4445 self
.logger
.error("Error {} occurred while finding pci devices on host: {}".format(exp
, host
))
4449 def get_host_and_PCIdevices(self
, content
, need_devices
):
4451 Method to get the details of pci devices infromation on all hosts
4454 content - vSphere host object
4455 need_devices - number of pci devices needed on host
4458 array of pci devices and host object
4461 pci_device_objs
= None
4464 container
= content
.viewManager
.CreateContainerView(content
.rootFolder
,
4465 [vim
.HostSystem
], True)
4466 for host
in container
.view
:
4467 devices
= self
.get_pci_devices(host
, need_devices
)
4470 pci_device_objs
= devices
4472 except Exception as exp
:
4473 self
.logger
.error("Error {} occurred while finding pci devices on host: {}".format(exp
, host_obj
))
4475 return host_obj
,pci_device_objs
4477 def relocate_vm(self
, dest_host
, vm
) :
4479 Method to get the relocate VM to new host
4482 dest_host - vSphere host object
4483 vm - vSphere VM object
4490 relocate_spec
= vim
.vm
.RelocateSpec(host
=dest_host
)
4491 task
= vm
.Relocate(relocate_spec
)
4492 self
.logger
.info("Migrating {} to destination host {}".format(vm
, dest_host
))
4493 except Exception as exp
:
4494 self
.logger
.error("Error occurred while relocate VM {} to new host {}: {}".format(
4495 dest_host
, vm
, exp
))
4498 def wait_for_vcenter_task(self
, task
, actionName
='job', hideResult
=False):
4500 Waits and provides updates on a vSphere task
4502 while task
.info
.state
== vim
.TaskInfo
.State
.running
:
4505 if task
.info
.state
== vim
.TaskInfo
.State
.success
:
4506 if task
.info
.result
is not None and not hideResult
:
4507 self
.logger
.info('{} completed successfully, result: {}'.format(
4511 self
.logger
.info('Task {} completed successfully.'.format(actionName
))
4513 self
.logger
.error('{} did not complete successfully: {} '.format(
4518 return task
.info
.result
4520 def add_pci_to_vm(self
,host_object
, vm_object
, host_pci_dev
):
4522 Method to add pci device in given VM
4525 host_object - vSphere host object
4526 vm_object - vSphere VM object
4527 host_pci_dev - host_pci_dev must be one of the devices from the
4528 host_object.hardware.pciDevice list
4529 which is configured as a PCI passthrough device
4535 if vm_object
and host_object
and host_pci_dev
:
4537 #Add PCI device to VM
4538 pci_passthroughs
= vm_object
.environmentBrowser
.QueryConfigTarget(host
=None).pciPassthrough
4539 systemid_by_pciid
= {item
.pciDevice
.id: item
.systemId
for item
in pci_passthroughs
}
4541 if host_pci_dev
.id not in systemid_by_pciid
:
4542 self
.logger
.error("Device {} is not a passthrough device ".format(host_pci_dev
))
4545 deviceId
= hex(host_pci_dev
.deviceId
% 2**16).lstrip('0x')
4546 backing
= vim
.VirtualPCIPassthroughDeviceBackingInfo(deviceId
=deviceId
,
4548 systemId
=systemid_by_pciid
[host_pci_dev
.id],
4549 vendorId
=host_pci_dev
.vendorId
,
4550 deviceName
=host_pci_dev
.deviceName
)
4552 hba_object
= vim
.VirtualPCIPassthrough(key
=-100, backing
=backing
)
4554 new_device_config
= vim
.VirtualDeviceConfigSpec(device
=hba_object
)
4555 new_device_config
.operation
= "add"
4556 vmConfigSpec
= vim
.vm
.ConfigSpec()
4557 vmConfigSpec
.deviceChange
= [new_device_config
]
4559 task
= vm_object
.ReconfigVM_Task(spec
=vmConfigSpec
)
4560 self
.logger
.info("Adding PCI device {} into VM {} from host {} ".format(
4561 host_pci_dev
, vm_object
, host_object
)
4563 except Exception as exp
:
4564 self
.logger
.error("Error occurred while adding pci devive {} to VM {}: {}".format(
4570 def get_vm_vcenter_info(self
):
4572 Method to get details of vCenter and vm
4575 vapp_uuid - uuid of vApp or VM
4578 Moref Id of VM and deails of vCenter
4580 vm_vcenter_info
= {}
4582 if self
.vcenter_ip
is not None:
4583 vm_vcenter_info
["vm_vcenter_ip"] = self
.vcenter_ip
4585 raise vimconn
.vimconnException(message
="vCenter IP is not provided."\
4586 " Please provide vCenter IP while attaching datacenter to tenant in --config")
4587 if self
.vcenter_port
is not None:
4588 vm_vcenter_info
["vm_vcenter_port"] = self
.vcenter_port
4590 raise vimconn
.vimconnException(message
="vCenter port is not provided."\
4591 " Please provide vCenter port while attaching datacenter to tenant in --config")
4592 if self
.vcenter_user
is not None:
4593 vm_vcenter_info
["vm_vcenter_user"] = self
.vcenter_user
4595 raise vimconn
.vimconnException(message
="vCenter user is not provided."\
4596 " Please provide vCenter user while attaching datacenter to tenant in --config")
4598 if self
.vcenter_password
is not None:
4599 vm_vcenter_info
["vm_vcenter_password"] = self
.vcenter_password
4601 raise vimconn
.vimconnException(message
="vCenter user password is not provided."\
4602 " Please provide vCenter user password while attaching datacenter to tenant in --config")
4604 return vm_vcenter_info
4607 def get_vm_pci_details(self
, vmuuid
):
4609 Method to get VM PCI device details from vCenter
4612 vm_obj - vSphere VM object
4615 dict of PCI devives attached to VM
4618 vm_pci_devices_info
= {}
4620 vcenter_conect
, content
= self
.get_vcenter_content()
4621 vm_moref_id
= self
.get_vm_moref_id(vmuuid
)
4623 #Get VM and its host
4625 host_obj
, vm_obj
= self
.get_vm_obj(content
, vm_moref_id
)
4626 if host_obj
and vm_obj
:
4627 vm_pci_devices_info
["host_name"]= host_obj
.name
4628 vm_pci_devices_info
["host_ip"]= host_obj
.config
.network
.vnic
[0].spec
.ip
.ipAddress
4629 for device
in vm_obj
.config
.hardware
.device
:
4630 if type(device
) == vim
.vm
.device
.VirtualPCIPassthrough
:
4631 device_details
={'devide_id':device
.backing
.id,
4632 'pciSlotNumber':device
.slotInfo
.pciSlotNumber
,
4634 vm_pci_devices_info
[device
.deviceInfo
.label
] = device_details
4636 self
.logger
.error("Can not connect to vCenter while getting "\
4637 "PCI devices infromationn")
4638 return vm_pci_devices_info
4639 except Exception as exp
:
4640 self
.logger
.error("Error occurred while getting VM infromationn"\
4641 " for VM : {}".format(exp
))
4642 raise vimconn
.vimconnException(message
=exp
)
4645 def remove_primary_network_adapter_from_all_vms(self
, vapp
):
4647 Method to remove network adapter type to vm
4654 self
.logger
.info("Removing network adapter from all VMs")
4655 for vms
in vapp
.get_all_vms():
4656 vm_id
= vms
.get('id').split(':')[-1]
4658 url_rest_call
= "{}/api/vApp/vm-{}/networkConnectionSection/".format(self
.url
, vm_id
)
4660 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
4661 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
4662 response
= self
.perform_request(req_type
='GET',
4666 if response
.status_code
== 403:
4667 response
= self
.retry_rest('GET', url_rest_call
)
4669 if response
.status_code
!= 200:
4670 self
.logger
.error("REST call {} failed reason : {}"\
4671 "status code : {}".format(url_rest_call
,
4673 response
.status_code
))
4674 raise vimconn
.vimconnException("remove_primary_network_adapter : Failed to get "\
4675 "network connection section")
4677 data
= response
.content
4678 data
= data
.split('<Link rel="edit"')[0]
4680 headers
['Content-Type'] = 'application/vnd.vmware.vcloud.networkConnectionSection+xml'
4682 newdata
= """<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
4683 <NetworkConnectionSection xmlns="http://www.vmware.com/vcloud/v1.5"
4684 xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
4685 xmlns:vssd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData"
4686 xmlns:common="http://schemas.dmtf.org/wbem/wscim/1/common"
4687 xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData"
4688 xmlns:vmw="http://www.vmware.com/schema/ovf"
4689 xmlns:ovfenv="http://schemas.dmtf.org/ovf/environment/1"
4690 xmlns:vmext="http://www.vmware.com/vcloud/extension/v1.5"
4691 xmlns:ns9="http://www.vmware.com/vcloud/versions"
4692 href="{url}" type="application/vnd.vmware.vcloud.networkConnectionSection+xml" ovf:required="false">
4693 <ovf:Info>Specifies the available VM network connections</ovf:Info>
4694 <PrimaryNetworkConnectionIndex>0</PrimaryNetworkConnectionIndex>
4695 <Link rel="edit" href="{url}" type="application/vnd.vmware.vcloud.networkConnectionSection+xml"/>
4696 </NetworkConnectionSection>""".format(url
=url_rest_call
)
4697 response
= self
.perform_request(req_type
='PUT',
4702 if response
.status_code
== 403:
4703 add_headers
= {'Content-Type': headers
['Content-Type']}
4704 response
= self
.retry_rest('PUT', url_rest_call
, add_headers
, newdata
)
4706 if response
.status_code
!= 202:
4707 self
.logger
.error("REST call {} failed reason : {}"\
4708 "status code : {} ".format(url_rest_call
,
4710 response
.status_code
))
4711 raise vimconn
.vimconnException("remove_primary_network_adapter : Failed to update "\
4712 "network connection section")
4714 nic_task
= self
.get_task_from_response(response
.content
)
4715 result
= self
.client
.get_task_monitor().wait_for_success(task
=nic_task
)
4716 if result
.get('status') == 'success':
4717 self
.logger
.info("remove_primary_network_adapter(): VM {} conneced to "\
4718 "default NIC type".format(vm_id
))
4720 self
.logger
.error("remove_primary_network_adapter(): VM {} failed to "\
4721 "connect NIC type".format(vm_id
))
4723 def add_network_adapter_to_vms(self
, vapp
, network_name
, primary_nic_index
, nicIndex
, net
, nic_type
=None):
4725 Method to add network adapter type to vm
4727 network_name - name of network
4728 primary_nic_index - int value for primary nic index
4729 nicIndex - int value for nic index
4730 nic_type - specify model name to which add to vm
4735 self
.logger
.info("Add network adapter to VM: network_name {} nicIndex {} nic_type {}".\
4736 format(network_name
, nicIndex
, nic_type
))
4741 if 'floating_ip' in net
: floating_ip
= net
['floating_ip']
4743 # Stub for ip_address feature
4744 if 'ip_address' in net
: ip_address
= net
['ip_address']
4746 if 'mac_address' in net
: mac_address
= net
['mac_address']
4749 allocation_mode
= "POOL"
4751 allocation_mode
= "MANUAL"
4753 allocation_mode
= "DHCP"
4756 for vms
in vapp
.get_all_vms():
4757 vm_id
= vms
.get('id').split(':')[-1]
4759 url_rest_call
= "{}/api/vApp/vm-{}/networkConnectionSection/".format(self
.url
, vm_id
)
4761 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
4762 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
4763 response
= self
.perform_request(req_type
='GET',
4767 if response
.status_code
== 403:
4768 response
= self
.retry_rest('GET', url_rest_call
)
4770 if response
.status_code
!= 200:
4771 self
.logger
.error("REST call {} failed reason : {}"\
4772 "status code : {}".format(url_rest_call
,
4774 response
.status_code
))
4775 raise vimconn
.vimconnException("add_network_adapter_to_vms : Failed to get "\
4776 "network connection section")
4778 data
= response
.content
4779 data
= data
.split('<Link rel="edit"')[0]
4780 if '<PrimaryNetworkConnectionIndex>' not in data
:
4781 self
.logger
.debug("add_network_adapter PrimaryNIC not in data")
4782 item
= """<PrimaryNetworkConnectionIndex>{}</PrimaryNetworkConnectionIndex>
4783 <NetworkConnection network="{}">
4784 <NetworkConnectionIndex>{}</NetworkConnectionIndex>
4785 <IsConnected>true</IsConnected>
4786 <IpAddressAllocationMode>{}</IpAddressAllocationMode>
4787 </NetworkConnection>""".format(primary_nic_index
, network_name
, nicIndex
,
4789 # Stub for ip_address feature
4791 ip_tag
= '<IpAddress>{}</IpAddress>'.format(ip_address
)
4792 item
= item
.replace('</NetworkConnectionIndex>\n','</NetworkConnectionIndex>\n{}\n'.format(ip_tag
))
4795 mac_tag
= '<MACAddress>{}</MACAddress>'.format(mac_address
)
4796 item
= item
.replace('</IsConnected>\n','</IsConnected>\n{}\n'.format(mac_tag
))
4798 data
= data
.replace('</ovf:Info>\n','</ovf:Info>\n{}\n</NetworkConnectionSection>'.format(item
))
4800 self
.logger
.debug("add_network_adapter PrimaryNIC in data")
4801 new_item
= """<NetworkConnection network="{}">
4802 <NetworkConnectionIndex>{}</NetworkConnectionIndex>
4803 <IsConnected>true</IsConnected>
4804 <IpAddressAllocationMode>{}</IpAddressAllocationMode>
4805 </NetworkConnection>""".format(network_name
, nicIndex
,
4807 # Stub for ip_address feature
4809 ip_tag
= '<IpAddress>{}</IpAddress>'.format(ip_address
)
4810 new_item
= new_item
.replace('</NetworkConnectionIndex>\n','</NetworkConnectionIndex>\n{}\n'.format(ip_tag
))
4813 mac_tag
= '<MACAddress>{}</MACAddress>'.format(mac_address
)
4814 new_item
= new_item
.replace('</IsConnected>\n','</IsConnected>\n{}\n'.format(mac_tag
))
4816 data
= data
+ new_item
+ '</NetworkConnectionSection>'
4818 headers
['Content-Type'] = 'application/vnd.vmware.vcloud.networkConnectionSection+xml'
4820 response
= self
.perform_request(req_type
='PUT',
4825 if response
.status_code
== 403:
4826 add_headers
= {'Content-Type': headers
['Content-Type']}
4827 response
= self
.retry_rest('PUT', url_rest_call
, add_headers
, data
)
4829 if response
.status_code
!= 202:
4830 self
.logger
.error("REST call {} failed reason : {}"\
4831 "status code : {} ".format(url_rest_call
,
4833 response
.status_code
))
4834 raise vimconn
.vimconnException("add_network_adapter_to_vms : Failed to update "\
4835 "network connection section")
4837 nic_task
= self
.get_task_from_response(response
.content
)
4838 result
= self
.client
.get_task_monitor().wait_for_success(task
=nic_task
)
4839 if result
.get('status') == 'success':
4840 self
.logger
.info("add_network_adapter_to_vms(): VM {} conneced to "\
4841 "default NIC type".format(vm_id
))
4843 self
.logger
.error("add_network_adapter_to_vms(): VM {} failed to "\
4844 "connect NIC type".format(vm_id
))
4846 for vms
in vapp
.get_all_vms():
4847 vm_id
= vms
.get('id').split(':')[-1]
4849 url_rest_call
= "{}/api/vApp/vm-{}/networkConnectionSection/".format(self
.url
, vm_id
)
4851 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
4852 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
4853 response
= self
.perform_request(req_type
='GET',
4857 if response
.status_code
== 403:
4858 response
= self
.retry_rest('GET', url_rest_call
)
4860 if response
.status_code
!= 200:
4861 self
.logger
.error("REST call {} failed reason : {}"\
4862 "status code : {}".format(url_rest_call
,
4864 response
.status_code
))
4865 raise vimconn
.vimconnException("add_network_adapter_to_vms : Failed to get "\
4866 "network connection section")
4867 data
= response
.content
4868 data
= data
.split('<Link rel="edit"')[0]
4869 if '<PrimaryNetworkConnectionIndex>' not in data
:
4870 self
.logger
.debug("add_network_adapter PrimaryNIC not in data nic_type {}".format(nic_type
))
4871 item
= """<PrimaryNetworkConnectionIndex>{}</PrimaryNetworkConnectionIndex>
4872 <NetworkConnection network="{}">
4873 <NetworkConnectionIndex>{}</NetworkConnectionIndex>
4874 <IsConnected>true</IsConnected>
4875 <IpAddressAllocationMode>{}</IpAddressAllocationMode>
4876 <NetworkAdapterType>{}</NetworkAdapterType>
4877 </NetworkConnection>""".format(primary_nic_index
, network_name
, nicIndex
,
4878 allocation_mode
, nic_type
)
4879 # Stub for ip_address feature
4881 ip_tag
= '<IpAddress>{}</IpAddress>'.format(ip_address
)
4882 item
= item
.replace('</NetworkConnectionIndex>\n','</NetworkConnectionIndex>\n{}\n'.format(ip_tag
))
4885 mac_tag
= '<MACAddress>{}</MACAddress>'.format(mac_address
)
4886 item
= item
.replace('</IsConnected>\n','</IsConnected>\n{}\n'.format(mac_tag
))
4888 data
= data
.replace('</ovf:Info>\n','</ovf:Info>\n{}\n</NetworkConnectionSection>'.format(item
))
4890 self
.logger
.debug("add_network_adapter PrimaryNIC in data nic_type {}".format(nic_type
))
4891 new_item
= """<NetworkConnection network="{}">
4892 <NetworkConnectionIndex>{}</NetworkConnectionIndex>
4893 <IsConnected>true</IsConnected>
4894 <IpAddressAllocationMode>{}</IpAddressAllocationMode>
4895 <NetworkAdapterType>{}</NetworkAdapterType>
4896 </NetworkConnection>""".format(network_name
, nicIndex
,
4897 allocation_mode
, nic_type
)
4898 # Stub for ip_address feature
4900 ip_tag
= '<IpAddress>{}</IpAddress>'.format(ip_address
)
4901 new_item
= new_item
.replace('</NetworkConnectionIndex>\n','</NetworkConnectionIndex>\n{}\n'.format(ip_tag
))
4904 mac_tag
= '<MACAddress>{}</MACAddress>'.format(mac_address
)
4905 new_item
= new_item
.replace('</IsConnected>\n','</IsConnected>\n{}\n'.format(mac_tag
))
4907 data
= data
+ new_item
+ '</NetworkConnectionSection>'
4909 headers
['Content-Type'] = 'application/vnd.vmware.vcloud.networkConnectionSection+xml'
4911 response
= self
.perform_request(req_type
='PUT',
4916 if response
.status_code
== 403:
4917 add_headers
= {'Content-Type': headers
['Content-Type']}
4918 response
= self
.retry_rest('PUT', url_rest_call
, add_headers
, data
)
4920 if response
.status_code
!= 202:
4921 self
.logger
.error("REST call {} failed reason : {}"\
4922 "status code : {}".format(url_rest_call
,
4924 response
.status_code
))
4925 raise vimconn
.vimconnException("add_network_adapter_to_vms : Failed to update "\
4926 "network connection section")
4928 nic_task
= self
.get_task_from_response(response
.content
)
4929 result
= self
.client
.get_task_monitor().wait_for_success(task
=nic_task
)
4930 if result
.get('status') == 'success':
4931 self
.logger
.info("add_network_adapter_to_vms(): VM {} "\
4932 "conneced to NIC type {}".format(vm_id
, nic_type
))
4934 self
.logger
.error("add_network_adapter_to_vms(): VM {} "\
4935 "failed to connect NIC type {}".format(vm_id
, nic_type
))
4936 except Exception as exp
:
4937 self
.logger
.error("add_network_adapter_to_vms() : exception occurred "\
4938 "while adding Network adapter")
4939 raise vimconn
.vimconnException(message
=exp
)
4942 def set_numa_affinity(self
, vmuuid
, paired_threads_id
):
4944 Method to assign numa affinity in vm configuration parammeters
4947 paired_threads_id - one or more virtual processor
4953 vcenter_conect
, content
= self
.get_vcenter_content()
4954 vm_moref_id
= self
.get_vm_moref_id(vmuuid
)
4956 host_obj
, vm_obj
= self
.get_vm_obj(content
,vm_moref_id
)
4958 config_spec
= vim
.vm
.ConfigSpec()
4959 config_spec
.extraConfig
= []
4960 opt
= vim
.option
.OptionValue()
4961 opt
.key
= 'numa.nodeAffinity'
4962 opt
.value
= str(paired_threads_id
)
4963 config_spec
.extraConfig
.append(opt
)
4964 task
= vm_obj
.ReconfigVM_Task(config_spec
)
4966 result
= self
.wait_for_vcenter_task(task
, vcenter_conect
)
4967 extra_config
= vm_obj
.config
.extraConfig
4969 for opts
in extra_config
:
4970 if 'numa.nodeAffinity' in opts
.key
:
4972 self
.logger
.info("set_numa_affinity: Sucessfully assign numa affinity "\
4973 "value {} for vm {}".format(opt
.value
, vm_obj
))
4977 self
.logger
.error("set_numa_affinity: Failed to assign numa affinity")
4978 except Exception as exp
:
4979 self
.logger
.error("set_numa_affinity : exception occurred while setting numa affinity "\
4980 "for VM {} : {}".format(vm_obj
, vm_moref_id
))
4981 raise vimconn
.vimconnException("set_numa_affinity : Error {} failed to assign numa "\
4982 "affinity".format(exp
))
4985 def cloud_init(self
, vapp
, cloud_config
):
4987 Method to inject ssh-key
4989 cloud_config a dictionary with:
4990 'key-pairs': (optional) list of strings with the public key to be inserted to the default user
4991 'users': (optional) list of users to be inserted, each item is a dict with:
4992 'name': (mandatory) user name,
4993 'key-pairs': (optional) list of strings with the public key to be inserted to the user
4994 'user-data': (optional) can be a string with the text script to be passed directly to cloud-init,
4995 or a list of strings, each one contains a script to be passed, usually with a MIMEmultipart file
4996 'config-files': (optional). List of files to be transferred. Each item is a dict with:
4997 'dest': (mandatory) string with the destination absolute path
4998 'encoding': (optional, by default text). Can be one of:
4999 'b64', 'base64', 'gz', 'gz+b64', 'gz+base64', 'gzip+b64', 'gzip+base64'
5000 'content' (mandatory): string with the content of the file
5001 'permissions': (optional) string with file permissions, typically octal notation '0644'
5002 'owner': (optional) file owner, string with the format 'owner:group'
5003 'boot-data-drive': boolean to indicate if user-data must be passed using a boot drive (hard disk
5006 if not isinstance(cloud_config
, dict):
5007 raise Exception("cloud_init : parameter cloud_config is not a dictionary")
5011 if "key-pairs" in cloud_config
:
5012 key_pairs
= cloud_config
["key-pairs"]
5014 if "users" in cloud_config
:
5015 userdata
= cloud_config
["users"]
5017 self
.logger
.debug("cloud_init : Guest os customization started..")
5018 customize_script
= self
.format_script(key_pairs
=key_pairs
, users_list
=userdata
)
5019 customize_script
= customize_script
.replace("&","&")
5020 self
.guest_customization(vapp
, customize_script
)
5022 except Exception as exp
:
5023 self
.logger
.error("cloud_init : exception occurred while injecting "\
5025 raise vimconn
.vimconnException("cloud_init : Error {} failed to inject "\
5026 "ssh-key".format(exp
))
5028 def format_script(self
, key_pairs
=[], users_list
=[]):
5029 bash_script
= """#!/bin/sh
5030 echo performing customization tasks with param $1 at `date "+DATE: %Y-%m-%d - TIME: %H:%M:%S"` >> /root/customization.log
5031 if [ "$1" = "precustomization" ];then
5032 echo performing precustomization tasks on `date "+DATE: %Y-%m-%d - TIME: %H:%M:%S"` >> /root/customization.log
5035 keys
= "\n".join(key_pairs
)
5038 if [ ! -d /root/.ssh ];then
5040 chown root:root /root/.ssh
5041 chmod 700 /root/.ssh
5042 touch /root/.ssh/authorized_keys
5043 chown root:root /root/.ssh/authorized_keys
5044 chmod 600 /root/.ssh/authorized_keys
5045 # make centos with selinux happy
5046 which restorecon && restorecon -Rv /root/.ssh
5048 touch /root/.ssh/authorized_keys
5049 chown root:root /root/.ssh/authorized_keys
5050 chmod 600 /root/.ssh/authorized_keys
5052 echo '{key}' >> /root/.ssh/authorized_keys
5053 """.format(key
=keys
)
5055 bash_script
+= keys_data
5057 for user
in users_list
:
5058 if 'name' in user
: user_name
= user
['name']
5059 if 'key-pairs' in user
:
5060 user_keys
= "\n".join(user
['key-pairs'])
5065 useradd -d /home/{user_name} -m -g users -s /bin/bash {user_name}
5066 """.format(user_name
=user_name
)
5068 bash_script
+= add_user_name
5071 user_keys_data
= """
5072 mkdir /home/{user_name}/.ssh
5073 chown {user_name}:{user_name} /home/{user_name}/.ssh
5074 chmod 700 /home/{user_name}/.ssh
5075 touch /home/{user_name}/.ssh/authorized_keys
5076 chown {user_name}:{user_name} /home/{user_name}/.ssh/authorized_keys
5077 chmod 600 /home/{user_name}/.ssh/authorized_keys
5078 # make centos with selinux happy
5079 which restorecon && restorecon -Rv /home/{user_name}/.ssh
5080 echo '{user_key}' >> /home/{user_name}/.ssh/authorized_keys
5081 """.format(user_name
=user_name
,user_key
=user_keys
)
5083 bash_script
+= user_keys_data
5085 return bash_script
+"\n\tfi"
5087 def guest_customization(self
, vapp
, customize_script
):
5089 Method to customize guest os
5091 customize_script - Customize script to be run at first boot of VM.
5093 for vm
in vapp
.get_all_vms():
5094 vm_id
= vm
.get('id').split(':')[-1]
5095 vm_name
= vm
.get('name')
5096 vm_name
= vm_name
.replace('_','-')
5098 vm_customization_url
= "{}/api/vApp/vm-{}/guestCustomizationSection/".format(self
.url
, vm_id
)
5099 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
5100 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
5102 headers
['Content-Type'] = "application/vnd.vmware.vcloud.guestCustomizationSection+xml"
5104 data
= """<GuestCustomizationSection
5105 xmlns="http://www.vmware.com/vcloud/v1.5"
5106 xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
5107 ovf:required="false" href="{}" type="application/vnd.vmware.vcloud.guestCustomizationSection+xml">
5108 <ovf:Info>Specifies Guest OS Customization Settings</ovf:Info>
5109 <Enabled>true</Enabled>
5110 <ChangeSid>false</ChangeSid>
5111 <VirtualMachineId>{}</VirtualMachineId>
5112 <JoinDomainEnabled>false</JoinDomainEnabled>
5113 <UseOrgSettings>false</UseOrgSettings>
5114 <AdminPasswordEnabled>false</AdminPasswordEnabled>
5115 <AdminPasswordAuto>true</AdminPasswordAuto>
5116 <AdminAutoLogonEnabled>false</AdminAutoLogonEnabled>
5117 <AdminAutoLogonCount>0</AdminAutoLogonCount>
5118 <ResetPasswordRequired>false</ResetPasswordRequired>
5119 <CustomizationScript>{}</CustomizationScript>
5120 <ComputerName>{}</ComputerName>
5121 <Link href="{}" type="application/vnd.vmware.vcloud.guestCustomizationSection+xml" rel="edit"/>
5122 </GuestCustomizationSection>
5123 """.format(vm_customization_url
,
5127 vm_customization_url
)
5129 response
= self
.perform_request(req_type
='PUT',
5130 url
=vm_customization_url
,
5133 if response
.status_code
== 202:
5134 guest_task
= self
.get_task_from_response(response
.content
)
5135 self
.client
.get_task_monitor().wait_for_success(task
=guest_task
)
5136 self
.logger
.info("guest_customization : customized guest os task "\
5137 "completed for VM {}".format(vm_name
))
5139 self
.logger
.error("guest_customization : task for customized guest os"\
5140 "failed for VM {}".format(vm_name
))
5141 raise vimconn
.vimconnException("guest_customization : failed to perform"\
5142 "guest os customization on VM {}".format(vm_name
))
5144 def add_new_disk(self
, vapp_uuid
, disk_size
):
5146 Method to create an empty vm disk
5149 vapp_uuid - is vapp identifier.
5150 disk_size - size of disk to be created in GB
5158 #Disk size in GB, convert it into MB
5159 if disk_size
is not None:
5160 disk_size_mb
= int(disk_size
) * 1024
5161 vm_details
= self
.get_vapp_details_rest(vapp_uuid
)
5163 if vm_details
and "vm_virtual_hardware" in vm_details
:
5164 self
.logger
.info("Adding disk to VM: {} disk size:{}GB".format(vm_details
["name"], disk_size
))
5165 disk_href
= vm_details
["vm_virtual_hardware"]["disk_edit_href"]
5166 status
= self
.add_new_disk_rest(disk_href
, disk_size_mb
)
5168 except Exception as exp
:
5169 msg
= "Error occurred while creating new disk {}.".format(exp
)
5170 self
.rollback_newvm(vapp_uuid
, msg
)
5173 self
.logger
.info("Added new disk to VM: {} disk size:{}GB".format(vm_details
["name"], disk_size
))
5175 #If failed to add disk, delete VM
5176 msg
= "add_new_disk: Failed to add new disk to {}".format(vm_details
["name"])
5177 self
.rollback_newvm(vapp_uuid
, msg
)
5180 def add_new_disk_rest(self
, disk_href
, disk_size_mb
):
5182 Retrives vApp Disks section & add new empty disk
5185 disk_href: Disk section href to addd disk
5186 disk_size_mb: Disk size in MB
5188 Returns: Status of add new disk task
5191 if self
.client
._session
:
5192 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
5193 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
5194 response
= self
.perform_request(req_type
='GET',
5198 if response
.status_code
== 403:
5199 response
= self
.retry_rest('GET', disk_href
)
5201 if response
.status_code
!= requests
.codes
.ok
:
5202 self
.logger
.error("add_new_disk_rest: GET REST API call {} failed. Return status code {}"
5203 .format(disk_href
, response
.status_code
))
5206 #Find but type & max of instance IDs assigned to disks
5207 lxmlroot_respond
= lxmlElementTree
.fromstring(response
.content
)
5208 namespaces
= {prefix
:uri
for prefix
,uri
in lxmlroot_respond
.nsmap
.iteritems() if prefix
}
5210 #namespaces = {prefix:uri for prefix,uri in lxmlroot_respond.nsmap.items() if prefix}
5211 namespaces
["xmlns"]= "http://www.vmware.com/vcloud/v1.5"
5213 for item
in lxmlroot_respond
.iterfind('xmlns:Item',namespaces
):
5214 if item
.find("rasd:Description",namespaces
).text
== "Hard disk":
5215 inst_id
= int(item
.find("rasd:InstanceID" ,namespaces
).text
)
5216 if inst_id
> instance_id
:
5217 instance_id
= inst_id
5218 disk_item
= item
.find("rasd:HostResource" ,namespaces
)
5219 bus_subtype
= disk_item
.attrib
["{"+namespaces
['xmlns']+"}busSubType"]
5220 bus_type
= disk_item
.attrib
["{"+namespaces
['xmlns']+"}busType"]
5222 instance_id
= instance_id
+ 1
5223 new_item
= """<Item>
5224 <rasd:Description>Hard disk</rasd:Description>
5225 <rasd:ElementName>New disk</rasd:ElementName>
5227 xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
5228 vcloud:capacity="{}"
5229 vcloud:busSubType="{}"
5230 vcloud:busType="{}"></rasd:HostResource>
5231 <rasd:InstanceID>{}</rasd:InstanceID>
5232 <rasd:ResourceType>17</rasd:ResourceType>
5233 </Item>""".format(disk_size_mb
, bus_subtype
, bus_type
, instance_id
)
5235 new_data
= response
.content
5236 #Add new item at the bottom
5237 new_data
= new_data
.replace('</Item>\n</RasdItemsList>', '</Item>\n{}\n</RasdItemsList>'.format(new_item
))
5239 # Send PUT request to modify virtual hardware section with new disk
5240 headers
['Content-Type'] = 'application/vnd.vmware.vcloud.rasdItemsList+xml; charset=ISO-8859-1'
5242 response
= self
.perform_request(req_type
='PUT',
5247 if response
.status_code
== 403:
5248 add_headers
= {'Content-Type': headers
['Content-Type']}
5249 response
= self
.retry_rest('PUT', disk_href
, add_headers
, new_data
)
5251 if response
.status_code
!= 202:
5252 self
.logger
.error("PUT REST API call {} failed. Return status code {}. Response Content:{}"
5253 .format(disk_href
, response
.status_code
, response
.content
))
5255 add_disk_task
= self
.get_task_from_response(response
.content
)
5256 result
= self
.client
.get_task_monitor().wait_for_success(task
=add_disk_task
)
5257 if result
.get('status') == 'success':
5260 self
.logger
.error("Add new disk REST task failed to add {} MB disk".format(disk_size_mb
))
5262 except Exception as exp
:
5263 self
.logger
.error("Error occurred calling rest api for creating new disk {}".format(exp
))
5268 def add_existing_disk(self
, catalogs
=None, image_id
=None, size
=None, template_name
=None, vapp_uuid
=None):
5270 Method to add existing disk to vm
5272 catalogs - List of VDC catalogs
5273 image_id - Catalog ID
5274 template_name - Name of template in catalog
5275 vapp_uuid - UUID of vApp
5280 vcenter_conect
, content
= self
.get_vcenter_content()
5281 #find moref-id of vm in image
5282 catalog_vm_info
= self
.get_vapp_template_details(catalogs
=catalogs
,
5286 if catalog_vm_info
and "vm_vcenter_info" in catalog_vm_info
:
5287 if "vm_moref_id" in catalog_vm_info
["vm_vcenter_info"]:
5288 catalog_vm_moref_id
= catalog_vm_info
["vm_vcenter_info"].get("vm_moref_id", None)
5289 if catalog_vm_moref_id
:
5290 self
.logger
.info("Moref_id of VM in catalog : {}" .format(catalog_vm_moref_id
))
5291 host
, catalog_vm_obj
= self
.get_vm_obj(content
, catalog_vm_moref_id
)
5294 disk_info
= self
.find_disk(catalog_vm_obj
)
5296 exp_msg
= "No VM with image id {} found".format(image_id
)
5297 self
.rollback_newvm(vapp_uuid
, exp_msg
, exp_type
="NotFound")
5299 exp_msg
= "No Image found with image ID {} ".format(image_id
)
5300 self
.rollback_newvm(vapp_uuid
, exp_msg
, exp_type
="NotFound")
5303 self
.logger
.info("Existing disk_info : {}".format(disk_info
))
5305 vm_moref_id
= self
.get_vm_moref_id(vapp_uuid
)
5306 host
, vm_obj
= self
.get_vm_obj(content
, vm_moref_id
)
5308 status
= self
.add_disk(vcenter_conect
=vcenter_conect
,
5310 disk_info
=disk_info
,
5315 self
.logger
.info("Disk from image id {} added to {}".format(image_id
,
5319 msg
= "No disk found with image id {} to add in VM {}".format(
5322 self
.rollback_newvm(vapp_uuid
, msg
, exp_type
="NotFound")
5325 def find_disk(self
, vm_obj
):
5327 Method to find details of existing disk in VM
5329 vm_obj - vCenter object of VM
5330 image_id - Catalog ID
5332 disk_info : dict of disk details
5337 devices
= vm_obj
.config
.hardware
.device
5338 for device
in devices
:
5339 if type(device
) is vim
.vm
.device
.VirtualDisk
:
5340 if isinstance(device
.backing
,vim
.vm
.device
.VirtualDisk
.FlatVer2BackingInfo
) and hasattr(device
.backing
, 'fileName'):
5341 disk_info
["full_path"] = device
.backing
.fileName
5342 disk_info
["datastore"] = device
.backing
.datastore
5343 disk_info
["capacityKB"] = device
.capacityInKB
5345 except Exception as exp
:
5346 self
.logger
.error("find_disk() : exception occurred while "\
5347 "getting existing disk details :{}".format(exp
))
5351 def add_disk(self
, vcenter_conect
=None, vm
=None, size
=None, vapp_uuid
=None, disk_info
={}):
5353 Method to add existing disk in VM
5355 vcenter_conect - vCenter content object
5356 vm - vCenter vm object
5357 disk_info : dict of disk details
5359 status : status of add disk task
5361 datastore
= disk_info
["datastore"] if "datastore" in disk_info
else None
5362 fullpath
= disk_info
["full_path"] if "full_path" in disk_info
else None
5363 capacityKB
= disk_info
["capacityKB"] if "capacityKB" in disk_info
else None
5364 if size
is not None:
5365 #Convert size from GB to KB
5366 sizeKB
= int(size
) * 1024 * 1024
5367 #compare size of existing disk and user given size.Assign whicherver is greater
5368 self
.logger
.info("Add Existing disk : sizeKB {} , capacityKB {}".format(
5369 sizeKB
, capacityKB
))
5370 if sizeKB
> capacityKB
:
5373 if datastore
and fullpath
and capacityKB
:
5375 spec
= vim
.vm
.ConfigSpec()
5376 # get all disks on a VM, set unit_number to the next available
5378 for dev
in vm
.config
.hardware
.device
:
5379 if hasattr(dev
.backing
, 'fileName'):
5380 unit_number
= int(dev
.unitNumber
) + 1
5381 # unit_number 7 reserved for scsi controller
5382 if unit_number
== 7:
5384 if isinstance(dev
, vim
.vm
.device
.VirtualDisk
):
5385 #vim.vm.device.VirtualSCSIController
5386 controller_key
= dev
.controllerKey
5388 self
.logger
.info("Add Existing disk : unit number {} , controller key {}".format(
5389 unit_number
, controller_key
))
5392 disk_spec
= vim
.vm
.device
.VirtualDeviceSpec()
5393 disk_spec
.operation
= vim
.vm
.device
.VirtualDeviceSpec
.Operation
.add
5394 disk_spec
.device
= vim
.vm
.device
.VirtualDisk()
5395 disk_spec
.device
.backing
= \
5396 vim
.vm
.device
.VirtualDisk
.FlatVer2BackingInfo()
5397 disk_spec
.device
.backing
.thinProvisioned
= True
5398 disk_spec
.device
.backing
.diskMode
= 'persistent'
5399 disk_spec
.device
.backing
.datastore
= datastore
5400 disk_spec
.device
.backing
.fileName
= fullpath
5402 disk_spec
.device
.unitNumber
= unit_number
5403 disk_spec
.device
.capacityInKB
= capacityKB
5404 disk_spec
.device
.controllerKey
= controller_key
5405 dev_changes
.append(disk_spec
)
5406 spec
.deviceChange
= dev_changes
5407 task
= vm
.ReconfigVM_Task(spec
=spec
)
5408 status
= self
.wait_for_vcenter_task(task
, vcenter_conect
)
5410 except Exception as exp
:
5411 exp_msg
= "add_disk() : exception {} occurred while adding disk "\
5412 "{} to vm {}".format(exp
,
5415 self
.rollback_newvm(vapp_uuid
, exp_msg
)
5417 msg
= "add_disk() : Can not add disk to VM with disk info {} ".format(disk_info
)
5418 self
.rollback_newvm(vapp_uuid
, msg
)
5421 def get_vcenter_content(self
):
5423 Get the vsphere content object
5426 vm_vcenter_info
= self
.get_vm_vcenter_info()
5427 except Exception as exp
:
5428 self
.logger
.error("Error occurred while getting vCenter infromationn"\
5429 " for VM : {}".format(exp
))
5430 raise vimconn
.vimconnException(message
=exp
)
5433 if hasattr(ssl
, '_create_unverified_context'):
5434 context
= ssl
._create
_unverified
_context
()
5436 vcenter_conect
= SmartConnect(
5437 host
=vm_vcenter_info
["vm_vcenter_ip"],
5438 user
=vm_vcenter_info
["vm_vcenter_user"],
5439 pwd
=vm_vcenter_info
["vm_vcenter_password"],
5440 port
=int(vm_vcenter_info
["vm_vcenter_port"]),
5443 atexit
.register(Disconnect
, vcenter_conect
)
5444 content
= vcenter_conect
.RetrieveContent()
5445 return vcenter_conect
, content
5448 def get_vm_moref_id(self
, vapp_uuid
):
5450 Get the moref_id of given VM
5454 vm_details
= self
.get_vapp_details_rest(vapp_uuid
, need_admin_access
=True)
5455 if vm_details
and "vm_vcenter_info" in vm_details
:
5456 vm_moref_id
= vm_details
["vm_vcenter_info"].get("vm_moref_id", None)
5459 except Exception as exp
:
5460 self
.logger
.error("Error occurred while getting VM moref ID "\
5461 " for VM : {}".format(exp
))
5465 def get_vapp_template_details(self
, catalogs
=None, image_id
=None , template_name
=None):
5467 Method to get vApp template details
5469 catalogs - list of VDC catalogs
5470 image_id - Catalog ID to find
5471 template_name : template name in catalog
5473 parsed_respond : dict of vApp tempalte details
5475 parsed_response
= {}
5477 vca
= self
.connect_as_admin()
5479 raise vimconn
.vimconnConnectionException("Failed to connect vCD")
5482 org
, vdc
= self
.get_vdc_details()
5483 catalog
= self
.get_catalog_obj(image_id
, catalogs
)
5485 items
= org
.get_catalog_item(catalog
.get('name'), catalog
.get('name'))
5486 catalog_items
= [items
.attrib
]
5488 if len(catalog_items
) == 1:
5489 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
5490 'x-vcloud-authorization': vca
._session
.headers
['x-vcloud-authorization']}
5492 response
= self
.perform_request(req_type
='GET',
5493 url
=catalog_items
[0].get('href'),
5495 catalogItem
= XmlElementTree
.fromstring(response
.content
)
5496 entity
= [child
for child
in catalogItem
if child
.get("type") == "application/vnd.vmware.vcloud.vAppTemplate+xml"][0]
5497 vapp_tempalte_href
= entity
.get("href")
5498 #get vapp details and parse moref id
5500 namespaces
= {"vssd":"http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData" ,
5501 'ovf': 'http://schemas.dmtf.org/ovf/envelope/1',
5502 'vmw': 'http://www.vmware.com/schema/ovf',
5503 'vm': 'http://www.vmware.com/vcloud/v1.5',
5504 'rasd':"http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData",
5505 'vmext':"http://www.vmware.com/vcloud/extension/v1.5",
5506 'xmlns':"http://www.vmware.com/vcloud/v1.5"
5510 response
= self
.perform_request(req_type
='GET',
5511 url
=vapp_tempalte_href
,
5514 if response
.status_code
!= requests
.codes
.ok
:
5515 self
.logger
.debug("REST API call {} failed. Return status code {}".format(
5516 vapp_tempalte_href
, response
.status_code
))
5519 xmlroot_respond
= XmlElementTree
.fromstring(response
.content
)
5520 children_section
= xmlroot_respond
.find('vm:Children/', namespaces
)
5521 if children_section
is not None:
5522 vCloud_extension_section
= children_section
.find('xmlns:VCloudExtension', namespaces
)
5523 if vCloud_extension_section
is not None:
5524 vm_vcenter_info
= {}
5525 vim_info
= vCloud_extension_section
.find('vmext:VmVimInfo', namespaces
)
5526 vmext
= vim_info
.find('vmext:VmVimObjectRef', namespaces
)
5527 if vmext
is not None:
5528 vm_vcenter_info
["vm_moref_id"] = vmext
.find('vmext:MoRef', namespaces
).text
5529 parsed_response
["vm_vcenter_info"]= vm_vcenter_info
5531 except Exception as exp
:
5532 self
.logger
.info("Error occurred calling rest api for getting vApp details {}".format(exp
))
5534 return parsed_response
5537 def rollback_newvm(self
, vapp_uuid
, msg
, exp_type
="Genric"):
5539 Method to delete vApp
5541 vapp_uuid - vApp UUID
5542 msg - Error message to be logged
5543 exp_type : Exception type
5548 status
= self
.delete_vminstance(vapp_uuid
)
5551 self
.logger
.error(msg
)
5552 if exp_type
== "Genric":
5553 raise vimconn
.vimconnException(msg
)
5554 elif exp_type
== "NotFound":
5555 raise vimconn
.vimconnNotFoundException(message
=msg
)
5557 def add_sriov(self
, vapp_uuid
, sriov_nets
, vmname_andid
):
5559 Method to attach SRIOV adapters to VM
5562 vapp_uuid - uuid of vApp/VM
5563 sriov_nets - SRIOV devices infromation as specified in VNFD (flavor)
5564 vmname_andid - vmname
5567 The status of add SRIOV adapter task , vm object and
5568 vcenter_conect object
5571 vcenter_conect
, content
= self
.get_vcenter_content()
5572 vm_moref_id
= self
.get_vm_moref_id(vapp_uuid
)
5576 no_of_sriov_devices
= len(sriov_nets
)
5577 if no_of_sriov_devices
> 0:
5578 #Get VM and its host
5579 host_obj
, vm_obj
= self
.get_vm_obj(content
, vm_moref_id
)
5580 self
.logger
.info("VM {} is currently on host {}".format(vm_obj
, host_obj
))
5581 if host_obj
and vm_obj
:
5582 #get SRIOV devies from host on which vapp is currently installed
5583 avilable_sriov_devices
= self
.get_sriov_devices(host_obj
,
5584 no_of_sriov_devices
,
5587 if len(avilable_sriov_devices
) == 0:
5588 #find other hosts with active pci devices
5589 new_host_obj
, avilable_sriov_devices
= self
.get_host_and_sriov_devices(
5591 no_of_sriov_devices
,
5594 if new_host_obj
is not None and len(avilable_sriov_devices
)> 0:
5595 #Migrate vm to the host where SRIOV devices are available
5596 self
.logger
.info("Relocate VM {} on new host {}".format(vm_obj
,
5598 task
= self
.relocate_vm(new_host_obj
, vm_obj
)
5599 if task
is not None:
5600 result
= self
.wait_for_vcenter_task(task
, vcenter_conect
)
5601 self
.logger
.info("Migrate VM status: {}".format(result
))
5602 host_obj
= new_host_obj
5604 self
.logger
.info("Fail to migrate VM : {}".format(result
))
5605 raise vimconn
.vimconnNotFoundException(
5606 "Fail to migrate VM : {} to host {}".format(
5611 if host_obj
is not None and avilable_sriov_devices
is not None and len(avilable_sriov_devices
)> 0:
5612 #Add SRIOV devices one by one
5613 for sriov_net
in sriov_nets
:
5614 network_name
= sriov_net
.get('net_id')
5615 dvs_portgr_name
= self
.create_dvPort_group(network_name
)
5616 if sriov_net
.get('type') == "VF" or sriov_net
.get('type') == "SR-IOV":
5617 #add vlan ID ,Modify portgroup for vlan ID
5618 self
.configure_vlanID(content
, vcenter_conect
, network_name
)
5620 task
= self
.add_sriov_to_vm(content
,
5624 avilable_sriov_devices
[0]
5627 status
= self
.wait_for_vcenter_task(task
, vcenter_conect
)
5629 self
.logger
.info("Added SRIOV {} to VM {}".format(
5630 no_of_sriov_devices
,
5633 self
.logger
.error("Fail to add SRIOV {} to VM {}".format(
5634 no_of_sriov_devices
,
5636 raise vimconn
.vimconnUnexpectedResponse(
5637 "Fail to add SRIOV adapter in VM ".format(str(vm_obj
))
5639 return True, vm_obj
, vcenter_conect
5641 self
.logger
.error("Currently there is no host with"\
5642 " {} number of avaialble SRIOV "\
5643 "VFs required for VM {}".format(
5644 no_of_sriov_devices
,
5647 raise vimconn
.vimconnNotFoundException(
5648 "Currently there is no host with {} "\
5649 "number of avaialble SRIOV devices required for VM {}".format(
5650 no_of_sriov_devices
,
5653 self
.logger
.debug("No infromation about SRIOV devices {} ",sriov_nets
)
5655 except vmodl
.MethodFault
as error
:
5656 self
.logger
.error("Error occurred while adding SRIOV {} ",error
)
5657 return None, vm_obj
, vcenter_conect
5660 def get_sriov_devices(self
,host
, no_of_vfs
):
5662 Method to get the details of SRIOV devices on given host
5664 host - vSphere host object
5665 no_of_vfs - number of VFs needed on host
5668 array of SRIOV devices
5672 for device
in host
.config
.pciPassthruInfo
:
5673 if isinstance(device
,vim
.host
.SriovInfo
) and device
.sriovActive
:
5674 if device
.numVirtualFunction
>= no_of_vfs
:
5675 sriovInfo
.append(device
)
5680 def get_host_and_sriov_devices(self
, content
, no_of_vfs
):
5682 Method to get the details of SRIOV devices infromation on all hosts
5685 content - vSphere host object
5686 no_of_vfs - number of pci VFs needed on host
5689 array of SRIOV devices and host object
5692 sriov_device_objs
= None
5695 container
= content
.viewManager
.CreateContainerView(content
.rootFolder
,
5696 [vim
.HostSystem
], True)
5697 for host
in container
.view
:
5698 devices
= self
.get_sriov_devices(host
, no_of_vfs
)
5701 sriov_device_objs
= devices
5703 except Exception as exp
:
5704 self
.logger
.error("Error {} occurred while finding SRIOV devices on host: {}".format(exp
, host_obj
))
5706 return host_obj
,sriov_device_objs
5709 def add_sriov_to_vm(self
,content
, vm_obj
, host_obj
, network_name
, sriov_device
):
5711 Method to add SRIOV adapter to vm
5714 host_obj - vSphere host object
5715 vm_obj - vSphere vm object
5716 content - vCenter content object
5717 network_name - name of distributed virtaul portgroup
5718 sriov_device - SRIOV device info
5724 vnic_label
= "sriov nic"
5726 dvs_portgr
= self
.get_dvport_group(network_name
)
5727 network_name
= dvs_portgr
.name
5728 nic
= vim
.vm
.device
.VirtualDeviceSpec()
5730 nic
.operation
= vim
.vm
.device
.VirtualDeviceSpec
.Operation
.add
5731 nic
.device
= vim
.vm
.device
.VirtualSriovEthernetCard()
5732 nic
.device
.addressType
= 'assigned'
5733 #nic.device.key = 13016
5734 nic
.device
.deviceInfo
= vim
.Description()
5735 nic
.device
.deviceInfo
.label
= vnic_label
5736 nic
.device
.deviceInfo
.summary
= network_name
5737 nic
.device
.backing
= vim
.vm
.device
.VirtualEthernetCard
.NetworkBackingInfo()
5739 nic
.device
.backing
.network
= self
.get_obj(content
, [vim
.Network
], network_name
)
5740 nic
.device
.backing
.deviceName
= network_name
5741 nic
.device
.backing
.useAutoDetect
= False
5742 nic
.device
.connectable
= vim
.vm
.device
.VirtualDevice
.ConnectInfo()
5743 nic
.device
.connectable
.startConnected
= True
5744 nic
.device
.connectable
.allowGuestControl
= True
5746 nic
.device
.sriovBacking
= vim
.vm
.device
.VirtualSriovEthernetCard
.SriovBackingInfo()
5747 nic
.device
.sriovBacking
.physicalFunctionBacking
= vim
.vm
.device
.VirtualPCIPassthrough
.DeviceBackingInfo()
5748 nic
.device
.sriovBacking
.physicalFunctionBacking
.id = sriov_device
.id
5751 vmconf
= vim
.vm
.ConfigSpec(deviceChange
=devices
)
5752 task
= vm_obj
.ReconfigVM_Task(vmconf
)
5754 except Exception as exp
:
5755 self
.logger
.error("Error {} occurred while adding SRIOV adapter in VM: {}".format(exp
, vm_obj
))
5759 def create_dvPort_group(self
, network_name
):
5761 Method to create disributed virtual portgroup
5764 network_name - name of network/portgroup
5770 new_network_name
= [network_name
, '-', str(uuid
.uuid4())]
5771 network_name
=''.join(new_network_name
)
5772 vcenter_conect
, content
= self
.get_vcenter_content()
5774 dv_switch
= self
.get_obj(content
, [vim
.DistributedVirtualSwitch
], self
.dvs_name
)
5776 dv_pg_spec
= vim
.dvs
.DistributedVirtualPortgroup
.ConfigSpec()
5777 dv_pg_spec
.name
= network_name
5779 dv_pg_spec
.type = vim
.dvs
.DistributedVirtualPortgroup
.PortgroupType
.earlyBinding
5780 dv_pg_spec
.defaultPortConfig
= vim
.dvs
.VmwareDistributedVirtualSwitch
.VmwarePortConfigPolicy()
5781 dv_pg_spec
.defaultPortConfig
.securityPolicy
= vim
.dvs
.VmwareDistributedVirtualSwitch
.SecurityPolicy()
5782 dv_pg_spec
.defaultPortConfig
.securityPolicy
.allowPromiscuous
= vim
.BoolPolicy(value
=False)
5783 dv_pg_spec
.defaultPortConfig
.securityPolicy
.forgedTransmits
= vim
.BoolPolicy(value
=False)
5784 dv_pg_spec
.defaultPortConfig
.securityPolicy
.macChanges
= vim
.BoolPolicy(value
=False)
5786 task
= dv_switch
.AddDVPortgroup_Task([dv_pg_spec
])
5787 self
.wait_for_vcenter_task(task
, vcenter_conect
)
5789 dvPort_group
= self
.get_obj(content
, [vim
.dvs
.DistributedVirtualPortgroup
], network_name
)
5791 self
.logger
.info("Created disributed virtaul port group: {}".format(dvPort_group
))
5792 return dvPort_group
.key
5794 self
.logger
.debug("No disributed virtual switch found with name {}".format(network_name
))
5796 except Exception as exp
:
5797 self
.logger
.error("Error occurred while creating disributed virtaul port group {}"\
5798 " : {}".format(network_name
, exp
))
5801 def reconfig_portgroup(self
, content
, dvPort_group_name
, config_info
={}):
5803 Method to reconfigure disributed virtual portgroup
5806 dvPort_group_name - name of disributed virtual portgroup
5807 content - vCenter content object
5808 config_info - disributed virtual portgroup configuration
5814 dvPort_group
= self
.get_dvport_group(dvPort_group_name
)
5816 dv_pg_spec
= vim
.dvs
.DistributedVirtualPortgroup
.ConfigSpec()
5817 dv_pg_spec
.configVersion
= dvPort_group
.config
.configVersion
5818 dv_pg_spec
.defaultPortConfig
= vim
.dvs
.VmwareDistributedVirtualSwitch
.VmwarePortConfigPolicy()
5819 if "vlanID" in config_info
:
5820 dv_pg_spec
.defaultPortConfig
.vlan
= vim
.dvs
.VmwareDistributedVirtualSwitch
.VlanIdSpec()
5821 dv_pg_spec
.defaultPortConfig
.vlan
.vlanId
= config_info
.get('vlanID')
5823 task
= dvPort_group
.ReconfigureDVPortgroup_Task(spec
=dv_pg_spec
)
5827 except Exception as exp
:
5828 self
.logger
.error("Error occurred while reconfiguraing disributed virtaul port group {}"\
5829 " : {}".format(dvPort_group_name
, exp
))
5833 def destroy_dvport_group(self
, dvPort_group_name
):
5835 Method to destroy disributed virtual portgroup
5838 network_name - name of network/portgroup
5841 True if portgroup successfully got deleted else false
5843 vcenter_conect
, content
= self
.get_vcenter_content()
5846 dvPort_group
= self
.get_dvport_group(dvPort_group_name
)
5848 task
= dvPort_group
.Destroy_Task()
5849 status
= self
.wait_for_vcenter_task(task
, vcenter_conect
)
5851 except vmodl
.MethodFault
as exp
:
5852 self
.logger
.error("Caught vmodl fault {} while deleting disributed virtaul port group {}".format(
5853 exp
, dvPort_group_name
))
5857 def get_dvport_group(self
, dvPort_group_name
):
5859 Method to get disributed virtual portgroup
5862 network_name - name of network/portgroup
5867 vcenter_conect
, content
= self
.get_vcenter_content()
5870 container
= content
.viewManager
.CreateContainerView(content
.rootFolder
, [vim
.dvs
.DistributedVirtualPortgroup
], True)
5871 for item
in container
.view
:
5872 if item
.key
== dvPort_group_name
:
5876 except vmodl
.MethodFault
as exp
:
5877 self
.logger
.error("Caught vmodl fault {} for disributed virtaul port group {}".format(
5878 exp
, dvPort_group_name
))
5881 def get_vlanID_from_dvs_portgr(self
, dvPort_group_name
):
5883 Method to get disributed virtual portgroup vlanID
5886 network_name - name of network/portgroup
5893 dvPort_group
= self
.get_dvport_group(dvPort_group_name
)
5895 vlanId
= dvPort_group
.config
.defaultPortConfig
.vlan
.vlanId
5896 except vmodl
.MethodFault
as exp
:
5897 self
.logger
.error("Caught vmodl fault {} for disributed virtaul port group {}".format(
5898 exp
, dvPort_group_name
))
5902 def configure_vlanID(self
, content
, vcenter_conect
, dvPort_group_name
):
5904 Method to configure vlanID in disributed virtual portgroup vlanID
5907 network_name - name of network/portgroup
5912 vlanID
= self
.get_vlanID_from_dvs_portgr(dvPort_group_name
)
5915 vlanID
= self
.genrate_vlanID(dvPort_group_name
)
5916 config
= {"vlanID":vlanID
}
5917 task
= self
.reconfig_portgroup(content
, dvPort_group_name
,
5920 status
= self
.wait_for_vcenter_task(task
, vcenter_conect
)
5922 self
.logger
.info("Reconfigured Port group {} for vlan ID {}".format(
5923 dvPort_group_name
,vlanID
))
5925 self
.logger
.error("Fail reconfigure portgroup {} for vlanID{}".format(
5926 dvPort_group_name
, vlanID
))
5929 def genrate_vlanID(self
, network_name
):
5931 Method to get unused vlanID
5933 network_name - name of network/portgroup
5939 if self
.config
.get('vlanID_range') == None:
5940 raise vimconn
.vimconnConflictException("You must provide a 'vlanID_range' "\
5941 "at config value before creating sriov network with vlan tag")
5942 if "used_vlanIDs" not in self
.persistent_info
:
5943 self
.persistent_info
["used_vlanIDs"] = {}
5945 used_ids
= self
.persistent_info
["used_vlanIDs"].values()
5947 #used_ids = list(self.persistent_info["used_vlanIDs"].values())
5949 for vlanID_range
in self
.config
.get('vlanID_range'):
5950 start_vlanid
, end_vlanid
= vlanID_range
.split("-")
5951 if start_vlanid
> end_vlanid
:
5952 raise vimconn
.vimconnConflictException("Invalid vlan ID range {}".format(
5955 for id in xrange(int(start_vlanid
), int(end_vlanid
) + 1):
5957 #for id in range(int(start_vlanid), int(end_vlanid) + 1):
5958 if id not in used_ids
:
5960 self
.persistent_info
["used_vlanIDs"][network_name
] = vlan_id
5963 raise vimconn
.vimconnConflictException("All Vlan IDs are in use")
5966 def get_obj(self
, content
, vimtype
, name
):
5968 Get the vsphere object associated with a given text name
5971 container
= content
.viewManager
.CreateContainerView(content
.rootFolder
, vimtype
, True)
5972 for item
in container
.view
:
5973 if item
.name
== name
:
5979 def insert_media_to_vm(self
, vapp
, image_id
):
5981 Method to insert media CD-ROM (ISO image) from catalog to vm.
5982 vapp - vapp object to get vm id
5983 Image_id - image id for cdrom to be inerted to vm
5985 # create connection object
5986 vca
= self
.connect()
5988 # fetching catalog details
5989 rest_url
= "{}/api/catalog/{}".format(self
.url
, image_id
)
5991 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
5992 'x-vcloud-authorization': vca
._session
.headers
['x-vcloud-authorization']}
5993 response
= self
.perform_request(req_type
='GET',
5997 if response
.status_code
!= 200:
5998 self
.logger
.error("REST call {} failed reason : {}"\
5999 "status code : {}".format(url_rest_call
,
6001 response
.status_code
))
6002 raise vimconn
.vimconnException("insert_media_to_vm(): Failed to get "\
6004 # searching iso name and id
6005 iso_name
,media_id
= self
.get_media_details(vca
, response
.content
)
6007 if iso_name
and media_id
:
6008 data
="""<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
6009 <ns6:MediaInsertOrEjectParams
6010 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">
6012 type="application/vnd.vmware.vcloud.media+xml"
6014 id="urn:vcloud:media:{}"
6015 href="https://{}/api/media/{}"/>
6016 </ns6:MediaInsertOrEjectParams>""".format(iso_name
, media_id
,
6019 for vms
in vapp
.get_all_vms():
6020 vm_id
= vms
.get('id').split(':')[-1]
6022 headers
['Content-Type'] = 'application/vnd.vmware.vcloud.mediaInsertOrEjectParams+xml'
6023 rest_url
= "{}/api/vApp/vm-{}/media/action/insertMedia".format(self
.url
,vm_id
)
6025 response
= self
.perform_request(req_type
='POST',
6030 if response
.status_code
!= 202:
6031 self
.logger
.error("Failed to insert CD-ROM to vm")
6032 raise vimconn
.vimconnException("insert_media_to_vm() : Failed to insert"\
6035 task
= self
.get_task_from_response(response
.content
)
6036 result
= self
.client
.get_task_monitor().wait_for_success(task
=task
)
6037 if result
.get('status') == 'success':
6038 self
.logger
.info("insert_media_to_vm(): Sucessfully inserted media ISO"\
6039 " image to vm {}".format(vm_id
))
6041 except Exception as exp
:
6042 self
.logger
.error("insert_media_to_vm() : exception occurred "\
6043 "while inserting media CD-ROM")
6044 raise vimconn
.vimconnException(message
=exp
)
6047 def get_media_details(self
, vca
, content
):
6049 Method to get catalog item details
6050 vca - connection object
6051 content - Catalog details
6052 Return - Media name, media id
6054 cataloghref_list
= []
6057 vm_list_xmlroot
= XmlElementTree
.fromstring(content
)
6058 for child
in vm_list_xmlroot
.iter():
6059 if 'CatalogItem' in child
.tag
:
6060 cataloghref_list
.append(child
.attrib
.get('href'))
6061 if cataloghref_list
is not None:
6062 for href
in cataloghref_list
:
6064 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
6065 'x-vcloud-authorization': vca
._session
.headers
['x-vcloud-authorization']}
6066 response
= self
.perform_request(req_type
='GET',
6069 if response
.status_code
!= 200:
6070 self
.logger
.error("REST call {} failed reason : {}"\
6071 "status code : {}".format(href
,
6073 response
.status_code
))
6074 raise vimconn
.vimconnException("get_media_details : Failed to get "\
6075 "catalogitem details")
6076 list_xmlroot
= XmlElementTree
.fromstring(response
.content
)
6077 for child
in list_xmlroot
.iter():
6078 if 'Entity' in child
.tag
:
6079 if 'media' in child
.attrib
.get('href'):
6080 name
= child
.attrib
.get('name')
6081 media_id
= child
.attrib
.get('href').split('/').pop()
6082 return name
,media_id
6084 self
.logger
.debug("Media name and id not found")
6086 except Exception as exp
:
6087 self
.logger
.error("get_media_details : exception occurred "\
6088 "getting media details")
6089 raise vimconn
.vimconnException(message
=exp
)
6092 def retry_rest(self
, method
, url
, add_headers
=None, data
=None):
6093 """ Method to get Token & retry respective REST request
6095 api - REST API - Can be one of 'GET' or 'PUT' or 'POST'
6096 url - request url to be used
6097 add_headers - Additional headers (optional)
6098 data - Request payload data to be passed in request
6100 response - Response of request
6107 if self
.client
._session
:
6108 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
6109 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
6112 headers
.update(add_headers
)
6115 response
= self
.perform_request(req_type
='GET',
6118 elif method
== 'PUT':
6119 response
= self
.perform_request(req_type
='PUT',
6123 elif method
== 'POST':
6124 response
= self
.perform_request(req_type
='POST',
6128 elif method
== 'DELETE':
6129 response
= self
.perform_request(req_type
='DELETE',
6135 def get_token(self
):
6136 """ Generate a new token if expired
6139 The return client object that letter can be used to connect to vCloud director as admin for VDC
6142 self
.logger
.debug("Generate token for vca {} as {} to datacenter {}.".format(self
.org_name
,
6146 client
= Client(host
, verify_ssl_certs
=False)
6147 client
.set_credentials(BasicLoginCredentials(self
.user
, self
.org_name
, self
.passwd
))
6149 self
.client
= client
6152 raise vimconn
.vimconnConnectionException("Can't connect to a vCloud director org: "
6153 "{} as user: {}".format(self
.org_name
, self
.user
))
6156 raise vimconn
.vimconnConnectionException("Failed while reconnecting vCD")
6159 def get_vdc_details(self
):
6160 """ Get VDC details using pyVcloud Lib
6162 Returns org and vdc object
6164 org
= Org(self
.client
, resource
=self
.client
.get_org())
6165 vdc
= org
.get_vdc(self
.tenant_name
)
6167 #Retry once, if failed by refreshing token
6170 vdc
= org
.get_vdc(self
.tenant_name
)
6175 def perform_request(self
, req_type
, url
, headers
=None, data
=None):
6176 """Perform the POST/PUT/GET/DELETE request."""
6178 #Log REST request details
6179 self
.log_request(req_type
, url
=url
, headers
=headers
, data
=data
)
6180 # perform request and return its result
6181 if req_type
== 'GET':
6182 response
= requests
.get(url
=url
,
6185 elif req_type
== 'PUT':
6186 response
= requests
.put(url
=url
,
6190 elif req_type
== 'POST':
6191 response
= requests
.post(url
=url
,
6195 elif req_type
== 'DELETE':
6196 response
= requests
.delete(url
=url
,
6199 #Log the REST response
6200 self
.log_response(response
)
6205 def log_request(self
, req_type
, url
=None, headers
=None, data
=None):
6206 """Logs REST request details"""
6208 if req_type
is not None:
6209 self
.logger
.debug("Request type: {}".format(req_type
))
6212 self
.logger
.debug("Request url: {}".format(url
))
6214 if headers
is not None:
6215 for header
in headers
:
6216 self
.logger
.debug("Request header: {}: {}".format(header
, headers
[header
]))
6218 if data
is not None:
6219 self
.logger
.debug("Request data: {}".format(data
))
6222 def log_response(self
, response
):
6223 """Logs REST response details"""
6225 self
.logger
.debug("Response status code: {} ".format(response
.status_code
))
6228 def get_task_from_response(self
, content
):
6230 content - API response content(response.content)
6233 xmlroot
= XmlElementTree
.fromstring(content
)
6234 if xmlroot
.tag
.split('}')[1] == "Task":
6238 if ele
.tag
.split("}")[1] == "Tasks":
6244 def power_on_vapp(self
,vapp_id
, vapp_name
):
6247 vapp_name - vAapp name
6248 return - Task object
6250 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
6251 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
6253 poweron_href
= "{}/api/vApp/vapp-{}/power/action/powerOn".format(self
.url
,
6255 response
= self
.perform_request(req_type
='POST',
6259 if response
.status_code
!= 202:
6260 self
.logger
.error("REST call {} failed reason : {}"\
6261 "status code : {} ".format(poweron_href
,
6263 response
.status_code
))
6264 raise vimconn
.vimconnException("power_on_vapp() : Failed to power on "\
6265 "vApp {}".format(vapp_name
))
6267 poweron_task
= self
.get_task_from_response(response
.content
)