Add qos_device_interface

changelogs/changelog.yaml

@@ -298,4 +298,11 @@ releases:
         - snmpv2_write_community_credential - remove `id` and `instanceTenantId` parameter.
         - site_health_info - add `siteType`, `offset`, `limit` parameters
         - sda_virtual_network_ip_pool - remove `payload` and `ipPoolName` parameter.
-        - sda_virtual_network_ip_pool - add `siteNameHierarchy`, `ipPoolName`, `trafficType`, `authenticationPolicyName`, `scalableGroupName`, `isL2FloodingEnabled`, `isThisCriticalPool`, `poolType`, `vlanName`, `isWirelessPool` parameters.
+        - sda_virtual_network_ip_pool - add `siteNameHierarchy`, `ipPoolName`, `trafficType`, `authenticationPolicyName`, `scalableGroupName`, `isL2FloodingEnabled`, `isThisCriticalPool`, `poolType`, `vlanName`, `isWirelessPool` parameters.
+  4.1.0:
+    release_date: '2021-12-07'
+    changes:
+      release_summary: Add qos_device_interface
+      minor_changes:
+        - qos_device_interface - new module.
+        - qos_device_interface_info - new module.

galaxy.yml

@@ -1,7 +1,7 @@
 ---
 namespace: cisco
 name: dnac
-version: 4.0.0
+version: 4.1.0
 readme: README.md
 authors:
 - Rafael Campos <[email protected]>

plugins/action/qos_device_interface.py

@@ -0,0 +1,251 @@
+#!/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"]),
+    payload=dict(type="list"),
+    id=dict(type="str"),
+))
+
+required_if = [
+    ("state", "present", ["id"], True),
+    ("state", "present", ["payload"], True),
+    ("state", "absent", ["id"], True),
+    ("state", "absent", ["payload"], True),
+]
+required_one_of = []
+mutually_exclusive = []
+required_together = []
+
+
+class QosDeviceInterface(object):
+    def __init__(self, params, dnac):
+        self.dnac = dnac
+        self.new_object = dict(
+            payload=params.get("payload"),
+            id=params.get("id"),
+        )
+
+    def get_all_params(self, name=None, id=None):
+        new_object_params = {}
+        new_object_params['network_device_id'] = self.new_object.get('network_device_id')
+        return new_object_params
+
+    def create_params(self):
+        new_object_params = {}
+        new_object_params['payload'] = self.new_object.get('payload')
+        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_all_params(self):
+        new_object_params = {}
+        new_object_params['payload'] = self.new_object.get('payload')
+        return new_object_params
+
+    def get_object_by_name(self, name):
+        result = None
+        # NOTICE: Does not have a get by name method or it is in another action
+        try:
+            items = self.dnac.exec(
+                family="application_policy",
+                function="get_qos_device_interface_info",
+                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
+        # NOTICE: Does not have a get by id method or it is in another action
+        return result
+
+    def exists(self):
+        id_exists = False
+        name_exists = False
+        prev_obj = None
+        requested_obj = self.new_object.get('payload')
+        if requested_obj and len(requested_obj) > 0:
+            requested_obj = requested_obj[0]
+        o_id = self.new_object.get("id") or requested_obj.get("id")
+        name = self.new_object.get("name") or requested_obj.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))
+        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.get('payload')
+        if requested_obj and len(requested_obj) > 0:
+            requested_obj = requested_obj[0]
+
+        obj_params = [
+            ("id", "id"),
+            ("name", "name"),
+            ("excludedInterfaces", "excludedInterfaces"),
+            ("networkDeviceId", "networkDeviceId"),
+            ("qosDeviceInterfaceInfo", "qosDeviceInterfaceInfo"),
+            ("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="application_policy",
+            function="create_qos_device_interface_info",
+            params=self.create_params(),
+            op_modifies=True,
+        )
+        return result
+
+    def update(self):
+        requested_obj = self.new_object.get('payload')
+        if requested_obj and len(requested_obj) > 0:
+            requested_obj = requested_obj[0]
+        id = self.new_object.get("id") or requested_obj.get("id")
+        name = self.new_object.get("name") or requested_obj.get("name")
+        result = None
+        result = self.dnac.exec(
+            family="application_policy",
+            function="update_qos_device_interface_info",
+            params=self.update_all_params(),
+            op_modifies=True,
+        )
+        return result
+
+    def delete(self):
+        requested_obj = self.new_object.get('payload')
+        if requested_obj and len(requested_obj) > 0:
+            requested_obj = requested_obj[0]
+        id = self.new_object.get("id") or requested_obj.get("id")
+        name = self.new_object.get("name") or requested_obj.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="application_policy",
+            function="delete_qos_device_interface_info",
+            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 = QosDeviceInterface(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

plugins/action/qos_device_interface_info.py

@@ -0,0 +1,89 @@
+#!/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,
+)
+
+# Get common arguments specification
+argument_spec = dnac_argument_spec()
+# Add arguments specific for this module
+argument_spec.update(dict(
+    networkDeviceId=dict(type="str"),
+    headers=dict(type="dict"),
+))
+
+required_if = []
+required_one_of = []
+mutually_exclusive = []
+required_together = []
+
+
+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 = True
+        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 get_object(self, params):
+        new_object = dict(
+            network_device_id=params.get("networkDeviceId"),
+            headers=params.get("headers"),
+        )
+        return new_object
+
+    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()
+
+        self._result.update(dict(dnac_response={}))
+
+        dnac = DNACSDK(params=self._task.args)
+
+        response = dnac.exec(
+            family="application_policy",
+            function='get_qos_device_interface_info',
+            params=self.get_object(self._task.args),
+        )
+        self._result.update(dict(dnac_response=response))
+        self._result.update(dnac.exit_json())
+        return self._result