Server IP : 85.214.239.14 / Your IP : 3.140.188.185 Web Server : Apache/2.4.62 (Debian) System : Linux h2886529.stratoserver.net 4.9.0 #1 SMP Tue Jan 9 19:45:01 MSK 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.18 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, MySQL : OFF | cURL : OFF | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : OFF Directory : /usr/lib/python3/dist-packages/ansible_collections/cisco/dnac/plugins/action/ |
Upload File : |
#!/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.dnac.plugins.plugin_utils.dnac import ( DNACSDK, dnac_argument_spec, dnac_compare_equality, get_dict_result, ) from ansible_collections.cisco.dnac.plugins.plugin_utils.exceptions import ( InconsistentParameters, ) # Get common arguments specification argument_spec = dnac_argument_spec() # Add arguments specific for this module argument_spec.update(dict( state=dict(type="str", default="present", choices=["present", "absent"]), _id=dict(type="str"), addToInventory=dict(type="bool"), addedOn=dict(type="int"), configId=dict(type="str"), currTaskIdx=dict(type="int"), description=dict(type="str"), endTime=dict(type="int"), execTime=dict(type="int"), imageId=dict(type="str"), instanceType=dict(type="str"), lastupdateOn=dict(type="int"), name=dict(type="str"), startTime=dict(type="int"), state_=dict(type="str"), tasks=dict(type="list"), tenantId=dict(type="str"), type=dict(type="str"), useState=dict(type="str"), version=dict(type="int"), id=dict(type="str"), )) required_if = [ ("state", "present", ["id", "name"], True), ("state", "absent", ["id", "name"], True), ] required_one_of = [] mutually_exclusive = [] required_together = [] class PnpWorkflow(object): def __init__(self, params, dnac): self.dnac = dnac self.new_object = dict( _id=params.get("_id"), addToInventory=params.get("addToInventory"), addedOn=params.get("addedOn"), configId=params.get("configId"), currTaskIdx=params.get("currTaskIdx"), description=params.get("description"), endTime=params.get("endTime"), execTime=params.get("execTime"), imageId=params.get("imageId"), instanceType=params.get("instanceType"), lastupdateOn=params.get("lastupdateOn"), name=params.get("name"), startTime=params.get("startTime"), state=params.get("state_"), tasks=params.get("tasks"), tenantId=params.get("tenantId"), type=params.get("type"), useState=params.get("useState"), version=params.get("version"), id=params.get("id"), ) def get_all_params(self, name=None, id=None): new_object_params = {} new_object_params['limit'] = self.new_object.get('limit') new_object_params['offset'] = self.new_object.get('offset') new_object_params['sort'] = self.new_object.get('sort') new_object_params['sort_order'] = self.new_object.get('sortOrder') or \ self.new_object.get('sort_order') new_object_params['type'] = self.new_object.get('type') new_object_params['name'] = name or self.new_object.get('name') return new_object_params def create_params(self): new_object_params = {} new_object_params['_id'] = self.new_object.get('_id') new_object_params['addToInventory'] = self.new_object.get('addToInventory') new_object_params['addedOn'] = self.new_object.get('addedOn') new_object_params['configId'] = self.new_object.get('configId') new_object_params['currTaskIdx'] = self.new_object.get('currTaskIdx') new_object_params['description'] = self.new_object.get('description') new_object_params['endTime'] = self.new_object.get('endTime') new_object_params['execTime'] = self.new_object.get('execTime') new_object_params['imageId'] = self.new_object.get('imageId') new_object_params['instanceType'] = self.new_object.get('instanceType') new_object_params['lastupdateOn'] = self.new_object.get('lastupdateOn') new_object_params['name'] = self.new_object.get('name') new_object_params['startTime'] = self.new_object.get('startTime') new_object_params['state_'] = self.new_object.get('state_') new_object_params['tasks'] = self.new_object.get('tasks') new_object_params['tenantId'] = self.new_object.get('tenantId') new_object_params['type'] = self.new_object.get('type') new_object_params['useState'] = self.new_object.get('useState') new_object_params['version'] = self.new_object.get('version') return new_object_params def delete_by_id_params(self): new_object_params = {} new_object_params['id'] = self.new_object.get('id') return new_object_params def update_by_id_params(self): new_object_params = {} new_object_params['_id'] = self.new_object.get('_id') new_object_params['addToInventory'] = self.new_object.get('addToInventory') new_object_params['addedOn'] = self.new_object.get('addedOn') new_object_params['configId'] = self.new_object.get('configId') new_object_params['currTaskIdx'] = self.new_object.get('currTaskIdx') new_object_params['description'] = self.new_object.get('description') new_object_params['endTime'] = self.new_object.get('endTime') new_object_params['execTime'] = self.new_object.get('execTime') new_object_params['imageId'] = self.new_object.get('imageId') new_object_params['instanceType'] = self.new_object.get('instanceType') new_object_params['lastupdateOn'] = self.new_object.get('lastupdateOn') new_object_params['name'] = self.new_object.get('name') new_object_params['startTime'] = self.new_object.get('startTime') new_object_params['state_'] = self.new_object.get('state_') new_object_params['tasks'] = self.new_object.get('tasks') new_object_params['tenantId'] = self.new_object.get('tenantId') new_object_params['type'] = self.new_object.get('type') new_object_params['useState'] = self.new_object.get('useState') new_object_params['version'] = self.new_object.get('version') new_object_params['id'] = self.new_object.get('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.dnac.exec( family="device_onboarding_pnp", function="get_workflows", 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) except Exception: result = None return result def get_object_by_id(self, id): result = None try: items = self.dnac.exec( family="device_onboarding_pnp", function="get_workflow_by_id", params={"id": id} ) if isinstance(items, dict): if 'response' in items: items = items.get('response') result = get_dict_result(items, 'id', id) except Exception: result = None return result def exists(self): id_exists = False name_exists = False prev_obj = None o_id = self.new_object.get("id") 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") 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)) 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 = [ ("_id", "_id"), ("addToInventory", "addToInventory"), ("addedOn", "addedOn"), ("configId", "configId"), ("currTaskIdx", "currTaskIdx"), ("description", "description"), ("endTime", "endTime"), ("execTime", "execTime"), ("imageId", "imageId"), ("instanceType", "instanceType"), ("lastupdateOn", "lastupdateOn"), ("name", "name"), ("startTime", "startTime"), ("state_", "state"), ("tasks", "tasks"), ("tenantId", "tenantId"), ("type", "type"), ("useState", "useState"), ("version", "version"), ("id", "id"), ] # 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 dnac_compare_equality(current_obj.get(dnac_param), requested_obj.get(ansible_param)) for (dnac_param, ansible_param) in obj_params) def create(self): result = self.dnac.exec( family="device_onboarding_pnp", function="add_a_workflow", params=self.create_params(), op_modifies=True, ) return result def update(self): id = self.new_object.get("id") 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") if id_: self.new_object.update(dict(id=id_)) result = self.dnac.exec( family="device_onboarding_pnp", function="update_workflow", params=self.update_by_id_params(), op_modifies=True, ) return result def delete(self): id = self.new_object.get("id") 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") if id_: self.new_object.update(dict(id=id_)) result = self.dnac.exec( family="device_onboarding_pnp", function="delete_workflow_by_id", 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() dnac = DNACSDK(self._task.args) obj = PnpWorkflow(self._task.args, dnac) 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() dnac.object_updated() else: response = prev_obj dnac.object_already_present() else: response = obj.create() dnac.object_created() elif state == "absent": (obj_exists, prev_obj) = obj.exists() if obj_exists: response = obj.delete() dnac.object_deleted() else: dnac.object_already_absent() self._result.update(dict(dnac_response=response)) self._result.update(dnac.exit_json()) return self._result