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("Adding {} to a list vcd id {} network {}".format(net_uuid
,
584 net_details
.get('name')))
585 filter_dict
["name"] = net_details
.get('name')
586 filter_dict
["id"] = net_uuid
587 if [i
.text
for i
in net_details
if i
.tag
.split('}')[-1] == 'IsShared'][0] == 'true':
591 filter_dict
["shared"] = shared
592 filter_dict
["tenant_id"] = vdc_uuid
593 if int(net_details
.get('status')) == 1:
594 filter_dict
["admin_state_up"] = True
596 filter_dict
["admin_state_up"] = False
597 filter_dict
["status"] = "ACTIVE"
598 filter_dict
["type"] = "bridge"
599 network_list
.append(filter_dict
)
600 self
.logger
.debug("get_vcd_network_list adding entry {}".format(filter_dict
))
602 self
.logger
.debug("Error in get_vcd_network_list", exc_info
=True)
605 self
.logger
.debug("get_vcd_network_list returning {}".format(network_list
))
608 def get_network_list(self
, filter_dict
={}):
609 """Obtain tenant networks of VIM
611 name: network name OR/AND
612 id: network uuid OR/AND
613 shared: boolean OR/AND
614 tenant_id: tenant OR/AND
615 admin_state_up: boolean
618 [{key : value , key : value}]
620 Returns the network list of dictionaries:
621 [{<the fields at Filter_dict plus some VIM specific>}, ...]
625 self
.logger
.debug("get_network_list(): retrieving network list for vcd {}".format(self
.tenant_name
))
627 if not self
.tenant_name
:
628 raise vimconn
.vimconnConnectionException("Tenant name is empty.")
630 org
, vdc
= self
.get_vdc_details()
632 raise vimconn
.vimconnConnectionException("Can't retrieve information for a VDC {}.".format(self
.tenant_name
))
635 vdcid
= vdc
.get('id').split(":")[3]
637 if self
.client
._session
:
638 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
639 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
640 response
= self
.perform_request(req_type
='GET',
643 if response
.status_code
!= 200:
644 self
.logger
.error("Failed to get vdc content")
645 raise vimconn
.vimconnNotFoundException("Failed to get vdc content")
647 content
= XmlElementTree
.fromstring(response
.content
)
651 if item
.tag
.split('}')[-1] == 'AvailableNetworks':
653 response
= self
.perform_request(req_type
='GET',
657 if response
.status_code
!= 200:
658 self
.logger
.error("Failed to get network content")
659 raise vimconn
.vimconnNotFoundException("Failed to get network content")
661 net_details
= XmlElementTree
.fromstring(response
.content
)
664 net_uuid
= net_details
.get('id').split(":")
665 if len(net_uuid
) != 4:
668 net_uuid
= net_uuid
[3]
670 self
.logger
.debug("Adding {} to a list vcd id {} network {}".format(net_uuid
,
672 net_details
.get('name')))
673 filter_entry
["name"] = net_details
.get('name')
674 filter_entry
["id"] = net_uuid
675 if [i
.text
for i
in net_details
if i
.tag
.split('}')[-1] == 'IsShared'][0] == 'true':
679 filter_entry
["shared"] = shared
680 filter_entry
["tenant_id"] = vdcid
681 if int(net_details
.get('status')) == 1:
682 filter_entry
["admin_state_up"] = True
684 filter_entry
["admin_state_up"] = False
685 filter_entry
["status"] = "ACTIVE"
686 filter_entry
["type"] = "bridge"
687 filtered_entry
= filter_entry
.copy()
689 if filter_dict
is not None and filter_dict
:
690 # we remove all the key : value we don't care and match only
692 filtered_dict
= set(filter_entry
.keys()) - set(filter_dict
)
693 for unwanted_key
in filtered_dict
: del filter_entry
[unwanted_key
]
694 if filter_dict
== filter_entry
:
695 network_list
.append(filtered_entry
)
697 network_list
.append(filtered_entry
)
698 except Exception as e
:
699 self
.logger
.debug("Error in get_network_list",exc_info
=True)
700 if isinstance(e
, vimconn
.vimconnException
):
703 raise vimconn
.vimconnNotFoundException("Failed : Networks list not found {} ".format(e
))
705 self
.logger
.debug("Returning {}".format(network_list
))
708 def get_network(self
, net_id
):
709 """Method obtains network details of net_id VIM network
710 Return a dict with the fields at filter_dict (see get_network_list) plus some VIM specific>}, ...]"""
713 org
, vdc
= self
.get_vdc_details()
714 vdc_id
= vdc
.get('id').split(":")[3]
715 if self
.client
._session
:
716 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
717 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
718 response
= self
.perform_request(req_type
='GET',
721 if response
.status_code
!= 200:
722 self
.logger
.error("Failed to get vdc content")
723 raise vimconn
.vimconnNotFoundException("Failed to get vdc content")
725 content
= XmlElementTree
.fromstring(response
.content
)
730 if item
.tag
.split('}')[-1] == 'AvailableNetworks':
732 response
= self
.perform_request(req_type
='GET',
736 if response
.status_code
!= 200:
737 self
.logger
.error("Failed to get network content")
738 raise vimconn
.vimconnNotFoundException("Failed to get network content")
740 net_details
= XmlElementTree
.fromstring(response
.content
)
742 vdc_network_id
= net_details
.get('id').split(":")
743 if len(vdc_network_id
) == 4 and vdc_network_id
[3] == net_id
:
744 filter_dict
["name"] = net_details
.get('name')
745 filter_dict
["id"] = vdc_network_id
[3]
746 if [i
.text
for i
in net_details
if i
.tag
.split('}')[-1] == 'IsShared'][0] == 'true':
750 filter_dict
["shared"] = shared
751 filter_dict
["tenant_id"] = vdc_id
752 if int(net_details
.get('status')) == 1:
753 filter_dict
["admin_state_up"] = True
755 filter_dict
["admin_state_up"] = False
756 filter_dict
["status"] = "ACTIVE"
757 filter_dict
["type"] = "bridge"
758 self
.logger
.debug("Returning {}".format(filter_dict
))
761 raise vimconn
.vimconnNotFoundException("Network {} not found".format(net_id
))
762 except Exception as e
:
763 self
.logger
.debug("Error in get_network")
764 self
.logger
.debug(traceback
.format_exc())
765 if isinstance(e
, vimconn
.vimconnException
):
768 raise vimconn
.vimconnNotFoundException("Failed : Network not found {} ".format(e
))
772 def delete_network(self
, net_id
):
774 Method Deletes a tenant network from VIM, provide the network id.
776 Returns the network identifier or raise an exception
779 # ############# Stub code for SRIOV #################
780 # dvport_group = self.get_dvport_group(net_id)
783 # status = self.destroy_dvport_group(net_id)
785 # # Remove vlanID from persistent info
786 # if net_id in self.persistent_info["used_vlanIDs"]:
787 # del self.persistent_info["used_vlanIDs"][net_id]
791 vcd_network
= self
.get_vcd_network(network_uuid
=net_id
)
792 if vcd_network
is not None and vcd_network
:
793 if self
.delete_network_action(network_uuid
=net_id
):
796 raise vimconn
.vimconnNotFoundException("Network {} not found".format(net_id
))
798 def refresh_nets_status(self
, net_list
):
799 """Get the status of the networks
800 Params: the list of network identifiers
801 Returns a dictionary with:
802 net_id: #VIM id of this network
803 status: #Mandatory. Text with one of:
804 # DELETED (not found at vim)
805 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
806 # OTHER (Vim reported other status not understood)
807 # ERROR (VIM indicates an ERROR status)
808 # ACTIVE, INACTIVE, DOWN (admin down),
809 # BUILD (on building process)
811 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
812 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
820 vcd_network
= self
.get_vcd_network(network_uuid
=net
)
821 if vcd_network
is not None and vcd_network
:
822 if vcd_network
['status'] == '1':
828 errormsg
= 'Network not found.'
830 dict_entry
[net
] = {'status': status
, 'error_msg': errormsg
,
831 'vim_info': yaml
.safe_dump(vcd_network
)}
833 self
.logger
.debug("Error in refresh_nets_status")
834 self
.logger
.debug(traceback
.format_exc())
838 def get_flavor(self
, flavor_id
):
839 """Obtain flavor details from the VIM
840 Returns the flavor dict details {'id':<>, 'name':<>, other vim specific } #TODO to concrete
842 if flavor_id
not in vimconnector
.flavorlist
:
843 raise vimconn
.vimconnNotFoundException("Flavor not found.")
844 return vimconnector
.flavorlist
[flavor_id
]
846 def new_flavor(self
, flavor_data
):
847 """Adds a tenant flavor to VIM
848 flavor_data contains a dictionary with information, keys:
850 ram: memory (cloud type) in MBytes
851 vpcus: cpus (cloud type)
852 extended: EPA parameters
853 - numas: #items requested in same NUMA
854 memory: number of 1G huge pages memory
855 paired-threads|cores|threads: number of paired hyperthreads, complete cores OR individual threads
856 interfaces: # passthrough(PT) or SRIOV interfaces attached to this numa
857 - name: interface name
858 dedicated: yes|no|yes:sriov; for PT, SRIOV or only one SRIOV for the physical NIC
859 bandwidth: X Gbps; requested guarantee bandwidth
860 vpci: requested virtual PCI address
864 Returns the flavor identifier"""
866 # generate a new uuid put to internal dict and return it.
867 self
.logger
.debug("Creating new flavor - flavor_data: {}".format(flavor_data
))
868 new_flavor
=flavor_data
869 ram
= flavor_data
.get(FLAVOR_RAM_KEY
, 1024)
870 cpu
= flavor_data
.get(FLAVOR_VCPUS_KEY
, 1)
871 disk
= flavor_data
.get(FLAVOR_DISK_KEY
, 0)
873 if not isinstance(ram
, int):
874 raise vimconn
.vimconnException("Non-integer value for ram")
875 elif not isinstance(cpu
, int):
876 raise vimconn
.vimconnException("Non-integer value for cpu")
877 elif not isinstance(disk
, int):
878 raise vimconn
.vimconnException("Non-integer value for disk")
880 extended_flv
= flavor_data
.get("extended")
882 numas
=extended_flv
.get("numas")
885 #overwrite ram and vcpus
887 ram
= numa
['memory']*1024
888 if 'paired-threads' in numa
:
889 cpu
= numa
['paired-threads']*2
890 elif 'cores' in numa
:
892 elif 'threads' in numa
:
893 cpu
= numa
['threads']
895 new_flavor
[FLAVOR_RAM_KEY
] = ram
896 new_flavor
[FLAVOR_VCPUS_KEY
] = cpu
897 new_flavor
[FLAVOR_DISK_KEY
] = disk
898 # generate a new uuid put to internal dict and return it.
899 flavor_id
= uuid
.uuid4()
900 vimconnector
.flavorlist
[str(flavor_id
)] = new_flavor
901 self
.logger
.debug("Created flavor - {} : {}".format(flavor_id
, new_flavor
))
903 return str(flavor_id
)
905 def delete_flavor(self
, flavor_id
):
906 """Deletes a tenant flavor from VIM identify by its id
908 Returns the used id or raise an exception
910 if flavor_id
not in vimconnector
.flavorlist
:
911 raise vimconn
.vimconnNotFoundException("Flavor not found.")
913 vimconnector
.flavorlist
.pop(flavor_id
, None)
916 def new_image(self
, image_dict
):
918 Adds a tenant image to VIM
920 200, image-id if the image is created
921 <0, message if there is an error
924 return self
.get_image_id_from_path(image_dict
['location'])
926 def delete_image(self
, image_id
):
928 Deletes a tenant image from VIM
930 image_id is ID of Image to be deleted
932 returns the image identifier in UUID format or raises an exception on error
934 conn
= self
.connect_as_admin()
936 raise vimconn
.vimconnConnectionException("Failed to connect vCD")
937 # Get Catalog details
938 url_list
= [self
.url
, '/api/catalog/', image_id
]
939 catalog_herf
= ''.join(url_list
)
941 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
942 'x-vcloud-authorization': conn
._session
.headers
['x-vcloud-authorization']}
944 response
= self
.perform_request(req_type
='GET',
948 if response
.status_code
!= requests
.codes
.ok
:
949 self
.logger
.debug("delete_image():GET REST API call {} failed. "\
950 "Return status code {}".format(catalog_herf
,
951 response
.status_code
))
952 raise vimconn
.vimconnNotFoundException("Fail to get image {}".format(image_id
))
954 lxmlroot_respond
= lxmlElementTree
.fromstring(response
.content
)
955 namespaces
= {prefix
:uri
for prefix
,uri
in lxmlroot_respond
.nsmap
.iteritems() if prefix
}
957 #namespaces = {prefix:uri for prefix,uri in lxmlroot_respond.nsmap.items() if prefix}
958 namespaces
["xmlns"]= "http://www.vmware.com/vcloud/v1.5"
960 catalogItems_section
= lxmlroot_respond
.find("xmlns:CatalogItems",namespaces
)
961 catalogItems
= catalogItems_section
.iterfind("xmlns:CatalogItem",namespaces
)
962 for catalogItem
in catalogItems
:
963 catalogItem_href
= catalogItem
.attrib
['href']
965 response
= self
.perform_request(req_type
='GET',
966 url
=catalogItem_href
,
969 if response
.status_code
!= requests
.codes
.ok
:
970 self
.logger
.debug("delete_image():GET REST API call {} failed. "\
971 "Return status code {}".format(catalog_herf
,
972 response
.status_code
))
973 raise vimconn
.vimconnNotFoundException("Fail to get catalogItem {} for catalog {}".format(
977 lxmlroot_respond
= lxmlElementTree
.fromstring(response
.content
)
978 namespaces
= {prefix
:uri
for prefix
,uri
in lxmlroot_respond
.nsmap
.iteritems() if prefix
}
980 #namespaces = {prefix:uri for prefix,uri in lxmlroot_respond.nsmap.items() if prefix}
981 namespaces
["xmlns"]= "http://www.vmware.com/vcloud/v1.5"
982 catalogitem_remove_href
= lxmlroot_respond
.find("xmlns:Link[@rel='remove']",namespaces
).attrib
['href']
985 response
= self
.perform_request(req_type
='DELETE',
986 url
=catalogitem_remove_href
,
988 if response
.status_code
== requests
.codes
.no_content
:
989 self
.logger
.debug("Deleted Catalog item {}".format(catalogItem
))
991 raise vimconn
.vimconnException("Fail to delete Catalog Item {}".format(catalogItem
))
994 url_list
= [self
.url
, '/api/admin/catalog/', image_id
]
995 catalog_remove_herf
= ''.join(url_list
)
996 response
= self
.perform_request(req_type
='DELETE',
997 url
=catalog_remove_herf
,
1000 if response
.status_code
== requests
.codes
.no_content
:
1001 self
.logger
.debug("Deleted Catalog {}".format(image_id
))
1004 raise vimconn
.vimconnException("Fail to delete Catalog {}".format(image_id
))
1007 def catalog_exists(self
, catalog_name
, catalogs
):
1010 :param catalog_name:
1014 for catalog
in catalogs
:
1015 if catalog
['name'] == catalog_name
:
1019 def create_vimcatalog(self
, vca
=None, catalog_name
=None):
1020 """ Create new catalog entry in vCloud director.
1023 vca: vCloud director.
1024 catalog_name catalog that client wish to create. Note no validation done for a name.
1025 Client must make sure that provide valid string representation.
1027 Return (bool) True if catalog created.
1031 result
= vca
.create_catalog(catalog_name
, catalog_name
)
1032 if result
is not None:
1034 catalogs
= vca
.list_catalogs()
1037 return self
.catalog_exists(catalog_name
, catalogs
)
1039 # noinspection PyIncorrectDocstring
1040 def upload_ovf(self
, vca
=None, catalog_name
=None, image_name
=None, media_file_name
=None,
1041 description
='', progress
=False, chunk_bytes
=128 * 1024):
1043 Uploads a OVF file to a vCloud catalog
1050 :param catalog_name: (str): The name of the catalog to upload the media.
1051 :param media_file_name: (str): The name of the local media file to upload.
1052 :return: (bool) True if the media file was successfully uploaded, false otherwise.
1054 os
.path
.isfile(media_file_name
)
1055 statinfo
= os
.stat(media_file_name
)
1057 # find a catalog entry where we upload OVF.
1058 # create vApp Template and check the status if vCD able to read OVF it will respond with appropirate
1060 # if VCD can parse OVF we upload VMDK file
1062 for catalog
in vca
.list_catalogs():
1063 if catalog_name
!= catalog
['name']:
1065 catalog_href
= "{}/api/catalog/{}/action/upload".format(self
.url
, catalog
['id'])
1067 <UploadVAppTemplateParams name="{}" xmlns="http://www.vmware.com/vcloud/v1.5" xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"><Description>{} vApp Template</Description></UploadVAppTemplateParams>
1068 """.format(catalog_name
, description
)
1071 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
1072 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
1073 headers
['Content-Type'] = 'application/vnd.vmware.vcloud.uploadVAppTemplateParams+xml'
1075 response
= self
.perform_request(req_type
='POST',
1080 if response
.status_code
== requests
.codes
.created
:
1081 catalogItem
= XmlElementTree
.fromstring(response
.content
)
1082 entity
= [child
for child
in catalogItem
if
1083 child
.get("type") == "application/vnd.vmware.vcloud.vAppTemplate+xml"][0]
1084 href
= entity
.get('href')
1087 response
= self
.perform_request(req_type
='GET',
1091 if response
.status_code
== requests
.codes
.ok
:
1092 headers
['Content-Type'] = 'Content-Type text/xml'
1093 result
= re
.search('rel="upload:default"\shref="(.*?\/descriptor.ovf)"',response
.content
)
1095 transfer_href
= result
.group(1)
1097 response
= self
.perform_request(req_type
='PUT',
1100 data
=open(media_file_name
, 'rb'))
1101 if response
.status_code
!= requests
.codes
.ok
:
1103 "Failed create vApp template for catalog name {} and image {}".format(catalog_name
,
1107 # TODO fix this with aync block
1110 self
.logger
.debug("vApp template for catalog name {} and image {}".format(catalog_name
, media_file_name
))
1112 # uploading VMDK file
1113 # check status of OVF upload and upload remaining files.
1114 response
= self
.perform_request(req_type
='GET',
1118 if response
.status_code
== requests
.codes
.ok
:
1119 result
= re
.search('rel="upload:default"\s*href="(.*?vmdk)"',response
.content
)
1121 link_href
= result
.group(1)
1122 # we skip ovf since it already uploaded.
1123 if 'ovf' in link_href
:
1125 # The OVF file and VMDK must be in a same directory
1126 head
, tail
= os
.path
.split(media_file_name
)
1127 file_vmdk
= head
+ '/' + link_href
.split("/")[-1]
1128 if not os
.path
.isfile(file_vmdk
):
1130 statinfo
= os
.stat(file_vmdk
)
1131 if statinfo
.st_size
== 0:
1133 hrefvmdk
= link_href
1136 widgets
= ['Uploading file: ', Percentage(), ' ', Bar(), ' ', ETA(), ' ',
1137 FileTransferSpeed()]
1138 progress_bar
= ProgressBar(widgets
=widgets
, maxval
=statinfo
.st_size
).start()
1140 bytes_transferred
= 0
1141 f
= open(file_vmdk
, 'rb')
1142 while bytes_transferred
< statinfo
.st_size
:
1143 my_bytes
= f
.read(chunk_bytes
)
1144 if len(my_bytes
) <= chunk_bytes
:
1145 headers
['Content-Range'] = 'bytes %s-%s/%s' % (
1146 bytes_transferred
, len(my_bytes
) - 1, statinfo
.st_size
)
1147 headers
['Content-Length'] = str(len(my_bytes
))
1148 response
= requests
.put(url
=hrefvmdk
,
1152 if response
.status_code
== requests
.codes
.ok
:
1153 bytes_transferred
+= len(my_bytes
)
1155 progress_bar
.update(bytes_transferred
)
1158 'file upload failed with error: [%s] %s' % (response
.status_code
,
1165 progress_bar
.finish()
1169 self
.logger
.debug("Failed retrieve vApp template for catalog name {} for OVF {}".
1170 format(catalog_name
, media_file_name
))
1172 except Exception as exp
:
1173 self
.logger
.debug("Failed while uploading OVF to catalog {} for OVF file {} with Exception {}"
1174 .format(catalog_name
,media_file_name
, exp
))
1175 raise vimconn
.vimconnException(
1176 "Failed while uploading OVF to catalog {} for OVF file {} with Exception {}"
1177 .format(catalog_name
,media_file_name
, exp
))
1179 self
.logger
.debug("Failed retrieve catalog name {} for OVF file {}".format(catalog_name
, media_file_name
))
1182 def upload_vimimage(self
, vca
=None, catalog_name
=None, media_name
=None, medial_file_name
=None, progress
=False):
1183 """Upload media file"""
1184 # TODO add named parameters for readability
1186 return self
.upload_ovf(vca
=vca
, catalog_name
=catalog_name
, image_name
=media_name
.split(".")[0],
1187 media_file_name
=medial_file_name
, description
='medial_file_name', progress
=progress
)
1189 def validate_uuid4(self
, uuid_string
=None):
1190 """ Method validate correct format of UUID.
1192 Return: true if string represent valid uuid
1195 val
= uuid
.UUID(uuid_string
, version
=4)
1200 def get_catalogid(self
, catalog_name
=None, catalogs
=None):
1201 """ Method check catalog and return catalog ID in UUID format.
1204 catalog_name: catalog name as string
1205 catalogs: list of catalogs.
1207 Return: catalogs uuid
1210 for catalog
in catalogs
:
1211 if catalog
['name'] == catalog_name
:
1212 catalog_id
= catalog
['id']
1216 def get_catalogbyid(self
, catalog_uuid
=None, catalogs
=None):
1217 """ Method check catalog and return catalog name lookup done by catalog UUID.
1220 catalog_name: catalog name as string
1221 catalogs: list of catalogs.
1223 Return: catalogs name or None
1226 if not self
.validate_uuid4(uuid_string
=catalog_uuid
):
1229 for catalog
in catalogs
:
1230 catalog_id
= catalog
.get('id')
1231 if catalog_id
== catalog_uuid
:
1232 return catalog
.get('name')
1235 def get_catalog_obj(self
, catalog_uuid
=None, catalogs
=None):
1236 """ Method check catalog and return catalog name lookup done by catalog UUID.
1239 catalog_name: catalog name as string
1240 catalogs: list of catalogs.
1242 Return: catalogs name or None
1245 if not self
.validate_uuid4(uuid_string
=catalog_uuid
):
1248 for catalog
in catalogs
:
1249 catalog_id
= catalog
.get('id')
1250 if catalog_id
== catalog_uuid
:
1254 def get_image_id_from_path(self
, path
=None, progress
=False):
1255 """ Method upload OVF image to vCloud director.
1257 Each OVF image represented as single catalog entry in vcloud director.
1258 The method check for existing catalog entry. The check done by file name without file extension.
1260 if given catalog name already present method will respond with existing catalog uuid otherwise
1261 it will create new catalog entry and upload OVF file to newly created catalog.
1263 If method can't create catalog entry or upload a file it will throw exception.
1265 Method accept boolean flag progress that will output progress bar. It useful method
1266 for standalone upload use case. In case to test large file upload.
1269 path: - valid path to OVF file.
1270 progress - boolean progress bar show progress bar.
1272 Return: if image uploaded correct method will provide image catalog UUID.
1276 raise vimconn
.vimconnException("Image path can't be None.")
1278 if not os
.path
.isfile(path
):
1279 raise vimconn
.vimconnException("Can't read file. File not found.")
1281 if not os
.access(path
, os
.R_OK
):
1282 raise vimconn
.vimconnException("Can't read file. Check file permission to read.")
1284 self
.logger
.debug("get_image_id_from_path() client requesting {} ".format(path
))
1286 dirpath
, filename
= os
.path
.split(path
)
1287 flname
, file_extension
= os
.path
.splitext(path
)
1288 if file_extension
!= '.ovf':
1289 self
.logger
.debug("Wrong file extension {} connector support only OVF container.".format(file_extension
))
1290 raise vimconn
.vimconnException("Wrong container. vCloud director supports only OVF.")
1292 catalog_name
= os
.path
.splitext(filename
)[0]
1293 catalog_md5_name
= hashlib
.md5(path
).hexdigest()
1294 self
.logger
.debug("File name {} Catalog Name {} file path {} "
1295 "vdc catalog name {}".format(filename
, catalog_name
, path
, catalog_md5_name
))
1298 org
,vdc
= self
.get_vdc_details()
1299 catalogs
= org
.list_catalogs()
1300 except Exception as exp
:
1301 self
.logger
.debug("Failed get catalogs() with Exception {} ".format(exp
))
1302 raise vimconn
.vimconnException("Failed get catalogs() with Exception {} ".format(exp
))
1304 if len(catalogs
) == 0:
1305 self
.logger
.info("Creating a new catalog entry {} in vcloud director".format(catalog_name
))
1306 result
= self
.create_vimcatalog(org
, catalog_md5_name
)
1308 raise vimconn
.vimconnException("Failed create new catalog {} ".format(catalog_md5_name
))
1310 result
= self
.upload_vimimage(vca
=org
, catalog_name
=catalog_md5_name
,
1311 media_name
=filename
, medial_file_name
=path
, progress
=progress
)
1313 raise vimconn
.vimconnException("Failed create vApp template for catalog {} ".format(catalog_name
))
1314 return self
.get_catalogid(catalog_name
, catalogs
)
1316 for catalog
in catalogs
:
1317 # search for existing catalog if we find same name we return ID
1318 # TODO optimize this
1319 if catalog
['name'] == catalog_md5_name
:
1320 self
.logger
.debug("Found existing catalog entry for {} "
1321 "catalog id {}".format(catalog_name
,
1322 self
.get_catalogid(catalog_md5_name
, catalogs
)))
1323 return self
.get_catalogid(catalog_md5_name
, catalogs
)
1325 # if we didn't find existing catalog we create a new one and upload image.
1326 self
.logger
.debug("Creating new catalog entry {} - {}".format(catalog_name
, catalog_md5_name
))
1327 result
= self
.create_vimcatalog(org
, catalog_md5_name
)
1329 raise vimconn
.vimconnException("Failed create new catalog {} ".format(catalog_md5_name
))
1331 result
= self
.upload_vimimage(vca
=org
, catalog_name
=catalog_md5_name
,
1332 media_name
=filename
, medial_file_name
=path
, progress
=progress
)
1334 raise vimconn
.vimconnException("Failed create vApp template for catalog {} ".format(catalog_md5_name
))
1336 return self
.get_catalogid(catalog_md5_name
, org
.list_catalogs())
1338 def get_image_list(self
, filter_dict
={}):
1339 '''Obtain tenant images from VIM
1343 checksum: image checksum
1344 location: image path
1345 Returns the image list of dictionaries:
1346 [{<the fields at Filter_dict plus some VIM specific>}, ...]
1351 org
, vdc
= self
.get_vdc_details()
1353 catalogs
= org
.list_catalogs()
1354 if len(catalogs
) == 0:
1357 for catalog
in catalogs
:
1358 catalog_uuid
= catalog
.get('id')
1359 name
= catalog
.get('name')
1361 if filter_dict
.get("name") and filter_dict
["name"] != name
:
1363 if filter_dict
.get("id") and filter_dict
["id"] != catalog_uuid
:
1365 filtered_dict
["name"] = name
1366 filtered_dict
["id"] = catalog_uuid
1367 image_list
.append(filtered_dict
)
1369 self
.logger
.debug("List of already created catalog items: {}".format(image_list
))
1371 except Exception as exp
:
1372 raise vimconn
.vimconnException("Exception occured while retriving catalog items {}".format(exp
))
1374 def get_vappid(self
, vdc
=None, vapp_name
=None):
1375 """ Method takes vdc object and vApp name and returns vapp uuid or None
1378 vdc: The VDC object.
1379 vapp_name: is application vappp name identifier
1382 The return vApp name otherwise None
1384 if vdc
is None or vapp_name
is None:
1386 # UUID has following format https://host/api/vApp/vapp-30da58a3-e7c7-4d09-8f68-d4c8201169cf
1388 refs
= filter(lambda ref
: ref
.name
== vapp_name
and ref
.type_
== 'application/vnd.vmware.vcloud.vApp+xml',
1389 vdc
.ResourceEntities
.ResourceEntity
)
1391 #refs = [ref for ref in vdc.ResourceEntities.ResourceEntity\
1392 # if ref.name == vapp_name and ref.type_ == 'application/vnd.vmware.vcloud.vApp+xml']
1394 return refs
[0].href
.split("vapp")[1][1:]
1395 except Exception as e
:
1396 self
.logger
.exception(e
)
1400 def check_vapp(self
, vdc
=None, vapp_uuid
=None):
1401 """ Method Method returns True or False if vapp deployed in vCloud director
1404 vca: Connector to VCA
1405 vdc: The VDC object.
1406 vappid: vappid is application identifier
1409 The return True if vApp deployed
1414 refs
= filter(lambda ref
:
1415 ref
.type_
== 'application/vnd.vmware.vcloud.vApp+xml',
1416 vdc
.ResourceEntities
.ResourceEntity
)
1418 #refs = [ref for ref in vdc.ResourceEntities.ResourceEntity\
1419 # if ref.type_ == 'application/vnd.vmware.vcloud.vApp+xml']
1421 vappid
= ref
.href
.split("vapp")[1][1:]
1422 # find vapp with respected vapp uuid
1423 if vappid
== vapp_uuid
:
1425 except Exception as e
:
1426 self
.logger
.exception(e
)
1430 def get_namebyvappid(self
, vapp_uuid
=None):
1431 """Method returns vApp name from vCD and lookup done by vapp_id.
1434 vapp_uuid: vappid is application identifier
1437 The return vApp name otherwise None
1440 if self
.client
and vapp_uuid
:
1441 vapp_call
= "{}/api/vApp/vapp-{}".format(self
.url
, vapp_uuid
)
1442 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
1443 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
1445 response
= self
.perform_request(req_type
='GET',
1448 #Retry login if session expired & retry sending request
1449 if response
.status_code
== 403:
1450 response
= self
.retry_rest('GET', vapp_call
)
1452 tree
= XmlElementTree
.fromstring(response
.content
)
1453 return tree
.attrib
['name']
1454 except Exception as e
:
1455 self
.logger
.exception(e
)
1459 def new_vminstance(self
, name
=None, description
="", start
=False, image_id
=None, flavor_id
=None, net_list
=[],
1460 cloud_config
=None, disk_list
=None, availability_zone_index
=None, availability_zone_list
=None):
1461 """Adds a VM instance to VIM
1463 'start': (boolean) indicates if VM must start or created in pause mode.
1464 'image_id','flavor_id': image and flavor VIM id to use for the VM
1465 'net_list': list of interfaces, each one is a dictionary with:
1466 'name': (optional) name for the interface.
1467 'net_id': VIM network id where this interface must be connect to. Mandatory for type==virtual
1468 'vpci': (optional) virtual vPCI address to assign at the VM. Can be ignored depending on VIM capabilities
1469 'model': (optional and only have sense for type==virtual) interface model: virtio, e2000, ...
1470 'mac_address': (optional) mac address to assign to this interface
1471 #TODO: CHECK if an optional 'vlan' parameter is needed for VIMs when type if VF and net_id is not provided,
1472 the VLAN tag to be used. In case net_id is provided, the internal network vlan is used for tagging VF
1473 'type': (mandatory) can be one of:
1474 'virtual', in this case always connected to a network of type 'net_type=bridge'
1475 'PCI-PASSTHROUGH' or 'PF' (passthrough): depending on VIM capabilities it can be connected to a data/ptp network ot it
1476 can created unconnected
1477 'SR-IOV' or 'VF' (SRIOV with VLAN tag): same as PF for network connectivity.
1478 'VFnotShared'(SRIOV without VLAN tag) same as PF for network connectivity. VF where no other VFs
1479 are allocated on the same physical NIC
1480 'bw': (optional) only for PF/VF/VFnotShared. Minimal Bandwidth required for the interface in GBPS
1481 'port_security': (optional) If False it must avoid any traffic filtering at this interface. If missing
1482 or True, it must apply the default VIM behaviour
1483 After execution the method will add the key:
1484 'vim_id': must be filled/added by this method with the VIM identifier generated by the VIM for this
1485 interface. 'net_list' is modified
1486 'cloud_config': (optional) dictionary with:
1487 'key-pairs': (optional) list of strings with the public key to be inserted to the default user
1488 'users': (optional) list of users to be inserted, each item is a dict with:
1489 'name': (mandatory) user name,
1490 'key-pairs': (optional) list of strings with the public key to be inserted to the user
1491 'user-data': (optional) can be a string with the text script to be passed directly to cloud-init,
1492 or a list of strings, each one contains a script to be passed, usually with a MIMEmultipart file
1493 'config-files': (optional). List of files to be transferred. Each item is a dict with:
1494 'dest': (mandatory) string with the destination absolute path
1495 'encoding': (optional, by default text). Can be one of:
1496 'b64', 'base64', 'gz', 'gz+b64', 'gz+base64', 'gzip+b64', 'gzip+base64'
1497 'content' (mandatory): string with the content of the file
1498 'permissions': (optional) string with file permissions, typically octal notation '0644'
1499 'owner': (optional) file owner, string with the format 'owner:group'
1500 'boot-data-drive': boolean to indicate if user-data must be passed using a boot drive (hard disk)
1501 'disk_list': (optional) list with additional disks to the VM. Each item is a dict with:
1502 'image_id': (optional). VIM id of an existing image. If not provided an empty disk must be mounted
1503 'size': (mandatory) string with the size of the disk in GB
1504 availability_zone_index: Index of availability_zone_list to use for this this VM. None if not AV required
1505 availability_zone_list: list of availability zones given by user in the VNFD descriptor. Ignore if
1506 availability_zone_index is None
1507 Returns a tuple with the instance identifier and created_items or raises an exception on error
1508 created_items can be None or a dictionary where this method can include key-values that will be passed to
1509 the method delete_vminstance and action_vminstance. Can be used to store created ports, volumes, etc.
1510 Format is vimconnector dependent, but do not use nested dictionaries and a value of None should be the same
1513 self
.logger
.info("Creating new instance for entry {}".format(name
))
1514 self
.logger
.debug("desc {} boot {} image_id: {} flavor_id: {} net_list: {} cloud_config {} disk_list {} "\
1515 "availability_zone_index {} availability_zone_list {}"\
1516 .format(description
, start
, image_id
, flavor_id
, net_list
, cloud_config
, disk_list
,\
1517 availability_zone_index
, availability_zone_list
))
1519 #new vm name = vmname + tenant_id + uuid
1520 new_vm_name
= [name
, '-', str(uuid
.uuid4())]
1521 vmname_andid
= ''.join(new_vm_name
)
1523 for net
in net_list
:
1524 if net
['type'] == "SR-IOV" or net
['type'] == "PCI-PASSTHROUGH":
1525 raise vimconn
.vimconnNotSupportedException(
1526 "Current vCD version does not support type : {}".format(net
['type']))
1528 if len(net_list
) > 10:
1529 raise vimconn
.vimconnNotSupportedException(
1530 "The VM hardware versions 7 and above support upto 10 NICs only")
1532 # if vm already deployed we return existing uuid
1533 # we check for presence of VDC, Catalog entry and Flavor.
1534 org
, vdc
= self
.get_vdc_details()
1536 raise vimconn
.vimconnNotFoundException(
1537 "new_vminstance(): Failed create vApp {}: (Failed retrieve VDC information)".format(name
))
1538 catalogs
= org
.list_catalogs()
1539 if catalogs
is None:
1540 #Retry once, if failed by refreshing token
1542 org
= Org(self
.client
, resource
=self
.client
.get_org())
1543 catalogs
= org
.list_catalogs()
1544 if catalogs
is None:
1545 raise vimconn
.vimconnNotFoundException(
1546 "new_vminstance(): Failed create vApp {}: (Failed retrieve catalogs list)".format(name
))
1548 catalog_hash_name
= self
.get_catalogbyid(catalog_uuid
=image_id
, catalogs
=catalogs
)
1549 if catalog_hash_name
:
1550 self
.logger
.info("Found catalog entry {} for image id {}".format(catalog_hash_name
, image_id
))
1552 raise vimconn
.vimconnNotFoundException("new_vminstance(): Failed create vApp {}: "
1553 "(Failed retrieve catalog information {})".format(name
, image_id
))
1556 # Set vCPU and Memory based on flavor.
1562 if flavor_id
is not None:
1563 if flavor_id
not in vimconnector
.flavorlist
:
1564 raise vimconn
.vimconnNotFoundException("new_vminstance(): Failed create vApp {}: "
1565 "Failed retrieve flavor information "
1566 "flavor id {}".format(name
, flavor_id
))
1569 flavor
= vimconnector
.flavorlist
[flavor_id
]
1570 vm_cpus
= flavor
[FLAVOR_VCPUS_KEY
]
1571 vm_memory
= flavor
[FLAVOR_RAM_KEY
]
1572 vm_disk
= flavor
[FLAVOR_DISK_KEY
]
1573 extended
= flavor
.get("extended", None)
1575 numas
=extended
.get("numas", None)
1577 except Exception as exp
:
1578 raise vimconn
.vimconnException("Corrupted flavor. {}.Exception: {}".format(flavor_id
, exp
))
1580 # image upload creates template name as catalog name space Template.
1581 templateName
= self
.get_catalogbyid(catalog_uuid
=image_id
, catalogs
=catalogs
)
1586 # client must provide at least one entry in net_list if not we report error
1587 #If net type is mgmt, then configure it as primary net & use its NIC index as primary NIC
1588 #If no mgmt, then the 1st NN in netlist is considered as primary net.
1590 primary_netname
= None
1591 primary_net_href
= None
1592 network_mode
= 'bridged'
1593 if net_list
is not None and len(net_list
) > 0:
1594 for net
in net_list
:
1595 if 'use' in net
and net
['use'] == 'mgmt' and not primary_net
:
1597 if primary_net
is None:
1598 primary_net
= net_list
[0]
1601 primary_net_id
= primary_net
['net_id']
1602 url_list
= [self
.url
, '/api/network/', primary_net_id
]
1603 primary_net_href
= ''.join(url_list
)
1604 network_dict
= self
.get_vcd_network(network_uuid
=primary_net_id
)
1605 if 'name' in network_dict
:
1606 primary_netname
= network_dict
['name']
1609 raise vimconn
.vimconnException("Corrupted flavor. {}".format(primary_net
))
1611 raise vimconn
.vimconnUnexpectedResponse("new_vminstance(): Failed network list is empty.".format(name
))
1613 # use: 'data', 'bridge', 'mgmt'
1614 # create vApp. Set vcpu and ram based on flavor id.
1616 vdc_obj
= VDC(self
.client
, resource
=org
.get_vdc(self
.tenant_name
))
1618 raise vimconn
.vimconnNotFoundException("new_vminstance(): Failed to get VDC object")
1621 items
= org
.get_catalog_item(catalog_hash_name
, catalog_hash_name
)
1622 catalog_items
= [items
.attrib
]
1624 if len(catalog_items
) == 1:
1626 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
1627 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
1629 response
= self
.perform_request(req_type
='GET',
1630 url
=catalog_items
[0].get('href'),
1632 catalogItem
= XmlElementTree
.fromstring(response
.content
)
1633 entity
= [child
for child
in catalogItem
if child
.get("type") == "application/vnd.vmware.vcloud.vAppTemplate+xml"][0]
1634 vapp_tempalte_href
= entity
.get("href")
1636 response
= self
.perform_request(req_type
='GET',
1637 url
=vapp_tempalte_href
,
1639 if response
.status_code
!= requests
.codes
.ok
:
1640 self
.logger
.debug("REST API call {} failed. Return status code {}".format(vapp_tempalte_href
,
1641 response
.status_code
))
1643 result
= (response
.content
).replace("\n"," ")
1645 src
= re
.search('<Vm goldMaster="false"\sstatus="\d+"\sname="(.*?)"\s'
1646 'id="(\w+:\w+:vm:.*?)"\shref="(.*?)"\s'
1647 'type="application/vnd\.vmware\.vcloud\.vm\+xml',result
)
1649 vm_name
= src
.group(1)
1650 vm_id
= src
.group(2)
1651 vm_href
= src
.group(3)
1653 cpus
= re
.search('<rasd:Description>Number of Virtual CPUs</.*?>(\d+)</rasd:VirtualQuantity>',result
).group(1)
1654 memory_mb
= re
.search('<rasd:Description>Memory Size</.*?>(\d+)</rasd:VirtualQuantity>',result
).group(1)
1655 cores
= re
.search('<vmw:CoresPerSocket ovf:required.*?>(\d+)</vmw:CoresPerSocket>',result
).group(1)
1657 headers
['Content-Type'] = 'application/vnd.vmware.vcloud.instantiateVAppTemplateParams+xml'
1658 vdc_id
= vdc
.get('id').split(':')[-1]
1659 instantiate_vapp_href
= "{}/api/vdc/{}/action/instantiateVAppTemplate".format(self
.url
,
1661 data
= """<?xml version="1.0" encoding="UTF-8"?>
1662 <InstantiateVAppTemplateParams
1663 xmlns="http://www.vmware.com/vcloud/v1.5"
1667 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
1668 xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1">
1669 <Description>Vapp instantiation</Description>
1670 <InstantiationParams>
1671 <NetworkConfigSection>
1672 <ovf:Info>Configuration parameters for logical networks</ovf:Info>
1673 <NetworkConfig networkName="{}">
1675 <ParentNetwork href="{}" />
1676 <FenceMode>bridged</FenceMode>
1679 </NetworkConfigSection>
1680 <LeaseSettingsSection
1681 type="application/vnd.vmware.vcloud.leaseSettingsSection+xml">
1682 <ovf:Info>Lease Settings</ovf:Info>
1683 <StorageLeaseInSeconds>172800</StorageLeaseInSeconds>
1684 <StorageLeaseExpiration>2014-04-25T08:08:16.438-07:00</StorageLeaseExpiration>
1685 </LeaseSettingsSection>
1686 </InstantiationParams>
1689 <Source href="{}" id="{}" name="{}"
1690 type="application/vnd.vmware.vcloud.vm+xml"/>
1692 <NeedsCustomization>false</NeedsCustomization>
1694 <InstantiationParams>
1695 <NetworkConnectionSection>
1696 <ovf:Info>Specifies the available VM network connections</ovf:Info>
1697 <NetworkConnection network="{}">
1698 <NetworkConnectionIndex>0</NetworkConnectionIndex>
1699 <IsConnected>true</IsConnected>
1700 <IpAddressAllocationMode>DHCP</IpAddressAllocationMode>
1701 </NetworkConnection>
1702 </NetworkConnectionSection><ovf:VirtualHardwareSection>
1703 <ovf:Info>Virtual hardware requirements</ovf:Info>
1704 <ovf:Item xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData"
1705 xmlns:vmw="http://www.vmware.com/schema/ovf">
1706 <rasd:AllocationUnits>hertz * 10^6</rasd:AllocationUnits>
1707 <rasd:Description>Number of Virtual CPUs</rasd:Description>
1708 <rasd:ElementName xmlns:py="http://codespeak.net/lxml/objectify/pytype" py:pytype="str">{cpu} virtual CPU(s)</rasd:ElementName>
1709 <rasd:InstanceID>4</rasd:InstanceID>
1710 <rasd:Reservation>0</rasd:Reservation>
1711 <rasd:ResourceType>3</rasd:ResourceType>
1712 <rasd:VirtualQuantity xmlns:py="http://codespeak.net/lxml/objectify/pytype" py:pytype="int">{cpu}</rasd:VirtualQuantity>
1713 <rasd:Weight>0</rasd:Weight>
1714 <vmw:CoresPerSocket ovf:required="false">{core}</vmw:CoresPerSocket>
1715 </ovf:Item><ovf:Item xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData">
1716 <rasd:AllocationUnits>byte * 2^20</rasd:AllocationUnits>
1717 <rasd:Description>Memory Size</rasd:Description>
1718 <rasd:ElementName xmlns:py="http://codespeak.net/lxml/objectify/pytype" py:pytype="str">{memory} MB of memory</rasd:ElementName>
1719 <rasd:InstanceID>5</rasd:InstanceID>
1720 <rasd:Reservation>0</rasd:Reservation>
1721 <rasd:ResourceType>4</rasd:ResourceType>
1722 <rasd:VirtualQuantity xmlns:py="http://codespeak.net/lxml/objectify/pytype" py:pytype="int">{memory}</rasd:VirtualQuantity>
1723 <rasd:Weight>0</rasd:Weight>
1725 </ovf:VirtualHardwareSection>
1726 </InstantiationParams>
1728 <AllEULAsAccepted>false</AllEULAsAccepted>
1729 </InstantiateVAppTemplateParams>""".format(vmname_andid
,
1741 response
= self
.perform_request(req_type
='POST',
1742 url
=instantiate_vapp_href
,
1746 if response
.status_code
!= 201:
1747 self
.logger
.error("REST call {} failed reason : {}"\
1748 "status code : {}".format(instantiate_vapp_href
,
1750 response
.status_code
))
1751 raise vimconn
.vimconnException("new_vminstance(): Failed to create"\
1752 "vAapp {}".format(vmname_andid
))
1754 vapptask
= self
.get_task_from_response(response
.content
)
1756 if vapptask
is None and retry
==1:
1757 self
.get_token() # Retry getting token
1762 if vapptask
is None or vapptask
is False:
1763 raise vimconn
.vimconnUnexpectedResponse(
1764 "new_vminstance(): failed to create vApp {}".format(vmname_andid
))
1766 # wait for task to complete
1767 result
= self
.client
.get_task_monitor().wait_for_success(task
=vapptask
)
1769 if result
.get('status') == 'success':
1770 self
.logger
.debug("new_vminstance(): Sucessfully created Vapp {}".format(vmname_andid
))
1772 raise vimconn
.vimconnUnexpectedResponse(
1773 "new_vminstance(): failed to create vApp {}".format(vmname_andid
))
1775 except Exception as exp
:
1776 raise vimconn
.vimconnUnexpectedResponse(
1777 "new_vminstance(): failed to create vApp {} with Exception:{}".format(vmname_andid
, exp
))
1779 # we should have now vapp in undeployed state.
1781 vdc_obj
= VDC(self
.client
, href
=vdc
.get('href'))
1782 vapp_resource
= vdc_obj
.get_vapp(vmname_andid
)
1783 vapp_uuid
= vapp_resource
.get('id').split(':')[-1]
1784 vapp
= VApp(self
.client
, resource
=vapp_resource
)
1786 except Exception as exp
:
1787 raise vimconn
.vimconnUnexpectedResponse(
1788 "new_vminstance(): Failed to retrieve vApp {} after creation: Exception:{}"
1789 .format(vmname_andid
, exp
))
1791 if vapp_uuid
is None:
1792 raise vimconn
.vimconnUnexpectedResponse(
1793 "new_vminstance(): Failed to retrieve vApp {} after creation".format(
1796 #Add PCI passthrough/SRIOV configrations
1798 pci_devices_info
= []
1800 reserve_memory
= False
1802 for net
in net_list
:
1803 if net
["type"] == "PF" or net
["type"] == "PCI-PASSTHROUGH":
1804 pci_devices_info
.append(net
)
1805 elif (net
["type"] == "VF" or net
["type"] == "SR-IOV" or net
["type"] == "VFnotShared") and 'net_id'in net
:
1806 sriov_net_info
.append(net
)
1809 if len(pci_devices_info
) > 0:
1810 self
.logger
.info("Need to add PCI devices {} into VM {}".format(pci_devices_info
,
1812 PCI_devices_status
, vm_obj
, vcenter_conect
= self
.add_pci_devices(vapp_uuid
,
1815 if PCI_devices_status
:
1816 self
.logger
.info("Added PCI devives {} to VM {}".format(
1820 reserve_memory
= True
1822 self
.logger
.info("Fail to add PCI devives {} to VM {}".format(
1829 #Assuming there is only one disk in ovf and fast provisioning in organization vDC is disabled
1830 result
= self
.modify_vm_disk(vapp_uuid
, vm_disk
)
1832 self
.logger
.debug("Modified Disk size of VM {} ".format(vmname_andid
))
1834 #Add new or existing disks to vApp
1836 added_existing_disk
= False
1837 for disk
in disk_list
:
1838 if 'device_type' in disk
and disk
['device_type'] == 'cdrom':
1839 image_id
= disk
['image_id']
1840 # Adding CD-ROM to VM
1841 # will revisit code once specification ready to support this feature
1842 self
.insert_media_to_vm(vapp
, image_id
)
1843 elif "image_id" in disk
and disk
["image_id"] is not None:
1844 self
.logger
.debug("Adding existing disk from image {} to vm {} ".format(
1845 disk
["image_id"] , vapp_uuid
))
1846 self
.add_existing_disk(catalogs
=catalogs
,
1847 image_id
=disk
["image_id"],
1848 size
= disk
["size"],
1849 template_name
=templateName
,
1852 added_existing_disk
= True
1854 #Wait till added existing disk gets reflected into vCD database/API
1855 if added_existing_disk
:
1857 added_existing_disk
= False
1858 self
.add_new_disk(vapp_uuid
, disk
['size'])
1861 # Assigning numa affinity setting
1863 if 'paired-threads-id' in numa
:
1864 paired_threads_id
= numa
['paired-threads-id']
1865 self
.set_numa_affinity(vapp_uuid
, paired_threads_id
)
1867 # add NICs & connect to networks in netlist
1869 self
.logger
.info("Request to connect VM to a network: {}".format(net_list
))
1870 primary_nic_index
= 0
1872 for net
in net_list
:
1873 # openmano uses network id in UUID format.
1874 # vCloud Director need a name so we do reverse operation from provided UUID we lookup a name
1875 # [{'use': 'bridge', 'net_id': '527d4bf7-566a-41e7-a9e7-ca3cdd9cef4f', 'type': 'virtual',
1876 # 'vpci': '0000:00:11.0', 'name': 'eth0'}]
1878 if 'net_id' not in net
:
1881 #Using net_id as a vim_id i.e. vim interface id, as do not have saperate vim interface id
1882 #Same will be returned in refresh_vms_status() as vim_interface_id
1883 net
['vim_id'] = net
['net_id'] # Provide the same VIM identifier as the VIM network
1885 interface_net_id
= net
['net_id']
1886 interface_net_name
= self
.get_network_name_by_id(network_uuid
=interface_net_id
)
1887 interface_network_mode
= net
['use']
1889 if interface_net_name
== primary_netname
:
1893 if interface_network_mode
== 'mgmt':
1894 primary_nic_index
= nicIndex
1896 """- POOL (A static IP address is allocated automatically from a pool of addresses.)
1897 - DHCP (The IP address is obtained from a DHCP service.)
1898 - MANUAL (The IP address is assigned manually in the IpAddress element.)
1899 - NONE (No IP addressing mode specified.)"""
1901 if primary_netname
is not None:
1902 nets
= filter(lambda n
: n
.get('name') == interface_net_name
, self
.get_network_list())
1904 #nets = [n for n in self.get_network_list() if n.get('name') == interface_net_name]
1906 self
.logger
.info("new_vminstance(): Found requested network: {}".format(nets
[0].get('name')))
1908 vdc_obj
= VDC(self
.client
, href
=vdc
.get('href'))
1909 vapp_resource
= vdc_obj
.get_vapp(vmname_andid
)
1910 vapp
= VApp(self
.client
, resource
=vapp_resource
)
1911 # connect network to VM - with all DHCP by default
1912 task
= vapp
.connect_org_vdc_network(nets
[0].get('name'))
1914 self
.client
.get_task_monitor().wait_for_success(task
=task
)
1916 type_list
= ('PF', 'PCI-PASSTHROUGH', 'VF', 'SR-IOV', 'VFnotShared')
1917 if 'type' in net
and net
['type'] not in type_list
:
1918 # fetching nic type from vnf
1920 if net
['model'] is not None and net
['model'].lower() == 'virtio':
1921 nic_type
= 'VMXNET3'
1923 nic_type
= net
['model']
1925 self
.logger
.info("new_vminstance(): adding network adapter "\
1926 "to a network {}".format(nets
[0].get('name')))
1927 self
.add_network_adapter_to_vms(vapp
, nets
[0].get('name'),
1933 self
.logger
.info("new_vminstance(): adding network adapter "\
1934 "to a network {}".format(nets
[0].get('name')))
1935 self
.add_network_adapter_to_vms(vapp
, nets
[0].get('name'),
1941 # cloud-init for ssh-key injection
1943 self
.cloud_init(vapp
,cloud_config
)
1945 # ############# Stub code for SRIOV #################
1947 # if len(sriov_net_info) > 0:
1948 # self.logger.info("Need to add SRIOV adapters {} into VM {}".format(sriov_net_info,
1950 # sriov_status, vm_obj, vcenter_conect = self.add_sriov(vapp_uuid,
1954 # self.logger.info("Added SRIOV {} to VM {}".format(
1958 # reserve_memory = True
1960 # self.logger.info("Fail to add SRIOV {} to VM {}".format(
1965 # If VM has PCI devices or SRIOV reserve memory for VM
1967 memReserve
= vm_obj
.config
.hardware
.memoryMB
1968 spec
= vim
.vm
.ConfigSpec()
1969 spec
.memoryAllocation
= vim
.ResourceAllocationInfo(reservation
=memReserve
)
1970 task
= vm_obj
.ReconfigVM_Task(spec
=spec
)
1972 result
= self
.wait_for_vcenter_task(task
, vcenter_conect
)
1973 self
.logger
.info("Reserved memory {} MB for "
1974 "VM VM status: {}".format(str(memReserve
), result
))
1976 self
.logger
.info("Fail to reserved memory {} to VM {}".format(
1977 str(memReserve
), str(vm_obj
)))
1979 self
.logger
.debug("new_vminstance(): starting power on vApp {} ".format(vmname_andid
))
1981 vapp_id
= vapp_resource
.get('id').split(':')[-1]
1982 poweron_task
= self
.power_on_vapp(vapp_id
, vmname_andid
)
1983 result
= self
.client
.get_task_monitor().wait_for_success(task
=poweron_task
)
1984 if result
.get('status') == 'success':
1985 self
.logger
.info("new_vminstance(): Successfully power on "\
1986 "vApp {}".format(vmname_andid
))
1988 self
.logger
.error("new_vminstance(): failed to power on vApp "\
1989 "{}".format(vmname_andid
))
1991 except Exception as exp
:
1992 # it might be a case if specific mandatory entry in dict is empty or some other pyVcloud exception
1993 self
.logger
.error("new_vminstance(): Failed create new vm instance {} with exception {}"
1995 raise vimconn
.vimconnException("new_vminstance(): Failed create new vm instance {} with exception {}"
1998 # check if vApp deployed and if that the case return vApp UUID otherwise -1
2001 while wait_time
<= MAX_WAIT_TIME
:
2003 vapp_resource
= vdc_obj
.get_vapp(vmname_andid
)
2004 vapp
= VApp(self
.client
, resource
=vapp_resource
)
2005 except Exception as exp
:
2006 raise vimconn
.vimconnUnexpectedResponse(
2007 "new_vminstance(): Failed to retrieve vApp {} after creation: Exception:{}"
2008 .format(vmname_andid
, exp
))
2010 #if vapp and vapp.me.deployed:
2011 if vapp
and vapp_resource
.get('deployed') == 'true':
2012 vapp_uuid
= vapp_resource
.get('id').split(':')[-1]
2015 self
.logger
.debug("new_vminstance(): Wait for vApp {} to deploy".format(name
))
2016 time
.sleep(INTERVAL_TIME
)
2018 wait_time
+=INTERVAL_TIME
2020 #SET Affinity Rule for VM
2021 #Pre-requisites: User has created Hosh Groups in vCenter with respective Hosts to be used
2022 #While creating VIM account user has to pass the Host Group names in availability_zone list
2023 #"availability_zone" is a part of VIM "config" parameters
2024 #For example, in VIM config: "availability_zone":["HG_170","HG_174","HG_175"]
2025 #Host groups are referred as availability zones
2026 #With following procedure, deployed VM will be added into a VM group.
2027 #Then A VM to Host Affinity rule will be created using the VM group & Host group.
2028 if(availability_zone_list
):
2029 self
.logger
.debug("Existing Host Groups in VIM {}".format(self
.config
.get('availability_zone')))
2030 #Admin access required for creating Affinity rules
2031 client
= self
.connect_as_admin()
2033 raise vimconn
.vimconnConnectionException("Failed to connect vCD as admin")
2035 self
.client
= client
2037 headers
= {'Accept':'application/*+xml;version=27.0',
2038 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
2039 #Step1: Get provider vdc details from organization
2040 pvdc_href
= self
.get_pvdc_for_org(self
.tenant_name
, headers
)
2041 if pvdc_href
is not None:
2042 #Step2: Found required pvdc, now get resource pool information
2043 respool_href
= self
.get_resource_pool_details(pvdc_href
, headers
)
2044 if respool_href
is None:
2045 #Raise error if respool_href not found
2046 msg
= "new_vminstance():Error in finding resource pool details in pvdc {}"\
2048 self
.log_message(msg
)
2050 #Step3: Verify requested availability zone(hostGroup) is present in vCD
2051 # get availability Zone
2052 vm_az
= self
.get_vm_availability_zone(availability_zone_index
, availability_zone_list
)
2053 # check if provided av zone(hostGroup) is present in vCD VIM
2054 status
= self
.check_availibility_zone(vm_az
, respool_href
, headers
)
2056 msg
= "new_vminstance(): Error in finding availability zone(Host Group): {} in "\
2057 "resource pool {} status: {}".format(vm_az
,respool_href
,status
)
2058 self
.log_message(msg
)
2060 self
.logger
.debug ("new_vminstance(): Availability zone {} found in VIM".format(vm_az
))
2062 #Step4: Find VM group references to create vm group
2063 vmgrp_href
= self
.find_vmgroup_reference(respool_href
, headers
)
2064 if vmgrp_href
== None:
2065 msg
= "new_vminstance(): No reference to VmGroup found in resource pool"
2066 self
.log_message(msg
)
2068 #Step5: Create a VmGroup with name az_VmGroup
2069 vmgrp_name
= vm_az
+ "_" + name
#Formed VM Group name = Host Group name + VM name
2070 status
= self
.create_vmgroup(vmgrp_name
, vmgrp_href
, headers
)
2071 if status
is not True:
2072 msg
= "new_vminstance(): Error in creating VM group {}".format(vmgrp_name
)
2073 self
.log_message(msg
)
2075 #VM Group url to add vms to vm group
2076 vmgrpname_url
= self
.url
+ "/api/admin/extension/vmGroup/name/"+ vmgrp_name
2078 #Step6: Add VM to VM Group
2079 #Find VM uuid from vapp_uuid
2080 vm_details
= self
.get_vapp_details_rest(vapp_uuid
)
2081 vm_uuid
= vm_details
['vmuuid']
2083 status
= self
.add_vm_to_vmgroup(vm_uuid
, vmgrpname_url
, vmgrp_name
, headers
)
2084 if status
is not True:
2085 msg
= "new_vminstance(): Error in adding VM to VM group {}".format(vmgrp_name
)
2086 self
.log_message(msg
)
2088 #Step7: Create VM to Host affinity rule
2089 addrule_href
= self
.get_add_rule_reference (respool_href
, headers
)
2090 if addrule_href
is None:
2091 msg
= "new_vminstance(): Error in finding href to add rule in resource pool: {}"\
2092 .format(respool_href
)
2093 self
.log_message(msg
)
2095 status
= self
.create_vm_to_host_affinity_rule(addrule_href
, vmgrp_name
, vm_az
, "Affinity", headers
)
2097 msg
= "new_vminstance(): Error in creating affinity rule for VM {} in Host group {}"\
2098 .format(name
, vm_az
)
2099 self
.log_message(msg
)
2101 self
.logger
.debug("new_vminstance(): Affinity rule created successfully. Added {} in Host group {}"\
2102 .format(name
, vm_az
))
2103 #Reset token to a normal user to perform other operations
2106 if vapp_uuid
is not None:
2107 return vapp_uuid
, None
2109 raise vimconn
.vimconnUnexpectedResponse("new_vminstance(): Failed create new vm instance {}".format(name
))
2112 def get_vcd_availibility_zones(self
,respool_href
, headers
):
2113 """ Method to find presence of av zone is VIM resource pool
2116 respool_href - resource pool href
2117 headers - header information
2120 vcd_az - list of azone present in vCD
2124 resp
= self
.perform_request(req_type
='GET',url
=respool_href
, headers
=headers
)
2126 if resp
.status_code
!= requests
.codes
.ok
:
2127 self
.logger
.debug ("REST API call {} failed. Return status code {}".format(url
, resp
.status_code
))
2129 #Get the href to hostGroups and find provided hostGroup is present in it
2130 resp_xml
= XmlElementTree
.fromstring(resp
.content
)
2131 for child
in resp_xml
:
2132 if 'VMWProviderVdcResourcePool' in child
.tag
:
2133 for schild
in child
:
2134 if 'Link' in schild
.tag
:
2135 if schild
.attrib
.get('type') == "application/vnd.vmware.admin.vmwHostGroupsType+xml":
2136 hostGroup
= schild
.attrib
.get('href')
2137 hg_resp
= self
.perform_request(req_type
='GET',url
=hostGroup
, headers
=headers
)
2138 if hg_resp
.status_code
!= requests
.codes
.ok
:
2139 self
.logger
.debug ("REST API call {} failed. Return status code {}".format(hostGroup
, hg_resp
.status_code
))
2141 hg_resp_xml
= XmlElementTree
.fromstring(hg_resp
.content
)
2142 for hostGroup
in hg_resp_xml
:
2143 if 'HostGroup' in hostGroup
.tag
:
2144 #append host group name to the list
2145 vcd_az
.append(hostGroup
.attrib
.get("name"))
2149 def set_availability_zones(self
):
2151 Set vim availability zone
2154 vim_availability_zones
= None
2155 availability_zone
= None
2156 if 'availability_zone' in self
.config
:
2157 vim_availability_zones
= self
.config
.get('availability_zone')
2158 if isinstance(vim_availability_zones
, str):
2159 availability_zone
= [vim_availability_zones
]
2160 elif isinstance(vim_availability_zones
, list):
2161 availability_zone
= vim_availability_zones
2163 return availability_zone
2165 return availability_zone
2168 def get_vm_availability_zone(self
, availability_zone_index
, availability_zone_list
):
2170 Return the availability zone to be used by the created VM.
2171 returns: The VIM availability zone to be used or None
2173 if availability_zone_index
is None:
2174 if not self
.config
.get('availability_zone'):
2176 elif isinstance(self
.config
.get('availability_zone'), str):
2177 return self
.config
['availability_zone']
2179 return self
.config
['availability_zone'][0]
2181 vim_availability_zones
= self
.availability_zone
2183 # check if VIM offer enough availability zones describe in the VNFD
2184 if vim_availability_zones
and len(availability_zone_list
) <= len(vim_availability_zones
):
2185 # check if all the names of NFV AV match VIM AV names
2186 match_by_index
= False
2187 for av
in availability_zone_list
:
2188 if av
not in vim_availability_zones
:
2189 match_by_index
= True
2192 self
.logger
.debug("Required Availability zone or Host Group not found in VIM config")
2193 self
.logger
.debug("Input Availability zone list: {}".format(availability_zone_list
))
2194 self
.logger
.debug("VIM configured Availability zones: {}".format(vim_availability_zones
))
2195 self
.logger
.debug("VIM Availability zones will be used by index")
2196 return vim_availability_zones
[availability_zone_index
]
2198 return availability_zone_list
[availability_zone_index
]
2200 raise vimconn
.vimconnConflictException("No enough availability zones at VIM for this deployment")
2203 def create_vm_to_host_affinity_rule(self
, addrule_href
, vmgrpname
, hostgrpname
, polarity
, headers
):
2204 """ Method to create VM to Host Affinity rule in vCD
2207 addrule_href - href to make a POST request
2208 vmgrpname - name of the VM group created
2209 hostgrpnmae - name of the host group created earlier
2210 polarity - Affinity or Anti-affinity (default: Affinity)
2211 headers - headers to make REST call
2214 True- if rule is created
2215 False- Failed to create rule due to some error
2219 rule_name
= polarity
+ "_" + vmgrpname
2220 payload
= """<?xml version="1.0" encoding="UTF-8"?>
2221 <vmext:VMWVmHostAffinityRule
2222 xmlns:vmext="http://www.vmware.com/vcloud/extension/v1.5"
2223 xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
2224 type="application/vnd.vmware.admin.vmwVmHostAffinityRule+xml">
2225 <vcloud:Name>{}</vcloud:Name>
2226 <vcloud:IsEnabled>true</vcloud:IsEnabled>
2227 <vcloud:IsMandatory>true</vcloud:IsMandatory>
2228 <vcloud:Polarity>{}</vcloud:Polarity>
2229 <vmext:HostGroupName>{}</vmext:HostGroupName>
2230 <vmext:VmGroupName>{}</vmext:VmGroupName>
2231 </vmext:VMWVmHostAffinityRule>""".format(rule_name
, polarity
, hostgrpname
, vmgrpname
)
2233 resp
= self
.perform_request(req_type
='POST',url
=addrule_href
, headers
=headers
, data
=payload
)
2235 if resp
.status_code
!= requests
.codes
.accepted
:
2236 self
.logger
.debug ("REST API call {} failed. Return status code {}".format(addrule_href
, resp
.status_code
))
2240 affinity_task
= self
.get_task_from_response(resp
.content
)
2241 self
.logger
.debug ("affinity_task: {}".format(affinity_task
))
2242 if affinity_task
is None or affinity_task
is False:
2243 raise vimconn
.vimconnUnexpectedResponse("failed to find affinity task")
2244 # wait for task to complete
2245 result
= self
.client
.get_task_monitor().wait_for_success(task
=affinity_task
)
2246 if result
.get('status') == 'success':
2247 self
.logger
.debug("Successfully created affinity rule {}".format(rule_name
))
2250 raise vimconn
.vimconnUnexpectedResponse(
2251 "failed to create affinity rule {}".format(rule_name
))
2254 def get_add_rule_reference (self
, respool_href
, headers
):
2255 """ This method finds href to add vm to host affinity rule to vCD
2258 respool_href- href to resource pool
2259 headers- header information to make REST call
2262 None - if no valid href to add rule found or
2263 addrule_href - href to add vm to host affinity rule of resource pool
2266 resp
= self
.perform_request(req_type
='GET',url
=respool_href
, headers
=headers
)
2268 if resp
.status_code
!= requests
.codes
.ok
:
2269 self
.logger
.debug ("REST API call {} failed. Return status code {}".format(respool_href
, resp
.status_code
))
2272 resp_xml
= XmlElementTree
.fromstring(resp
.content
)
2273 for child
in resp_xml
:
2274 if 'VMWProviderVdcResourcePool' in child
.tag
:
2275 for schild
in child
:
2276 if 'Link' in schild
.tag
:
2277 if schild
.attrib
.get('type') == "application/vnd.vmware.admin.vmwVmHostAffinityRule+xml" and \
2278 schild
.attrib
.get('rel') == "add":
2279 addrule_href
= schild
.attrib
.get('href')
2285 def add_vm_to_vmgroup(self
, vm_uuid
, vmGroupNameURL
, vmGroup_name
, headers
):
2286 """ Method to add deployed VM to newly created VM Group.
2287 This is required to create VM to Host affinity in vCD
2290 vm_uuid- newly created vm uuid
2291 vmGroupNameURL- URL to VM Group name
2292 vmGroup_name- Name of VM group created
2293 headers- Headers for REST request
2296 True- if VM added to VM group successfully
2297 False- if any error encounter
2300 addvm_resp
= self
.perform_request(req_type
='GET',url
=vmGroupNameURL
, headers
=headers
)#, data=payload)
2302 if addvm_resp
.status_code
!= requests
.codes
.ok
:
2303 self
.logger
.debug ("REST API call to get VM Group Name url {} failed. Return status code {}"\
2304 .format(vmGroupNameURL
, addvm_resp
.status_code
))
2307 resp_xml
= XmlElementTree
.fromstring(addvm_resp
.content
)
2308 for child
in resp_xml
:
2309 if child
.tag
.split('}')[1] == 'Link':
2310 if child
.attrib
.get("rel") == "addVms":
2311 addvmtogrpURL
= child
.attrib
.get("href")
2314 url_list
= [self
.url
, '/api/vApp/vm-',vm_uuid
]
2315 vmdetailsURL
= ''.join(url_list
)
2317 resp
= self
.perform_request(req_type
='GET',url
=vmdetailsURL
, headers
=headers
)
2319 if resp
.status_code
!= requests
.codes
.ok
:
2320 self
.logger
.debug ("REST API call {} failed. Return status code {}".format(vmdetailsURL
, resp
.status_code
))
2324 resp_xml
= XmlElementTree
.fromstring(resp
.content
)
2325 if resp_xml
.tag
.split('}')[1] == "Vm":
2326 vm_id
= resp_xml
.attrib
.get("id")
2327 vm_name
= resp_xml
.attrib
.get("name")
2328 vm_href
= resp_xml
.attrib
.get("href")
2329 #print vm_id, vm_name, vm_href
2330 #Add VM into VMgroup
2331 payload
= """<?xml version="1.0" encoding="UTF-8"?>\
2332 <ns2:Vms xmlns:ns2="http://www.vmware.com/vcloud/v1.5" \
2333 xmlns="http://www.vmware.com/vcloud/versions" \
2334 xmlns:ns3="http://schemas.dmtf.org/ovf/envelope/1" \
2335 xmlns:ns4="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData" \
2336 xmlns:ns5="http://schemas.dmtf.org/wbem/wscim/1/common" \
2337 xmlns:ns6="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData" \
2338 xmlns:ns7="http://www.vmware.com/schema/ovf" \
2339 xmlns:ns8="http://schemas.dmtf.org/ovf/environment/1" \
2340 xmlns:ns9="http://www.vmware.com/vcloud/extension/v1.5">\
2341 <ns2:VmReference href="{}" id="{}" name="{}" \
2342 type="application/vnd.vmware.vcloud.vm+xml" />\
2343 </ns2:Vms>""".format(vm_href
, vm_id
, vm_name
)
2345 addvmtogrp_resp
= self
.perform_request(req_type
='POST',url
=addvmtogrpURL
, headers
=headers
, data
=payload
)
2347 if addvmtogrp_resp
.status_code
!= requests
.codes
.accepted
:
2348 self
.logger
.debug ("REST API call {} failed. Return status code {}".format(addvmtogrpURL
, addvmtogrp_resp
.status_code
))
2351 self
.logger
.debug ("Done adding VM {} to VMgroup {}".format(vm_name
, vmGroup_name
))
2355 def create_vmgroup(self
, vmgroup_name
, vmgroup_href
, headers
):
2356 """Method to create a VM group in vCD
2359 vmgroup_name : Name of VM group to be created
2360 vmgroup_href : href for vmgroup
2361 headers- Headers for REST request
2363 #POST to add URL with required data
2364 vmgroup_status
= False
2365 payload
= """<VMWVmGroup xmlns="http://www.vmware.com/vcloud/extension/v1.5" \
2366 xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5" name="{}">\
2367 <vmCount>1</vmCount>\
2368 </VMWVmGroup>""".format(vmgroup_name
)
2369 resp
= self
.perform_request(req_type
='POST',url
=vmgroup_href
, headers
=headers
, data
=payload
)
2371 if resp
.status_code
!= requests
.codes
.accepted
:
2372 self
.logger
.debug ("REST API call {} failed. Return status code {}".format(vmgroup_href
, resp
.status_code
))
2373 return vmgroup_status
2375 vmgroup_task
= self
.get_task_from_response(resp
.content
)
2376 if vmgroup_task
is None or vmgroup_task
is False:
2377 raise vimconn
.vimconnUnexpectedResponse(
2378 "create_vmgroup(): failed to create VM group {}".format(vmgroup_name
))
2380 # wait for task to complete
2381 result
= self
.client
.get_task_monitor().wait_for_success(task
=vmgroup_task
)
2383 if result
.get('status') == 'success':
2384 self
.logger
.debug("create_vmgroup(): Successfully created VM group {}".format(vmgroup_name
))
2386 vmgroup_status
= True
2387 return vmgroup_status
2389 raise vimconn
.vimconnUnexpectedResponse(\
2390 "create_vmgroup(): failed to create VM group {}".format(vmgroup_name
))
2393 def find_vmgroup_reference(self
, url
, headers
):
2394 """ Method to create a new VMGroup which is required to add created VM
2396 url- resource pool href
2397 headers- header information
2400 returns href to VM group to create VM group
2402 #Perform GET on resource pool to find 'add' link to create VMGroup
2403 #https://vcd-ip/api/admin/extension/providervdc/<providervdc id>/resourcePools
2405 resp
= self
.perform_request(req_type
='GET',url
=url
, headers
=headers
)
2407 if resp
.status_code
!= requests
.codes
.ok
:
2408 self
.logger
.debug ("REST API call {} failed. Return status code {}".format(url
, resp
.status_code
))
2410 #Get the href to add vmGroup to vCD
2411 resp_xml
= XmlElementTree
.fromstring(resp
.content
)
2412 for child
in resp_xml
:
2413 if 'VMWProviderVdcResourcePool' in child
.tag
:
2414 for schild
in child
:
2415 if 'Link' in schild
.tag
:
2416 #Find href with type VMGroup and rel with add
2417 if schild
.attrib
.get('type') == "application/vnd.vmware.admin.vmwVmGroupType+xml"\
2418 and schild
.attrib
.get('rel') == "add":
2419 vmgrp_href
= schild
.attrib
.get('href')
2423 def check_availibility_zone(self
, az
, respool_href
, headers
):
2424 """ Method to verify requested av zone is present or not in provided
2428 az - name of hostgroup (availibility_zone)
2429 respool_href - Resource Pool href
2430 headers - Headers to make REST call
2432 az_found - True if availibility_zone is found else False
2435 headers
['Accept']='application/*+xml;version=27.0'
2436 resp
= self
.perform_request(req_type
='GET',url
=respool_href
, headers
=headers
)
2438 if resp
.status_code
!= requests
.codes
.ok
:
2439 self
.logger
.debug ("REST API call {} failed. Return status code {}".format(respool_href
, resp
.status_code
))
2441 #Get the href to hostGroups and find provided hostGroup is present in it
2442 resp_xml
= XmlElementTree
.fromstring(resp
.content
)
2444 for child
in resp_xml
:
2445 if 'VMWProviderVdcResourcePool' in child
.tag
:
2446 for schild
in child
:
2447 if 'Link' in schild
.tag
:
2448 if schild
.attrib
.get('type') == "application/vnd.vmware.admin.vmwHostGroupsType+xml":
2449 hostGroup_href
= schild
.attrib
.get('href')
2450 hg_resp
= self
.perform_request(req_type
='GET',url
=hostGroup_href
, headers
=headers
)
2451 if hg_resp
.status_code
!= requests
.codes
.ok
:
2452 self
.logger
.debug ("REST API call {} failed. Return status code {}".format(hostGroup_href
, hg_resp
.status_code
))
2454 hg_resp_xml
= XmlElementTree
.fromstring(hg_resp
.content
)
2455 for hostGroup
in hg_resp_xml
:
2456 if 'HostGroup' in hostGroup
.tag
:
2457 if hostGroup
.attrib
.get("name") == az
:
2463 def get_pvdc_for_org(self
, org_vdc
, headers
):
2464 """ This method gets provider vdc references from organisation
2467 org_vdc - name of the organisation VDC to find pvdc
2468 headers - headers to make REST call
2471 None - if no pvdc href found else
2472 pvdc_href - href to pvdc
2475 #Get provider VDC references from vCD
2477 #url = '<vcd url>/api/admin/extension/providerVdcReferences'
2478 url_list
= [self
.url
, '/api/admin/extension/providerVdcReferences']
2479 url
= ''.join(url_list
)
2481 response
= self
.perform_request(req_type
='GET',url
=url
, headers
=headers
)
2482 if response
.status_code
!= requests
.codes
.ok
:
2483 self
.logger
.debug ("REST API call {} failed. Return status code {}"\
2484 .format(url
, response
.status_code
))
2486 xmlroot_response
= XmlElementTree
.fromstring(response
.content
)
2487 for child
in xmlroot_response
:
2488 if 'ProviderVdcReference' in child
.tag
:
2489 pvdc_href
= child
.attrib
.get('href')
2490 #Get vdcReferences to find org
2491 pvdc_resp
= self
.perform_request(req_type
='GET',url
=pvdc_href
, headers
=headers
)
2492 if pvdc_resp
.status_code
!= requests
.codes
.ok
:
2493 raise vimconn
.vimconnException("REST API call {} failed. "\
2494 "Return status code {}"\
2495 .format(url
, pvdc_resp
.status_code
))
2497 pvdc_resp_xml
= XmlElementTree
.fromstring(pvdc_resp
.content
)
2498 for child
in pvdc_resp_xml
:
2499 if 'Link' in child
.tag
:
2500 if child
.attrib
.get('type') == "application/vnd.vmware.admin.vdcReferences+xml":
2501 vdc_href
= child
.attrib
.get('href')
2503 #Check if provided org is present in vdc
2504 vdc_resp
= self
.perform_request(req_type
='GET',
2507 if vdc_resp
.status_code
!= requests
.codes
.ok
:
2508 raise vimconn
.vimconnException("REST API call {} failed. "\
2509 "Return status code {}"\
2510 .format(url
, vdc_resp
.status_code
))
2511 vdc_resp_xml
= XmlElementTree
.fromstring(vdc_resp
.content
)
2512 for child
in vdc_resp_xml
:
2513 if 'VdcReference' in child
.tag
:
2514 if child
.attrib
.get('name') == org_vdc
:
2518 def get_resource_pool_details(self
, pvdc_href
, headers
):
2519 """ Method to get resource pool information.
2520 Host groups are property of resource group.
2521 To get host groups, we need to GET details of resource pool.
2524 pvdc_href: href to pvdc details
2528 respool_href - Returns href link reference to resource pool
2531 resp
= self
.perform_request(req_type
='GET',url
=pvdc_href
, headers
=headers
)
2533 if resp
.status_code
!= requests
.codes
.ok
:
2534 self
.logger
.debug ("REST API call {} failed. Return status code {}"\
2535 .format(pvdc_href
, resp
.status_code
))
2537 respool_resp_xml
= XmlElementTree
.fromstring(resp
.content
)
2538 for child
in respool_resp_xml
:
2539 if 'Link' in child
.tag
:
2540 if child
.attrib
.get('type') == "application/vnd.vmware.admin.vmwProviderVdcResourcePoolSet+xml":
2541 respool_href
= child
.attrib
.get("href")
2546 def log_message(self
, msg
):
2548 Method to log error messages related to Affinity rule creation
2549 in new_vminstance & raise Exception
2551 msg - Error message to be logged
2554 #get token to connect vCD as a normal user
2556 self
.logger
.debug(msg
)
2557 raise vimconn
.vimconnException(msg
)
2562 ## based on current discussion
2566 # created: '2016-09-08T11:51:58'
2567 # description: simple-instance.linux1.1
2568 # flavor: ddc6776e-75a9-11e6-ad5f-0800273e724c
2569 # hostId: e836c036-74e7-11e6-b249-0800273e724c
2570 # image: dde30fe6-75a9-11e6-ad5f-0800273e724c
2575 def get_vminstance(self
, vim_vm_uuid
=None):
2576 """Returns the VM instance information from VIM"""
2578 self
.logger
.debug("Client requesting vm instance {} ".format(vim_vm_uuid
))
2580 org
, vdc
= self
.get_vdc_details()
2582 raise vimconn
.vimconnConnectionException(
2583 "Failed to get a reference of VDC for a tenant {}".format(self
.tenant_name
))
2585 vm_info_dict
= self
.get_vapp_details_rest(vapp_uuid
=vim_vm_uuid
)
2586 if not vm_info_dict
:
2587 self
.logger
.debug("get_vminstance(): Failed to get vApp name by UUID {}".format(vim_vm_uuid
))
2588 raise vimconn
.vimconnNotFoundException("Failed to get vApp name by UUID {}".format(vim_vm_uuid
))
2590 status_key
= vm_info_dict
['status']
2593 vm_dict
= {'created': vm_info_dict
['created'],
2594 'description': vm_info_dict
['name'],
2595 'status': vcdStatusCode2manoFormat
[int(status_key
)],
2596 'hostId': vm_info_dict
['vmuuid'],
2598 'vim_info': yaml
.safe_dump(vm_info_dict
), 'interfaces': []}
2600 if 'interfaces' in vm_info_dict
:
2601 vm_dict
['interfaces'] = vm_info_dict
['interfaces']
2603 vm_dict
['interfaces'] = []
2605 vm_dict
= {'created': '',
2607 'status': vcdStatusCode2manoFormat
[int(-1)],
2608 'hostId': vm_info_dict
['vmuuid'],
2609 'error_msg': "Inconsistency state",
2610 'vim_info': yaml
.safe_dump(vm_info_dict
), 'interfaces': []}
2614 def delete_vminstance(self
, vm__vim_uuid
, created_items
=None):
2615 """Method poweroff and remove VM instance from vcloud director network.
2618 vm__vim_uuid: VM UUID
2621 Returns the instance identifier
2624 self
.logger
.debug("Client requesting delete vm instance {} ".format(vm__vim_uuid
))
2626 org
, vdc
= self
.get_vdc_details()
2627 vdc_obj
= VDC(self
.client
, href
=vdc
.get('href'))
2629 self
.logger
.debug("delete_vminstance(): Failed to get a reference of VDC for a tenant {}".format(
2631 raise vimconn
.vimconnException(
2632 "delete_vminstance(): Failed to get a reference of VDC for a tenant {}".format(self
.tenant_name
))
2635 vapp_name
= self
.get_namebyvappid(vm__vim_uuid
)
2636 vapp_resource
= vdc_obj
.get_vapp(vapp_name
)
2637 vapp
= VApp(self
.client
, resource
=vapp_resource
)
2638 if vapp_name
is None:
2639 self
.logger
.debug("delete_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid
))
2640 return -1, "delete_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid
)
2642 self
.logger
.info("Deleting vApp {} and UUID {}".format(vapp_name
, vm__vim_uuid
))
2644 # Delete vApp and wait for status change if task executed and vApp is None.
2647 if vapp_resource
.get('deployed') == 'true':
2648 self
.logger
.info("Powering off vApp {}".format(vapp_name
))
2652 while wait_time
<= MAX_WAIT_TIME
:
2653 power_off_task
= vapp
.power_off()
2654 result
= self
.client
.get_task_monitor().wait_for_success(task
=power_off_task
)
2656 if result
.get('status') == 'success':
2660 self
.logger
.info("Wait for vApp {} to power off".format(vapp_name
))
2661 time
.sleep(INTERVAL_TIME
)
2663 wait_time
+=INTERVAL_TIME
2665 self
.logger
.debug("delete_vminstance(): Failed to power off VM instance {} ".format(vm__vim_uuid
))
2667 self
.logger
.info("delete_vminstance(): Powered off VM instance {} ".format(vm__vim_uuid
))
2670 self
.logger
.info("Undeploy vApp {}".format(vapp_name
))
2673 while wait_time
<= MAX_WAIT_TIME
:
2674 vapp
= VApp(self
.client
, resource
=vapp_resource
)
2676 self
.logger
.debug("delete_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid
))
2677 return -1, "delete_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid
)
2678 undeploy_task
= vapp
.undeploy()
2680 result
= self
.client
.get_task_monitor().wait_for_success(task
=undeploy_task
)
2681 if result
.get('status') == 'success':
2685 self
.logger
.debug("Wait for vApp {} to undeploy".format(vapp_name
))
2686 time
.sleep(INTERVAL_TIME
)
2688 wait_time
+=INTERVAL_TIME
2691 self
.logger
.debug("delete_vminstance(): Failed to undeploy vApp {} ".format(vm__vim_uuid
))
2694 self
.logger
.info("Start deletion of vApp {} ".format(vapp_name
))
2696 if vapp
is not None:
2700 while wait_time
<= MAX_WAIT_TIME
:
2701 vapp
= VApp(self
.client
, resource
=vapp_resource
)
2703 self
.logger
.debug("delete_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid
))
2704 return -1, "delete_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid
)
2706 delete_task
= vdc_obj
.delete_vapp(vapp
.name
, force
=True)
2708 result
= self
.client
.get_task_monitor().wait_for_success(task
=delete_task
)
2709 if result
.get('status') == 'success':
2712 self
.logger
.debug("Wait for vApp {} to delete".format(vapp_name
))
2713 time
.sleep(INTERVAL_TIME
)
2715 wait_time
+=INTERVAL_TIME
2718 self
.logger
.debug("delete_vminstance(): Failed delete uuid {} ".format(vm__vim_uuid
))
2720 self
.logger
.info("Deleted vm instance {} sccessfully".format(vm__vim_uuid
))
2723 self
.logger
.debug(traceback
.format_exc())
2724 raise vimconn
.vimconnException("delete_vminstance(): Failed delete vm instance {}".format(vm__vim_uuid
))
2727 def refresh_vms_status(self
, vm_list
):
2728 """Get the status of the virtual machines and their interfaces/ports
2729 Params: the list of VM identifiers
2730 Returns a dictionary with:
2731 vm_id: #VIM id of this Virtual Machine
2732 status: #Mandatory. Text with one of:
2733 # DELETED (not found at vim)
2734 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
2735 # OTHER (Vim reported other status not understood)
2736 # ERROR (VIM indicates an ERROR status)
2737 # ACTIVE, PAUSED, SUSPENDED, INACTIVE (not running),
2738 # CREATING (on building process), ERROR
2739 # ACTIVE:NoMgmtIP (Active but any of its interface has an IP address
2741 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
2742 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
2744 - vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
2745 mac_address: #Text format XX:XX:XX:XX:XX:XX
2746 vim_net_id: #network id where this interface is connected
2747 vim_interface_id: #interface/port VIM id
2748 ip_address: #null, or text with IPv4, IPv6 address
2751 self
.logger
.debug("Client requesting refresh vm status for {} ".format(vm_list
))
2753 org
,vdc
= self
.get_vdc_details()
2755 raise vimconn
.vimconnException("Failed to get a reference of VDC for a tenant {}".format(self
.tenant_name
))
2759 for vmuuid
in vm_list
:
2760 vapp_name
= self
.get_namebyvappid(vmuuid
)
2761 if vapp_name
is not None:
2764 vm_pci_details
= self
.get_vm_pci_details(vmuuid
)
2765 vdc_obj
= VDC(self
.client
, href
=vdc
.get('href'))
2766 vapp_resource
= vdc_obj
.get_vapp(vapp_name
)
2767 the_vapp
= VApp(self
.client
, resource
=vapp_resource
)
2770 for vm
in the_vapp
.get_all_vms():
2771 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
2772 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
2773 response
= self
.perform_request(req_type
='GET',
2777 if response
.status_code
!= 200:
2778 self
.logger
.error("refresh_vms_status : REST call {} failed reason : {}"\
2779 "status code : {}".format(vm
.get('href'),
2781 response
.status_code
))
2782 raise vimconn
.vimconnException("refresh_vms_status : Failed to get "\
2784 xmlroot
= XmlElementTree
.fromstring(response
.content
)
2787 result
= response
.content
.replace("\n"," ")
2788 hdd_match
= re
.search('vcloud:capacity="(\d+)"\svcloud:storageProfileOverrideVmDefault=',result
)
2790 hdd_mb
= hdd_match
.group(1)
2791 vm_details
['hdd_mb'] = int(hdd_mb
) if hdd_mb
else None
2792 cpus_match
= re
.search('<rasd:Description>Number of Virtual CPUs</.*?>(\d+)</rasd:VirtualQuantity>',result
)
2794 cpus
= cpus_match
.group(1)
2795 vm_details
['cpus'] = int(cpus
) if cpus
else None
2796 memory_mb
= re
.search('<rasd:Description>Memory Size</.*?>(\d+)</rasd:VirtualQuantity>',result
).group(1)
2797 vm_details
['memory_mb'] = int(memory_mb
) if memory_mb
else None
2798 vm_details
['status'] = vcdStatusCode2manoFormat
[int(xmlroot
.get('status'))]
2799 vm_details
['id'] = xmlroot
.get('id')
2800 vm_details
['name'] = xmlroot
.get('name')
2801 vm_info
= [vm_details
]
2803 vm_info
[0].update(vm_pci_details
)
2805 vm_dict
= {'status': vcdStatusCode2manoFormat
[int(vapp_resource
.get('status'))],
2806 'error_msg': vcdStatusCode2manoFormat
[int(vapp_resource
.get('status'))],
2807 'vim_info': yaml
.safe_dump(vm_info
), 'interfaces': []}
2812 networks
= re
.findall('<NetworkConnection needsCustomization=.*?</NetworkConnection>',result
)
2813 for network
in networks
:
2814 mac_s
= re
.search('<MACAddress>(.*?)</MACAddress>',network
)
2815 vm_mac
= mac_s
.group(1) if mac_s
else None
2816 ip_s
= re
.search('<IpAddress>(.*?)</IpAddress>',network
)
2817 vm_ip
= ip_s
.group(1) if ip_s
else None
2820 if not nsx_edge_list
:
2821 nsx_edge_list
= self
.get_edge_details()
2822 if nsx_edge_list
is None:
2823 raise vimconn
.vimconnException("refresh_vms_status:"\
2824 "Failed to get edge details from NSX Manager")
2825 if vm_mac
is not None:
2826 vm_ip
= self
.get_ipaddr_from_NSXedge(nsx_edge_list
, vm_mac
)
2828 net_s
= re
.search('network="(.*?)"',network
)
2829 network_name
= net_s
.group(1) if net_s
else None
2831 vm_net_id
= self
.get_network_id_by_name(network_name
)
2832 interface
= {"mac_address": vm_mac
,
2833 "vim_net_id": vm_net_id
,
2834 "vim_interface_id": vm_net_id
,
2835 "ip_address": vm_ip
}
2837 vm_dict
["interfaces"].append(interface
)
2839 # add a vm to vm dict
2840 vms_dict
.setdefault(vmuuid
, vm_dict
)
2841 self
.logger
.debug("refresh_vms_status : vm info {}".format(vm_dict
))
2842 except Exception as exp
:
2843 self
.logger
.debug("Error in response {}".format(exp
))
2844 self
.logger
.debug(traceback
.format_exc())
2849 def get_edge_details(self
):
2850 """Get the NSX edge list from NSX Manager
2851 Returns list of NSX edges
2854 rheaders
= {'Content-Type': 'application/xml'}
2855 nsx_api_url
= '/api/4.0/edges'
2857 self
.logger
.debug("Get edge details from NSX Manager {} {}".format(self
.nsx_manager
, nsx_api_url
))
2860 resp
= requests
.get(self
.nsx_manager
+ nsx_api_url
,
2861 auth
= (self
.nsx_user
, self
.nsx_password
),
2862 verify
= False, headers
= rheaders
)
2863 if resp
.status_code
== requests
.codes
.ok
:
2864 paged_Edge_List
= XmlElementTree
.fromstring(resp
.text
)
2865 for edge_pages
in paged_Edge_List
:
2866 if edge_pages
.tag
== 'edgePage':
2867 for edge_summary
in edge_pages
:
2868 if edge_summary
.tag
== 'pagingInfo':
2869 for element
in edge_summary
:
2870 if element
.tag
== 'totalCount' and element
.text
== '0':
2871 raise vimconn
.vimconnException("get_edge_details: No NSX edges details found: {}"
2872 .format(self
.nsx_manager
))
2874 if edge_summary
.tag
== 'edgeSummary':
2875 for element
in edge_summary
:
2876 if element
.tag
== 'id':
2877 edge_list
.append(element
.text
)
2879 raise vimconn
.vimconnException("get_edge_details: No NSX edge details found: {}"
2880 .format(self
.nsx_manager
))
2883 raise vimconn
.vimconnException("get_edge_details: "\
2884 "No NSX edge details found: {}"
2885 .format(self
.nsx_manager
))
2887 self
.logger
.debug("get_edge_details: Found NSX edges {}".format(edge_list
))
2890 self
.logger
.debug("get_edge_details: "
2891 "Failed to get NSX edge details from NSX Manager: {}"
2892 .format(resp
.content
))
2895 except Exception as exp
:
2896 self
.logger
.debug("get_edge_details: "\
2897 "Failed to get NSX edge details from NSX Manager: {}"
2899 raise vimconn
.vimconnException("get_edge_details: "\
2900 "Failed to get NSX edge details from NSX Manager: {}"
2904 def get_ipaddr_from_NSXedge(self
, nsx_edges
, mac_address
):
2905 """Get IP address details from NSX edges, using the MAC address
2906 PARAMS: nsx_edges : List of NSX edges
2907 mac_address : Find IP address corresponding to this MAC address
2908 Returns: IP address corrresponding to the provided MAC address
2912 rheaders
= {'Content-Type': 'application/xml'}
2914 self
.logger
.debug("get_ipaddr_from_NSXedge: Finding IP addr from NSX edge")
2917 for edge
in nsx_edges
:
2918 nsx_api_url
= '/api/4.0/edges/'+ edge
+'/dhcp/leaseInfo'
2920 resp
= requests
.get(self
.nsx_manager
+ nsx_api_url
,
2921 auth
= (self
.nsx_user
, self
.nsx_password
),
2922 verify
= False, headers
= rheaders
)
2924 if resp
.status_code
== requests
.codes
.ok
:
2925 dhcp_leases
= XmlElementTree
.fromstring(resp
.text
)
2926 for child
in dhcp_leases
:
2927 if child
.tag
== 'dhcpLeaseInfo':
2928 dhcpLeaseInfo
= child
2929 for leaseInfo
in dhcpLeaseInfo
:
2930 for elem
in leaseInfo
:
2931 if (elem
.tag
)=='macAddress':
2932 edge_mac_addr
= elem
.text
2933 if (elem
.tag
)=='ipAddress':
2935 if edge_mac_addr
is not None:
2936 if edge_mac_addr
== mac_address
:
2937 self
.logger
.debug("Found ip addr {} for mac {} at NSX edge {}"
2938 .format(ip_addr
, mac_address
,edge
))
2941 self
.logger
.debug("get_ipaddr_from_NSXedge: "\
2942 "Error occurred while getting DHCP lease info from NSX Manager: {}"
2943 .format(resp
.content
))
2945 self
.logger
.debug("get_ipaddr_from_NSXedge: No IP addr found in any NSX edge")
2948 except XmlElementTree
.ParseError
as Err
:
2949 self
.logger
.debug("ParseError in response from NSX Manager {}".format(Err
.message
), exc_info
=True)
2952 def action_vminstance(self
, vm__vim_uuid
=None, action_dict
=None, created_items
={}):
2953 """Send and action over a VM instance from VIM
2954 Returns the vm_id if the action was successfully sent to the VIM"""
2956 self
.logger
.debug("Received action for vm {} and action dict {}".format(vm__vim_uuid
, action_dict
))
2957 if vm__vim_uuid
is None or action_dict
is None:
2958 raise vimconn
.vimconnException("Invalid request. VM id or action is None.")
2960 org
, vdc
= self
.get_vdc_details()
2962 raise vimconn
.vimconnException("Failed to get a reference of VDC for a tenant {}".format(self
.tenant_name
))
2964 vapp_name
= self
.get_namebyvappid(vm__vim_uuid
)
2965 if vapp_name
is None:
2966 self
.logger
.debug("action_vminstance(): Failed to get vm by given {} vm uuid".format(vm__vim_uuid
))
2967 raise vimconn
.vimconnException("Failed to get vm by given {} vm uuid".format(vm__vim_uuid
))
2969 self
.logger
.info("Action_vminstance vApp {} and UUID {}".format(vapp_name
, vm__vim_uuid
))
2972 vdc_obj
= VDC(self
.client
, href
=vdc
.get('href'))
2973 vapp_resource
= vdc_obj
.get_vapp(vapp_name
)
2974 vapp
= VApp(self
.client
, resource
=vapp_resource
)
2975 if "start" in action_dict
:
2976 self
.logger
.info("action_vminstance: Power on vApp: {}".format(vapp_name
))
2977 poweron_task
= self
.power_on_vapp(vm__vim_uuid
, vapp_name
)
2978 result
= self
.client
.get_task_monitor().wait_for_success(task
=poweron_task
)
2979 self
.instance_actions_result("start", result
, vapp_name
)
2980 elif "rebuild" in action_dict
:
2981 self
.logger
.info("action_vminstance: Rebuild vApp: {}".format(vapp_name
))
2982 rebuild_task
= vapp
.deploy(power_on
=True)
2983 result
= self
.client
.get_task_monitor().wait_for_success(task
=rebuild_task
)
2984 self
.instance_actions_result("rebuild", result
, vapp_name
)
2985 elif "pause" in action_dict
:
2986 self
.logger
.info("action_vminstance: pause vApp: {}".format(vapp_name
))
2987 pause_task
= vapp
.undeploy(action
='suspend')
2988 result
= self
.client
.get_task_monitor().wait_for_success(task
=pause_task
)
2989 self
.instance_actions_result("pause", result
, vapp_name
)
2990 elif "resume" in action_dict
:
2991 self
.logger
.info("action_vminstance: resume vApp: {}".format(vapp_name
))
2992 poweron_task
= self
.power_on_vapp(vm__vim_uuid
, vapp_name
)
2993 result
= self
.client
.get_task_monitor().wait_for_success(task
=poweron_task
)
2994 self
.instance_actions_result("resume", result
, vapp_name
)
2995 elif "shutoff" in action_dict
or "shutdown" in action_dict
:
2996 action_name
, value
= action_dict
.items()[0]
2998 #action_name , value = list(action_dict.items())[0]
2999 self
.logger
.info("action_vminstance: {} vApp: {}".format(action_name
, vapp_name
))
3000 shutdown_task
= vapp
.shutdown()
3001 result
= self
.client
.get_task_monitor().wait_for_success(task
=shutdown_task
)
3002 if action_name
== "shutdown":
3003 self
.instance_actions_result("shutdown", result
, vapp_name
)
3005 self
.instance_actions_result("shutoff", result
, vapp_name
)
3006 elif "forceOff" in action_dict
:
3007 result
= vapp
.undeploy(action
='powerOff')
3008 self
.instance_actions_result("forceOff", result
, vapp_name
)
3009 elif "reboot" in action_dict
:
3010 self
.logger
.info("action_vminstance: reboot vApp: {}".format(vapp_name
))
3011 reboot_task
= vapp
.reboot()
3012 self
.client
.get_task_monitor().wait_for_success(task
=reboot_task
)
3014 raise vimconn
.vimconnException("action_vminstance: Invalid action {} or action is None.".format(action_dict
))
3016 except Exception as exp
:
3017 self
.logger
.debug("action_vminstance: Failed with Exception {}".format(exp
))
3018 raise vimconn
.vimconnException("action_vminstance: Failed with Exception {}".format(exp
))
3020 def instance_actions_result(self
, action
, result
, vapp_name
):
3021 if result
.get('status') == 'success':
3022 self
.logger
.info("action_vminstance: Sucessfully {} the vApp: {}".format(action
, vapp_name
))
3024 self
.logger
.error("action_vminstance: Failed to {} vApp: {}".format(action
, vapp_name
))
3026 def get_vminstance_console(self
, vm_id
, console_type
="vnc"):
3028 Get a console for the virtual machine
3030 vm_id: uuid of the VM
3031 console_type, can be:
3032 "novnc" (by default), "xvpvnc" for VNC types,
3033 "rdp-html5" for RDP types, "spice-html5" for SPICE types
3034 Returns dict with the console parameters:
3035 protocol: ssh, ftp, http, https, ...
3036 server: usually ip address
3037 port: the http, ssh, ... port
3038 suffix: extra text, e.g. the http path and query string
3040 raise vimconn
.vimconnNotImplemented("Should have implemented this")
3042 # NOT USED METHODS in current version
3044 def host_vim2gui(self
, host
, server_dict
):
3045 """Transform host dictionary from VIM format to GUI format,
3046 and append to the server_dict
3048 raise vimconn
.vimconnNotImplemented("Should have implemented this")
3050 def get_hosts_info(self
):
3051 """Get the information of deployed hosts
3052 Returns the hosts content"""
3053 raise vimconn
.vimconnNotImplemented("Should have implemented this")
3055 def get_hosts(self
, vim_tenant
):
3056 """Get the hosts and deployed instances
3057 Returns the hosts content"""
3058 raise vimconn
.vimconnNotImplemented("Should have implemented this")
3060 def get_processor_rankings(self
):
3061 """Get the processor rankings in the VIM database"""
3062 raise vimconn
.vimconnNotImplemented("Should have implemented this")
3064 def new_host(self
, host_data
):
3065 """Adds a new host to VIM"""
3066 '''Returns status code of the VIM response'''
3067 raise vimconn
.vimconnNotImplemented("Should have implemented this")
3069 def new_external_port(self
, port_data
):
3070 """Adds a external port to VIM"""
3071 '''Returns the port identifier'''
3072 raise vimconn
.vimconnNotImplemented("Should have implemented this")
3074 def new_external_network(self
, net_name
, net_type
):
3075 """Adds a external network to VIM (shared)"""
3076 '''Returns the network identifier'''
3077 raise vimconn
.vimconnNotImplemented("Should have implemented this")
3079 def connect_port_network(self
, port_id
, network_id
, admin
=False):
3080 """Connects a external port to a network"""
3081 '''Returns status code of the VIM response'''
3082 raise vimconn
.vimconnNotImplemented("Should have implemented this")
3084 def new_vminstancefromJSON(self
, vm_data
):
3085 """Adds a VM instance to VIM"""
3086 '''Returns the instance identifier'''
3087 raise vimconn
.vimconnNotImplemented("Should have implemented this")
3089 def get_network_name_by_id(self
, network_uuid
=None):
3090 """Method gets vcloud director network named based on supplied uuid.
3093 network_uuid: network_id
3096 The return network name.
3099 if not network_uuid
:
3103 org_dict
= self
.get_org(self
.org_uuid
)
3104 if 'networks' in org_dict
:
3105 org_network_dict
= org_dict
['networks']
3106 for net_uuid
in org_network_dict
:
3107 if net_uuid
== network_uuid
:
3108 return org_network_dict
[net_uuid
]
3110 self
.logger
.debug("Exception in get_network_name_by_id")
3111 self
.logger
.debug(traceback
.format_exc())
3115 def get_network_id_by_name(self
, network_name
=None):
3116 """Method gets vcloud director network uuid based on supplied name.
3119 network_name: network_name
3121 The return network uuid.
3122 network_uuid: network_id
3125 if not network_name
:
3126 self
.logger
.debug("get_network_id_by_name() : Network name is empty")
3130 org_dict
= self
.get_org(self
.org_uuid
)
3131 if org_dict
and 'networks' in org_dict
:
3132 org_network_dict
= org_dict
['networks']
3133 for net_uuid
,net_name
in org_network_dict
.iteritems():
3135 #for net_uuid,net_name in org_network_dict.items():
3136 if net_name
== network_name
:
3139 except KeyError as exp
:
3140 self
.logger
.debug("get_network_id_by_name() : KeyError- {} ".format(exp
))
3144 def list_org_action(self
):
3146 Method leverages vCloud director and query for available organization for particular user
3149 vca - is active VCA connection.
3150 vdc_name - is a vdc name that will be used to query vms action
3153 The return XML respond
3155 url_list
= [self
.url
, '/api/org']
3156 vm_list_rest_call
= ''.join(url_list
)
3158 if self
.client
._session
:
3159 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
3160 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
3162 response
= self
.perform_request(req_type
='GET',
3163 url
=vm_list_rest_call
,
3166 if response
.status_code
== 403:
3167 response
= self
.retry_rest('GET', vm_list_rest_call
)
3169 if response
.status_code
== requests
.codes
.ok
:
3170 return response
.content
3174 def get_org_action(self
, org_uuid
=None):
3176 Method leverages vCloud director and retrieve available object for organization.
3179 org_uuid - vCD organization uuid
3180 self.client - is active connection.
3183 The return XML respond
3186 if org_uuid
is None:
3189 url_list
= [self
.url
, '/api/org/', org_uuid
]
3190 vm_list_rest_call
= ''.join(url_list
)
3192 if self
.client
._session
:
3193 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
3194 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
3196 #response = requests.get(vm_list_rest_call, headers=headers, verify=False)
3197 response
= self
.perform_request(req_type
='GET',
3198 url
=vm_list_rest_call
,
3200 if response
.status_code
== 403:
3201 response
= self
.retry_rest('GET', vm_list_rest_call
)
3203 if response
.status_code
== requests
.codes
.ok
:
3204 return response
.content
3207 def get_org(self
, org_uuid
=None):
3209 Method retrieves available organization in vCloud Director
3212 org_uuid - is a organization uuid.
3215 The return dictionary with following key
3216 "network" - for network list under the org
3217 "catalogs" - for network list under the org
3218 "vdcs" - for vdc list under org
3223 if org_uuid
is None:
3226 content
= self
.get_org_action(org_uuid
=org_uuid
)
3231 vm_list_xmlroot
= XmlElementTree
.fromstring(content
)
3232 for child
in vm_list_xmlroot
:
3233 if child
.attrib
['type'] == 'application/vnd.vmware.vcloud.vdc+xml':
3234 vdc_list
[child
.attrib
['href'].split("/")[-1:][0]] = child
.attrib
['name']
3235 org_dict
['vdcs'] = vdc_list
3236 if child
.attrib
['type'] == 'application/vnd.vmware.vcloud.orgNetwork+xml':
3237 network_list
[child
.attrib
['href'].split("/")[-1:][0]] = child
.attrib
['name']
3238 org_dict
['networks'] = network_list
3239 if child
.attrib
['type'] == 'application/vnd.vmware.vcloud.catalog+xml':
3240 catalog_list
[child
.attrib
['href'].split("/")[-1:][0]] = child
.attrib
['name']
3241 org_dict
['catalogs'] = catalog_list
3247 def get_org_list(self
):
3249 Method retrieves available organization in vCloud Director
3252 vca - is active VCA connection.
3255 The return dictionary and key for each entry VDC UUID
3260 content
= self
.list_org_action()
3262 vm_list_xmlroot
= XmlElementTree
.fromstring(content
)
3263 for vm_xml
in vm_list_xmlroot
:
3264 if vm_xml
.tag
.split("}")[1] == 'Org':
3265 org_uuid
= vm_xml
.attrib
['href'].split('/')[-1:]
3266 org_dict
[org_uuid
[0]] = vm_xml
.attrib
['name']
3272 def vms_view_action(self
, vdc_name
=None):
3273 """ Method leverages vCloud director vms query call
3276 vca - is active VCA connection.
3277 vdc_name - is a vdc name that will be used to query vms action
3280 The return XML respond
3282 vca
= self
.connect()
3283 if vdc_name
is None:
3286 url_list
= [vca
.host
, '/api/vms/query']
3287 vm_list_rest_call
= ''.join(url_list
)
3289 if not (not vca
.vcloud_session
or not vca
.vcloud_session
.organization
):
3290 refs
= filter(lambda ref
: ref
.name
== vdc_name
and ref
.type_
== 'application/vnd.vmware.vcloud.vdc+xml',
3291 vca
.vcloud_session
.organization
.Link
)
3293 #refs = [ref for ref in vca.vcloud_session.organization.Link if ref.name == vdc_name and\
3294 # ref.type_ == 'application/vnd.vmware.vcloud.vdc+xml']
3296 response
= Http
.get(url
=vm_list_rest_call
,
3297 headers
=vca
.vcloud_session
.get_vcloud_headers(),
3300 if response
.status_code
== requests
.codes
.ok
:
3301 return response
.content
3305 def get_vapp_list(self
, vdc_name
=None):
3307 Method retrieves vApp list deployed vCloud director and returns a dictionary
3308 contains a list of all vapp deployed for queried VDC.
3309 The key for a dictionary is vApp UUID
3313 vca - is active VCA connection.
3314 vdc_name - is a vdc name that will be used to query vms action
3317 The return dictionary and key for each entry vapp UUID
3321 if vdc_name
is None:
3324 content
= self
.vms_view_action(vdc_name
=vdc_name
)
3326 vm_list_xmlroot
= XmlElementTree
.fromstring(content
)
3327 for vm_xml
in vm_list_xmlroot
:
3328 if vm_xml
.tag
.split("}")[1] == 'VMRecord':
3329 if vm_xml
.attrib
['isVAppTemplate'] == 'true':
3330 rawuuid
= vm_xml
.attrib
['container'].split('/')[-1:]
3331 if 'vappTemplate-' in rawuuid
[0]:
3332 # vm in format vappTemplate-e63d40e7-4ff5-4c6d-851f-96c1e4da86a5 we remove
3333 # vm and use raw UUID as key
3334 vapp_dict
[rawuuid
[0][13:]] = vm_xml
.attrib
3340 def get_vm_list(self
, vdc_name
=None):
3342 Method retrieves VM's list deployed vCloud director. It returns a dictionary
3343 contains a list of all VM's deployed for queried VDC.
3344 The key for a dictionary is VM UUID
3348 vca - is active VCA connection.
3349 vdc_name - is a vdc name that will be used to query vms action
3352 The return dictionary and key for each entry vapp UUID
3356 if vdc_name
is None:
3359 content
= self
.vms_view_action(vdc_name
=vdc_name
)
3361 vm_list_xmlroot
= XmlElementTree
.fromstring(content
)
3362 for vm_xml
in vm_list_xmlroot
:
3363 if vm_xml
.tag
.split("}")[1] == 'VMRecord':
3364 if vm_xml
.attrib
['isVAppTemplate'] == 'false':
3365 rawuuid
= vm_xml
.attrib
['href'].split('/')[-1:]
3366 if 'vm-' in rawuuid
[0]:
3367 # vm in format vm-e63d40e7-4ff5-4c6d-851f-96c1e4da86a5 we remove
3368 # vm and use raw UUID as key
3369 vm_dict
[rawuuid
[0][3:]] = vm_xml
.attrib
3375 def get_vapp(self
, vdc_name
=None, vapp_name
=None, isuuid
=False):
3377 Method retrieves VM deployed vCloud director. It returns VM attribute as dictionary
3378 contains a list of all VM's deployed for queried VDC.
3379 The key for a dictionary is VM UUID
3383 vca - is active VCA connection.
3384 vdc_name - is a vdc name that will be used to query vms action
3387 The return dictionary and key for each entry vapp UUID
3390 vca
= self
.connect()
3392 raise vimconn
.vimconnConnectionException("self.connect() is failed")
3394 if vdc_name
is None:
3397 content
= self
.vms_view_action(vdc_name
=vdc_name
)
3399 vm_list_xmlroot
= XmlElementTree
.fromstring(content
)
3400 for vm_xml
in vm_list_xmlroot
:
3401 if vm_xml
.tag
.split("}")[1] == 'VMRecord' and vm_xml
.attrib
['isVAppTemplate'] == 'false':
3402 # lookup done by UUID
3404 if vapp_name
in vm_xml
.attrib
['container']:
3405 rawuuid
= vm_xml
.attrib
['href'].split('/')[-1:]
3406 if 'vm-' in rawuuid
[0]:
3407 vm_dict
[rawuuid
[0][3:]] = vm_xml
.attrib
3409 # lookup done by Name
3411 if vapp_name
in vm_xml
.attrib
['name']:
3412 rawuuid
= vm_xml
.attrib
['href'].split('/')[-1:]
3413 if 'vm-' in rawuuid
[0]:
3414 vm_dict
[rawuuid
[0][3:]] = vm_xml
.attrib
3421 def get_network_action(self
, network_uuid
=None):
3423 Method leverages vCloud director and query network based on network uuid
3426 vca - is active VCA connection.
3427 network_uuid - is a network uuid
3430 The return XML respond
3433 if network_uuid
is None:
3436 url_list
= [self
.url
, '/api/network/', network_uuid
]
3437 vm_list_rest_call
= ''.join(url_list
)
3439 if self
.client
._session
:
3440 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
3441 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
3443 response
= self
.perform_request(req_type
='GET',
3444 url
=vm_list_rest_call
,
3446 #Retry login if session expired & retry sending request
3447 if response
.status_code
== 403:
3448 response
= self
.retry_rest('GET', vm_list_rest_call
)
3450 if response
.status_code
== requests
.codes
.ok
:
3451 return response
.content
3455 def get_vcd_network(self
, network_uuid
=None):
3457 Method retrieves available network from vCloud Director
3460 network_uuid - is VCD network UUID
3462 Each element serialized as key : value pair
3464 Following keys available for access. network_configuration['Gateway'}
3468 <IsInherited>true</IsInherited>
3469 <Gateway>172.16.252.100</Gateway>
3470 <Netmask>255.255.255.0</Netmask>
3471 <Dns1>172.16.254.201</Dns1>
3472 <Dns2>172.16.254.202</Dns2>
3473 <DnsSuffix>vmwarelab.edu</DnsSuffix>
3474 <IsEnabled>true</IsEnabled>
3477 <StartAddress>172.16.252.1</StartAddress>
3478 <EndAddress>172.16.252.99</EndAddress>
3483 <FenceMode>bridged</FenceMode>
3486 The return dictionary and key for each entry vapp UUID
3489 network_configuration
= {}
3490 if network_uuid
is None:
3494 content
= self
.get_network_action(network_uuid
=network_uuid
)
3495 vm_list_xmlroot
= XmlElementTree
.fromstring(content
)
3497 network_configuration
['status'] = vm_list_xmlroot
.get("status")
3498 network_configuration
['name'] = vm_list_xmlroot
.get("name")
3499 network_configuration
['uuid'] = vm_list_xmlroot
.get("id").split(":")[3]
3501 for child
in vm_list_xmlroot
:
3502 if child
.tag
.split("}")[1] == 'IsShared':
3503 network_configuration
['isShared'] = child
.text
.strip()
3504 if child
.tag
.split("}")[1] == 'Configuration':
3505 for configuration
in child
.iter():
3506 tagKey
= configuration
.tag
.split("}")[1].strip()
3508 network_configuration
[tagKey
] = configuration
.text
.strip()
3509 return network_configuration
3510 except Exception as exp
:
3511 self
.logger
.debug("get_vcd_network: Failed with Exception {}".format(exp
))
3512 raise vimconn
.vimconnException("get_vcd_network: Failed with Exception {}".format(exp
))
3514 return network_configuration
3516 def delete_network_action(self
, network_uuid
=None):
3518 Method delete given network from vCloud director
3521 network_uuid - is a network uuid that client wish to delete
3524 The return None or XML respond or false
3526 client
= self
.connect_as_admin()
3528 raise vimconn
.vimconnConnectionException("Failed to connect vCD as admin")
3529 if network_uuid
is None:
3532 url_list
= [self
.url
, '/api/admin/network/', network_uuid
]
3533 vm_list_rest_call
= ''.join(url_list
)
3536 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
3537 'x-vcloud-authorization': client
._session
.headers
['x-vcloud-authorization']}
3538 response
= self
.perform_request(req_type
='DELETE',
3539 url
=vm_list_rest_call
,
3541 if response
.status_code
== 202:
3546 def create_network(self
, network_name
=None, net_type
='bridge', parent_network_uuid
=None,
3547 ip_profile
=None, isshared
='true'):
3549 Method create network in vCloud director
3552 network_name - is network name to be created.
3553 net_type - can be 'bridge','data','ptp','mgmt'.
3554 ip_profile is a dict containing the IP parameters of the network
3555 isshared - is a boolean
3556 parent_network_uuid - is parent provider vdc network that will be used for mapping.
3557 It optional attribute. by default if no parent network indicate the first available will be used.
3560 The return network uuid or return None
3563 new_network_name
= [network_name
, '-', str(uuid
.uuid4())]
3564 content
= self
.create_network_rest(network_name
=''.join(new_network_name
),
3565 ip_profile
=ip_profile
,
3567 parent_network_uuid
=parent_network_uuid
,
3570 self
.logger
.debug("Failed create network {}.".format(network_name
))
3574 vm_list_xmlroot
= XmlElementTree
.fromstring(content
)
3575 vcd_uuid
= vm_list_xmlroot
.get('id').split(":")
3576 if len(vcd_uuid
) == 4:
3577 self
.logger
.info("Created new network name: {} uuid: {}".format(network_name
, vcd_uuid
[3]))
3580 self
.logger
.debug("Failed create network {}".format(network_name
))
3583 def create_network_rest(self
, network_name
=None, net_type
='bridge', parent_network_uuid
=None,
3584 ip_profile
=None, isshared
='true'):
3586 Method create network in vCloud director
3589 network_name - is network name to be created.
3590 net_type - can be 'bridge','data','ptp','mgmt'.
3591 ip_profile is a dict containing the IP parameters of the network
3592 isshared - is a boolean
3593 parent_network_uuid - is parent provider vdc network that will be used for mapping.
3594 It optional attribute. by default if no parent network indicate the first available will be used.
3597 The return network uuid or return None
3599 client_as_admin
= self
.connect_as_admin()
3600 if not client_as_admin
:
3601 raise vimconn
.vimconnConnectionException("Failed to connect vCD.")
3602 if network_name
is None:
3605 url_list
= [self
.url
, '/api/admin/vdc/', self
.tenant_id
]
3606 vm_list_rest_call
= ''.join(url_list
)
3608 if client_as_admin
._session
:
3609 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
3610 'x-vcloud-authorization': client_as_admin
._session
.headers
['x-vcloud-authorization']}
3612 response
= self
.perform_request(req_type
='GET',
3613 url
=vm_list_rest_call
,
3616 provider_network
= None
3617 available_networks
= None
3618 add_vdc_rest_url
= None
3620 if response
.status_code
!= requests
.codes
.ok
:
3621 self
.logger
.debug("REST API call {} failed. Return status code {}".format(vm_list_rest_call
,
3622 response
.status_code
))
3626 vm_list_xmlroot
= XmlElementTree
.fromstring(response
.content
)
3627 for child
in vm_list_xmlroot
:
3628 if child
.tag
.split("}")[1] == 'ProviderVdcReference':
3629 provider_network
= child
.attrib
.get('href')
3630 # application/vnd.vmware.admin.providervdc+xml
3631 if child
.tag
.split("}")[1] == 'Link':
3632 if child
.attrib
.get('type') == 'application/vnd.vmware.vcloud.orgVdcNetwork+xml' \
3633 and child
.attrib
.get('rel') == 'add':
3634 add_vdc_rest_url
= child
.attrib
.get('href')
3636 self
.logger
.debug("Failed parse respond for rest api call {}".format(vm_list_rest_call
))
3637 self
.logger
.debug("Respond body {}".format(response
.content
))
3640 # find pvdc provided available network
3641 response
= self
.perform_request(req_type
='GET',
3642 url
=provider_network
,
3644 if response
.status_code
!= requests
.codes
.ok
:
3645 self
.logger
.debug("REST API call {} failed. Return status code {}".format(vm_list_rest_call
,
3646 response
.status_code
))
3649 if parent_network_uuid
is None:
3651 vm_list_xmlroot
= XmlElementTree
.fromstring(response
.content
)
3652 for child
in vm_list_xmlroot
.iter():
3653 if child
.tag
.split("}")[1] == 'AvailableNetworks':
3654 for networks
in child
.iter():
3655 # application/vnd.vmware.admin.network+xml
3656 if networks
.attrib
.get('href') is not None:
3657 available_networks
= networks
.attrib
.get('href')
3663 #Configure IP profile of the network
3664 ip_profile
= ip_profile
if ip_profile
is not None else DEFAULT_IP_PROFILE
3666 if 'subnet_address' not in ip_profile
or ip_profile
['subnet_address'] is None:
3667 subnet_rand
= random
.randint(0, 255)
3668 ip_base
= "192.168.{}.".format(subnet_rand
)
3669 ip_profile
['subnet_address'] = ip_base
+ "0/24"
3671 ip_base
= ip_profile
['subnet_address'].rsplit('.',1)[0] + '.'
3673 if 'gateway_address' not in ip_profile
or ip_profile
['gateway_address'] is None:
3674 ip_profile
['gateway_address']=ip_base
+ "1"
3675 if 'dhcp_count' not in ip_profile
or ip_profile
['dhcp_count'] is None:
3676 ip_profile
['dhcp_count']=DEFAULT_IP_PROFILE
['dhcp_count']
3677 if 'dhcp_enabled' not in ip_profile
or ip_profile
['dhcp_enabled'] is None:
3678 ip_profile
['dhcp_enabled']=DEFAULT_IP_PROFILE
['dhcp_enabled']
3679 if 'dhcp_start_address' not in ip_profile
or ip_profile
['dhcp_start_address'] is None:
3680 ip_profile
['dhcp_start_address']=ip_base
+ "3"
3681 if 'ip_version' not in ip_profile
or ip_profile
['ip_version'] is None:
3682 ip_profile
['ip_version']=DEFAULT_IP_PROFILE
['ip_version']
3683 if 'dns_address' not in ip_profile
or ip_profile
['dns_address'] is None:
3684 ip_profile
['dns_address']=ip_base
+ "2"
3686 gateway_address
=ip_profile
['gateway_address']
3687 dhcp_count
=int(ip_profile
['dhcp_count'])
3688 subnet_address
=self
.convert_cidr_to_netmask(ip_profile
['subnet_address'])
3690 if ip_profile
['dhcp_enabled']==True:
3693 dhcp_enabled
='false'
3694 dhcp_start_address
=ip_profile
['dhcp_start_address']
3696 #derive dhcp_end_address from dhcp_start_address & dhcp_count
3697 end_ip_int
= int(netaddr
.IPAddress(dhcp_start_address
))
3698 end_ip_int
+= dhcp_count
- 1
3699 dhcp_end_address
= str(netaddr
.IPAddress(end_ip_int
))
3701 ip_version
=ip_profile
['ip_version']
3702 dns_address
=ip_profile
['dns_address']
3703 except KeyError as exp
:
3704 self
.logger
.debug("Create Network REST: Key error {}".format(exp
))
3705 raise vimconn
.vimconnException("Create Network REST: Key error{}".format(exp
))
3707 # either use client provided UUID or search for a first available
3708 # if both are not defined we return none
3709 if parent_network_uuid
is not None:
3710 url_list
= [self
.url
, '/api/admin/network/', parent_network_uuid
]
3711 add_vdc_rest_url
= ''.join(url_list
)
3713 #Creating all networks as Direct Org VDC type networks.
3714 #Unused in case of Underlay (data/ptp) network interface.
3715 fence_mode
="bridged"
3716 is_inherited
='false'
3717 dns_list
= dns_address
.split(";")
3720 if len(dns_list
) >= 2:
3721 dns2_text
= "\n <Dns2>{}</Dns2>\n".format(dns_list
[1])
3722 data
= """ <OrgVdcNetwork name="{0:s}" xmlns="http://www.vmware.com/vcloud/v1.5">
3723 <Description>Openmano created</Description>
3727 <IsInherited>{1:s}</IsInherited>
3728 <Gateway>{2:s}</Gateway>
3729 <Netmask>{3:s}</Netmask>
3730 <Dns1>{4:s}</Dns1>{5:s}
3731 <IsEnabled>{6:s}</IsEnabled>
3734 <StartAddress>{7:s}</StartAddress>
3735 <EndAddress>{8:s}</EndAddress>
3740 <ParentNetwork href="{9:s}"/>
3741 <FenceMode>{10:s}</FenceMode>
3743 <IsShared>{11:s}</IsShared>
3744 </OrgVdcNetwork> """.format(escape(network_name
), is_inherited
, gateway_address
,
3745 subnet_address
, dns1
, dns2_text
, dhcp_enabled
,
3746 dhcp_start_address
, dhcp_end_address
, available_networks
,
3747 fence_mode
, isshared
)
3749 headers
['Content-Type'] = 'application/vnd.vmware.vcloud.orgVdcNetwork+xml'
3751 response
= self
.perform_request(req_type
='POST',
3752 url
=add_vdc_rest_url
,
3756 if response
.status_code
!= 201:
3757 self
.logger
.debug("Create Network POST REST API call failed. Return status code {}, Response content: {}"
3758 .format(response
.status_code
,response
.content
))
3760 network_task
= self
.get_task_from_response(response
.content
)
3761 self
.logger
.debug("Create Network REST : Waiting for Network creation complete")
3763 result
= self
.client
.get_task_monitor().wait_for_success(task
=network_task
)
3764 if result
.get('status') == 'success':
3765 return response
.content
3767 self
.logger
.debug("create_network_rest task failed. Network Create response : {}"
3768 .format(response
.content
))
3769 except Exception as exp
:
3770 self
.logger
.debug("create_network_rest : Exception : {} ".format(exp
))
3774 def convert_cidr_to_netmask(self
, cidr_ip
=None):
3776 Method sets convert CIDR netmask address to normal IP format
3778 cidr_ip : CIDR IP address
3780 netmask : Converted netmask
3782 if cidr_ip
is not None:
3784 network
, net_bits
= cidr_ip
.split('/')
3785 netmask
= socket
.inet_ntoa(struct
.pack(">I", (0xffffffff << (32 - int(net_bits
))) & 0xffffffff))
3791 def get_provider_rest(self
, vca
=None):
3793 Method gets provider vdc view from vcloud director
3796 network_name - is network name to be created.
3797 parent_network_uuid - is parent provider vdc network that will be used for mapping.
3798 It optional attribute. by default if no parent network indicate the first available will be used.
3801 The return xml content of respond or None
3804 url_list
= [self
.url
, '/api/admin']
3806 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
3807 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
3808 response
= self
.perform_request(req_type
='GET',
3809 url
=''.join(url_list
),
3812 if response
.status_code
== requests
.codes
.ok
:
3813 return response
.content
3816 def create_vdc(self
, vdc_name
=None):
3820 xml_content
= self
.create_vdc_from_tmpl_rest(vdc_name
=vdc_name
)
3821 if xml_content
is not None:
3823 task_resp_xmlroot
= XmlElementTree
.fromstring(xml_content
)
3824 for child
in task_resp_xmlroot
:
3825 if child
.tag
.split("}")[1] == 'Owner':
3826 vdc_id
= child
.attrib
.get('href').split("/")[-1]
3827 vdc_dict
[vdc_id
] = task_resp_xmlroot
.get('href')
3830 self
.logger
.debug("Respond body {}".format(xml_content
))
3834 def create_vdc_from_tmpl_rest(self
, vdc_name
=None):
3836 Method create vdc in vCloud director based on VDC template.
3837 it uses pre-defined template.
3840 vdc_name - name of a new vdc.
3843 The return xml content of respond or None
3845 # pre-requesite atleast one vdc template should be available in vCD
3846 self
.logger
.info("Creating new vdc {}".format(vdc_name
))
3847 vca
= self
.connect_as_admin()
3849 raise vimconn
.vimconnConnectionException("Failed to connect vCD")
3850 if vdc_name
is None:
3853 url_list
= [self
.url
, '/api/vdcTemplates']
3854 vm_list_rest_call
= ''.join(url_list
)
3856 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
3857 'x-vcloud-authorization': vca
._session
.headers
['x-vcloud-authorization']}
3858 response
= self
.perform_request(req_type
='GET',
3859 url
=vm_list_rest_call
,
3862 # container url to a template
3863 vdc_template_ref
= None
3865 vm_list_xmlroot
= XmlElementTree
.fromstring(response
.content
)
3866 for child
in vm_list_xmlroot
:
3867 # application/vnd.vmware.admin.providervdc+xml
3868 # we need find a template from witch we instantiate VDC
3869 if child
.tag
.split("}")[1] == 'VdcTemplate':
3870 if child
.attrib
.get('type') == 'application/vnd.vmware.admin.vdcTemplate+xml':
3871 vdc_template_ref
= child
.attrib
.get('href')
3873 self
.logger
.debug("Failed parse respond for rest api call {}".format(vm_list_rest_call
))
3874 self
.logger
.debug("Respond body {}".format(response
.content
))
3877 # if we didn't found required pre defined template we return None
3878 if vdc_template_ref
is None:
3883 url_list
= [self
.url
, '/api/org/', self
.org_uuid
, '/action/instantiate']
3884 vm_list_rest_call
= ''.join(url_list
)
3885 data
= """<InstantiateVdcTemplateParams name="{0:s}" xmlns="http://www.vmware.com/vcloud/v1.5">
3886 <Source href="{1:s}"></Source>
3887 <Description>opnemano</Description>
3888 </InstantiateVdcTemplateParams>""".format(vdc_name
, vdc_template_ref
)
3890 headers
['Content-Type'] = 'application/vnd.vmware.vcloud.instantiateVdcTemplateParams+xml'
3892 response
= self
.perform_request(req_type
='POST',
3893 url
=vm_list_rest_call
,
3897 vdc_task
= self
.get_task_from_response(response
.content
)
3898 self
.client
.get_task_monitor().wait_for_success(task
=vdc_task
)
3900 # if we all ok we respond with content otherwise by default None
3901 if response
.status_code
>= 200 and response
.status_code
< 300:
3902 return response
.content
3905 self
.logger
.debug("Failed parse respond for rest api call {}".format(vm_list_rest_call
))
3906 self
.logger
.debug("Respond body {}".format(response
.content
))
3910 def create_vdc_rest(self
, vdc_name
=None):
3912 Method create network in vCloud director
3915 vdc_name - vdc name to be created
3920 self
.logger
.info("Creating new vdc {}".format(vdc_name
))
3922 vca
= self
.connect_as_admin()
3924 raise vimconn
.vimconnConnectionException("Failed to connect vCD")
3925 if vdc_name
is None:
3928 url_list
= [self
.url
, '/api/admin/org/', self
.org_uuid
]
3929 vm_list_rest_call
= ''.join(url_list
)
3932 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
3933 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
3934 response
= self
.perform_request(req_type
='GET',
3935 url
=vm_list_rest_call
,
3938 provider_vdc_ref
= None
3939 add_vdc_rest_url
= None
3940 available_networks
= None
3942 if response
.status_code
!= requests
.codes
.ok
:
3943 self
.logger
.debug("REST API call {} failed. Return status code {}".format(vm_list_rest_call
,
3944 response
.status_code
))
3948 vm_list_xmlroot
= XmlElementTree
.fromstring(response
.content
)
3949 for child
in vm_list_xmlroot
:
3950 # application/vnd.vmware.admin.providervdc+xml
3951 if child
.tag
.split("}")[1] == 'Link':
3952 if child
.attrib
.get('type') == 'application/vnd.vmware.admin.createVdcParams+xml' \
3953 and child
.attrib
.get('rel') == 'add':
3954 add_vdc_rest_url
= child
.attrib
.get('href')
3956 self
.logger
.debug("Failed parse respond for rest api call {}".format(vm_list_rest_call
))
3957 self
.logger
.debug("Respond body {}".format(response
.content
))
3960 response
= self
.get_provider_rest(vca
=vca
)
3962 vm_list_xmlroot
= XmlElementTree
.fromstring(response
)
3963 for child
in vm_list_xmlroot
:
3964 if child
.tag
.split("}")[1] == 'ProviderVdcReferences':
3965 for sub_child
in child
:
3966 provider_vdc_ref
= sub_child
.attrib
.get('href')
3968 self
.logger
.debug("Failed parse respond for rest api call {}".format(vm_list_rest_call
))
3969 self
.logger
.debug("Respond body {}".format(response
))
3972 if add_vdc_rest_url
is not None and provider_vdc_ref
is not None:
3973 data
= """ <CreateVdcParams name="{0:s}" xmlns="http://www.vmware.com/vcloud/v1.5"><Description>{1:s}</Description>
3974 <AllocationModel>ReservationPool</AllocationModel>
3975 <ComputeCapacity><Cpu><Units>MHz</Units><Allocated>2048</Allocated><Limit>2048</Limit></Cpu>
3976 <Memory><Units>MB</Units><Allocated>2048</Allocated><Limit>2048</Limit></Memory>
3977 </ComputeCapacity><NicQuota>0</NicQuota><NetworkQuota>100</NetworkQuota>
3978 <VdcStorageProfile><Enabled>true</Enabled><Units>MB</Units><Limit>20480</Limit><Default>true</Default></VdcStorageProfile>
3979 <ProviderVdcReference
3980 name="Main Provider"
3982 <UsesFastProvisioning>true</UsesFastProvisioning></CreateVdcParams>""".format(escape(vdc_name
),
3986 headers
['Content-Type'] = 'application/vnd.vmware.admin.createVdcParams+xml'
3988 response
= self
.perform_request(req_type
='POST',
3989 url
=add_vdc_rest_url
,
3993 # if we all ok we respond with content otherwise by default None
3994 if response
.status_code
== 201:
3995 return response
.content
3998 def get_vapp_details_rest(self
, vapp_uuid
=None, need_admin_access
=False):
4000 Method retrieve vapp detail from vCloud director
4003 vapp_uuid - is vapp identifier.
4006 The return network uuid or return None
4012 if need_admin_access
:
4013 vca
= self
.connect_as_admin()
4018 raise vimconn
.vimconnConnectionException("Failed to connect vCD")
4019 if vapp_uuid
is None:
4022 url_list
= [self
.url
, '/api/vApp/vapp-', vapp_uuid
]
4023 get_vapp_restcall
= ''.join(url_list
)
4026 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
4027 'x-vcloud-authorization': vca
._session
.headers
['x-vcloud-authorization']}
4028 response
= self
.perform_request(req_type
='GET',
4029 url
=get_vapp_restcall
,
4032 if response
.status_code
== 403:
4033 if need_admin_access
== False:
4034 response
= self
.retry_rest('GET', get_vapp_restcall
)
4036 if response
.status_code
!= requests
.codes
.ok
:
4037 self
.logger
.debug("REST API call {} failed. Return status code {}".format(get_vapp_restcall
,
4038 response
.status_code
))
4039 return parsed_respond
4042 xmlroot_respond
= XmlElementTree
.fromstring(response
.content
)
4043 parsed_respond
['ovfDescriptorUploaded'] = xmlroot_respond
.attrib
['ovfDescriptorUploaded']
4045 namespaces
= {"vssd":"http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData" ,
4046 'ovf': 'http://schemas.dmtf.org/ovf/envelope/1',
4047 'vmw': 'http://www.vmware.com/schema/ovf',
4048 'vm': 'http://www.vmware.com/vcloud/v1.5',
4049 'rasd':"http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData",
4050 "vmext":"http://www.vmware.com/vcloud/extension/v1.5",
4051 "xmlns":"http://www.vmware.com/vcloud/v1.5"
4054 created_section
= xmlroot_respond
.find('vm:DateCreated', namespaces
)
4055 if created_section
is not None:
4056 parsed_respond
['created'] = created_section
.text
4058 network_section
= xmlroot_respond
.find('vm:NetworkConfigSection/vm:NetworkConfig', namespaces
)
4059 if network_section
is not None and 'networkName' in network_section
.attrib
:
4060 parsed_respond
['networkname'] = network_section
.attrib
['networkName']
4062 ipscopes_section
= \
4063 xmlroot_respond
.find('vm:NetworkConfigSection/vm:NetworkConfig/vm:Configuration/vm:IpScopes',
4065 if ipscopes_section
is not None:
4066 for ipscope
in ipscopes_section
:
4067 for scope
in ipscope
:
4068 tag_key
= scope
.tag
.split("}")[1]
4069 if tag_key
== 'IpRanges':
4070 ip_ranges
= scope
.getchildren()
4071 for ipblock
in ip_ranges
:
4072 for block
in ipblock
:
4073 parsed_respond
[block
.tag
.split("}")[1]] = block
.text
4075 parsed_respond
[tag_key
] = scope
.text
4077 # parse children section for other attrib
4078 children_section
= xmlroot_respond
.find('vm:Children/', namespaces
)
4079 if children_section
is not None:
4080 parsed_respond
['name'] = children_section
.attrib
['name']
4081 parsed_respond
['nestedHypervisorEnabled'] = children_section
.attrib
['nestedHypervisorEnabled'] \
4082 if "nestedHypervisorEnabled" in children_section
.attrib
else None
4083 parsed_respond
['deployed'] = children_section
.attrib
['deployed']
4084 parsed_respond
['status'] = children_section
.attrib
['status']
4085 parsed_respond
['vmuuid'] = children_section
.attrib
['id'].split(":")[-1]
4086 network_adapter
= children_section
.find('vm:NetworkConnectionSection', namespaces
)
4088 for adapters
in network_adapter
:
4089 adapter_key
= adapters
.tag
.split("}")[1]
4090 if adapter_key
== 'PrimaryNetworkConnectionIndex':
4091 parsed_respond
['primarynetwork'] = adapters
.text
4092 if adapter_key
== 'NetworkConnection':
4094 if 'network' in adapters
.attrib
:
4095 vnic
['network'] = adapters
.attrib
['network']
4096 for adapter
in adapters
:
4097 setting_key
= adapter
.tag
.split("}")[1]
4098 vnic
[setting_key
] = adapter
.text
4099 nic_list
.append(vnic
)
4101 for link
in children_section
:
4102 if link
.tag
.split("}")[1] == 'Link' and 'rel' in link
.attrib
:
4103 if link
.attrib
['rel'] == 'screen:acquireTicket':
4104 parsed_respond
['acquireTicket'] = link
.attrib
4105 if link
.attrib
['rel'] == 'screen:acquireMksTicket':
4106 parsed_respond
['acquireMksTicket'] = link
.attrib
4108 parsed_respond
['interfaces'] = nic_list
4109 vCloud_extension_section
= children_section
.find('xmlns:VCloudExtension', namespaces
)
4110 if vCloud_extension_section
is not None:
4111 vm_vcenter_info
= {}
4112 vim_info
= vCloud_extension_section
.find('vmext:VmVimInfo', namespaces
)
4113 vmext
= vim_info
.find('vmext:VmVimObjectRef', namespaces
)
4114 if vmext
is not None:
4115 vm_vcenter_info
["vm_moref_id"] = vmext
.find('vmext:MoRef', namespaces
).text
4116 parsed_respond
["vm_vcenter_info"]= vm_vcenter_info
4118 virtual_hardware_section
= children_section
.find('ovf:VirtualHardwareSection', namespaces
)
4119 vm_virtual_hardware_info
= {}
4120 if virtual_hardware_section
is not None:
4121 for item
in virtual_hardware_section
.iterfind('ovf:Item',namespaces
):
4122 if item
.find("rasd:Description",namespaces
).text
== "Hard disk":
4123 disk_size
= item
.find("rasd:HostResource" ,namespaces
4124 ).attrib
["{"+namespaces
['vm']+"}capacity"]
4126 vm_virtual_hardware_info
["disk_size"]= disk_size
4129 for link
in virtual_hardware_section
:
4130 if link
.tag
.split("}")[1] == 'Link' and 'rel' in link
.attrib
:
4131 if link
.attrib
['rel'] == 'edit' and link
.attrib
['href'].endswith("/disks"):
4132 vm_virtual_hardware_info
["disk_edit_href"] = link
.attrib
['href']
4135 parsed_respond
["vm_virtual_hardware"]= vm_virtual_hardware_info
4136 except Exception as exp
:
4137 self
.logger
.info("Error occurred calling rest api for getting vApp details {}".format(exp
))
4138 return parsed_respond
4140 def acquire_console(self
, vm_uuid
=None):
4144 if self
.client
._session
:
4145 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
4146 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
4147 vm_dict
= self
.get_vapp_details_rest(vapp_uuid
=vm_uuid
)
4148 console_dict
= vm_dict
['acquireTicket']
4149 console_rest_call
= console_dict
['href']
4151 response
= self
.perform_request(req_type
='POST',
4152 url
=console_rest_call
,
4155 if response
.status_code
== 403:
4156 response
= self
.retry_rest('POST', console_rest_call
)
4158 if response
.status_code
== requests
.codes
.ok
:
4159 return response
.content
4163 def modify_vm_disk(self
, vapp_uuid
, flavor_disk
):
4165 Method retrieve vm disk details
4168 vapp_uuid - is vapp identifier.
4169 flavor_disk - disk size as specified in VNFD (flavor)
4172 The return network uuid or return None
4176 #Flavor disk is in GB convert it into MB
4177 flavor_disk
= int(flavor_disk
) * 1024
4178 vm_details
= self
.get_vapp_details_rest(vapp_uuid
)
4180 vm_name
= vm_details
["name"]
4181 self
.logger
.info("VM: {} flavor_disk :{}".format(vm_name
, flavor_disk
))
4183 if vm_details
and "vm_virtual_hardware" in vm_details
:
4184 vm_disk
= int(vm_details
["vm_virtual_hardware"]["disk_size"])
4185 disk_edit_href
= vm_details
["vm_virtual_hardware"]["disk_edit_href"]
4187 self
.logger
.info("VM: {} VM_disk :{}".format(vm_name
, vm_disk
))
4189 if flavor_disk
> vm_disk
:
4190 status
= self
.modify_vm_disk_rest(disk_edit_href
,flavor_disk
)
4191 self
.logger
.info("Modify disk of VM {} from {} to {} MB".format(vm_name
,
4192 vm_disk
, flavor_disk
))
4195 self
.logger
.info("No need to modify disk of VM {}".format(vm_name
))
4198 except Exception as exp
:
4199 self
.logger
.info("Error occurred while modifing disk size {}".format(exp
))
4202 def modify_vm_disk_rest(self
, disk_href
, disk_size
):
4204 Method retrieve modify vm disk size
4207 disk_href - vCD API URL to GET and PUT disk data
4208 disk_size - disk size as specified in VNFD (flavor)
4211 The return network uuid or return None
4213 if disk_href
is None or disk_size
is None:
4216 if self
.client
._session
:
4217 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
4218 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
4219 response
= self
.perform_request(req_type
='GET',
4223 if response
.status_code
== 403:
4224 response
= self
.retry_rest('GET', disk_href
)
4226 if response
.status_code
!= requests
.codes
.ok
:
4227 self
.logger
.debug("GET REST API call {} failed. Return status code {}".format(disk_href
,
4228 response
.status_code
))
4231 lxmlroot_respond
= lxmlElementTree
.fromstring(response
.content
)
4232 namespaces
= {prefix
:uri
for prefix
,uri
in lxmlroot_respond
.nsmap
.iteritems() if prefix
}
4234 #namespaces = {prefix:uri for prefix,uri in lxmlroot_respond.nsmap.items() if prefix}
4235 namespaces
["xmlns"]= "http://www.vmware.com/vcloud/v1.5"
4237 for item
in lxmlroot_respond
.iterfind('xmlns:Item',namespaces
):
4238 if item
.find("rasd:Description",namespaces
).text
== "Hard disk":
4239 disk_item
= item
.find("rasd:HostResource" ,namespaces
)
4240 if disk_item
is not None:
4241 disk_item
.attrib
["{"+namespaces
['xmlns']+"}capacity"] = str(disk_size
)
4244 data
= lxmlElementTree
.tostring(lxmlroot_respond
, encoding
='utf8', method
='xml',
4245 xml_declaration
=True)
4247 #Send PUT request to modify disk size
4248 headers
['Content-Type'] = 'application/vnd.vmware.vcloud.rasdItemsList+xml; charset=ISO-8859-1'
4250 response
= self
.perform_request(req_type
='PUT',
4254 if response
.status_code
== 403:
4255 add_headers
= {'Content-Type': headers
['Content-Type']}
4256 response
= self
.retry_rest('PUT', disk_href
, add_headers
, data
)
4258 if response
.status_code
!= 202:
4259 self
.logger
.debug("PUT REST API call {} failed. Return status code {}".format(disk_href
,
4260 response
.status_code
))
4262 modify_disk_task
= self
.get_task_from_response(response
.content
)
4263 result
= self
.client
.get_task_monitor().wait_for_success(task
=modify_disk_task
)
4264 if result
.get('status') == 'success':
4270 except Exception as exp
:
4271 self
.logger
.info("Error occurred calling rest api for modifing disk size {}".format(exp
))
4274 def add_pci_devices(self
, vapp_uuid
, pci_devices
, vmname_andid
):
4276 Method to attach pci devices to VM
4279 vapp_uuid - uuid of vApp/VM
4280 pci_devices - pci devices infromation as specified in VNFD (flavor)
4283 The status of add pci device task , vm object and
4284 vcenter_conect object
4287 self
.logger
.info("Add pci devices {} into vApp {}".format(pci_devices
, vapp_uuid
))
4288 vcenter_conect
, content
= self
.get_vcenter_content()
4289 vm_moref_id
= self
.get_vm_moref_id(vapp_uuid
)
4293 no_of_pci_devices
= len(pci_devices
)
4294 if no_of_pci_devices
> 0:
4295 #Get VM and its host
4296 host_obj
, vm_obj
= self
.get_vm_obj(content
, vm_moref_id
)
4297 self
.logger
.info("VM {} is currently on host {}".format(vm_obj
, host_obj
))
4298 if host_obj
and vm_obj
:
4299 #get PCI devies from host on which vapp is currently installed
4300 avilable_pci_devices
= self
.get_pci_devices(host_obj
, no_of_pci_devices
)
4302 if avilable_pci_devices
is None:
4303 #find other hosts with active pci devices
4304 new_host_obj
, avilable_pci_devices
= self
.get_host_and_PCIdevices(
4309 if new_host_obj
is not None and avilable_pci_devices
is not None and len(avilable_pci_devices
)> 0:
4310 #Migrate vm to the host where PCI devices are availble
4311 self
.logger
.info("Relocate VM {} on new host {}".format(vm_obj
, new_host_obj
))
4312 task
= self
.relocate_vm(new_host_obj
, vm_obj
)
4313 if task
is not None:
4314 result
= self
.wait_for_vcenter_task(task
, vcenter_conect
)
4315 self
.logger
.info("Migrate VM status: {}".format(result
))
4316 host_obj
= new_host_obj
4318 self
.logger
.info("Fail to migrate VM : {}".format(result
))
4319 raise vimconn
.vimconnNotFoundException(
4320 "Fail to migrate VM : {} to host {}".format(
4325 if host_obj
is not None and avilable_pci_devices
is not None and len(avilable_pci_devices
)> 0:
4326 #Add PCI devices one by one
4327 for pci_device
in avilable_pci_devices
:
4328 task
= self
.add_pci_to_vm(host_obj
, vm_obj
, pci_device
)
4330 status
= self
.wait_for_vcenter_task(task
, vcenter_conect
)
4332 self
.logger
.info("Added PCI device {} to VM {}".format(pci_device
,str(vm_obj
)))
4334 self
.logger
.error("Fail to add PCI device {} to VM {}".format(pci_device
,str(vm_obj
)))
4335 return True, vm_obj
, vcenter_conect
4337 self
.logger
.error("Currently there is no host with"\
4338 " {} number of avaialble PCI devices required for VM {}".format(
4342 raise vimconn
.vimconnNotFoundException(
4343 "Currently there is no host with {} "\
4344 "number of avaialble PCI devices required for VM {}".format(
4348 self
.logger
.debug("No infromation about PCI devices {} ",pci_devices
)
4350 except vmodl
.MethodFault
as error
:
4351 self
.logger
.error("Error occurred while adding PCI devices {} ",error
)
4352 return None, vm_obj
, vcenter_conect
4354 def get_vm_obj(self
, content
, mob_id
):
4356 Method to get the vsphere VM object associated with a given morf ID
4358 vapp_uuid - uuid of vApp/VM
4359 content - vCenter content object
4360 mob_id - mob_id of VM
4368 container
= content
.viewManager
.CreateContainerView(content
.rootFolder
,
4369 [vim
.VirtualMachine
], True
4371 for vm
in container
.view
:
4372 mobID
= vm
._GetMoId
()
4375 host_obj
= vm_obj
.runtime
.host
4377 except Exception as exp
:
4378 self
.logger
.error("Error occurred while finding VM object : {}".format(exp
))
4379 return host_obj
, vm_obj
4381 def get_pci_devices(self
, host
, need_devices
):
4383 Method to get the details of pci devices on given host
4385 host - vSphere host object
4386 need_devices - number of pci devices needed on host
4389 array of pci devices
4393 used_devices_ids
= []
4397 pciPassthruInfo
= host
.config
.pciPassthruInfo
4398 pciDevies
= host
.hardware
.pciDevice
4400 for pci_status
in pciPassthruInfo
:
4401 if pci_status
.passthruActive
:
4402 for device
in pciDevies
:
4403 if device
.id == pci_status
.id:
4404 all_device_ids
.append(device
.id)
4405 all_devices
.append(device
)
4407 #check if devices are in use
4408 avalible_devices
= all_devices
4410 if vm
.runtime
.powerState
== vim
.VirtualMachinePowerState
.poweredOn
:
4411 vm_devices
= vm
.config
.hardware
.device
4412 for device
in vm_devices
:
4413 if type(device
) is vim
.vm
.device
.VirtualPCIPassthrough
:
4414 if device
.backing
.id in all_device_ids
:
4415 for use_device
in avalible_devices
:
4416 if use_device
.id == device
.backing
.id:
4417 avalible_devices
.remove(use_device
)
4418 used_devices_ids
.append(device
.backing
.id)
4419 self
.logger
.debug("Device {} from devices {}"\
4420 "is in use".format(device
.backing
.id,
4423 if len(avalible_devices
) < need_devices
:
4424 self
.logger
.debug("Host {} don't have {} number of active devices".format(host
,
4426 self
.logger
.debug("found only {} devives {}".format(len(avalible_devices
),
4430 required_devices
= avalible_devices
[:need_devices
]
4431 self
.logger
.info("Found {} PCI devivces on host {} but required only {}".format(
4432 len(avalible_devices
),
4435 self
.logger
.info("Retruning {} devices as {}".format(need_devices
,
4437 return required_devices
4439 except Exception as exp
:
4440 self
.logger
.error("Error {} occurred while finding pci devices on host: {}".format(exp
, host
))
4444 def get_host_and_PCIdevices(self
, content
, need_devices
):
4446 Method to get the details of pci devices infromation on all hosts
4449 content - vSphere host object
4450 need_devices - number of pci devices needed on host
4453 array of pci devices and host object
4456 pci_device_objs
= None
4459 container
= content
.viewManager
.CreateContainerView(content
.rootFolder
,
4460 [vim
.HostSystem
], True)
4461 for host
in container
.view
:
4462 devices
= self
.get_pci_devices(host
, need_devices
)
4465 pci_device_objs
= devices
4467 except Exception as exp
:
4468 self
.logger
.error("Error {} occurred while finding pci devices on host: {}".format(exp
, host_obj
))
4470 return host_obj
,pci_device_objs
4472 def relocate_vm(self
, dest_host
, vm
) :
4474 Method to get the relocate VM to new host
4477 dest_host - vSphere host object
4478 vm - vSphere VM object
4485 relocate_spec
= vim
.vm
.RelocateSpec(host
=dest_host
)
4486 task
= vm
.Relocate(relocate_spec
)
4487 self
.logger
.info("Migrating {} to destination host {}".format(vm
, dest_host
))
4488 except Exception as exp
:
4489 self
.logger
.error("Error occurred while relocate VM {} to new host {}: {}".format(
4490 dest_host
, vm
, exp
))
4493 def wait_for_vcenter_task(self
, task
, actionName
='job', hideResult
=False):
4495 Waits and provides updates on a vSphere task
4497 while task
.info
.state
== vim
.TaskInfo
.State
.running
:
4500 if task
.info
.state
== vim
.TaskInfo
.State
.success
:
4501 if task
.info
.result
is not None and not hideResult
:
4502 self
.logger
.info('{} completed successfully, result: {}'.format(
4506 self
.logger
.info('Task {} completed successfully.'.format(actionName
))
4508 self
.logger
.error('{} did not complete successfully: {} '.format(
4513 return task
.info
.result
4515 def add_pci_to_vm(self
,host_object
, vm_object
, host_pci_dev
):
4517 Method to add pci device in given VM
4520 host_object - vSphere host object
4521 vm_object - vSphere VM object
4522 host_pci_dev - host_pci_dev must be one of the devices from the
4523 host_object.hardware.pciDevice list
4524 which is configured as a PCI passthrough device
4530 if vm_object
and host_object
and host_pci_dev
:
4532 #Add PCI device to VM
4533 pci_passthroughs
= vm_object
.environmentBrowser
.QueryConfigTarget(host
=None).pciPassthrough
4534 systemid_by_pciid
= {item
.pciDevice
.id: item
.systemId
for item
in pci_passthroughs
}
4536 if host_pci_dev
.id not in systemid_by_pciid
:
4537 self
.logger
.error("Device {} is not a passthrough device ".format(host_pci_dev
))
4540 deviceId
= hex(host_pci_dev
.deviceId
% 2**16).lstrip('0x')
4541 backing
= vim
.VirtualPCIPassthroughDeviceBackingInfo(deviceId
=deviceId
,
4543 systemId
=systemid_by_pciid
[host_pci_dev
.id],
4544 vendorId
=host_pci_dev
.vendorId
,
4545 deviceName
=host_pci_dev
.deviceName
)
4547 hba_object
= vim
.VirtualPCIPassthrough(key
=-100, backing
=backing
)
4549 new_device_config
= vim
.VirtualDeviceConfigSpec(device
=hba_object
)
4550 new_device_config
.operation
= "add"
4551 vmConfigSpec
= vim
.vm
.ConfigSpec()
4552 vmConfigSpec
.deviceChange
= [new_device_config
]
4554 task
= vm_object
.ReconfigVM_Task(spec
=vmConfigSpec
)
4555 self
.logger
.info("Adding PCI device {} into VM {} from host {} ".format(
4556 host_pci_dev
, vm_object
, host_object
)
4558 except Exception as exp
:
4559 self
.logger
.error("Error occurred while adding pci devive {} to VM {}: {}".format(
4565 def get_vm_vcenter_info(self
):
4567 Method to get details of vCenter and vm
4570 vapp_uuid - uuid of vApp or VM
4573 Moref Id of VM and deails of vCenter
4575 vm_vcenter_info
= {}
4577 if self
.vcenter_ip
is not None:
4578 vm_vcenter_info
["vm_vcenter_ip"] = self
.vcenter_ip
4580 raise vimconn
.vimconnException(message
="vCenter IP is not provided."\
4581 " Please provide vCenter IP while attaching datacenter to tenant in --config")
4582 if self
.vcenter_port
is not None:
4583 vm_vcenter_info
["vm_vcenter_port"] = self
.vcenter_port
4585 raise vimconn
.vimconnException(message
="vCenter port is not provided."\
4586 " Please provide vCenter port while attaching datacenter to tenant in --config")
4587 if self
.vcenter_user
is not None:
4588 vm_vcenter_info
["vm_vcenter_user"] = self
.vcenter_user
4590 raise vimconn
.vimconnException(message
="vCenter user is not provided."\
4591 " Please provide vCenter user while attaching datacenter to tenant in --config")
4593 if self
.vcenter_password
is not None:
4594 vm_vcenter_info
["vm_vcenter_password"] = self
.vcenter_password
4596 raise vimconn
.vimconnException(message
="vCenter user password is not provided."\
4597 " Please provide vCenter user password while attaching datacenter to tenant in --config")
4599 return vm_vcenter_info
4602 def get_vm_pci_details(self
, vmuuid
):
4604 Method to get VM PCI device details from vCenter
4607 vm_obj - vSphere VM object
4610 dict of PCI devives attached to VM
4613 vm_pci_devices_info
= {}
4615 vcenter_conect
, content
= self
.get_vcenter_content()
4616 vm_moref_id
= self
.get_vm_moref_id(vmuuid
)
4618 #Get VM and its host
4620 host_obj
, vm_obj
= self
.get_vm_obj(content
, vm_moref_id
)
4621 if host_obj
and vm_obj
:
4622 vm_pci_devices_info
["host_name"]= host_obj
.name
4623 vm_pci_devices_info
["host_ip"]= host_obj
.config
.network
.vnic
[0].spec
.ip
.ipAddress
4624 for device
in vm_obj
.config
.hardware
.device
:
4625 if type(device
) == vim
.vm
.device
.VirtualPCIPassthrough
:
4626 device_details
={'devide_id':device
.backing
.id,
4627 'pciSlotNumber':device
.slotInfo
.pciSlotNumber
,
4629 vm_pci_devices_info
[device
.deviceInfo
.label
] = device_details
4631 self
.logger
.error("Can not connect to vCenter while getting "\
4632 "PCI devices infromationn")
4633 return vm_pci_devices_info
4634 except Exception as exp
:
4635 self
.logger
.error("Error occurred while getting VM infromationn"\
4636 " for VM : {}".format(exp
))
4637 raise vimconn
.vimconnException(message
=exp
)
4639 def add_network_adapter_to_vms(self
, vapp
, network_name
, primary_nic_index
, nicIndex
, net
, nic_type
=None):
4641 Method to add network adapter type to vm
4643 network_name - name of network
4644 primary_nic_index - int value for primary nic index
4645 nicIndex - int value for nic index
4646 nic_type - specify model name to which add to vm
4651 self
.logger
.info("Add network adapter to VM: network_name {} nicIndex {}".\
4652 format(network_name
, nicIndex
))
4657 if 'floating_ip' in net
: floating_ip
= net
['floating_ip']
4659 # Stub for ip_address feature
4660 if 'ip_address' in net
: ip_address
= net
['ip_address']
4662 if 'mac_address' in net
: mac_address
= net
['mac_address']
4665 allocation_mode
= "POOL"
4667 allocation_mode
= "MANUAL"
4669 allocation_mode
= "DHCP"
4672 for vms
in vapp
.get_all_vms():
4673 vm_id
= vms
.get('id').split(':')[-1]
4675 url_rest_call
= "{}/api/vApp/vm-{}/networkConnectionSection/".format(self
.url
, vm_id
)
4677 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
4678 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
4679 response
= self
.perform_request(req_type
='GET',
4683 if response
.status_code
== 403:
4684 response
= self
.retry_rest('GET', url_rest_call
)
4686 if response
.status_code
!= 200:
4687 self
.logger
.error("REST call {} failed reason : {}"\
4688 "status code : {}".format(url_rest_call
,
4690 response
.status_code
))
4691 raise vimconn
.vimconnException("add_network_adapter_to_vms : Failed to get "\
4692 "network connection section")
4694 data
= response
.content
4695 data
= data
.split('<Link rel="edit"')[0]
4696 if '<PrimaryNetworkConnectionIndex>' not in data
:
4697 item
= """<PrimaryNetworkConnectionIndex>{}</PrimaryNetworkConnectionIndex>
4698 <NetworkConnection network="{}">
4699 <NetworkConnectionIndex>{}</NetworkConnectionIndex>
4700 <IsConnected>true</IsConnected>
4701 <IpAddressAllocationMode>{}</IpAddressAllocationMode>
4702 </NetworkConnection>""".format(primary_nic_index
, network_name
, nicIndex
,
4704 # Stub for ip_address feature
4706 ip_tag
= '<IpAddress>{}</IpAddress>'.format(ip_address
)
4707 item
= item
.replace('</NetworkConnectionIndex>\n','</NetworkConnectionIndex>\n{}\n'.format(ip_tag
))
4710 mac_tag
= '<MACAddress>{}</MACAddress>'.format(mac_address
)
4711 item
= item
.replace('</IsConnected>\n','</IsConnected>\n{}\n'.format(mac_tag
))
4713 data
= data
.replace('</ovf:Info>\n','</ovf:Info>\n{}\n</NetworkConnectionSection>'.format(item
))
4715 new_item
= """<NetworkConnection network="{}">
4716 <NetworkConnectionIndex>{}</NetworkConnectionIndex>
4717 <IsConnected>true</IsConnected>
4718 <IpAddressAllocationMode>{}</IpAddressAllocationMode>
4719 </NetworkConnection>""".format(network_name
, nicIndex
,
4721 # Stub for ip_address feature
4723 ip_tag
= '<IpAddress>{}</IpAddress>'.format(ip_address
)
4724 new_item
= new_item
.replace('</NetworkConnectionIndex>\n','</NetworkConnectionIndex>\n{}\n'.format(ip_tag
))
4727 mac_tag
= '<MACAddress>{}</MACAddress>'.format(mac_address
)
4728 new_item
= new_item
.replace('</IsConnected>\n','</IsConnected>\n{}\n'.format(mac_tag
))
4730 data
= data
+ new_item
+ '</NetworkConnectionSection>'
4732 headers
['Content-Type'] = 'application/vnd.vmware.vcloud.networkConnectionSection+xml'
4734 response
= self
.perform_request(req_type
='PUT',
4739 if response
.status_code
== 403:
4740 add_headers
= {'Content-Type': headers
['Content-Type']}
4741 response
= self
.retry_rest('PUT', url_rest_call
, add_headers
, data
)
4743 if response
.status_code
!= 202:
4744 self
.logger
.error("REST call {} failed reason : {}"\
4745 "status code : {} ".format(url_rest_call
,
4747 response
.status_code
))
4748 raise vimconn
.vimconnException("add_network_adapter_to_vms : Failed to update "\
4749 "network connection section")
4751 nic_task
= self
.get_task_from_response(response
.content
)
4752 result
= self
.client
.get_task_monitor().wait_for_success(task
=nic_task
)
4753 if result
.get('status') == 'success':
4754 self
.logger
.info("add_network_adapter_to_vms(): VM {} conneced to "\
4755 "default NIC type".format(vm_id
))
4757 self
.logger
.error("add_network_adapter_to_vms(): VM {} failed to "\
4758 "connect NIC type".format(vm_id
))
4760 for vms
in vapp
.get_all_vms():
4761 vm_id
= vms
.get('id').split(':')[-1]
4764 url_rest_call
= "{}/api/vApp/vm-{}/networkConnectionSection/".format(self
.url
, vm_id
)
4766 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
4767 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
4768 response
= self
.perform_request(req_type
='GET',
4772 if response
.status_code
== 403:
4773 response
= self
.retry_rest('GET', url_rest_call
)
4775 if response
.status_code
!= 200:
4776 self
.logger
.error("REST call {} failed reason : {}"\
4777 "status code : {}".format(url_rest_call
,
4779 response
.status_code
))
4780 raise vimconn
.vimconnException("add_network_adapter_to_vms : Failed to get "\
4781 "network connection section")
4782 data
= response
.content
4783 data
= data
.split('<Link rel="edit"')[0]
4784 if '<PrimaryNetworkConnectionIndex>' not in data
:
4785 item
= """<PrimaryNetworkConnectionIndex>{}</PrimaryNetworkConnectionIndex>
4786 <NetworkConnection network="{}">
4787 <NetworkConnectionIndex>{}</NetworkConnectionIndex>
4788 <IsConnected>true</IsConnected>
4789 <IpAddressAllocationMode>{}</IpAddressAllocationMode>
4790 <NetworkAdapterType>{}</NetworkAdapterType>
4791 </NetworkConnection>""".format(primary_nic_index
, network_name
, nicIndex
,
4792 allocation_mode
, nic_type
)
4793 # Stub for ip_address feature
4795 ip_tag
= '<IpAddress>{}</IpAddress>'.format(ip_address
)
4796 item
= item
.replace('</NetworkConnectionIndex>\n','</NetworkConnectionIndex>\n{}\n'.format(ip_tag
))
4799 mac_tag
= '<MACAddress>{}</MACAddress>'.format(mac_address
)
4800 item
= item
.replace('</IsConnected>\n','</IsConnected>\n{}\n'.format(mac_tag
))
4802 data
= data
.replace('</ovf:Info>\n','</ovf:Info>\n{}\n</NetworkConnectionSection>'.format(item
))
4804 new_item
= """<NetworkConnection network="{}">
4805 <NetworkConnectionIndex>{}</NetworkConnectionIndex>
4806 <IsConnected>true</IsConnected>
4807 <IpAddressAllocationMode>{}</IpAddressAllocationMode>
4808 <NetworkAdapterType>{}</NetworkAdapterType>
4809 </NetworkConnection>""".format(network_name
, nicIndex
,
4810 allocation_mode
, nic_type
)
4811 # Stub for ip_address feature
4813 ip_tag
= '<IpAddress>{}</IpAddress>'.format(ip_address
)
4814 new_item
= new_item
.replace('</NetworkConnectionIndex>\n','</NetworkConnectionIndex>\n{}\n'.format(ip_tag
))
4817 mac_tag
= '<MACAddress>{}</MACAddress>'.format(mac_address
)
4818 new_item
= new_item
.replace('</IsConnected>\n','</IsConnected>\n{}\n'.format(mac_tag
))
4820 data
= data
+ new_item
+ '</NetworkConnectionSection>'
4822 headers
['Content-Type'] = 'application/vnd.vmware.vcloud.networkConnectionSection+xml'
4824 response
= self
.perform_request(req_type
='PUT',
4829 if response
.status_code
== 403:
4830 add_headers
= {'Content-Type': headers
['Content-Type']}
4831 response
= self
.retry_rest('PUT', url_rest_call
, add_headers
, data
)
4833 if response
.status_code
!= 202:
4834 self
.logger
.error("REST call {} failed reason : {}"\
4835 "status code : {}".format(url_rest_call
,
4837 response
.status_code
))
4838 raise vimconn
.vimconnException("add_network_adapter_to_vms : Failed to update "\
4839 "network connection section")
4841 nic_task
= self
.get_task_from_response(response
.content
)
4842 result
= self
.client
.get_task_monitor().wait_for_success(task
=nic_task
)
4843 if result
.get('status') == 'success':
4844 self
.logger
.info("add_network_adapter_to_vms(): VM {} "\
4845 "conneced to NIC type {}".format(vm_id
, nic_type
))
4847 self
.logger
.error("add_network_adapter_to_vms(): VM {} "\
4848 "failed to connect NIC type {}".format(vm_id
, nic_type
))
4849 except Exception as exp
:
4850 self
.logger
.error("add_network_adapter_to_vms() : exception occurred "\
4851 "while adding Network adapter")
4852 raise vimconn
.vimconnException(message
=exp
)
4855 def set_numa_affinity(self
, vmuuid
, paired_threads_id
):
4857 Method to assign numa affinity in vm configuration parammeters
4860 paired_threads_id - one or more virtual processor
4866 vcenter_conect
, content
= self
.get_vcenter_content()
4867 vm_moref_id
= self
.get_vm_moref_id(vmuuid
)
4869 host_obj
, vm_obj
= self
.get_vm_obj(content
,vm_moref_id
)
4871 config_spec
= vim
.vm
.ConfigSpec()
4872 config_spec
.extraConfig
= []
4873 opt
= vim
.option
.OptionValue()
4874 opt
.key
= 'numa.nodeAffinity'
4875 opt
.value
= str(paired_threads_id
)
4876 config_spec
.extraConfig
.append(opt
)
4877 task
= vm_obj
.ReconfigVM_Task(config_spec
)
4879 result
= self
.wait_for_vcenter_task(task
, vcenter_conect
)
4880 extra_config
= vm_obj
.config
.extraConfig
4882 for opts
in extra_config
:
4883 if 'numa.nodeAffinity' in opts
.key
:
4885 self
.logger
.info("set_numa_affinity: Sucessfully assign numa affinity "\
4886 "value {} for vm {}".format(opt
.value
, vm_obj
))
4890 self
.logger
.error("set_numa_affinity: Failed to assign numa affinity")
4891 except Exception as exp
:
4892 self
.logger
.error("set_numa_affinity : exception occurred while setting numa affinity "\
4893 "for VM {} : {}".format(vm_obj
, vm_moref_id
))
4894 raise vimconn
.vimconnException("set_numa_affinity : Error {} failed to assign numa "\
4895 "affinity".format(exp
))
4898 def cloud_init(self
, vapp
, cloud_config
):
4900 Method to inject ssh-key
4902 cloud_config a dictionary with:
4903 'key-pairs': (optional) list of strings with the public key to be inserted to the default user
4904 'users': (optional) list of users to be inserted, each item is a dict with:
4905 'name': (mandatory) user name,
4906 'key-pairs': (optional) list of strings with the public key to be inserted to the user
4907 'user-data': (optional) can be a string with the text script to be passed directly to cloud-init,
4908 or a list of strings, each one contains a script to be passed, usually with a MIMEmultipart file
4909 'config-files': (optional). List of files to be transferred. Each item is a dict with:
4910 'dest': (mandatory) string with the destination absolute path
4911 'encoding': (optional, by default text). Can be one of:
4912 'b64', 'base64', 'gz', 'gz+b64', 'gz+base64', 'gzip+b64', 'gzip+base64'
4913 'content' (mandatory): string with the content of the file
4914 'permissions': (optional) string with file permissions, typically octal notation '0644'
4915 'owner': (optional) file owner, string with the format 'owner:group'
4916 'boot-data-drive': boolean to indicate if user-data must be passed using a boot drive (hard disk
4919 if not isinstance(cloud_config
, dict):
4920 raise Exception("cloud_init : parameter cloud_config is not a dictionary")
4924 if "key-pairs" in cloud_config
:
4925 key_pairs
= cloud_config
["key-pairs"]
4927 if "users" in cloud_config
:
4928 userdata
= cloud_config
["users"]
4930 self
.logger
.debug("cloud_init : Guest os customization started..")
4931 customize_script
= self
.format_script(key_pairs
=key_pairs
, users_list
=userdata
)
4932 customize_script
= customize_script
.replace("&","&")
4933 self
.guest_customization(vapp
, customize_script
)
4935 except Exception as exp
:
4936 self
.logger
.error("cloud_init : exception occurred while injecting "\
4938 raise vimconn
.vimconnException("cloud_init : Error {} failed to inject "\
4939 "ssh-key".format(exp
))
4941 def format_script(self
, key_pairs
=[], users_list
=[]):
4942 bash_script
= """#!/bin/sh
4943 echo performing customization tasks with param $1 at `date "+DATE: %Y-%m-%d - TIME: %H:%M:%S"` >> /root/customization.log
4944 if [ "$1" = "precustomization" ];then
4945 echo performing precustomization tasks on `date "+DATE: %Y-%m-%d - TIME: %H:%M:%S"` >> /root/customization.log
4948 keys
= "\n".join(key_pairs
)
4951 if [ ! -d /root/.ssh ];then
4953 chown root:root /root/.ssh
4954 chmod 700 /root/.ssh
4955 touch /root/.ssh/authorized_keys
4956 chown root:root /root/.ssh/authorized_keys
4957 chmod 600 /root/.ssh/authorized_keys
4958 # make centos with selinux happy
4959 which restorecon && restorecon -Rv /root/.ssh
4961 touch /root/.ssh/authorized_keys
4962 chown root:root /root/.ssh/authorized_keys
4963 chmod 600 /root/.ssh/authorized_keys
4965 echo '{key}' >> /root/.ssh/authorized_keys
4966 """.format(key
=keys
)
4968 bash_script
+= keys_data
4970 for user
in users_list
:
4971 if 'name' in user
: user_name
= user
['name']
4972 if 'key-pairs' in user
:
4973 user_keys
= "\n".join(user
['key-pairs'])
4978 useradd -d /home/{user_name} -m -g users -s /bin/bash {user_name}
4979 """.format(user_name
=user_name
)
4981 bash_script
+= add_user_name
4984 user_keys_data
= """
4985 mkdir /home/{user_name}/.ssh
4986 chown {user_name}:{user_name} /home/{user_name}/.ssh
4987 chmod 700 /home/{user_name}/.ssh
4988 touch /home/{user_name}/.ssh/authorized_keys
4989 chown {user_name}:{user_name} /home/{user_name}/.ssh/authorized_keys
4990 chmod 600 /home/{user_name}/.ssh/authorized_keys
4991 # make centos with selinux happy
4992 which restorecon && restorecon -Rv /home/{user_name}/.ssh
4993 echo '{user_key}' >> /home/{user_name}/.ssh/authorized_keys
4994 """.format(user_name
=user_name
,user_key
=user_keys
)
4996 bash_script
+= user_keys_data
4998 return bash_script
+"\n\tfi"
5000 def guest_customization(self
, vapp
, customize_script
):
5002 Method to customize guest os
5004 customize_script - Customize script to be run at first boot of VM.
5006 for vm
in vapp
.get_all_vms():
5007 vm_id
= vm
.get('id').split(':')[-1]
5008 vm_name
= vm
.get('name')
5009 vm_name
= vm_name
.replace('_','-')
5011 vm_customization_url
= "{}/api/vApp/vm-{}/guestCustomizationSection/".format(self
.url
, vm_id
)
5012 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
5013 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
5015 headers
['Content-Type'] = "application/vnd.vmware.vcloud.guestCustomizationSection+xml"
5017 data
= """<GuestCustomizationSection
5018 xmlns="http://www.vmware.com/vcloud/v1.5"
5019 xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
5020 ovf:required="false" href="{}" type="application/vnd.vmware.vcloud.guestCustomizationSection+xml">
5021 <ovf:Info>Specifies Guest OS Customization Settings</ovf:Info>
5022 <Enabled>true</Enabled>
5023 <ChangeSid>false</ChangeSid>
5024 <VirtualMachineId>{}</VirtualMachineId>
5025 <JoinDomainEnabled>false</JoinDomainEnabled>
5026 <UseOrgSettings>false</UseOrgSettings>
5027 <AdminPasswordEnabled>false</AdminPasswordEnabled>
5028 <AdminPasswordAuto>true</AdminPasswordAuto>
5029 <AdminAutoLogonEnabled>false</AdminAutoLogonEnabled>
5030 <AdminAutoLogonCount>0</AdminAutoLogonCount>
5031 <ResetPasswordRequired>false</ResetPasswordRequired>
5032 <CustomizationScript>{}</CustomizationScript>
5033 <ComputerName>{}</ComputerName>
5034 <Link href="{}" type="application/vnd.vmware.vcloud.guestCustomizationSection+xml" rel="edit"/>
5035 </GuestCustomizationSection>
5036 """.format(vm_customization_url
,
5040 vm_customization_url
)
5042 response
= self
.perform_request(req_type
='PUT',
5043 url
=vm_customization_url
,
5046 if response
.status_code
== 202:
5047 guest_task
= self
.get_task_from_response(response
.content
)
5048 self
.client
.get_task_monitor().wait_for_success(task
=guest_task
)
5049 self
.logger
.info("guest_customization : customized guest os task "\
5050 "completed for VM {}".format(vm_name
))
5052 self
.logger
.error("guest_customization : task for customized guest os"\
5053 "failed for VM {}".format(vm_name
))
5054 raise vimconn
.vimconnException("guest_customization : failed to perform"\
5055 "guest os customization on VM {}".format(vm_name
))
5057 def add_new_disk(self
, vapp_uuid
, disk_size
):
5059 Method to create an empty vm disk
5062 vapp_uuid - is vapp identifier.
5063 disk_size - size of disk to be created in GB
5071 #Disk size in GB, convert it into MB
5072 if disk_size
is not None:
5073 disk_size_mb
= int(disk_size
) * 1024
5074 vm_details
= self
.get_vapp_details_rest(vapp_uuid
)
5076 if vm_details
and "vm_virtual_hardware" in vm_details
:
5077 self
.logger
.info("Adding disk to VM: {} disk size:{}GB".format(vm_details
["name"], disk_size
))
5078 disk_href
= vm_details
["vm_virtual_hardware"]["disk_edit_href"]
5079 status
= self
.add_new_disk_rest(disk_href
, disk_size_mb
)
5081 except Exception as exp
:
5082 msg
= "Error occurred while creating new disk {}.".format(exp
)
5083 self
.rollback_newvm(vapp_uuid
, msg
)
5086 self
.logger
.info("Added new disk to VM: {} disk size:{}GB".format(vm_details
["name"], disk_size
))
5088 #If failed to add disk, delete VM
5089 msg
= "add_new_disk: Failed to add new disk to {}".format(vm_details
["name"])
5090 self
.rollback_newvm(vapp_uuid
, msg
)
5093 def add_new_disk_rest(self
, disk_href
, disk_size_mb
):
5095 Retrives vApp Disks section & add new empty disk
5098 disk_href: Disk section href to addd disk
5099 disk_size_mb: Disk size in MB
5101 Returns: Status of add new disk task
5104 if self
.client
._session
:
5105 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
5106 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
5107 response
= self
.perform_request(req_type
='GET',
5111 if response
.status_code
== 403:
5112 response
= self
.retry_rest('GET', disk_href
)
5114 if response
.status_code
!= requests
.codes
.ok
:
5115 self
.logger
.error("add_new_disk_rest: GET REST API call {} failed. Return status code {}"
5116 .format(disk_href
, response
.status_code
))
5119 #Find but type & max of instance IDs assigned to disks
5120 lxmlroot_respond
= lxmlElementTree
.fromstring(response
.content
)
5121 namespaces
= {prefix
:uri
for prefix
,uri
in lxmlroot_respond
.nsmap
.iteritems() if prefix
}
5123 #namespaces = {prefix:uri for prefix,uri in lxmlroot_respond.nsmap.items() if prefix}
5124 namespaces
["xmlns"]= "http://www.vmware.com/vcloud/v1.5"
5126 for item
in lxmlroot_respond
.iterfind('xmlns:Item',namespaces
):
5127 if item
.find("rasd:Description",namespaces
).text
== "Hard disk":
5128 inst_id
= int(item
.find("rasd:InstanceID" ,namespaces
).text
)
5129 if inst_id
> instance_id
:
5130 instance_id
= inst_id
5131 disk_item
= item
.find("rasd:HostResource" ,namespaces
)
5132 bus_subtype
= disk_item
.attrib
["{"+namespaces
['xmlns']+"}busSubType"]
5133 bus_type
= disk_item
.attrib
["{"+namespaces
['xmlns']+"}busType"]
5135 instance_id
= instance_id
+ 1
5136 new_item
= """<Item>
5137 <rasd:Description>Hard disk</rasd:Description>
5138 <rasd:ElementName>New disk</rasd:ElementName>
5140 xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
5141 vcloud:capacity="{}"
5142 vcloud:busSubType="{}"
5143 vcloud:busType="{}"></rasd:HostResource>
5144 <rasd:InstanceID>{}</rasd:InstanceID>
5145 <rasd:ResourceType>17</rasd:ResourceType>
5146 </Item>""".format(disk_size_mb
, bus_subtype
, bus_type
, instance_id
)
5148 new_data
= response
.content
5149 #Add new item at the bottom
5150 new_data
= new_data
.replace('</Item>\n</RasdItemsList>', '</Item>\n{}\n</RasdItemsList>'.format(new_item
))
5152 # Send PUT request to modify virtual hardware section with new disk
5153 headers
['Content-Type'] = 'application/vnd.vmware.vcloud.rasdItemsList+xml; charset=ISO-8859-1'
5155 response
= self
.perform_request(req_type
='PUT',
5160 if response
.status_code
== 403:
5161 add_headers
= {'Content-Type': headers
['Content-Type']}
5162 response
= self
.retry_rest('PUT', disk_href
, add_headers
, new_data
)
5164 if response
.status_code
!= 202:
5165 self
.logger
.error("PUT REST API call {} failed. Return status code {}. Response Content:{}"
5166 .format(disk_href
, response
.status_code
, response
.content
))
5168 add_disk_task
= self
.get_task_from_response(response
.content
)
5169 result
= self
.client
.get_task_monitor().wait_for_success(task
=add_disk_task
)
5170 if result
.get('status') == 'success':
5173 self
.logger
.error("Add new disk REST task failed to add {} MB disk".format(disk_size_mb
))
5175 except Exception as exp
:
5176 self
.logger
.error("Error occurred calling rest api for creating new disk {}".format(exp
))
5181 def add_existing_disk(self
, catalogs
=None, image_id
=None, size
=None, template_name
=None, vapp_uuid
=None):
5183 Method to add existing disk to vm
5185 catalogs - List of VDC catalogs
5186 image_id - Catalog ID
5187 template_name - Name of template in catalog
5188 vapp_uuid - UUID of vApp
5193 vcenter_conect
, content
= self
.get_vcenter_content()
5194 #find moref-id of vm in image
5195 catalog_vm_info
= self
.get_vapp_template_details(catalogs
=catalogs
,
5199 if catalog_vm_info
and "vm_vcenter_info" in catalog_vm_info
:
5200 if "vm_moref_id" in catalog_vm_info
["vm_vcenter_info"]:
5201 catalog_vm_moref_id
= catalog_vm_info
["vm_vcenter_info"].get("vm_moref_id", None)
5202 if catalog_vm_moref_id
:
5203 self
.logger
.info("Moref_id of VM in catalog : {}" .format(catalog_vm_moref_id
))
5204 host
, catalog_vm_obj
= self
.get_vm_obj(content
, catalog_vm_moref_id
)
5207 disk_info
= self
.find_disk(catalog_vm_obj
)
5209 exp_msg
= "No VM with image id {} found".format(image_id
)
5210 self
.rollback_newvm(vapp_uuid
, exp_msg
, exp_type
="NotFound")
5212 exp_msg
= "No Image found with image ID {} ".format(image_id
)
5213 self
.rollback_newvm(vapp_uuid
, exp_msg
, exp_type
="NotFound")
5216 self
.logger
.info("Existing disk_info : {}".format(disk_info
))
5218 vm_moref_id
= self
.get_vm_moref_id(vapp_uuid
)
5219 host
, vm_obj
= self
.get_vm_obj(content
, vm_moref_id
)
5221 status
= self
.add_disk(vcenter_conect
=vcenter_conect
,
5223 disk_info
=disk_info
,
5228 self
.logger
.info("Disk from image id {} added to {}".format(image_id
,
5232 msg
= "No disk found with image id {} to add in VM {}".format(
5235 self
.rollback_newvm(vapp_uuid
, msg
, exp_type
="NotFound")
5238 def find_disk(self
, vm_obj
):
5240 Method to find details of existing disk in VM
5242 vm_obj - vCenter object of VM
5243 image_id - Catalog ID
5245 disk_info : dict of disk details
5250 devices
= vm_obj
.config
.hardware
.device
5251 for device
in devices
:
5252 if type(device
) is vim
.vm
.device
.VirtualDisk
:
5253 if isinstance(device
.backing
,vim
.vm
.device
.VirtualDisk
.FlatVer2BackingInfo
) and hasattr(device
.backing
, 'fileName'):
5254 disk_info
["full_path"] = device
.backing
.fileName
5255 disk_info
["datastore"] = device
.backing
.datastore
5256 disk_info
["capacityKB"] = device
.capacityInKB
5258 except Exception as exp
:
5259 self
.logger
.error("find_disk() : exception occurred while "\
5260 "getting existing disk details :{}".format(exp
))
5264 def add_disk(self
, vcenter_conect
=None, vm
=None, size
=None, vapp_uuid
=None, disk_info
={}):
5266 Method to add existing disk in VM
5268 vcenter_conect - vCenter content object
5269 vm - vCenter vm object
5270 disk_info : dict of disk details
5272 status : status of add disk task
5274 datastore
= disk_info
["datastore"] if "datastore" in disk_info
else None
5275 fullpath
= disk_info
["full_path"] if "full_path" in disk_info
else None
5276 capacityKB
= disk_info
["capacityKB"] if "capacityKB" in disk_info
else None
5277 if size
is not None:
5278 #Convert size from GB to KB
5279 sizeKB
= int(size
) * 1024 * 1024
5280 #compare size of existing disk and user given size.Assign whicherver is greater
5281 self
.logger
.info("Add Existing disk : sizeKB {} , capacityKB {}".format(
5282 sizeKB
, capacityKB
))
5283 if sizeKB
> capacityKB
:
5286 if datastore
and fullpath
and capacityKB
:
5288 spec
= vim
.vm
.ConfigSpec()
5289 # get all disks on a VM, set unit_number to the next available
5291 for dev
in vm
.config
.hardware
.device
:
5292 if hasattr(dev
.backing
, 'fileName'):
5293 unit_number
= int(dev
.unitNumber
) + 1
5294 # unit_number 7 reserved for scsi controller
5295 if unit_number
== 7:
5297 if isinstance(dev
, vim
.vm
.device
.VirtualDisk
):
5298 #vim.vm.device.VirtualSCSIController
5299 controller_key
= dev
.controllerKey
5301 self
.logger
.info("Add Existing disk : unit number {} , controller key {}".format(
5302 unit_number
, controller_key
))
5305 disk_spec
= vim
.vm
.device
.VirtualDeviceSpec()
5306 disk_spec
.operation
= vim
.vm
.device
.VirtualDeviceSpec
.Operation
.add
5307 disk_spec
.device
= vim
.vm
.device
.VirtualDisk()
5308 disk_spec
.device
.backing
= \
5309 vim
.vm
.device
.VirtualDisk
.FlatVer2BackingInfo()
5310 disk_spec
.device
.backing
.thinProvisioned
= True
5311 disk_spec
.device
.backing
.diskMode
= 'persistent'
5312 disk_spec
.device
.backing
.datastore
= datastore
5313 disk_spec
.device
.backing
.fileName
= fullpath
5315 disk_spec
.device
.unitNumber
= unit_number
5316 disk_spec
.device
.capacityInKB
= capacityKB
5317 disk_spec
.device
.controllerKey
= controller_key
5318 dev_changes
.append(disk_spec
)
5319 spec
.deviceChange
= dev_changes
5320 task
= vm
.ReconfigVM_Task(spec
=spec
)
5321 status
= self
.wait_for_vcenter_task(task
, vcenter_conect
)
5323 except Exception as exp
:
5324 exp_msg
= "add_disk() : exception {} occurred while adding disk "\
5325 "{} to vm {}".format(exp
,
5328 self
.rollback_newvm(vapp_uuid
, exp_msg
)
5330 msg
= "add_disk() : Can not add disk to VM with disk info {} ".format(disk_info
)
5331 self
.rollback_newvm(vapp_uuid
, msg
)
5334 def get_vcenter_content(self
):
5336 Get the vsphere content object
5339 vm_vcenter_info
= self
.get_vm_vcenter_info()
5340 except Exception as exp
:
5341 self
.logger
.error("Error occurred while getting vCenter infromationn"\
5342 " for VM : {}".format(exp
))
5343 raise vimconn
.vimconnException(message
=exp
)
5346 if hasattr(ssl
, '_create_unverified_context'):
5347 context
= ssl
._create
_unverified
_context
()
5349 vcenter_conect
= SmartConnect(
5350 host
=vm_vcenter_info
["vm_vcenter_ip"],
5351 user
=vm_vcenter_info
["vm_vcenter_user"],
5352 pwd
=vm_vcenter_info
["vm_vcenter_password"],
5353 port
=int(vm_vcenter_info
["vm_vcenter_port"]),
5356 atexit
.register(Disconnect
, vcenter_conect
)
5357 content
= vcenter_conect
.RetrieveContent()
5358 return vcenter_conect
, content
5361 def get_vm_moref_id(self
, vapp_uuid
):
5363 Get the moref_id of given VM
5367 vm_details
= self
.get_vapp_details_rest(vapp_uuid
, need_admin_access
=True)
5368 if vm_details
and "vm_vcenter_info" in vm_details
:
5369 vm_moref_id
= vm_details
["vm_vcenter_info"].get("vm_moref_id", None)
5372 except Exception as exp
:
5373 self
.logger
.error("Error occurred while getting VM moref ID "\
5374 " for VM : {}".format(exp
))
5378 def get_vapp_template_details(self
, catalogs
=None, image_id
=None , template_name
=None):
5380 Method to get vApp template details
5382 catalogs - list of VDC catalogs
5383 image_id - Catalog ID to find
5384 template_name : template name in catalog
5386 parsed_respond : dict of vApp tempalte details
5388 parsed_response
= {}
5390 vca
= self
.connect_as_admin()
5392 raise vimconn
.vimconnConnectionException("Failed to connect vCD")
5395 org
, vdc
= self
.get_vdc_details()
5396 catalog
= self
.get_catalog_obj(image_id
, catalogs
)
5398 items
= org
.get_catalog_item(catalog
.get('name'), catalog
.get('name'))
5399 catalog_items
= [items
.attrib
]
5401 if len(catalog_items
) == 1:
5402 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
5403 'x-vcloud-authorization': vca
._session
.headers
['x-vcloud-authorization']}
5405 response
= self
.perform_request(req_type
='GET',
5406 url
=catalog_items
[0].get('href'),
5408 catalogItem
= XmlElementTree
.fromstring(response
.content
)
5409 entity
= [child
for child
in catalogItem
if child
.get("type") == "application/vnd.vmware.vcloud.vAppTemplate+xml"][0]
5410 vapp_tempalte_href
= entity
.get("href")
5411 #get vapp details and parse moref id
5413 namespaces
= {"vssd":"http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData" ,
5414 'ovf': 'http://schemas.dmtf.org/ovf/envelope/1',
5415 'vmw': 'http://www.vmware.com/schema/ovf',
5416 'vm': 'http://www.vmware.com/vcloud/v1.5',
5417 'rasd':"http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData",
5418 'vmext':"http://www.vmware.com/vcloud/extension/v1.5",
5419 'xmlns':"http://www.vmware.com/vcloud/v1.5"
5423 response
= self
.perform_request(req_type
='GET',
5424 url
=vapp_tempalte_href
,
5427 if response
.status_code
!= requests
.codes
.ok
:
5428 self
.logger
.debug("REST API call {} failed. Return status code {}".format(
5429 vapp_tempalte_href
, response
.status_code
))
5432 xmlroot_respond
= XmlElementTree
.fromstring(response
.content
)
5433 children_section
= xmlroot_respond
.find('vm:Children/', namespaces
)
5434 if children_section
is not None:
5435 vCloud_extension_section
= children_section
.find('xmlns:VCloudExtension', namespaces
)
5436 if vCloud_extension_section
is not None:
5437 vm_vcenter_info
= {}
5438 vim_info
= vCloud_extension_section
.find('vmext:VmVimInfo', namespaces
)
5439 vmext
= vim_info
.find('vmext:VmVimObjectRef', namespaces
)
5440 if vmext
is not None:
5441 vm_vcenter_info
["vm_moref_id"] = vmext
.find('vmext:MoRef', namespaces
).text
5442 parsed_response
["vm_vcenter_info"]= vm_vcenter_info
5444 except Exception as exp
:
5445 self
.logger
.info("Error occurred calling rest api for getting vApp details {}".format(exp
))
5447 return parsed_response
5450 def rollback_newvm(self
, vapp_uuid
, msg
, exp_type
="Genric"):
5452 Method to delete vApp
5454 vapp_uuid - vApp UUID
5455 msg - Error message to be logged
5456 exp_type : Exception type
5461 status
= self
.delete_vminstance(vapp_uuid
)
5464 self
.logger
.error(msg
)
5465 if exp_type
== "Genric":
5466 raise vimconn
.vimconnException(msg
)
5467 elif exp_type
== "NotFound":
5468 raise vimconn
.vimconnNotFoundException(message
=msg
)
5470 def add_sriov(self
, vapp_uuid
, sriov_nets
, vmname_andid
):
5472 Method to attach SRIOV adapters to VM
5475 vapp_uuid - uuid of vApp/VM
5476 sriov_nets - SRIOV devices infromation as specified in VNFD (flavor)
5477 vmname_andid - vmname
5480 The status of add SRIOV adapter task , vm object and
5481 vcenter_conect object
5484 vcenter_conect
, content
= self
.get_vcenter_content()
5485 vm_moref_id
= self
.get_vm_moref_id(vapp_uuid
)
5489 no_of_sriov_devices
= len(sriov_nets
)
5490 if no_of_sriov_devices
> 0:
5491 #Get VM and its host
5492 host_obj
, vm_obj
= self
.get_vm_obj(content
, vm_moref_id
)
5493 self
.logger
.info("VM {} is currently on host {}".format(vm_obj
, host_obj
))
5494 if host_obj
and vm_obj
:
5495 #get SRIOV devies from host on which vapp is currently installed
5496 avilable_sriov_devices
= self
.get_sriov_devices(host_obj
,
5497 no_of_sriov_devices
,
5500 if len(avilable_sriov_devices
) == 0:
5501 #find other hosts with active pci devices
5502 new_host_obj
, avilable_sriov_devices
= self
.get_host_and_sriov_devices(
5504 no_of_sriov_devices
,
5507 if new_host_obj
is not None and len(avilable_sriov_devices
)> 0:
5508 #Migrate vm to the host where SRIOV devices are available
5509 self
.logger
.info("Relocate VM {} on new host {}".format(vm_obj
,
5511 task
= self
.relocate_vm(new_host_obj
, vm_obj
)
5512 if task
is not None:
5513 result
= self
.wait_for_vcenter_task(task
, vcenter_conect
)
5514 self
.logger
.info("Migrate VM status: {}".format(result
))
5515 host_obj
= new_host_obj
5517 self
.logger
.info("Fail to migrate VM : {}".format(result
))
5518 raise vimconn
.vimconnNotFoundException(
5519 "Fail to migrate VM : {} to host {}".format(
5524 if host_obj
is not None and avilable_sriov_devices
is not None and len(avilable_sriov_devices
)> 0:
5525 #Add SRIOV devices one by one
5526 for sriov_net
in sriov_nets
:
5527 network_name
= sriov_net
.get('net_id')
5528 dvs_portgr_name
= self
.create_dvPort_group(network_name
)
5529 if sriov_net
.get('type') == "VF" or sriov_net
.get('type') == "SR-IOV":
5530 #add vlan ID ,Modify portgroup for vlan ID
5531 self
.configure_vlanID(content
, vcenter_conect
, network_name
)
5533 task
= self
.add_sriov_to_vm(content
,
5537 avilable_sriov_devices
[0]
5540 status
= self
.wait_for_vcenter_task(task
, vcenter_conect
)
5542 self
.logger
.info("Added SRIOV {} to VM {}".format(
5543 no_of_sriov_devices
,
5546 self
.logger
.error("Fail to add SRIOV {} to VM {}".format(
5547 no_of_sriov_devices
,
5549 raise vimconn
.vimconnUnexpectedResponse(
5550 "Fail to add SRIOV adapter in VM ".format(str(vm_obj
))
5552 return True, vm_obj
, vcenter_conect
5554 self
.logger
.error("Currently there is no host with"\
5555 " {} number of avaialble SRIOV "\
5556 "VFs required for VM {}".format(
5557 no_of_sriov_devices
,
5560 raise vimconn
.vimconnNotFoundException(
5561 "Currently there is no host with {} "\
5562 "number of avaialble SRIOV devices required for VM {}".format(
5563 no_of_sriov_devices
,
5566 self
.logger
.debug("No infromation about SRIOV devices {} ",sriov_nets
)
5568 except vmodl
.MethodFault
as error
:
5569 self
.logger
.error("Error occurred while adding SRIOV {} ",error
)
5570 return None, vm_obj
, vcenter_conect
5573 def get_sriov_devices(self
,host
, no_of_vfs
):
5575 Method to get the details of SRIOV devices on given host
5577 host - vSphere host object
5578 no_of_vfs - number of VFs needed on host
5581 array of SRIOV devices
5585 for device
in host
.config
.pciPassthruInfo
:
5586 if isinstance(device
,vim
.host
.SriovInfo
) and device
.sriovActive
:
5587 if device
.numVirtualFunction
>= no_of_vfs
:
5588 sriovInfo
.append(device
)
5593 def get_host_and_sriov_devices(self
, content
, no_of_vfs
):
5595 Method to get the details of SRIOV devices infromation on all hosts
5598 content - vSphere host object
5599 no_of_vfs - number of pci VFs needed on host
5602 array of SRIOV devices and host object
5605 sriov_device_objs
= None
5608 container
= content
.viewManager
.CreateContainerView(content
.rootFolder
,
5609 [vim
.HostSystem
], True)
5610 for host
in container
.view
:
5611 devices
= self
.get_sriov_devices(host
, no_of_vfs
)
5614 sriov_device_objs
= devices
5616 except Exception as exp
:
5617 self
.logger
.error("Error {} occurred while finding SRIOV devices on host: {}".format(exp
, host_obj
))
5619 return host_obj
,sriov_device_objs
5622 def add_sriov_to_vm(self
,content
, vm_obj
, host_obj
, network_name
, sriov_device
):
5624 Method to add SRIOV adapter to vm
5627 host_obj - vSphere host object
5628 vm_obj - vSphere vm object
5629 content - vCenter content object
5630 network_name - name of distributed virtaul portgroup
5631 sriov_device - SRIOV device info
5637 vnic_label
= "sriov nic"
5639 dvs_portgr
= self
.get_dvport_group(network_name
)
5640 network_name
= dvs_portgr
.name
5641 nic
= vim
.vm
.device
.VirtualDeviceSpec()
5643 nic
.operation
= vim
.vm
.device
.VirtualDeviceSpec
.Operation
.add
5644 nic
.device
= vim
.vm
.device
.VirtualSriovEthernetCard()
5645 nic
.device
.addressType
= 'assigned'
5646 #nic.device.key = 13016
5647 nic
.device
.deviceInfo
= vim
.Description()
5648 nic
.device
.deviceInfo
.label
= vnic_label
5649 nic
.device
.deviceInfo
.summary
= network_name
5650 nic
.device
.backing
= vim
.vm
.device
.VirtualEthernetCard
.NetworkBackingInfo()
5652 nic
.device
.backing
.network
= self
.get_obj(content
, [vim
.Network
], network_name
)
5653 nic
.device
.backing
.deviceName
= network_name
5654 nic
.device
.backing
.useAutoDetect
= False
5655 nic
.device
.connectable
= vim
.vm
.device
.VirtualDevice
.ConnectInfo()
5656 nic
.device
.connectable
.startConnected
= True
5657 nic
.device
.connectable
.allowGuestControl
= True
5659 nic
.device
.sriovBacking
= vim
.vm
.device
.VirtualSriovEthernetCard
.SriovBackingInfo()
5660 nic
.device
.sriovBacking
.physicalFunctionBacking
= vim
.vm
.device
.VirtualPCIPassthrough
.DeviceBackingInfo()
5661 nic
.device
.sriovBacking
.physicalFunctionBacking
.id = sriov_device
.id
5664 vmconf
= vim
.vm
.ConfigSpec(deviceChange
=devices
)
5665 task
= vm_obj
.ReconfigVM_Task(vmconf
)
5667 except Exception as exp
:
5668 self
.logger
.error("Error {} occurred while adding SRIOV adapter in VM: {}".format(exp
, vm_obj
))
5672 def create_dvPort_group(self
, network_name
):
5674 Method to create disributed virtual portgroup
5677 network_name - name of network/portgroup
5683 new_network_name
= [network_name
, '-', str(uuid
.uuid4())]
5684 network_name
=''.join(new_network_name
)
5685 vcenter_conect
, content
= self
.get_vcenter_content()
5687 dv_switch
= self
.get_obj(content
, [vim
.DistributedVirtualSwitch
], self
.dvs_name
)
5689 dv_pg_spec
= vim
.dvs
.DistributedVirtualPortgroup
.ConfigSpec()
5690 dv_pg_spec
.name
= network_name
5692 dv_pg_spec
.type = vim
.dvs
.DistributedVirtualPortgroup
.PortgroupType
.earlyBinding
5693 dv_pg_spec
.defaultPortConfig
= vim
.dvs
.VmwareDistributedVirtualSwitch
.VmwarePortConfigPolicy()
5694 dv_pg_spec
.defaultPortConfig
.securityPolicy
= vim
.dvs
.VmwareDistributedVirtualSwitch
.SecurityPolicy()
5695 dv_pg_spec
.defaultPortConfig
.securityPolicy
.allowPromiscuous
= vim
.BoolPolicy(value
=False)
5696 dv_pg_spec
.defaultPortConfig
.securityPolicy
.forgedTransmits
= vim
.BoolPolicy(value
=False)
5697 dv_pg_spec
.defaultPortConfig
.securityPolicy
.macChanges
= vim
.BoolPolicy(value
=False)
5699 task
= dv_switch
.AddDVPortgroup_Task([dv_pg_spec
])
5700 self
.wait_for_vcenter_task(task
, vcenter_conect
)
5702 dvPort_group
= self
.get_obj(content
, [vim
.dvs
.DistributedVirtualPortgroup
], network_name
)
5704 self
.logger
.info("Created disributed virtaul port group: {}".format(dvPort_group
))
5705 return dvPort_group
.key
5707 self
.logger
.debug("No disributed virtual switch found with name {}".format(network_name
))
5709 except Exception as exp
:
5710 self
.logger
.error("Error occurred while creating disributed virtaul port group {}"\
5711 " : {}".format(network_name
, exp
))
5714 def reconfig_portgroup(self
, content
, dvPort_group_name
, config_info
={}):
5716 Method to reconfigure disributed virtual portgroup
5719 dvPort_group_name - name of disributed virtual portgroup
5720 content - vCenter content object
5721 config_info - disributed virtual portgroup configuration
5727 dvPort_group
= self
.get_dvport_group(dvPort_group_name
)
5729 dv_pg_spec
= vim
.dvs
.DistributedVirtualPortgroup
.ConfigSpec()
5730 dv_pg_spec
.configVersion
= dvPort_group
.config
.configVersion
5731 dv_pg_spec
.defaultPortConfig
= vim
.dvs
.VmwareDistributedVirtualSwitch
.VmwarePortConfigPolicy()
5732 if "vlanID" in config_info
:
5733 dv_pg_spec
.defaultPortConfig
.vlan
= vim
.dvs
.VmwareDistributedVirtualSwitch
.VlanIdSpec()
5734 dv_pg_spec
.defaultPortConfig
.vlan
.vlanId
= config_info
.get('vlanID')
5736 task
= dvPort_group
.ReconfigureDVPortgroup_Task(spec
=dv_pg_spec
)
5740 except Exception as exp
:
5741 self
.logger
.error("Error occurred while reconfiguraing disributed virtaul port group {}"\
5742 " : {}".format(dvPort_group_name
, exp
))
5746 def destroy_dvport_group(self
, dvPort_group_name
):
5748 Method to destroy disributed virtual portgroup
5751 network_name - name of network/portgroup
5754 True if portgroup successfully got deleted else false
5756 vcenter_conect
, content
= self
.get_vcenter_content()
5759 dvPort_group
= self
.get_dvport_group(dvPort_group_name
)
5761 task
= dvPort_group
.Destroy_Task()
5762 status
= self
.wait_for_vcenter_task(task
, vcenter_conect
)
5764 except vmodl
.MethodFault
as exp
:
5765 self
.logger
.error("Caught vmodl fault {} while deleting disributed virtaul port group {}".format(
5766 exp
, dvPort_group_name
))
5770 def get_dvport_group(self
, dvPort_group_name
):
5772 Method to get disributed virtual portgroup
5775 network_name - name of network/portgroup
5780 vcenter_conect
, content
= self
.get_vcenter_content()
5783 container
= content
.viewManager
.CreateContainerView(content
.rootFolder
, [vim
.dvs
.DistributedVirtualPortgroup
], True)
5784 for item
in container
.view
:
5785 if item
.key
== dvPort_group_name
:
5789 except vmodl
.MethodFault
as exp
:
5790 self
.logger
.error("Caught vmodl fault {} for disributed virtaul port group {}".format(
5791 exp
, dvPort_group_name
))
5794 def get_vlanID_from_dvs_portgr(self
, dvPort_group_name
):
5796 Method to get disributed virtual portgroup vlanID
5799 network_name - name of network/portgroup
5806 dvPort_group
= self
.get_dvport_group(dvPort_group_name
)
5808 vlanId
= dvPort_group
.config
.defaultPortConfig
.vlan
.vlanId
5809 except vmodl
.MethodFault
as exp
:
5810 self
.logger
.error("Caught vmodl fault {} for disributed virtaul port group {}".format(
5811 exp
, dvPort_group_name
))
5815 def configure_vlanID(self
, content
, vcenter_conect
, dvPort_group_name
):
5817 Method to configure vlanID in disributed virtual portgroup vlanID
5820 network_name - name of network/portgroup
5825 vlanID
= self
.get_vlanID_from_dvs_portgr(dvPort_group_name
)
5828 vlanID
= self
.genrate_vlanID(dvPort_group_name
)
5829 config
= {"vlanID":vlanID
}
5830 task
= self
.reconfig_portgroup(content
, dvPort_group_name
,
5833 status
= self
.wait_for_vcenter_task(task
, vcenter_conect
)
5835 self
.logger
.info("Reconfigured Port group {} for vlan ID {}".format(
5836 dvPort_group_name
,vlanID
))
5838 self
.logger
.error("Fail reconfigure portgroup {} for vlanID{}".format(
5839 dvPort_group_name
, vlanID
))
5842 def genrate_vlanID(self
, network_name
):
5844 Method to get unused vlanID
5846 network_name - name of network/portgroup
5852 if self
.config
.get('vlanID_range') == None:
5853 raise vimconn
.vimconnConflictException("You must provide a 'vlanID_range' "\
5854 "at config value before creating sriov network with vlan tag")
5855 if "used_vlanIDs" not in self
.persistent_info
:
5856 self
.persistent_info
["used_vlanIDs"] = {}
5858 used_ids
= self
.persistent_info
["used_vlanIDs"].values()
5860 #used_ids = list(self.persistent_info["used_vlanIDs"].values())
5862 for vlanID_range
in self
.config
.get('vlanID_range'):
5863 start_vlanid
, end_vlanid
= vlanID_range
.split("-")
5864 if start_vlanid
> end_vlanid
:
5865 raise vimconn
.vimconnConflictException("Invalid vlan ID range {}".format(
5868 for id in xrange(int(start_vlanid
), int(end_vlanid
) + 1):
5870 #for id in range(int(start_vlanid), int(end_vlanid) + 1):
5871 if id not in used_ids
:
5873 self
.persistent_info
["used_vlanIDs"][network_name
] = vlan_id
5876 raise vimconn
.vimconnConflictException("All Vlan IDs are in use")
5879 def get_obj(self
, content
, vimtype
, name
):
5881 Get the vsphere object associated with a given text name
5884 container
= content
.viewManager
.CreateContainerView(content
.rootFolder
, vimtype
, True)
5885 for item
in container
.view
:
5886 if item
.name
== name
:
5892 def insert_media_to_vm(self
, vapp
, image_id
):
5894 Method to insert media CD-ROM (ISO image) from catalog to vm.
5895 vapp - vapp object to get vm id
5896 Image_id - image id for cdrom to be inerted to vm
5898 # create connection object
5899 vca
= self
.connect()
5901 # fetching catalog details
5902 rest_url
= "{}/api/catalog/{}".format(self
.url
, image_id
)
5904 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
5905 'x-vcloud-authorization': vca
._session
.headers
['x-vcloud-authorization']}
5906 response
= self
.perform_request(req_type
='GET',
5910 if response
.status_code
!= 200:
5911 self
.logger
.error("REST call {} failed reason : {}"\
5912 "status code : {}".format(url_rest_call
,
5914 response
.status_code
))
5915 raise vimconn
.vimconnException("insert_media_to_vm(): Failed to get "\
5917 # searching iso name and id
5918 iso_name
,media_id
= self
.get_media_details(vca
, response
.content
)
5920 if iso_name
and media_id
:
5921 data
="""<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
5922 <ns6:MediaInsertOrEjectParams
5923 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">
5925 type="application/vnd.vmware.vcloud.media+xml"
5927 id="urn:vcloud:media:{}"
5928 href="https://{}/api/media/{}"/>
5929 </ns6:MediaInsertOrEjectParams>""".format(iso_name
, media_id
,
5932 for vms
in vapp
.get_all_vms():
5933 vm_id
= vms
.get('id').split(':')[-1]
5935 headers
['Content-Type'] = 'application/vnd.vmware.vcloud.mediaInsertOrEjectParams+xml'
5936 rest_url
= "{}/api/vApp/vm-{}/media/action/insertMedia".format(self
.url
,vm_id
)
5938 response
= self
.perform_request(req_type
='POST',
5943 if response
.status_code
!= 202:
5944 self
.logger
.error("Failed to insert CD-ROM to vm")
5945 raise vimconn
.vimconnException("insert_media_to_vm() : Failed to insert"\
5948 task
= self
.get_task_from_response(response
.content
)
5949 result
= self
.client
.get_task_monitor().wait_for_success(task
=task
)
5950 if result
.get('status') == 'success':
5951 self
.logger
.info("insert_media_to_vm(): Sucessfully inserted media ISO"\
5952 " image to vm {}".format(vm_id
))
5954 except Exception as exp
:
5955 self
.logger
.error("insert_media_to_vm() : exception occurred "\
5956 "while inserting media CD-ROM")
5957 raise vimconn
.vimconnException(message
=exp
)
5960 def get_media_details(self
, vca
, content
):
5962 Method to get catalog item details
5963 vca - connection object
5964 content - Catalog details
5965 Return - Media name, media id
5967 cataloghref_list
= []
5970 vm_list_xmlroot
= XmlElementTree
.fromstring(content
)
5971 for child
in vm_list_xmlroot
.iter():
5972 if 'CatalogItem' in child
.tag
:
5973 cataloghref_list
.append(child
.attrib
.get('href'))
5974 if cataloghref_list
is not None:
5975 for href
in cataloghref_list
:
5977 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
5978 'x-vcloud-authorization': vca
._session
.headers
['x-vcloud-authorization']}
5979 response
= self
.perform_request(req_type
='GET',
5982 if response
.status_code
!= 200:
5983 self
.logger
.error("REST call {} failed reason : {}"\
5984 "status code : {}".format(href
,
5986 response
.status_code
))
5987 raise vimconn
.vimconnException("get_media_details : Failed to get "\
5988 "catalogitem details")
5989 list_xmlroot
= XmlElementTree
.fromstring(response
.content
)
5990 for child
in list_xmlroot
.iter():
5991 if 'Entity' in child
.tag
:
5992 if 'media' in child
.attrib
.get('href'):
5993 name
= child
.attrib
.get('name')
5994 media_id
= child
.attrib
.get('href').split('/').pop()
5995 return name
,media_id
5997 self
.logger
.debug("Media name and id not found")
5999 except Exception as exp
:
6000 self
.logger
.error("get_media_details : exception occurred "\
6001 "getting media details")
6002 raise vimconn
.vimconnException(message
=exp
)
6005 def retry_rest(self
, method
, url
, add_headers
=None, data
=None):
6006 """ Method to get Token & retry respective REST request
6008 api - REST API - Can be one of 'GET' or 'PUT' or 'POST'
6009 url - request url to be used
6010 add_headers - Additional headers (optional)
6011 data - Request payload data to be passed in request
6013 response - Response of request
6020 if self
.client
._session
:
6021 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
6022 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
6025 headers
.update(add_headers
)
6028 response
= self
.perform_request(req_type
='GET',
6031 elif method
== 'PUT':
6032 response
= self
.perform_request(req_type
='PUT',
6036 elif method
== 'POST':
6037 response
= self
.perform_request(req_type
='POST',
6041 elif method
== 'DELETE':
6042 response
= self
.perform_request(req_type
='DELETE',
6048 def get_token(self
):
6049 """ Generate a new token if expired
6052 The return client object that letter can be used to connect to vCloud director as admin for VDC
6055 self
.logger
.debug("Generate token for vca {} as {} to datacenter {}.".format(self
.org_name
,
6059 client
= Client(host
, verify_ssl_certs
=False)
6060 client
.set_credentials(BasicLoginCredentials(self
.user
, self
.org_name
, self
.passwd
))
6062 self
.client
= client
6065 raise vimconn
.vimconnConnectionException("Can't connect to a vCloud director org: "
6066 "{} as user: {}".format(self
.org_name
, self
.user
))
6069 raise vimconn
.vimconnConnectionException("Failed while reconnecting vCD")
6072 def get_vdc_details(self
):
6073 """ Get VDC details using pyVcloud Lib
6075 Returns org and vdc object
6077 org
= Org(self
.client
, resource
=self
.client
.get_org())
6078 vdc
= org
.get_vdc(self
.tenant_name
)
6080 #Retry once, if failed by refreshing token
6083 vdc
= org
.get_vdc(self
.tenant_name
)
6088 def perform_request(self
, req_type
, url
, headers
=None, data
=None):
6089 """Perform the POST/PUT/GET/DELETE request."""
6091 #Log REST request details
6092 self
.log_request(req_type
, url
=url
, headers
=headers
, data
=data
)
6093 # perform request and return its result
6094 if req_type
== 'GET':
6095 response
= requests
.get(url
=url
,
6098 elif req_type
== 'PUT':
6099 response
= requests
.put(url
=url
,
6103 elif req_type
== 'POST':
6104 response
= requests
.post(url
=url
,
6108 elif req_type
== 'DELETE':
6109 response
= requests
.delete(url
=url
,
6112 #Log the REST response
6113 self
.log_response(response
)
6118 def log_request(self
, req_type
, url
=None, headers
=None, data
=None):
6119 """Logs REST request details"""
6121 if req_type
is not None:
6122 self
.logger
.debug("Request type: {}".format(req_type
))
6125 self
.logger
.debug("Request url: {}".format(url
))
6127 if headers
is not None:
6128 for header
in headers
:
6129 self
.logger
.debug("Request header: {}: {}".format(header
, headers
[header
]))
6131 if data
is not None:
6132 self
.logger
.debug("Request data: {}".format(data
))
6135 def log_response(self
, response
):
6136 """Logs REST response details"""
6138 self
.logger
.debug("Response status code: {} ".format(response
.status_code
))
6141 def get_task_from_response(self
, content
):
6143 content - API response content(response.content)
6146 xmlroot
= XmlElementTree
.fromstring(content
)
6147 if xmlroot
.tag
.split('}')[1] == "Task":
6151 if ele
.tag
.split("}")[1] == "Tasks":
6157 def power_on_vapp(self
,vapp_id
, vapp_name
):
6160 vapp_name - vAapp name
6161 return - Task object
6163 headers
= {'Accept':'application/*+xml;version=' + API_VERSION
,
6164 'x-vcloud-authorization': self
.client
._session
.headers
['x-vcloud-authorization']}
6166 poweron_href
= "{}/api/vApp/vapp-{}/power/action/powerOn".format(self
.url
,
6168 response
= self
.perform_request(req_type
='POST',
6172 if response
.status_code
!= 202:
6173 self
.logger
.error("REST call {} failed reason : {}"\
6174 "status code : {} ".format(poweron_href
,
6176 response
.status_code
))
6177 raise vimconn
.vimconnException("power_on_vapp() : Failed to power on "\
6178 "vApp {}".format(vapp_name
))
6180 poweron_task
= self
.get_task_from_response(response
.content
)