#!/usr/bin/env python # -*- coding: utf-8 -*- # Copyright (c) 2024, 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.ise.plugins.plugin_utils.ise import ( ISESDK, ise_argument_spec, ) # Get common arguements specification argument_spec = ise_argument_spec() # Add arguments specific for this module argument_spec.update(dict( backupDescription=dict(type="str"), backupEncryptionKey=dict(type="str"), backupName=dict(type="str"), endDate=dict(type="str"), frequency=dict(type="str"), monthDay=dict(type="str"), repositoryName=dict(type="str"), startDate=dict(type="str"), status=dict(type="str"), time=dict(type="str"), weekDay=dict(type="str"), )) 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 = 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 get_object(self, params): new_object = dict( backup_description=params.get("backupDescription"), backup_encryption_key=params.get("backupEncryptionKey"), backup_name=params.get("backupName"), end_date=params.get("endDate"), frequency=params.get("frequency"), month_day=params.get("monthDay"), repository_name=params.get("repositoryName"), start_date=params.get("startDate"), status=params.get("status"), time=params.get("time"), week_day=params.get("weekDay"), ) 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() ise = ISESDK(params=self._task.args) response = ise.exec( family="backup_and_restore", function="create_scheduled_config_backup", params=self.get_object(self._task.args), ).response self._result.update(dict(ise_response=response)) self._result.update(ise.exit_json()) return self._result