1 # -*- coding: utf-8 -*-
4 # Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U.
5 # This file is part of openmano
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 with: nfvlabs@tid.es
25 vimconnector implements all the methods to interact with openvim using the openvim API.
27 __author__
="Alfonso Tierno, Gerardo Garcia"
28 __date__
="$26-aug-2014 11:09:29$"
35 from openmano_schemas
import id_schema
, name_schema
, nameshort_schema
, description_schema
, \
36 vlan1000_schema
, integer0_schema
37 from jsonschema
import validate
as js_v
, exceptions
as js_e
38 from urllib
import quote
40 '''contain the openvim virtual machine status to openmano status'''
41 vmStatus2manoFormat
={'ACTIVE':'ACTIVE',
43 'SUSPENDED': 'SUSPENDED',
44 'INACTIVE':'INACTIVE',
46 'ERROR':'ERROR','DELETED':'DELETED'
48 netStatus2manoFormat
={'ACTIVE':'ACTIVE','INACTIVE':'INACTIVE','BUILD':'BUILD','ERROR':'ERROR','DELETED':'DELETED', 'DOWN':'DOWN'
66 "required": ["id","name"]
74 "required": ["id","name"]
76 new_host_response_schema
= {
77 "title":"host response information schema",
78 "$schema": "http://json-schema.org/draft-04/schema#",
84 "additionalProperties": False
87 get_images_response_schema
= {
88 "title":"openvim images response information schema",
89 "$schema": "http://json-schema.org/draft-04/schema#",
94 "items": image_schema
,
97 "required": ["images"],
98 "additionalProperties": False
101 get_hosts_response_schema
= {
102 "title":"openvim hosts response information schema",
103 "$schema": "http://json-schema.org/draft-04/schema#",
108 "items": host_schema
,
111 "required": ["hosts"],
112 "additionalProperties": False
115 get_host_detail_response_schema
= new_host_response_schema
# TODO: Content is not parsed yet
117 get_server_response_schema
= {
118 "title":"openvim server response information schema",
119 "$schema": "http://json-schema.org/draft-04/schema#",
124 "items": server_schema
,
127 "required": ["servers"],
128 "additionalProperties": False
131 new_tenant_response_schema
= {
132 "title":"tenant response information schema",
133 "$schema": "http://json-schema.org/draft-04/schema#",
140 "name": nameshort_schema
,
141 "description":description_schema
,
142 "enabled":{"type" : "boolean"}
147 "required": ["tenant"],
148 "additionalProperties": False
151 new_network_response_schema
= {
152 "title":"network response information schema",
153 "$schema": "http://json-schema.org/draft-04/schema#",
161 "type":{"type":"string", "enum":["bridge_man","bridge_data","data", "ptp"]},
162 "shared":{"type":"boolean"},
163 "tenant_id":id_schema
,
164 "admin_state_up":{"type":"boolean"},
165 "vlan":vlan1000_schema
170 "required": ["network"],
171 "additionalProperties": False
175 # get_network_response_schema = {
176 # "title":"get network response information schema",
177 # "$schema": "http://json-schema.org/draft-04/schema#",
184 # "name":name_schema,
185 # "type":{"type":"string", "enum":["bridge_man","bridge_data","data", "ptp"]},
186 # "shared":{"type":"boolean"},
187 # "tenant_id":id_schema,
188 # "admin_state_up":{"type":"boolean"},
189 # "vlan":vlan1000_schema
194 # "required": ["network"],
195 # "additionalProperties": False
199 new_port_response_schema
= {
200 "title":"port response information schema",
201 "$schema": "http://json-schema.org/draft-04/schema#",
212 "required": ["port"],
213 "additionalProperties": False
216 get_flavor_response_schema
= {
217 "title":"openvim flavors response information schema",
218 "$schema": "http://json-schema.org/draft-04/schema#",
226 "extended": {"type":"object"},
228 "required": ["id", "name"],
231 "required": ["flavor"],
232 "additionalProperties": False
235 new_flavor_response_schema
= {
236 "title":"flavor response information schema",
237 "$schema": "http://json-schema.org/draft-04/schema#",
248 "required": ["flavor"],
249 "additionalProperties": False
252 get_image_response_schema
= {
253 "title":"openvim images response information schema",
254 "$schema": "http://json-schema.org/draft-04/schema#",
263 "required": ["id", "name"],
266 "required": ["flavor"],
267 "additionalProperties": False
269 new_image_response_schema
= {
270 "title":"image response information schema",
271 "$schema": "http://json-schema.org/draft-04/schema#",
282 "required": ["image"],
283 "additionalProperties": False
286 new_vminstance_response_schema
= {
287 "title":"server response information schema",
288 "$schema": "http://json-schema.org/draft-04/schema#",
299 "required": ["server"],
300 "additionalProperties": False
303 get_processor_rankings_response_schema
= {
304 "title":"processor rankings information schema",
305 "$schema": "http://json-schema.org/draft-04/schema#",
313 "model": description_schema
,
314 "value": integer0_schema
316 "additionalProperties": False,
317 "required": ["model","value"]
320 "additionalProperties": False,
321 "required": ["rankings"]
325 class vimconnector(vimconn
.vimconnector
):
326 def __init__(self
, uuid
, name
, tenant_id
, tenant_name
, url
, url_admin
=None, user
=None, passwd
=None,log_level
="DEBUG",config
={}):
327 vimconn
.vimconnector
.__init
__(self
, uuid
, name
, tenant_id
, tenant_name
, url
, url_admin
, user
, passwd
, log_level
, config
)
329 self
.headers_req
= {'content-type': 'application/json'}
330 self
.logger
= logging
.getLogger('mano.vim.openvim')
332 self
.tenant
= tenant_id
334 def __setitem__(self
,index
, value
):
335 '''Set individuals parameters
336 Throw TypeError, KeyError
338 if index
=='tenant_id':
340 elif index
=='tenant_name':
342 vimconn
.vimconnector
.__setitem
__(self
,index
, value
)
344 def _get_my_tenant(self
):
345 '''Obtain uuid of my tenant from name
350 url
= self
.url
+'/tenants?name='+ quote(self
.tenant_name
)
351 self
.logger
.info("Getting VIM tenant_id GET %s", url
)
352 vim_response
= requests
.get(url
, headers
= self
.headers_req
)
353 self
._check
_http
_request
_response
(vim_response
)
355 tenant_list
= vim_response
.json()["tenants"]
356 if len(tenant_list
) == 0:
357 raise vimconn
.vimconnNotFoundException("No tenant found for name '%s'" % str(self
.tenant_name
))
358 elif len(tenant_list
) > 1:
359 raise vimconn
.vimconnConflictException ("More that one tenant found for name '%s'" % str(self
.tenant_name
))
360 self
.tenant
= tenant_list
[0]["id"]
362 except Exception as e
:
363 raise vimconn
.vimconnUnexpectedResponse("Get VIM tenant {} '{}'".format(type(e
).__name
__, str(e
)))
365 def _format_jsonerror(self
,http_response
):
366 #DEPRECATED, to delete in the future
368 data
= http_response
.json()
369 return data
["error"]["description"]
371 return http_response
.text
373 def _format_in(self
, http_response
, schema
):
374 #DEPRECATED, to delete in the future
376 client_data
= http_response
.json()
377 js_v(client_data
, schema
)
378 #print "Input data: ", str(client_data)
379 return True, client_data
380 except js_e
.ValidationError
, exc
:
381 print "validate_in error, jsonschema exception ", exc
.message
, "at", exc
.path
382 return False, ("validate_in error, jsonschema exception ", exc
.message
, "at", exc
.path
)
384 def _remove_extra_items(self
, data
, schema
):
386 if type(data
) is tuple or type(data
) is list:
388 a
= self
._remove
_extra
_items
(d
, schema
['items'])
389 if a
is not None: deleted
.append(a
)
390 elif type(data
) is dict:
391 for k
in data
.keys():
392 if 'properties' not in schema
or k
not in schema
['properties'].keys():
396 a
= self
._remove
_extra
_items
(data
[k
], schema
['properties'][k
])
397 if a
is not None: deleted
.append({k
:a
})
398 if len(deleted
) == 0: return None
399 elif len(deleted
) == 1: return deleted
[0]
402 def _format_request_exception(self
, request_exception
):
403 '''Transform a request exception into a vimconn exception'''
404 if isinstance(request_exception
, js_e
.ValidationError
):
405 raise vimconn
.vimconnUnexpectedResponse("jsonschema exception '{}' at '{}'".format(request_exception
.message
, request_exception
.path
))
406 elif isinstance(request_exception
, requests
.exceptions
.HTTPError
):
407 raise vimconn
.vimconnUnexpectedResponse(type(request_exception
).__name
__ + ": " + str(request_exception
))
409 raise vimconn
.vimconnConnectionException(type(request_exception
).__name
__ + ": " + str(request_exception
))
411 def _check_http_request_response(self
, request_response
):
412 '''Raise a vimconn exception if the response is not Ok'''
413 if request_response
.status_code
>= 200 and request_response
.status_code
< 300:
415 if request_response
.status_code
== vimconn
.HTTP_Unauthorized
:
416 raise vimconn
.vimconnAuthException(request_response
.text
)
417 elif request_response
.status_code
== vimconn
.HTTP_Not_Found
:
418 raise vimconn
.vimconnNotFoundException(request_response
.text
)
419 elif request_response
.status_code
== vimconn
.HTTP_Conflict
:
420 raise vimconn
.vimconnConflictException(request_response
.text
)
422 raise vimconn
.vimconnUnexpectedResponse("VIM HTTP_response {}, {}".format(request_response
.status_code
, str(request_response
.text
)))
424 def new_tenant(self
,tenant_name
,tenant_description
):
425 '''Adds a new tenant to VIM with this name and description, returns the tenant identifier'''
426 #print "VIMConnector: Adding a new tenant to VIM"
427 payload_dict
= {"tenant": {"name":tenant_name
,"description": tenant_description
, "enabled": True}}
428 payload_req
= json
.dumps(payload_dict
)
430 url
= self
.url_admin
+'/tenants'
431 self
.logger
.info("Adding a new tenant %s", url
)
432 vim_response
= requests
.post(url
, headers
= self
.headers_req
, data
=payload_req
)
433 self
._check
_http
_request
_response
(vim_response
)
434 self
.logger
.debug(vim_response
.text
)
435 #print json.dumps(vim_response.json(), indent=4)
436 response
= vim_response
.json()
437 js_v(response
, new_tenant_response_schema
)
438 #r = self._remove_extra_items(response, new_tenant_response_schema)
440 # self.logger.warn("Warning: remove extra items %s", str(r))
441 tenant_id
= response
['tenant']['id']
443 except (requests
.exceptions
.RequestException
, js_e
.ValidationError
) as e
:
444 self
._format
_request
_exception
(e
)
446 def delete_tenant(self
,tenant_id
):
447 '''Delete a tenant from VIM. Returns the old tenant identifier'''
449 url
= self
.url_admin
+'/tenants/'+tenant_id
450 self
.logger
.info("Delete a tenant DELETE %s", url
)
451 vim_response
= requests
.delete(url
, headers
= self
.headers_req
)
452 self
._check
_http
_request
_response
(vim_response
)
453 self
.logger
.debug(vim_response
.text
)
454 #print json.dumps(vim_response.json(), indent=4)
456 except (requests
.exceptions
.RequestException
, js_e
.ValidationError
) as e
:
457 self
._format
_request
_exception
(e
)
459 def get_tenant_list(self
, filter_dict
={}):
460 '''Obtain tenants of VIM
461 filter_dict can contain the following keys:
462 name: filter by tenant name
463 id: filter by tenant uuid/id
465 Returns the tenant list of dictionaries: [{'name':'<name>, 'id':'<id>, ...}, ...]
469 for k
,v
in filter_dict
.iteritems():
470 filterquery
.append(str(k
)+'='+str(v
))
471 if len(filterquery
)>0:
472 filterquery_text
='?'+ '&'.join(filterquery
)
474 url
= self
.url
+'/tenants'+filterquery_text
475 self
.logger
.info("get_tenant_list GET %s", url
)
476 vim_response
= requests
.get(url
, headers
= self
.headers_req
)
477 self
._check
_http
_request
_response
(vim_response
)
478 self
.logger
.debug(vim_response
.text
)
479 #print json.dumps(vim_response.json(), indent=4)
480 return vim_response
.json()["tenants"]
481 except requests
.exceptions
.RequestException
as e
:
482 self
._format
_request
_exception
(e
)
484 def new_network(self
,net_name
, net_type
, ip_profile
=None, shared
=False, **vim_specific
):
485 '''Adds a tenant network to VIM'''
486 '''Returns the network identifier'''
488 self
._get
_my
_tenant
()
489 if net_type
=="bridge":
490 net_type
="bridge_data"
491 payload_req
= {"name": net_name
, "type": net_type
, "tenant_id": self
.tenant
, "shared": shared
}
492 payload_req
.update(vim_specific
)
493 url
= self
.url
+'/networks'
494 self
.logger
.info("Adding a new network POST: %s DATA: %s", url
, str(payload_req
))
495 vim_response
= requests
.post(url
, headers
= self
.headers_req
, data
=json
.dumps({"network": payload_req
}) )
496 self
._check
_http
_request
_response
(vim_response
)
497 self
.logger
.debug(vim_response
.text
)
498 #print json.dumps(vim_response.json(), indent=4)
499 response
= vim_response
.json()
500 js_v(response
, new_network_response_schema
)
501 #r = self._remove_extra_items(response, new_network_response_schema)
503 # self.logger.warn("Warning: remove extra items %s", str(r))
504 network_id
= response
['network']['id']
506 except (requests
.exceptions
.RequestException
, js_e
.ValidationError
) as e
:
507 self
._format
_request
_exception
(e
)
509 def get_network_list(self
, filter_dict
={}):
510 '''Obtain tenant networks of VIM
516 admin_state_up: boolean
518 Returns the network list of dictionaries
521 if 'tenant_id' not in filter_dict
:
522 filter_dict
["tenant_id"] = self
._get
_my
_tenant
()
523 elif not filter_dict
["tenant_id"]:
524 del filter_dict
["tenant_id"]
527 for k
,v
in filter_dict
.iteritems():
528 filterquery
.append(str(k
)+'='+str(v
))
529 if len(filterquery
)>0:
530 filterquery_text
='?'+ '&'.join(filterquery
)
531 url
= self
.url
+'/networks'+filterquery_text
532 self
.logger
.info("Getting network list GET %s", url
)
533 vim_response
= requests
.get(url
, headers
= self
.headers_req
)
534 self
._check
_http
_request
_response
(vim_response
)
535 self
.logger
.debug(vim_response
.text
)
536 #print json.dumps(vim_response.json(), indent=4)
537 response
= vim_response
.json()
538 return response
['networks']
539 except (requests
.exceptions
.RequestException
, js_e
.ValidationError
) as e
:
540 self
._format
_request
_exception
(e
)
542 def get_network(self
, net_id
):
543 '''Obtain network details of network id'''
545 url
= self
.url
+'/networks/'+net_id
546 self
.logger
.info("Getting network GET %s", url
)
547 vim_response
= requests
.get(url
, headers
= self
.headers_req
)
548 self
._check
_http
_request
_response
(vim_response
)
549 self
.logger
.debug(vim_response
.text
)
550 #print json.dumps(vim_response.json(), indent=4)
551 response
= vim_response
.json()
552 return response
['network']
553 except (requests
.exceptions
.RequestException
, js_e
.ValidationError
) as e
:
554 self
._format
_request
_exception
(e
)
556 def delete_network(self
, net_id
):
557 '''Deletes a tenant network from VIM'''
558 '''Returns the network identifier'''
560 self
._get
_my
_tenant
()
561 url
= self
.url
+'/networks/'+net_id
562 self
.logger
.info("Deleting VIM network DELETE %s", url
)
563 vim_response
= requests
.delete(url
, headers
=self
.headers_req
)
564 self
._check
_http
_request
_response
(vim_response
)
565 #self.logger.debug(vim_response.text)
566 #print json.dumps(vim_response.json(), indent=4)
568 except (requests
.exceptions
.RequestException
, js_e
.ValidationError
) as e
:
569 self
._format
_request
_exception
(e
)
571 def get_flavor(self
, flavor_id
):
572 '''Obtain flavor details from the VIM'''
574 self
._get
_my
_tenant
()
575 url
= self
.url
+'/'+self
.tenant
+'/flavors/'+flavor_id
576 self
.logger
.info("Getting flavor GET %s", url
)
577 vim_response
= requests
.get(url
, headers
= self
.headers_req
)
578 self
._check
_http
_request
_response
(vim_response
)
579 self
.logger
.debug(vim_response
.text
)
580 #print json.dumps(vim_response.json(), indent=4)
581 response
= vim_response
.json()
582 js_v(response
, get_flavor_response_schema
)
583 r
= self
._remove
_extra
_items
(response
, get_flavor_response_schema
)
585 self
.logger
.warn("Warning: remove extra items %s", str(r
))
586 return response
['flavor']
587 except (requests
.exceptions
.RequestException
, js_e
.ValidationError
) as e
:
588 self
._format
_request
_exception
(e
)
590 def new_flavor(self
, flavor_data
):
591 '''Adds a tenant flavor to VIM'''
592 '''Returns the flavor identifier'''
594 self
._get
_my
_tenant
()
595 payload_req
= json
.dumps({'flavor': flavor_data
})
596 url
= self
.url
+'/'+self
.tenant
+'/flavors'
597 self
.logger
.info("Adding a new VIM flavor POST %s", url
)
598 vim_response
= requests
.post(url
, headers
= self
.headers_req
, data
=payload_req
)
599 self
._check
_http
_request
_response
(vim_response
)
600 self
.logger
.debug(vim_response
.text
)
601 #print json.dumps(vim_response.json(), indent=4)
602 response
= vim_response
.json()
603 js_v(response
, new_flavor_response_schema
)
604 r
= self
._remove
_extra
_items
(response
, new_flavor_response_schema
)
606 self
.logger
.warn("Warning: remove extra items %s", str(r
))
607 flavor_id
= response
['flavor']['id']
609 except (requests
.exceptions
.RequestException
, js_e
.ValidationError
) as e
:
610 self
._format
_request
_exception
(e
)
612 def delete_flavor(self
,flavor_id
):
613 '''Deletes a tenant flavor from VIM'''
614 '''Returns the old flavor_id'''
616 self
._get
_my
_tenant
()
617 url
= self
.url
+'/'+self
.tenant
+'/flavors/'+flavor_id
618 self
.logger
.info("Deleting VIM flavor DELETE %s", url
)
619 vim_response
= requests
.delete(url
, headers
=self
.headers_req
)
620 self
._check
_http
_request
_response
(vim_response
)
621 #self.logger.debug(vim_response.text)
622 #print json.dumps(vim_response.json(), indent=4)
624 except (requests
.exceptions
.RequestException
, js_e
.ValidationError
) as e
:
625 self
._format
_request
_exception
(e
)
627 def get_image(self
, image_id
):
628 '''Obtain image details from the VIM'''
630 self
._get
_my
_tenant
()
631 url
= self
.url
+'/'+self
.tenant
+'/images/'+image_id
632 self
.logger
.info("Getting image GET %s", url
)
633 vim_response
= requests
.get(url
, headers
= self
.headers_req
)
634 self
._check
_http
_request
_response
(vim_response
)
635 self
.logger
.debug(vim_response
.text
)
636 #print json.dumps(vim_response.json(), indent=4)
637 response
= vim_response
.json()
638 js_v(response
, get_image_response_schema
)
639 r
= self
._remove
_extra
_items
(response
, get_image_response_schema
)
641 self
.logger
.warn("Warning: remove extra items %s", str(r
))
642 return response
['image']
643 except (requests
.exceptions
.RequestException
, js_e
.ValidationError
) as e
:
644 self
._format
_request
_exception
(e
)
646 def new_image(self
,image_dict
):
647 ''' Adds a tenant image to VIM, returns image_id'''
649 self
._get
_my
_tenant
()
650 new_image_dict
={'name': image_dict
['name']}
651 if image_dict
.get('description'):
652 new_image_dict
['description'] = image_dict
['description']
653 if image_dict
.get('metadata'):
654 new_image_dict
['metadata'] = yaml
.load(image_dict
['metadata'])
655 if image_dict
.get('location'):
656 new_image_dict
['path'] = image_dict
['location']
657 payload_req
= json
.dumps({"image":new_image_dict
})
658 url
=self
.url
+ '/' + self
.tenant
+ '/images'
659 self
.logger
.info("Adding a new VIM image POST %s", url
)
660 vim_response
= requests
.post(url
, headers
= self
.headers_req
, data
=payload_req
)
661 self
._check
_http
_request
_response
(vim_response
)
662 self
.logger
.debug(vim_response
.text
)
663 #print json.dumps(vim_response.json(), indent=4)
664 response
= vim_response
.json()
665 js_v(response
, new_image_response_schema
)
666 r
= self
._remove
_extra
_items
(response
, new_image_response_schema
)
668 self
.logger
.warn("Warning: remove extra items %s", str(r
))
669 image_id
= response
['image']['id']
671 except (requests
.exceptions
.RequestException
, js_e
.ValidationError
) as e
:
672 self
._format
_request
_exception
(e
)
674 def delete_image(self
, image_id
):
675 '''Deletes a tenant image from VIM'''
676 '''Returns the deleted image_id'''
678 self
._get
_my
_tenant
()
679 url
= self
.url
+ '/'+ self
.tenant
+'/images/'+image_id
680 self
.logger
.info("Deleting VIM image DELETE %s", url
)
681 vim_response
= requests
.delete(url
, headers
=self
.headers_req
)
682 self
._check
_http
_request
_response
(vim_response
)
683 #self.logger.debug(vim_response.text)
684 #print json.dumps(vim_response.json(), indent=4)
686 except (requests
.exceptions
.RequestException
, js_e
.ValidationError
) as e
:
687 self
._format
_request
_exception
(e
)
690 def get_image_id_from_path(self
, path
):
691 '''Get the image id from image path in the VIM database'''
693 self
._get
_my
_tenant
()
694 url
=self
.url
+ '/' + self
.tenant
+ '/images?path='+quote(path
)
695 self
.logger
.info("Getting images GET %s", url
)
696 vim_response
= requests
.get(url
)
697 self
._check
_http
_request
_response
(vim_response
)
698 self
.logger
.debug(vim_response
.text
)
699 #print json.dumps(vim_response.json(), indent=4)
700 response
= vim_response
.json()
701 js_v(response
, get_images_response_schema
)
702 #r = self._remove_extra_items(response, get_images_response_schema)
704 # self.logger.warn("Warning: remove extra items %s", str(r))
705 if len(response
['images'])==0:
706 raise vimconn
.vimconnNotFoundException("Image not found at VIM with path '%s'", path
)
707 elif len(response
['images'])>1:
708 raise vimconn
.vimconnConflictException("More than one image found at VIM with path '%s'", path
)
709 return response
['images'][0]['id']
710 except (requests
.exceptions
.RequestException
, js_e
.ValidationError
) as e
:
711 self
._format
_request
_exception
(e
)
713 def new_vminstancefromJSON(self
, vm_data
):
714 '''Adds a VM instance to VIM'''
715 '''Returns the instance identifier'''
717 self
._get
_my
_tenant
()
718 except Exception as e
:
719 return -vimconn
.HTTP_Not_Found
, str(e
)
720 print "VIMConnector: Adding a new VM instance from JSON to VIM"
721 payload_req
= vm_data
723 vim_response
= requests
.post(self
.url
+'/'+self
.tenant
+'/servers', headers
= self
.headers_req
, data
=payload_req
)
724 except requests
.exceptions
.RequestException
, e
:
725 print "new_vminstancefromJSON Exception: ", e
.args
726 return -vimconn
.HTTP_Not_Found
, str(e
.args
[0])
728 #print vim_response.status_code
729 if vim_response
.status_code
== 200:
730 #print vim_response.json()
731 #print json.dumps(vim_response.json(), indent=4)
732 res
,http_content
= self
._format
_in
(vim_response
, new_image_response_schema
)
735 r
= self
._remove
_extra
_items
(http_content
, new_image_response_schema
)
736 if r
is not None: print "Warning: remove extra items ", r
738 vminstance_id
= http_content
['server']['id']
739 print "Tenant image id: ",vminstance_id
740 return vim_response
.status_code
,vminstance_id
741 else: return -vimconn
.HTTP_Bad_Request
,http_content
743 #print vim_response.text
744 jsonerror
= self
._format
_jsonerror
(vim_response
)
745 text
= 'Error in VIM "%s": not possible to add new vm instance. HTTP Response: %d. Error: %s' % (self
.url
, vim_response
.status_code
, jsonerror
)
747 return -vim_response
.status_code
,text
749 def new_vminstance(self
,name
,description
,start
,image_id
,flavor_id
,net_list
, cloud_config
=None):
750 '''Adds a VM instance to VIM
752 start: indicates if VM must start or boot in pause mode. Ignored
753 image_id,flavor_id: image and flavor uuid
754 net_list: list of interfaces, each one is a dictionary with:
756 net_id: network uuid to connect
757 vpci: virtual vcpi to assign
758 model: interface model, virtio, e2000, ...
760 use: 'data', 'bridge', 'mgmt'
761 type: 'virtual', 'PF', 'VF', 'VFnotShared'
762 vim_id: filled/added by this function
763 #TODO ip, security groups
764 Returns the instance identifier
767 self
._get
_my
_tenant
()
769 # for k,v in net_dict.items():
771 # net_list.append('{"name":"' + k + '", "uuid":"' + v + '"}')
772 # net_list_string = ', '.join(net_list)
775 if not net
.get("net_id"):
777 net_dict
={'uuid': net
["net_id"]}
778 if net
.get("type"): net_dict
["type"] = net
["type"]
779 if net
.get("name"): net_dict
["name"] = net
["name"]
780 if net
.get("vpci"): net_dict
["vpci"] = net
["vpci"]
781 if net
.get("model"): net_dict
["model"] = net
["model"]
782 if net
.get("mac_address"): net_dict
["mac_address"] = net
["mac_address"]
783 virtio_net_list
.append(net_dict
)
784 payload_dict
={ "name": name
,
785 "description": description
,
786 "imageRef": image_id
,
787 "flavorRef": flavor_id
,
788 "networks": virtio_net_list
791 payload_dict
["start"] = start
792 payload_req
= json
.dumps({"server": payload_dict
})
793 url
= self
.url
+'/'+self
.tenant
+'/servers'
794 self
.logger
.info("Adding a new vm POST %s DATA %s", url
, payload_req
)
795 vim_response
= requests
.post(url
, headers
= self
.headers_req
, data
=payload_req
)
796 self
._check
_http
_request
_response
(vim_response
)
797 self
.logger
.debug(vim_response
.text
)
798 #print json.dumps(vim_response.json(), indent=4)
799 response
= vim_response
.json()
800 js_v(response
, new_vminstance_response_schema
)
801 #r = self._remove_extra_items(response, new_vminstance_response_schema)
803 # self.logger.warn("Warning: remove extra items %s", str(r))
804 vminstance_id
= response
['server']['id']
806 #connect data plane interfaces to network
808 if net
["type"]=="virtual":
809 if not net
.get("net_id"):
811 for iface
in response
['server']['networks']:
813 if net
["name"]==iface
["name"]:
814 net
["vim_id"] = iface
['iface_id']
816 elif "net_id" in net
:
817 if net
["net_id"]==iface
["net_id"]:
818 net
["vim_id"] = iface
['iface_id']
821 for numa
in response
['server'].get('extended',{}).get('numas',() ):
822 for iface
in numa
.get('interfaces',() ):
823 if net
['name'] == iface
['name']:
824 net
['vim_id'] = iface
['iface_id']
825 #Code bellow is not needed, current openvim connect dataplane interfaces
826 #if net.get("net_id"):
827 ##connect dataplane interface
828 # result, port_id = self.connect_port_network(iface['iface_id'], net["net_id"])
830 # error_text = "Error attaching port %s to network %s: %s." % (iface['iface_id'], net["net_id"], port_id)
831 # print "new_vminstance: " + error_text
832 # self.delete_vminstance(vminstance_id)
833 # return result, error_text
837 except (requests
.exceptions
.RequestException
, js_e
.ValidationError
) as e
:
838 self
._format
_request
_exception
(e
)
840 def get_vminstance(self
, vm_id
):
841 '''Returns the VM instance information from VIM'''
843 self
._get
_my
_tenant
()
844 url
= self
.url
+'/'+self
.tenant
+'/servers/'+vm_id
845 self
.logger
.info("Getting vm GET %s", url
)
846 vim_response
= requests
.get(url
, headers
= self
.headers_req
)
847 vim_response
= requests
.get(url
, headers
= self
.headers_req
)
848 self
._check
_http
_request
_response
(vim_response
)
849 self
.logger
.debug(vim_response
.text
)
850 #print json.dumps(vim_response.json(), indent=4)
851 response
= vim_response
.json()
852 js_v(response
, new_vminstance_response_schema
)
853 #r = self._remove_extra_items(response, new_vminstance_response_schema)
855 # self.logger.warn("Warning: remove extra items %s", str(r))
856 return response
['server']
857 except (requests
.exceptions
.RequestException
, js_e
.ValidationError
) as e
:
858 self
._format
_request
_exception
(e
)
860 def delete_vminstance(self
, vm_id
):
861 '''Removes a VM instance from VIM, returns the deleted vm_id'''
863 self
._get
_my
_tenant
()
864 url
= self
.url
+'/'+self
.tenant
+'/servers/'+vm_id
865 self
.logger
.info("Deleting VIM vm DELETE %s", url
)
866 vim_response
= requests
.delete(url
, headers
=self
.headers_req
)
867 self
._check
_http
_request
_response
(vim_response
)
868 #self.logger.debug(vim_response.text)
869 #print json.dumps(vim_response.json(), indent=4)
871 except (requests
.exceptions
.RequestException
, js_e
.ValidationError
) as e
:
872 self
._format
_request
_exception
(e
)
874 def refresh_vms_status(self
, vm_list
):
875 '''Refreshes the status of the virtual machines'''
877 self
._get
_my
_tenant
()
878 except requests
.exceptions
.RequestException
as e
:
879 self
._format
_request
_exception
(e
)
881 for vm_id
in vm_list
:
883 #print "VIMConnector refresh_tenant_vms and nets: Getting tenant VM instance information from VIM"
885 url
= self
.url
+'/'+self
.tenant
+'/servers/'+ vm_id
886 self
.logger
.info("Getting vm GET %s", url
)
887 vim_response
= requests
.get(url
, headers
= self
.headers_req
)
888 self
._check
_http
_request
_response
(vim_response
)
889 response
= vim_response
.json()
890 js_v(response
, new_vminstance_response_schema
)
891 if response
['server']['status'] in vmStatus2manoFormat
:
892 vm
['status'] = vmStatus2manoFormat
[ response
['server']['status'] ]
894 vm
['status'] = "OTHER"
895 vm
['error_msg'] = "VIM status reported " + response
['server']['status']
896 if response
['server'].get('last_error'):
897 vm
['error_msg'] = response
['server']['last_error']
898 vm
["vim_info"] = yaml
.safe_dump(response
['server'])
901 management_ip
= False
902 url2
= self
.url
+'/ports?device_id='+ quote(vm_id
)
903 self
.logger
.info("Getting PORTS GET %s", url2
)
904 vim_response2
= requests
.get(url2
, headers
= self
.headers_req
)
905 self
._check
_http
_request
_response
(vim_response2
)
906 client_data
= vim_response2
.json()
907 if isinstance(client_data
.get("ports"), list):
909 for port
in client_data
.get("ports"):
911 interface
['vim_info'] = yaml
.safe_dump(port
)
912 interface
["mac_address"] = port
.get("mac_address")
913 interface
["vim_net_id"] = port
["network_id"]
914 interface
["vim_interface_id"] = port
["id"]
915 interface
["ip_address"] = port
.get("ip_address")
916 if interface
["ip_address"]:
918 if interface
["ip_address"] == "0.0.0.0":
919 interface
["ip_address"] = None
920 vm
["interfaces"].append(interface
)
922 except Exception as e
:
923 self
.logger
.error("refresh_vms_and_nets. Port get %s: %s", type(e
).__name
__, str(e
))
925 if vm
['status'] == "ACTIVE" and not management_ip
:
926 vm
['status'] = "ACTIVE:NoMgmtIP"
928 except vimconn
.vimconnNotFoundException
as e
:
929 self
.logger
.error("Exception getting vm status: %s", str(e
))
930 vm
['status'] = "DELETED"
931 vm
['error_msg'] = str(e
)
932 except (requests
.exceptions
.RequestException
, js_e
.ValidationError
, vimconn
.vimconnException
) as e
:
933 self
.logger
.error("Exception getting vm status: %s", str(e
))
934 vm
['status'] = "VIM_ERROR"
935 vm
['error_msg'] = str(e
)
939 def refresh_nets_status(self
, net_list
):
940 '''Get the status of the networks
941 Params: the list of network identifiers
942 Returns a dictionary with:
943 net_id: #VIM id of this network
944 status: #Mandatory. Text with one of:
945 # DELETED (not found at vim)
946 # VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
947 # OTHER (Vim reported other status not understood)
948 # ERROR (VIM indicates an ERROR status)
949 # ACTIVE, INACTIVE, DOWN (admin down),
950 # BUILD (on building process)
952 error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR
953 vim_info: #Text with plain information obtained from vim (yaml.safe_dump)
957 self
._get
_my
_tenant
()
958 except requests
.exceptions
.RequestException
as e
:
959 self
._format
_request
_exception
(e
)
962 for net_id
in net_list
:
964 #print "VIMConnector refresh_tenant_vms_and_nets: Getting tenant network from VIM (tenant: " + str(self.tenant) + "): "
966 net_vim
= self
.get_network(net_id
)
967 if net_vim
['status'] in netStatus2manoFormat
:
968 net
["status"] = netStatus2manoFormat
[ net_vim
['status'] ]
970 net
["status"] = "OTHER"
971 net
["error_msg"] = "VIM status reported " + net_vim
['status']
973 if net
["status"] == "ACTIVE" and not net_vim
['admin_state_up']:
974 net
["status"] = "DOWN"
975 if net_vim
.get('last_error'):
976 net
['error_msg'] = net_vim
['last_error']
977 net
["vim_info"] = yaml
.safe_dump(net_vim
)
978 except vimconn
.vimconnNotFoundException
as e
:
979 self
.logger
.error("Exception getting net status: %s", str(e
))
980 net
['status'] = "DELETED"
981 net
['error_msg'] = str(e
)
982 except (requests
.exceptions
.RequestException
, js_e
.ValidationError
, vimconn
.vimconnException
) as e
:
983 self
.logger
.error("Exception getting net status: %s", str(e
))
984 net
['status'] = "VIM_ERROR"
985 net
['error_msg'] = str(e
)
986 net_dict
[net_id
] = net
989 def action_vminstance(self
, vm_id
, action_dict
):
990 '''Send and action over a VM instance from VIM'''
991 '''Returns the status'''
993 self
._get
_my
_tenant
()
994 if "console" in action_dict
:
995 raise vimconn
.vimconnException("getting console is not available at openvim", http_code
=vimconn
.HTTP_Service_Unavailable
)
996 url
= self
.url
+'/'+self
.tenant
+'/servers/'+vm_id
+"/action"
997 self
.logger
.info("Action over VM instance POST %s", url
)
998 vim_response
= requests
.post(url
, headers
= self
.headers_req
, data
=json
.dumps(action_dict
) )
999 self
._check
_http
_request
_response
(vim_response
)
1001 except (requests
.exceptions
.RequestException
, js_e
.ValidationError
) as e
:
1002 self
._format
_request
_exception
(e
)
1004 #NOT USED METHODS in current version
1006 def host_vim2gui(self
, host
, server_dict
):
1007 '''Transform host dictionary from VIM format to GUI format,
1008 and append to the server_dict
1010 if type(server_dict
) is not dict:
1011 print 'vimconnector.host_vim2gui() ERROR, param server_dict must be a dictionary'
1015 for numa
in host
['host']['numas']:
1019 RAD_item
['memory']={'size': str(numa
['memory'])+'GB', 'eligible': str(numa
['hugepages'])+'GB'}
1020 occupation_item
['memory']= str(numa
['hugepages_consumed'])+'GB'
1023 RAD_item
['cpus']['cores'] = []
1024 RAD_item
['cpus']['eligible_cores'] = []
1025 occupation_item
['cores']=[]
1026 for _
in range(0, len(numa
['cores']) / 2):
1027 RAD_item
['cpus']['cores'].append( [] )
1028 for core
in numa
['cores']:
1029 RAD_item
['cpus']['cores'][core
['core_id']].append(core
['thread_id'])
1030 if not 'status' in core
: RAD_item
['cpus']['eligible_cores'].append(core
['thread_id'])
1031 if 'instance_id' in core
: occupation_item
['cores'].append(core
['thread_id'])
1033 RAD_item
['ports']={}
1034 occupation_item
['ports']={}
1035 for iface
in numa
['interfaces']:
1036 RAD_item
['ports'][ iface
['pci'] ] = 'speed:'+str(iface
['Mbps'])+'M'
1037 occupation_item
['ports'][ iface
['pci'] ] = { 'occupied': str(100*iface
['Mbps_consumed'] / iface
['Mbps']) + "%" }
1039 RAD
[ numa
['numa_socket'] ] = RAD_item
1040 occupation
[ numa
['numa_socket'] ] = occupation_item
1041 server_dict
[ host
['host']['name'] ] = {'RAD':RAD
, 'occupation':occupation
}
1043 def get_hosts_info(self
):
1044 '''Get the information of deployed hosts
1045 Returns the hosts content'''
1047 url
=self
.url
+'/hosts'
1049 vim_response
= requests
.get(url
)
1050 except requests
.exceptions
.RequestException
, e
:
1051 print "get_hosts_info Exception: ", e
.args
1052 return -vimconn
.HTTP_Not_Found
, str(e
.args
[0])
1053 print "vim get", url
, "response:", vim_response
.status_code
, vim_response
.json()
1054 #print vim_response.status_code
1055 #print json.dumps(vim_response.json(), indent=4)
1056 if vim_response
.status_code
!= 200:
1058 print 'vimconnector.get_hosts_info error getting host list %d %s' %(vim_response
.status_code
, vim_response
.json())
1059 return -vim_response
.status_code
, "Error getting host list"
1061 res
,hosts
= self
._format
_in
(vim_response
, get_hosts_response_schema
)
1064 print "vimconnector.get_hosts_info error parsing GET HOSTS vim response", hosts
1065 return vimconn
.HTTP_Internal_Server_Error
, hosts
1066 #obtain hosts details
1068 for host
in hosts
['hosts']:
1069 url
=self
.url
+'/hosts/'+host
['id']
1071 vim_response
= requests
.get(url
)
1072 except requests
.exceptions
.RequestException
, e
:
1073 print "get_hosts_info Exception: ", e
.args
1074 return -vimconn
.HTTP_Not_Found
, str(e
.args
[0])
1075 print "vim get", url
, "response:", vim_response
.status_code
, vim_response
.json()
1076 if vim_response
.status_code
!= 200:
1077 print 'vimconnector.get_hosts_info error getting detailed host %d %s' %(vim_response
.status_code
, vim_response
.json())
1079 res
,host_detail
= self
._format
_in
(vim_response
, get_host_detail_response_schema
)
1081 print "vimconnector.get_hosts_info error parsing GET HOSTS/%s vim response" % host
['id'], host_detail
1083 #print 'host id '+host['id'], json.dumps(host_detail, indent=4)
1084 self
.host_vim2gui(host_detail
, hosts_dict
)
1085 return 200, hosts_dict
1087 def get_hosts(self
, vim_tenant
):
1088 '''Get the hosts and deployed instances
1089 Returns the hosts content'''
1091 url
=self
.url
+'/hosts'
1093 vim_response
= requests
.get(url
)
1094 except requests
.exceptions
.RequestException
, e
:
1095 print "get_hosts Exception: ", e
.args
1096 return -vimconn
.HTTP_Not_Found
, str(e
.args
[0])
1097 print "vim get", url
, "response:", vim_response
.status_code
, vim_response
.json()
1098 #print vim_response.status_code
1099 #print json.dumps(vim_response.json(), indent=4)
1100 if vim_response
.status_code
!= 200:
1102 print 'vimconnector.get_hosts error getting host list %d %s' %(vim_response
.status_code
, vim_response
.json())
1103 return -vim_response
.status_code
, "Error getting host list"
1105 res
,hosts
= self
._format
_in
(vim_response
, get_hosts_response_schema
)
1108 print "vimconnector.get_host error parsing GET HOSTS vim response", hosts
1109 return vimconn
.HTTP_Internal_Server_Error
, hosts
1110 #obtain instances from hosts
1111 for host
in hosts
['hosts']:
1112 url
=self
.url
+'/' + vim_tenant
+ '/servers?hostId='+host
['id']
1114 vim_response
= requests
.get(url
)
1115 except requests
.exceptions
.RequestException
, e
:
1116 print "get_hosts Exception: ", e
.args
1117 return -vimconn
.HTTP_Not_Found
, str(e
.args
[0])
1118 print "vim get", url
, "response:", vim_response
.status_code
, vim_response
.json()
1119 if vim_response
.status_code
!= 200:
1120 print 'vimconnector.get_hosts error getting instances at host %d %s' %(vim_response
.status_code
, vim_response
.json())
1122 res
,servers
= self
._format
_in
(vim_response
, get_server_response_schema
)
1124 print "vimconnector.get_host error parsing GET SERVERS/%s vim response" % host
['id'], servers
1126 #print 'host id '+host['id'], json.dumps(host_detail, indent=4)
1127 host
['instances'] = servers
['servers']
1128 return 200, hosts
['hosts']
1130 def get_processor_rankings(self
):
1131 '''Get the processor rankings in the VIM database'''
1132 url
=self
.url
+'/processor_ranking'
1134 vim_response
= requests
.get(url
)
1135 except requests
.exceptions
.RequestException
, e
:
1136 print "get_processor_rankings Exception: ", e
.args
1137 return -vimconn
.HTTP_Not_Found
, str(e
.args
[0])
1138 print "vim get", url
, "response:", vim_response
.status_code
, vim_response
.json()
1139 #print vim_response.status_code
1140 #print json.dumps(vim_response.json(), indent=4)
1141 if vim_response
.status_code
!= 200:
1143 print 'vimconnector.get_processor_rankings error getting processor rankings %d %s' %(vim_response
.status_code
, vim_response
.json())
1144 return -vim_response
.status_code
, "Error getting processor rankings"
1146 res
,rankings
= self
._format
_in
(vim_response
, get_processor_rankings_response_schema
)
1147 return res
, rankings
['rankings']
1149 def new_host(self
, host_data
):
1150 '''Adds a new host to VIM'''
1151 '''Returns status code of the VIM response'''
1152 payload_req
= host_data
1154 url
= self
.url_admin
+'/hosts'
1155 self
.logger
.info("Adding a new host POST %s", url
)
1156 vim_response
= requests
.post(url
, headers
= self
.headers_req
, data
=payload_req
)
1157 self
._check
_http
_request
_response
(vim_response
)
1158 self
.logger
.debug(vim_response
.text
)
1159 #print json.dumps(vim_response.json(), indent=4)
1160 response
= vim_response
.json()
1161 js_v(response
, new_host_response_schema
)
1162 r
= self
._remove
_extra
_items
(response
, new_host_response_schema
)
1164 self
.logger
.warn("Warning: remove extra items %s", str(r
))
1165 host_id
= response
['host']['id']
1167 except (requests
.exceptions
.RequestException
, js_e
.ValidationError
) as e
:
1168 self
._format
_request
_exception
(e
)
1170 def new_external_port(self
, port_data
):
1171 '''Adds a external port to VIM'''
1172 '''Returns the port identifier'''
1173 #TODO change to logging exception code policies
1174 print "VIMConnector: Adding a new external port"
1175 payload_req
= port_data
1177 vim_response
= requests
.post(self
.url_admin
+'/ports', headers
= self
.headers_req
, data
=payload_req
)
1178 except requests
.exceptions
.RequestException
, e
:
1179 self
.logger
.error("new_external_port Exception: ", str(e
))
1180 return -vimconn
.HTTP_Not_Found
, str(e
.args
[0])
1182 #print vim_response.status_code
1183 if vim_response
.status_code
== 200:
1184 #print vim_response.json()
1185 #print json.dumps(vim_response.json(), indent=4)
1186 res
, http_content
= self
._format
_in
(vim_response
, new_port_response_schema
)
1189 r
= self
._remove
_extra
_items
(http_content
, new_port_response_schema
)
1190 if r
is not None: print "Warning: remove extra items ", r
1192 port_id
= http_content
['port']['id']
1193 print "Port id: ",port_id
1194 return vim_response
.status_code
,port_id
1195 else: return -vimconn
.HTTP_Bad_Request
,http_content
1197 #print vim_response.text
1198 jsonerror
= self
._format
_jsonerror
(vim_response
)
1199 text
= 'Error in VIM "%s": not possible to add new external port. HTTP Response: %d. Error: %s' % (self
.url_admin
, vim_response
.status_code
, jsonerror
)
1201 return -vim_response
.status_code
,text
1203 def new_external_network(self
,net_name
,net_type
):
1204 '''Adds a external network to VIM (shared)'''
1205 '''Returns the network identifier'''
1206 #TODO change to logging exception code policies
1207 print "VIMConnector: Adding external shared network to VIM (type " + net_type
+ "): "+ net_name
1209 payload_req
= '{"network":{"name": "' + net_name
+ '","shared":true,"type": "' + net_type
+ '"}}'
1211 vim_response
= requests
.post(self
.url
+'/networks', headers
= self
.headers_req
, data
=payload_req
)
1212 except requests
.exceptions
.RequestException
, e
:
1213 self
.logger
.error( "new_external_network Exception: ", e
.args
)
1214 return -vimconn
.HTTP_Not_Found
, str(e
.args
[0])
1216 #print vim_response.status_code
1217 if vim_response
.status_code
== 200:
1218 #print vim_response.json()
1219 #print json.dumps(vim_response.json(), indent=4)
1220 res
,http_content
= self
._format
_in
(vim_response
, new_network_response_schema
)
1223 r
= self
._remove
_extra
_items
(http_content
, new_network_response_schema
)
1224 if r
is not None: print "Warning: remove extra items ", r
1226 network_id
= http_content
['network']['id']
1227 print "Network id: ",network_id
1228 return vim_response
.status_code
,network_id
1229 else: return -vimconn
.HTTP_Bad_Request
,http_content
1231 #print vim_response.text
1232 jsonerror
= self
._format
_jsonerror
(vim_response
)
1233 text
= 'Error in VIM "%s": not possible to add new external network. HTTP Response: %d. Error: %s' % (self
.url
, vim_response
.status_code
, jsonerror
)
1235 return -vim_response
.status_code
,text
1237 def connect_port_network(self
, port_id
, network_id
, admin
=False):
1238 '''Connects a external port to a network'''
1239 '''Returns status code of the VIM response'''
1240 #TODO change to logging exception code policies
1241 print "VIMConnector: Connecting external port to network"
1243 payload_req
= '{"port":{"network_id":"' + network_id
+ '"}}'
1245 if self
.url_admin
==None:
1246 return -vimconn
.HTTP_Unauthorized
, "datacenter cannot contain admin URL"
1251 vim_response
= requests
.put(url
+'/ports/'+port_id
, headers
= self
.headers_req
, data
=payload_req
)
1252 except requests
.exceptions
.RequestException
, e
:
1253 print "connect_port_network Exception: ", e
.args
1254 return -vimconn
.HTTP_Not_Found
, str(e
.args
[0])
1256 #print vim_response.status_code
1257 if vim_response
.status_code
== 200:
1258 #print vim_response.json()
1259 #print json.dumps(vim_response.json(), indent=4)
1260 res
,http_content
= self
._format
_in
(vim_response
, new_port_response_schema
)
1263 r
= self
._remove
_extra
_items
(http_content
, new_port_response_schema
)
1264 if r
is not None: print "Warning: remove extra items ", r
1266 port_id
= http_content
['port']['id']
1267 print "Port id: ",port_id
1268 return vim_response
.status_code
,port_id
1269 else: return -vimconn
.HTTP_Bad_Request
,http_content
1271 print vim_response
.text
1272 jsonerror
= self
._format
_jsonerror
(vim_response
)
1273 text
= 'Error in VIM "%s": not possible to connect external port to network. HTTP Response: %d. Error: %s' % (self
.url_admin
, vim_response
.status_code
, jsonerror
)
1275 return -vim_response
.status_code
,text