#!/usr/bin/env python # -*- coding: utf-8 -*- # Copyright (c) 2021, Cisco Systems # GNU General Public License v3.0+ (see LICENSE or # https://www.gnu.org/licenses/gpl-3.0.txt) from __future__ import (absolute_import, division, print_function) __metaclass__ = type from ansible.plugins.action import ActionBase try: from ansible_collections.ansible.utils.plugins.module_utils.common.argspec_validate import ( AnsibleArgSpecValidator, ) except ImportError: ANSIBLE_UTILS_IS_INSTALLED = False else: ANSIBLE_UTILS_IS_INSTALLED = True from ansible.errors import AnsibleActionFail from ansible_collections.cisco.meraki.plugins.plugin_utils.meraki import ( MERAKI, meraki_argument_spec, meraki_compare_equality2, get_dict_result, ) from ansible_collections.cisco.meraki.plugins.plugin_utils.exceptions import ( InconsistentParameters, ) # Get common arguments specification argument_spec = meraki_argument_spec() # Add arguments specific for this module argument_spec.update(dict( state=dict(type="str", default="present", choices=["present", "absent"]), copyFromNetworkId=dict(type="str"), name=dict(type="str"), notes=dict(type="str"), productTypes=dict(type="list"), tags=dict(type="list"), timeZone=dict(type="str"), organizationId=dict(type="str"), networkId=dict(type="str"), enrollmentString=dict(type="str"), )) required_if = [ ("state", "present", ["name", "networkId", "organizationId"], True), ("state", "absent", ["name", "networkId", "organizationId"], True), ] required_one_of = [] mutually_exclusive = [] required_together = [] class Networks(object): def __init__(self, params, meraki): self.meraki = meraki self.new_object = dict( copyFromNetworkId=params.get("copyFromNetworkId"), name=params.get("name"), notes=params.get("notes"), productTypes=params.get("productTypes"), tags=params.get("tags"), timeZone=params.get("timeZone"), organizationId=params.get("organizationId"), networkId=params.get("networkId"), enrollmentString=params.get("enrollmentString"), ) def get_all_params(self, name=None, id=None): new_object_params = {} if self.new_object.get('configTemplateId') is not None or self.new_object.get('config_template_id') is not None: new_object_params['configTemplateId'] = self.new_object.get('configTemplateId') or \ self.new_object.get('config_template_id') if self.new_object.get('isBoundToConfigTemplate') is not None or self.new_object.get('is_bound_to_config_template') is not None: new_object_params['isBoundToConfigTemplate'] = self.new_object.get('isBoundToConfigTemplate') or \ self.new_object.get('is_bound_to_config_template') if self.new_object.get('tags') is not None or self.new_object.get('tags') is not None: new_object_params['tags'] = self.new_object.get('tags') if self.new_object.get('tagsFilterType') is not None or self.new_object.get('tags_filter_type') is not None: new_object_params['tagsFilterType'] = self.new_object.get('tagsFilterType') or \ self.new_object.get('tags_filter_type') if self.new_object.get('perPage') is not None or self.new_object.get('per_page') is not None: new_object_params['perPage'] = self.new_object.get('perPage') or \ self.new_object.get('per_page') new_object_params['total_pages'] = -1 if self.new_object.get('startingAfter') is not None or self.new_object.get('starting_after') is not None: new_object_params['startingAfter'] = self.new_object.get('startingAfter') or \ self.new_object.get('starting_after') if self.new_object.get('endingBefore') is not None or self.new_object.get('ending_before') is not None: new_object_params['endingBefore'] = self.new_object.get('endingBefore') or \ self.new_object.get('ending_before') if self.new_object.get('organizationId') is not None or self.new_object.get('organization_id') is not None: new_object_params['organizationId'] = self.new_object.get('organizationId') or \ self.new_object.get('organization_id') return new_object_params def get_params_by_id(self, name=None, id=None): new_object_params = {} if self.new_object.get('networkId') is not None or self.new_object.get('network_id') is not None: new_object_params['networkId'] = self.new_object.get('networkId') or \ self.new_object.get('network_id') return new_object_params def create_params(self): new_object_params = {} if self.new_object.get('copyFromNetworkId') is not None or self.new_object.get('copy_from_network_id') is not None: new_object_params['copyFromNetworkId'] = self.new_object.get('copyFromNetworkId') or \ self.new_object.get('copy_from_network_id') if self.new_object.get('name') is not None or self.new_object.get('name') is not None: new_object_params['name'] = self.new_object.get('name') or \ self.new_object.get('name') if self.new_object.get('notes') is not None or self.new_object.get('notes') is not None: new_object_params['notes'] = self.new_object.get('notes') or \ self.new_object.get('notes') if self.new_object.get('productTypes') is not None or self.new_object.get('product_types') is not None: new_object_params['productTypes'] = self.new_object.get('productTypes') or \ self.new_object.get('product_types') if self.new_object.get('tags') is not None or self.new_object.get('tags') is not None: new_object_params['tags'] = self.new_object.get('tags') or \ self.new_object.get('tags') if self.new_object.get('timeZone') is not None or self.new_object.get('time_zone') is not None: new_object_params['timeZone'] = self.new_object.get('timeZone') or \ self.new_object.get('time_zone') if self.new_object.get('organizationId') is not None or self.new_object.get('organization_id') is not None: new_object_params['organizationId'] = self.new_object.get('organizationId') or \ self.new_object.get('organization_id') return new_object_params def delete_by_id_params(self): new_object_params = {} if self.new_object.get('networkId') is not None or self.new_object.get('network_id') is not None: new_object_params['networkId'] = self.new_object.get('networkId') or \ self.new_object.get('network_id') return new_object_params def update_by_id_params(self): new_object_params = {} if self.new_object.get('enrollmentString') is not None or self.new_object.get('enrollment_string') is not None: new_object_params['enrollmentString'] = self.new_object.get('enrollmentString') or \ self.new_object.get('enrollment_string') if self.new_object.get('name') is not None or self.new_object.get('name') is not None: new_object_params['name'] = self.new_object.get('name') or \ self.new_object.get('name') if self.new_object.get('notes') is not None or self.new_object.get('notes') is not None: new_object_params['notes'] = self.new_object.get('notes') or \ self.new_object.get('notes') if self.new_object.get('tags') is not None or self.new_object.get('tags') is not None: new_object_params['tags'] = self.new_object.get('tags') or \ self.new_object.get('tags') if self.new_object.get('timeZone') is not None or self.new_object.get('time_zone') is not None: new_object_params['timeZone'] = self.new_object.get('timeZone') or \ self.new_object.get('time_zone') if self.new_object.get('networkId') is not None or self.new_object.get('network_id') is not None: new_object_params['networkId'] = self.new_object.get('networkId') or \ self.new_object.get('network_id') return new_object_params def get_object_by_name(self, name): result = None # NOTE: Does not have a get by name method or it is in another action try: items = self.meraki.exec_meraki( family="organizations", function="getOrganizationNetworks", params=self.get_all_params(name=name), ) if isinstance(items, dict): if 'response' in items: items = items.get('response') result = get_dict_result(items, 'name', name) if result is None: result = items except Exception as e: print("Error: ", e) result = None return result def get_object_by_id(self, id): result = None try: items = self.meraki.exec_meraki( family="networks", function="getNetwork", params=self.get_params_by_id() ) if isinstance(items, dict): if 'response' in items: items = items.get('response') result = get_dict_result(items, 'networkId', id) except Exception as e: print("Error: ", e) result = None return result def exists(self): id_exists = False name_exists = False prev_obj = None o_id = self.new_object.get("id") o_id = o_id or self.new_object.get( "network_id") or self.new_object.get("networkId") name = self.new_object.get("name") if o_id: prev_obj = self.get_object_by_id(o_id) id_exists = prev_obj is not None and isinstance(prev_obj, dict) if not id_exists and name: prev_obj = self.get_object_by_name(name) name_exists = prev_obj is not None and isinstance(prev_obj, dict) if name_exists: _id = prev_obj.get("id") _id = _id or prev_obj.get("networkId") if id_exists and name_exists and o_id != _id: raise InconsistentParameters( "The 'id' and 'name' params don't refer to the same object") if _id: self.new_object.update(dict(id=_id)) self.new_object.update(dict(networkId=_id)) if _id: prev_obj = self.get_object_by_id(_id) it_exists = prev_obj is not None and isinstance(prev_obj, dict) return (it_exists, prev_obj) def requires_update(self, current_obj): requested_obj = self.new_object obj_params = [ ("copyFromNetworkId", "copyFromNetworkId"), ("name", "name"), ("notes", "notes"), ("productTypes", "productTypes"), ("tags", "tags"), ("timeZone", "timeZone"), ("organizationId", "organizationId"), ("networkId", "networkId"), ("enrollmentString", "enrollmentString"), ] # Method 1. Params present in request (Ansible) obj are the same as the current (DNAC) params # If any does not have eq params, it requires update return any(not meraki_compare_equality2(current_obj.get(meraki_param), requested_obj.get(ansible_param)) for (meraki_param, ansible_param) in obj_params) def create(self): result = self.meraki.exec_meraki( family="organizations", function="createOrganizationNetwork", params=self.create_params(), op_modifies=True, ) return result def update(self): id = self.new_object.get("id") id = id or self.new_object.get("networkId") name = self.new_object.get("name") result = None if not id: prev_obj_name = self.get_object_by_name(name) id_ = None if prev_obj_name: id_ = prev_obj_name.get("id") id_ = id_ or prev_obj_name.get("networkId") if id_: self.new_object.update(dict(networkId=id_)) result = self.meraki.exec_meraki( family="networks", function="updateNetwork", params=self.update_by_id_params(), op_modifies=True, ) return result def delete(self): id = self.new_object.get("id") id = id or self.new_object.get("networkId") name = self.new_object.get("name") result = None if not id: prev_obj_name = self.get_object_by_name(name) id_ = None if prev_obj_name: id_ = prev_obj_name.get("id") id_ = id_ or prev_obj_name.get("networkId") if id_: self.new_object.update(dict(networkId=id_)) result = self.meraki.exec_meraki( family="networks", function="deleteNetwork", params=self.delete_by_id_params(), ) return result class ActionModule(ActionBase): def __init__(self, *args, **kwargs): if not ANSIBLE_UTILS_IS_INSTALLED: raise AnsibleActionFail( "ansible.utils is not installed. Execute 'ansible-galaxy collection install ansible.utils'") super(ActionModule, self).__init__(*args, **kwargs) self._supports_async = False self._supports_check_mode = False self._result = None # Checks the supplied parameters against the argument spec for this module def _check_argspec(self): aav = AnsibleArgSpecValidator( data=self._task.args, schema=dict(argument_spec=argument_spec), schema_format="argspec", schema_conditionals=dict( required_if=required_if, required_one_of=required_one_of, mutually_exclusive=mutually_exclusive, required_together=required_together, ), name=self._task.action, ) valid, errors, self._task.args = aav.validate() if not valid: raise AnsibleActionFail(errors) def run(self, tmp=None, task_vars=None): self._task.diff = False self._result = super(ActionModule, self).run(tmp, task_vars) self._result["changed"] = False self._check_argspec() meraki = MERAKI(self._task.args) obj = Networks(self._task.args, meraki) state = self._task.args.get("state") response = None if state == "present": (obj_exists, prev_obj) = obj.exists() if obj_exists: if obj.requires_update(prev_obj): response = obj.update() meraki.object_updated() else: response = prev_obj meraki.object_already_present() else: response = obj.create() meraki.object_created() elif state == "absent": (obj_exists, prev_obj) = obj.exists() if obj_exists: response = obj.delete() meraki.object_deleted() else: meraki.object_already_absent() self._result.update(dict(meraki_response=response)) self._result.update(meraki.exit_json()) return self._result