X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=plugins%2FvRealiseOps%2Fmon_plugin_vrops.py;h=6ca3d40e6a040a38a539c669f8e826effbfc4be8;hb=HEAD;hp=a65d01ca1a892d44055fe76ab9ccc322a2ff9138;hpb=357945916f48f24887db89791ef4551610de59c2;p=osm%2FMON.git diff --git a/plugins/vRealiseOps/mon_plugin_vrops.py b/plugins/vRealiseOps/mon_plugin_vrops.py deleted file mode 100644 index a65d01c..0000000 --- a/plugins/vRealiseOps/mon_plugin_vrops.py +++ /dev/null @@ -1,580 +0,0 @@ -# -*- coding: utf-8 -*- -""" -Montoring metrics & creating Alarm definations in vROPs -""" - -import requests -import logging as log -from pyvcloud.vcloudair import VCA -from xml.etree import ElementTree as XmlElementTree -import traceback - -OPERATION_MAPPING = {'GE':'GT_EQ', 'LE':'LT_EQ', 'GT':'GT', 'LT':'LT', 'EQ':'EQ'} -SEVERITY_MAPPING = {'WARNING':'WARNING', 'MINOR':'WARNING', 'MAJOR':"IMMEDIATE", 'CRITICAL':'CRITICAL'} - - -class MonPlugin(): - """MON Plugin class for vROPs telemetry plugin - """ - def __init__(self, access_config={}): - """Constructor of MON plugin - Params: - 'access_config': dictionary with VIM access information based on VIM type. - This contains a consolidate version of VIM & monitoring tool config at creation and - particular VIM config at their attachment. - For VIM type: 'vmware', access_config - {'vrops_site':<>, 'vrops_user':<>, 'vrops_password':<>, - 'vcloud-site':<>,'admin_username':<>,'admin_password':<>, - 'nsx_manager':<>,'nsx_user':<>,'nsx_password':<>, - 'vcenter_ip':<>,'vcenter_port':<>,'vcenter_user':<>,'vcenter_password':<>, - 'vim_tenant_name':<>,'orgname':<>} - - #To Do - Returns: Raise an exception if some needed parameter is missing, but it must not do any connectivity - check against the VIM - """ - self.access_config = access_config - self.vrops_site = access_config['vrops_site'] - self.vrops_user = access_config['vrops_user'] - self.vrops_password = access_config['vrops_password'] - self.vcloud_site = access_config['vcloud_site'] - self.vcloud_username = access_config['vcloud_username'] - self.vcloud_password = access_config['vcloud_password'] - - def configure_alarm(self, config_dict = {}): - """Configures or creates a new alarm using the input parameters in config_dict - Params: - "alarm_name": Alarm name in string format - "description": Description of alarm in string format - "resource_uuid": Resource UUID for which alarm needs to be configured. in string format - "Resource type": String resource type: 'VDU' or 'host' - "Severity": 'WARNING', 'MINOR', 'MAJOR', 'CRITICAL' - "metric": Metric key in string format - "operation": One of ('GE', 'LE', 'GT', 'LT', 'EQ') - "threshold_value": Defines the threshold (up to 2 fraction digits) that, if crossed, will trigger the alarm. - "unit": Unit of measurement in string format - "statistic": AVERAGE, MINIMUM, MAXIMUM, COUNT, SUM - - Default parameters for each alarm are read from the plugin specific config file. - Dict of default parameters is as follows: - default_params keys = {'cancel_cycles','wait_cycles','resource_kind','adapter_kind','alarm_type','alarm_subType',impact} - - Returns the UUID of created alarm or None - """ - alarm_def_uuid = None - #1) get alarm & metrics parameters from plugin specific file - def_params = self.get_default_Params(config_dict['alarm_name']) - metric_key_params = self.get_default_Params(config_dict['metric']) - #2) create symptom definition - #TO DO - 'metric_key':config_dict['metric'] - mapping from file def_params - symptom_params ={'cancel_cycles': (def_params['cancel_period']/300)*def_params['cancel_cycles'], - 'wait_cycles': (def_params['period']/300)*def_params['evaluation'], - 'resource_kind_key': def_params['resource_kind'],'adapter_kind_key': def_params['adapter_kind'], - 'symptom_name':config_dict['alarm_name'],'severity': SEVERITY_MAPPING[config_dict['severity']], - 'metric_key':metric_key_params['metric_key'],'operation':OPERATION_MAPPING[config_dict['operation']], - 'threshold_value':config_dict['threshold_value']} - symptom_uuid = self.create_symptom(symptom_params) - if symptom_uuid is not None: - log.info("Symptom defined: {} with ID: {}".format(symptom_params['symptom_name'],symptom_uuid)) - else: - log.warn("Failed to create Symptom: {}".format(symptom_params['symptom_name'])) - return None - #3) create alert definition - #To Do - Get type & subtypes for all 5 alarms - alarm_params = {'name':config_dict['alarm_name'], - 'description':config_dict['description'] if config_dict['description'] is not None else config_dict['alarm_name'], - 'adapterKindKey':def_params['adapter_kind'], 'resourceKindKey':def_params['resource_kind'], - 'waitCycles':1, 'cancelCycles':1, - 'type':def_params['alarm_type'], 'subType':def_params['alarm_subType'], - 'severity':SEVERITY_MAPPING[config_dict['severity']], - 'symptomDefinitionId':symptom_uuid, - 'impact':def_params['impact']} - - alarm_def_uuid = self.create_alarm_definition(alarm_params) - if alarm_def_uuid is None: - log.warn("Failed to create Alert: {}".format(alarm_params['name'])) - return None - - log.info("Alarm defined: {} with ID: {}".format(alarm_params['name'],alarm_def_uuid)) - - #4) Find vm_moref_id from vApp uuid in vCD - vm_moref_id = self.get_vm_moref_id(config_dict['resource_uuid']) - if vm_moref_id is None: - log.warn("Failed to find vm morefid for vApp in vCD: {}".format(config_dict['resource_uuid'])) - return None - - #5) Based on vm_moref_id, find VM's corresponding resource_id in vROPs to set notification - resource_id = self.get_vm_resource_id(vm_moref_id) - if resource_id is None: - log.warn("Failed to find resource in vROPs: {}".format(config_dict['resource_uuid'])) - return None - - #6) Configure alarm notification for a particular VM using it's resource_id - notification_id = self.create_alarm_notification(config_dict['alarm_name'], alarm_def_uuid, resource_id) - if notification_id is None: - return None - else: - log.info("Alarm defination created with notification: {} with ID: {}".format(alarm_params['name'],alarm_def_uuid)) - return alarm_def_uuid - - def get_default_Params(self, metric_alarm_name): - """ - Read the default config parameters from plugin specific file stored with plugin file. - Params: - metric_alarm_name: Name of the alarm, whose congif params to be read from the config file. - """ - tree = XmlElementTree.parse('vROPs_default_config.xml') - alarms = tree.getroot() - a_params = {} - for alarm in alarms: - if alarm.tag == metric_alarm_name: - for param in alarm: - if param.tag in ("period", "evaluation", "cancel_period", "alarm_type", "cancel_cycles", "alarm_subType"): - a_params[param.tag] = int(param.text) - elif param.tag in ("enabled", "repeat"): - if(param.text == "True" or param.text == "true"): - a_params[param.tag] = True - else: - a_params[param.tag] = False - else: - a_params[param.tag] = param.text - - if not a_params: - log.warn("No such '{}' alarm found!.".format(alarm)) - - return a_params - - - def create_symptom(self, symptom_params): - """Create Symptom definition for an alarm - Params: - symptom_params: Dict of parameters required for defining a symptom as follows - cancel_cycles - wait_cycles - resource_kind_key = "VirtualMachine" - adapter_kind_key = "VMWARE" - symptom_name = Test_Memory_Usage_TooHigh - severity - metric_key - operation = GT_EQ - threshold_value = 85 - Returns the uuid of Symptom definition - """ - symptom_id = None - - try: - api_url = '/suite-api/api/symptomdefinitions' - headers = {'Content-Type': 'application/xml'} - data = """ - - {4:s} - - - {6:s} - {7:s} - {8:s} - NUMERIC - false - STATIC - - - """.format(str(symptom_params['cancel_cycles']),str(symptom_params['wait_cycles']),symptom_params['resource_kind_key'], - symptom_params['adapter_kind_key'],symptom_params['symptom_name'],symptom_params['severity'], - symptom_params['metric_key'],symptom_params['operation'],str(symptom_params['threshold_value'])) - - resp = requests.post(self.vrops_site + api_url, - auth=(self.vrops_user, self.vrops_password), - headers=headers, - verify = False, - data=data) - - if resp.status_code != 201: - log.warn("Failed to create Symptom definition: {}, response {}".format(symptom_params['symptom_name'], resp.content)) - return None - - symptom_xmlroot = XmlElementTree.fromstring(resp.content) - if symptom_xmlroot is not None and 'id' in symptom_xmlroot.attrib: - symptom_id = symptom_xmlroot.attrib['id'] - - return symptom_id - - except Exception as exp: - log.warn("Error creating symptom definition : {}\n{}".format(exp, traceback.format_exc())) - - - def create_alarm_definition(self, alarm_params): - """ - Create an alarm definition in vROPs - Params: - 'name': Alarm Name, - 'description':Alarm description, - 'adapterKindKey': Adapter type in vROPs "VMWARE", - 'resourceKindKey':Resource type in vROPs "VirtualMachine", - 'waitCycles': No of wait cycles, - 'cancelCycles': No of cancel cycles, - 'type': Alarm type: , - 'subType': Alarm subtype: , - 'severity': Severity in vROPs "CRITICAL", - 'symptomDefinitionId':symptom Definition uuid, - 'impact': impact 'risk' - Returns: - 'alarm_uuid': returns alarm uuid - """ - - alarm_uuid = None - - try: - api_url = '/suite-api/api/alertdefinitions' - headers = {'Content-Type': 'application/xml'} - data = """ - - {0:s} - {1:s} - {2:s} - {3:s} - 1 - 1 - {4:s} - {5:s} - - - - - {7:s} - - SELF - ALL - AND - - - BADGE - {8:s} - - - - """.format(alarm_params['name'],alarm_params['description'],alarm_params['adapterKindKey'], - alarm_params['resourceKindKey'],str(alarm_params['type']),str(alarm_params['subType']), - alarm_params['severity'],alarm_params['symptomDefinitionId'],alarm_params['impact']) - - resp = requests.post(self.vrops_site + api_url, - auth=(self.vrops_user, self.vrops_password), - headers=headers, - verify = False, - data=data) - - if resp.status_code != 201: - log.warn("Failed to create Alarm definition: {}, response {}".format(alarm_params['name'], resp.content)) - return None - - alarm_xmlroot = XmlElementTree.fromstring(resp.content) - for child in alarm_xmlroot: - if child.tag.split("}")[1] == 'id': - alarm_uuid = child.text - - return alarm_uuid - - except Exception as exp: - log.warn("Error creating alarm definition : {}\n{}".format(exp, traceback.format_exc())) - - - def configure_rest_plugin(self, plugin_name, webhook_url, certificate): - """ - Creates REST Plug-in for vROPs outbound alerts - - Params: - plugin_name: name of REST plugin instance - pluginTypeId - RestPlugin - Optional configValues - "Url">https://dev14136.service-now.com:8080 - reqd - "Username">admin - optional - "Password">VMware1! - optional - "Content-type">application/xml - reqd - "Certificate">abcdefgh123456 - get n set - "ConnectionCount" - 20 - default - """ - plugin_id = None - - api_url = '/suite-api/api/alertplugins' - headers = {'Content-Type': 'application/xml'} - data = """ - - RestPlugin - {0:s} - - {1:s} - application/xml - {2:s} - 20 - - """.format(plugin_name, webhook_url, certificate) - - resp = requests.post(self.vrops_site + api_url, - auth=(self.vrops_user, self.vrops_password), - headers=headers, - verify = False, - data=data) - - if resp.status_code is not 201: - log.warn("Failed to create REST Plugin: {} for url: {}, \nresponse code: {},\nresponse content: {}"\ - .format(plugin_name, webhook_url, resp.status_code, resp.content)) - return None - - plugin_xmlroot = XmlElementTree.fromstring(resp.content) - if plugin_xmlroot is not None: - for child in plugin_xmlroot: - if child.tag.split("}")[1] == 'pluginId': - plugin_id = plugin_xmlroot.find('{http://webservice.vmware.com/vRealizeOpsMgr/1.0/}pluginId').text - - if plugin_id is None: - log.warn("Failed to get REST Plugin ID for {}, url: {}".format(plugin_name, webhook_url)) - return None - else: - log.info("Created REST Plugin: {} with ID : {} for url: {}".format(plugin_name, plugin_id, webhook_url)) - status = self.enable_rest_plugin(plugin_id, plugin_name) - if status is False: - log.warn("Failed to enable created REST Plugin: {} for url: {}".format(plugin_name, webhook_url)) - return None - else: - log.info("Enabled REST Plugin: {} for url: {}".format(plugin_name, webhook_url)) - return plugin_id - - - def enable_rest_plugin(self, plugin_id, plugin_name): - """ - Enable the REST plugin using plugin_id - Params: plugin_id: plugin ID string that is to be enabled - Returns: status (Boolean) - True for success, False for failure - """ - - if plugin_id is None or plugin_name is None: - log.debug("enable_rest_plugin() : Plugin ID or plugin_name not provided for {} plugin".format(plugin_name)) - return False - - try: - api_url = "/suite-api/api/alertplugins/{}/enable/True".format(plugin_id) - - resp = requests.put(self.vrops_site + api_url, auth=(self.vrops_user, self.vrops_password), verify = False) - - if resp.status_code is not 204: - log.warn("Failed to enable REST plugin {}. \nResponse code {}\nResponse Content: {}"\ - .format(plugin_name, resp.status_code, resp.content)) - return False - - log.info("Enabled REST plugin {}.".format(plugin_name)) - return True - - except Exception as exp: - log.warn("Error enabling REST plugin for {} plugin: Exception: {}\n{}".format(plugin_name, exp, traceback.format_exc())) - - def create_alarm_notification(self, alarm_name, alarm_id, resource_id): - """ - Create notification for each alarm - Params: - alarm_name - alarm_id - resource_id - - Returns: - notification_id: notification_id or None - """ - notification_name = 'notify_' + alarm_name - notification_id = None - - #1) Find the REST Plugin id details for - MON_module_REST_Plugin - api_url = '/suite-api/api/alertplugins' - headers = {'Accept': 'application/xml'} - namespace = {'params':"http://webservice.vmware.com/vRealizeOpsMgr/1.0/"} - - resp = requests.get(self.vrops_site + api_url, - auth=(self.vrops_user, self.vrops_password), - verify = False, headers = headers) - - if resp.status_code is not 200: - log.warn("Failed to REST GET Alarm plugin details \nResponse code: {}\nResponse content: {}"\ - .format(resp.status_code, resp.content)) - return None - - # Look for specific plugin & parse pluginId for 'MON_module_REST_Plugin' - xmlroot_resp = XmlElementTree.fromstring(resp.content) - for notify_plugin in xmlroot_resp.findall('params:notification-plugin',namespace): - if notify_plugin.find('params:name',namespace) is not None and notify_plugin.find('params:pluginId',namespace) is not None: - if notify_plugin.find('params:name',namespace).text == 'MON_module_REST_Plugin': - plugin_id = notify_plugin.find('params:pluginId',namespace).text - - if plugin_id is None: - log.warn("Failed to get REST plugin_id for : {}".format('MON_module_REST_Plugin')) - return None - - #2) Create Alarm notification rule - api_url = '/suite-api/api/notifications/rules' - headers = {'Content-Type': 'application/xml'} - data = """ - - {0:s} - {1:s} - - true - - - {3:s} - - """.format(notification_name, plugin_id, resource_id, alarm_id) - - resp = requests.post(self.vrops_site + api_url, - auth=(self.vrops_user, self.vrops_password), - headers=headers, - verify = False, - data=data) - - if resp.status_code is not 201: - log.warn("Failed to create Alarm notification {} for {} alarm. \nResponse code: {}\nResponse content: {}"\ - .format(notification_name, alarm_name, resp.status_code, resp.content)) - return None - - #parse notification id from response - xmlroot_resp = XmlElementTree.fromstring(resp.content) - if xmlroot_resp is not None and 'id' in xmlroot_resp.attrib: - notification_id = xmlroot_resp.attrib.get('id') - - log.info("Created Alarm notification rule {} for {} alarm.".format(notification_name, alarm_name)) - return notification_id - - def get_vm_moref_id(self, vapp_uuid): - """ - Get the moref_id of given VM - """ - try: - if vapp_uuid: - vm_details = self.get_vapp_details_rest(vapp_uuid) - if vm_details and "vm_vcenter_info" in vm_details: - vm_moref_id = vm_details["vm_vcenter_info"].get("vm_moref_id", None) - - log.info("Found vm_moref_id: {} for vApp UUID: {}".format(vm_moref_id, vapp_uuid)) - return vm_moref_id - - except Exception as exp: - log.warn("Error occurred while getting VM moref ID for VM : {}\n{}".format(exp, traceback.format_exc())) - - - def get_vapp_details_rest(self, vapp_uuid=None): - """ - Method retrieve vapp detail from vCloud director - - Args: - vapp_uuid - is vapp identifier. - - Returns: - Returns VM MOref ID or return None - """ - - parsed_respond = {} - vca = None - - vca = self.connect_as_admin() - - if not vca: - log.warn("connect() to vCD is failed") - if vapp_uuid is None: - return None - - url_list = [vca.host, '/api/vApp/vapp-', vapp_uuid] - get_vapp_restcall = ''.join(url_list) - - if vca.vcloud_session and vca.vcloud_session.organization: - response = requests.get(get_vapp_restcall, - headers=vca.vcloud_session.get_vcloud_headers(), - verify=vca.verify) - - if response.status_code != 200: - log.warn("REST API call {} failed. Return status code {}".format(get_vapp_restcall, response.content)) - return parsed_respond - - try: - xmlroot_respond = XmlElementTree.fromstring(response.content) - - namespaces = {'vm': 'http://www.vmware.com/vcloud/v1.5', - "vmext":"http://www.vmware.com/vcloud/extension/v1.5", - "xmlns":"http://www.vmware.com/vcloud/v1.5" - } - - # parse children section for other attrib - children_section = xmlroot_respond.find('vm:Children/', namespaces) - if children_section is not None: - vCloud_extension_section = children_section.find('xmlns:VCloudExtension', namespaces) - if vCloud_extension_section is not None: - vm_vcenter_info = {} - vim_info = vCloud_extension_section.find('vmext:VmVimInfo', namespaces) - vmext = vim_info.find('vmext:VmVimObjectRef', namespaces) - if vmext is not None: - vm_vcenter_info["vm_moref_id"] = vmext.find('vmext:MoRef', namespaces).text - parsed_respond["vm_vcenter_info"]= vm_vcenter_info - - except Exception as exp : - log.warn("Error occurred calling rest api for getting vApp details: {}\n{}".format(exp, traceback.format_exc())) - - return parsed_respond - - - def connect_as_admin(self): - """ Method connect as pvdc admin user to vCloud director. - There are certain action that can be done only by provider vdc admin user. - Organization creation / provider network creation etc. - - Returns: - The return vca object that letter can be used to connect to vcloud direct as admin for provider vdc - """ - - log.info("Logging in to a VCD org as admin.") - - vca_admin = VCA(host=self.vcloud_site, - username=self.vcloud_username, - service_type='standalone', - version='5.9', - verify=False, - log=False) - result = vca_admin.login(password=self.vcloud_password, org='System') - if not result: - log.warn("Can't connect to a vCloud director as: {}".format(self.vcloud_username)) - result = vca_admin.login(token=vca_admin.token, org='System', org_url=vca_admin.vcloud_session.org_url) - if result is True: - log.info("Successfully logged to a vcloud direct org: {} as user: {}".format('System', self.vcloud_username)) - - return vca_admin - - - def get_vm_resource_id(self, vm_moref_id): - """ Find resource ID in vROPs using vm_moref_id - """ - if vm_moref_id is None: - return None - - api_url = '/suite-api/api/resources' - headers = {'Accept': 'application/xml'} - namespace = {'params':"http://webservice.vmware.com/vRealizeOpsMgr/1.0/"} - - resp = requests.get(self.vrops_site + api_url, - auth=(self.vrops_user, self.vrops_password), - verify = False, headers = headers) - - if resp.status_code is not 200: - log.warn("Failed to get resource details from vROPs for {}\nResponse code:{}\nResponse Content: {}"\ - .format(vm_moref_id, resp.status_code, resp.content)) - return None - - try: - xmlroot_respond = XmlElementTree.fromstring(resp.content) - for resource in xmlroot_respond.findall('params:resource',namespace): - if resource is not None: - resource_key = resource.find('params:resourceKey',namespace) - if resource_key is not None: - if resource_key.find('params:adapterKindKey',namespace).text == 'VMWARE' and \ - resource_key.find('params:resourceKindKey',namespace).text == 'VirtualMachine': - for child in resource_key: - if child.tag.split('}')[1]=='resourceIdentifiers': - resourceIdentifiers = child - for r_id in resourceIdentifiers: - if r_id.find('params:value',namespace).text == vm_moref_id: - log.info("Found Resource ID : {} in vROPs for {}".format(resource.attrib['identifier'], vm_moref_id)) - return resource.attrib['identifier'] - except Exception as exp: - log.warn("Error in parsing {}\n{}".format(exp, traceback.format_exc())) -