File: //lib/python3.9/site-packages/ansible_collections/cisco/dnac/plugins/action/sda_virtual_network.py
# -*- 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 (
AnsibleSDAException,
)
# 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"]),
virtualNetworkName=dict(type="str"),
siteNameHierarchy=dict(type="str"),
))
required_if = [
]
required_one_of = []
mutually_exclusive = []
required_together = []
class SdaVirtualNetwork(object):
def __init__(self, params, dnac):
self.dnac = dnac
self.new_object = dict(
virtualNetworkName=params.get("virtualNetworkName"),
siteNameHierarchy=params.get("siteNameHierarchy"),
virtual_network_name=params.get("virtualNetworkName"),
site_name_hierarchy=params.get("siteNameHierarchy"),
)
def get_all_params(self, name=None, id=None):
new_object_params = {}
new_object_params['virtual_network_name'] = self.new_object.get('virtualNetworkName') or \
self.new_object.get('virtual_network_name')
new_object_params['site_name_hierarchy'] = self.new_object.get('siteNameHierarchy') or \
self.new_object.get('site_name_hierarchy')
return new_object_params
def create_params(self):
new_object_params = {}
new_object_params['virtualNetworkName'] = self.new_object.get('virtualNetworkName')
new_object_params['siteNameHierarchy'] = self.new_object.get('siteNameHierarchy')
return new_object_params
def delete_all_params(self):
new_object_params = {}
new_object_params['virtual_network_name'] = self.new_object.get('virtual_network_name')
new_object_params['site_name_hierarchy'] = self.new_object.get('site_name_hierarchy')
return new_object_params
def get_object_by_name(self, name, is_absent=False):
result = None
# NOTE: Does not have a get by name method, using get all
try:
items = self.dnac.exec(
family="sda",
function="get_vn",
params=self.get_all_params(name=name),
)
if isinstance(items, dict):
if 'response' in items:
items = items.get('response')
if isinstance(items, dict) and items.get("status") == "failed":
if is_absent:
raise AnsibleSDAException(response=items)
result = None
return result
result = get_dict_result(items, 'name', name)
except Exception:
if is_absent:
raise
result = None
return result
def get_object_by_id(self, id):
result = None
# NOTE: Does not have a get by id method or it is in another action
return result
def exists(self, is_absent=False):
name = self.new_object.get("name")
prev_obj = self.get_object_by_name(name, is_absent=is_absent)
it_exists = prev_obj is not None and isinstance(prev_obj, dict) and prev_obj.get("status") != "failed"
return (it_exists, prev_obj)
def requires_update(self, current_obj):
requested_obj = self.new_object
obj_params = [
("virtualNetworkName", "virtualNetworkName"),
("siteNameHierarchy", "siteNameHierarchy"),
("virtualNetworkName", "virtual_network_name"),
("siteNameHierarchy", "site_name_hierarchy"),
]
# 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 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="sda",
function="add_vn",
params=self.create_params(),
op_modifies=True,
)
if isinstance(result, dict):
if 'response' in result:
result = result.get('response')
if isinstance(result, dict) and result.get("status") == "failed":
raise AnsibleSDAException(response=result)
return result
def delete(self):
id = self.new_object.get("id")
name = self.new_object.get("name")
result = None
result = self.dnac.exec(
family="sda",
function="delete_vn",
params=self.delete_all_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 = SdaVirtualNetwork(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 = prev_obj
dnac.object_present_and_different()
else:
response = prev_obj
dnac.object_already_present()
else:
try:
response = obj.create()
dnac.object_created()
except AnsibleSDAException as e:
dnac.fail_json("Could not create object {e}".format(e=e._response))
elif state == "absent":
try:
(obj_exists, prev_obj) = obj.exists(is_absent=True)
if obj_exists:
response = obj.delete()
dnac.object_deleted()
else:
dnac.object_already_absent()
except AnsibleSDAException as e:
dnac.fail_json("Could not get object to be delete {e}".format(e=e._response))
self._result.update(dict(dnac_response=response))
self._result.update(dnac.exit_json())
return self._result