Adding upstream version 7.7.0+dfsg.upstream/7.7.0+dfsg

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 275 insertions, 0 deletions

diff --git a/ansible_collections/cisco/ise/plugins/action/endpoint.py b/ansible_collections/cisco/ise/plugins/action/endpoint.py
new file mode 100644
index 000000000..b8526e704
--- /dev/null
+++ b/ansible_collections/cisco/ise/plugins/action/endpoint.py
@@ -0,0 +1,275 @@
+#!/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
+import re
+from ansible_collections.cisco.ise.plugins.plugin_utils.ise import (
+    ISESDK,
+    ise_argument_spec,
+    ise_compare_equality,
+    get_dict_result,
+)
+
+# Get common arguments specification
+argument_spec = ise_argument_spec()
+# Add arguments specific for this module
+argument_spec.update(dict(
+    state=dict(type="str", default="present", choices=["present", "absent"]),
+    description=dict(type="str"),
+    mac=dict(type="str"),
+    profileId=dict(type="str"),
+    staticProfileAssignment=dict(type="bool"),
+    groupId=dict(type="str"),
+    staticGroupAssignment=dict(type="bool"),
+    portalUser=dict(type="str"),
+    identityStore=dict(type="str"),
+    identityStoreId=dict(type="str"),
+    mdmAttributes=dict(type="dict"),
+    customAttributes=dict(type="dict"),
+    id=dict(type="str"),
+))
+
+required_if = [
+    ("state", "present", ["id", "mac"], True),
+    ("state", "absent", ["id", "mac"], True),
+]
+required_one_of = []
+mutually_exclusive = []
+required_together = []
+
+
+class Endpoint(object):
+    def __init__(self, params, ise):
+        self.ise = ise
+        self.new_object = dict(
+            description=params.get("description"),
+            mac=params.get("mac"),
+            profile_id=params.get("profileId"),
+            static_profile_assignment=params.get("staticProfileAssignment"),
+            group_id=params.get("groupId"),
+            static_group_assignment=params.get("staticGroupAssignment"),
+            portal_user=params.get("portalUser"),
+            identity_store=params.get("identityStore"),
+            identity_store_id=params.get("identityStoreId"),
+            mdm_attributes=params.get("mdmAttributes"),
+            custom_attributes=params.get("customAttributes"),
+            id=params.get("id"),
+        )
+
+    def get_object_by_name(self, name):
+        try:
+            result = self.ise.exec(
+                family="endpoint",
+                function="get_endpoint_by_name",
+                params={"name": name},
+                handle_func_exception=False,
+            ).response['ERSEndPoint']
+            result["name"] = re.sub("[-:.]", "", result.get("name")).lower()
+            result["mac"] = re.sub("[-:.]", "", result.get("mac")).lower()
+            result = get_dict_result(result, 'name', name)
+        except (TypeError, AttributeError) as e:
+            self.ise.fail_json(
+                msg=(
+                    "An error occured when executing operation."
+                    " Check the configuration of your API Settings and API Gateway settings on your ISE server."
+                    " This collection assumes that the API Gateway, the ERS APIs and OpenAPIs are enabled."
+                    " You may want to enable the (ise_debug: True) argument."
+                    " The error was: {error}"
+                ).format(error=e)
+            )
+        except Exception:
+            result = None
+        return result
+
+    def get_object_by_id(self, id):
+        try:
+            result = self.ise.exec(
+                family="endpoint",
+                function="get_endpoint_by_id",
+                handle_func_exception=False,
+                params={"id": id}
+            ).response['ERSEndPoint']
+        except (TypeError, AttributeError) as e:
+            self.ise.fail_json(
+                msg=(
+                    "An error occured when executing operation."
+                    " Check the configuration of your API Settings and API Gateway settings on your ISE server."
+                    " This collection assumes that the API Gateway, the ERS APIs and OpenAPIs are enabled."
+                    " You may want to enable the (ise_debug: True) argument."
+                    " The error was: {error}"
+                ).format(error=e)
+            )
+        except Exception:
+            result = None
+        return result
+
+    def exists(self):
+        result = False
+        prev_obj = None
+        id = self.new_object.get("id")
+        name = self.new_object.get("mac")
+        if name:
+            name = re.sub("[-:.]", "", name).lower()
+            self.new_object.update(dict(mac=name))
+        if id:
+            prev_obj = self.get_object_by_id(id)
+            result = prev_obj is not None and isinstance(prev_obj, dict)
+        elif name:
+            prev_obj = self.get_object_by_name(name)
+            result = prev_obj is not None and isinstance(prev_obj, dict)
+        return (result, prev_obj)
+
+    def requires_update(self, current_obj):
+        requested_obj = self.new_object
+
+        obj_params = [
+            ("description", "description"),
+            ("mac", "mac"),
+            ("profileId", "profile_id"),
+            ("staticProfileAssignment", "static_profile_assignment"),
+            ("groupId", "group_id"),
+            ("staticGroupAssignment", "static_group_assignment"),
+            ("portalUser", "portal_user"),
+            ("identityStore", "identity_store"),
+            ("identityStoreId", "identity_store_id"),
+            ("mdmAttributes", "mdm_attributes"),
+            ("customAttributes", "custom_attributes"),
+            ("id", "id"),
+        ]
+        # Method 1. Params present in request (Ansible) obj are the same as the current (ISE) params
+        # If any does not have eq params, it requires update
+        return any(not ise_compare_equality(current_obj.get(ise_param),
+                                            requested_obj.get(ansible_param))
+                   for (ise_param, ansible_param) in obj_params)
+
+    def create(self):
+        result = self.ise.exec(
+            family="endpoint",
+            function="create_endpoint",
+            params=self.new_object,
+        ).response
+        return result
+
+    def update(self):
+        id = self.new_object.get("id")
+        name = self.new_object.get("mac")
+        result = None
+        if not id:
+            id_ = self.get_object_by_name(name).get("id")
+            self.new_object.update(dict(id=id_))
+        result = self.ise.exec(
+            family="endpoint",
+            function="update_endpoint_by_id",
+            params=self.new_object
+        ).response
+        return result
+
+    def delete(self):
+        id = self.new_object.get("id")
+        name = self.new_object.get("mac")
+        result = None
+        if not id:
+            id_ = self.get_object_by_name(name).get("id")
+            self.new_object.update(dict(id=id_))
+        result = self.ise.exec(
+            family="endpoint",
+            function="delete_endpoint_by_id",
+            params=self.new_object
+        ).response
+        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()
+
+        ise = ISESDK(params=self._task.args)
+        obj = Endpoint(self._task.args, ise)
+
+        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):
+                    ise_update_response = obj.update()
+                    self._result.update(dict(ise_update_response=ise_update_response))
+                    (obj_exists, updated_obj) = obj.exists()
+                    response = updated_obj
+                    has_changed = None
+                    has_changed = ise_update_response.get("UpdatedFieldsList").get("updatedField")
+                    if (len(has_changed) == 0 or
+                       has_changed[0].get("newValue") == "" and
+                       has_changed[0].get("newValue") == has_changed[0].get("oldValue")):
+                        self._result.pop("ise_update_response", None)
+                        ise.object_already_present()
+                    else:
+                        ise.object_updated()
+                else:
+                    response = prev_obj
+                    ise.object_already_present()
+            else:
+                ise_create_response = obj.create()
+                (obj_exists, created_obj) = obj.exists()
+                response = created_obj
+                ise.object_created()
+
+        elif state == "absent":
+            (obj_exists, prev_obj) = obj.exists()
+            if obj_exists:
+                obj.delete()
+                response = prev_obj
+                ise.object_deleted()
+            else:
+                ise.object_already_absent()
+
+        self._result.update(dict(ise_response=response))
+        self._result.update(ise.exit_json())
+        return self._result