mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-30 14:21:26 -07:00
8472a53bea
* Add prompt check in action plugin for network platform In case of ignore_errors for a wrong configuration the prompt is left in configuration mode and moved to next task, if the next taks requires prompt to be in operational state it results in failure. Hence add a check to ensure right prompt at start of each task run. * Add prompt check in action plugin for network platform * In case of ignore_errors for a wrong configuration the prompt is left in configuration mode and moved to next task, if the next taks requires prompt to be in operational state it results in failure. * Hence add a check to ensure right prompt at start of each task run. * Fix CI issue * Fix CI issues Fix review comment Change iosxr exit command to abort as per review comment
163 lines
7.2 KiB
Python
163 lines
7.2 KiB
Python
# (c) 2015, Ansible Inc,
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
import sys
|
|
import copy
|
|
|
|
from ansible import constants as C
|
|
from ansible.module_utils._text import to_text
|
|
from ansible.module_utils.connection import Connection
|
|
from ansible.errors import AnsibleError
|
|
from ansible.plugins.action import ActionBase
|
|
from ansible.module_utils.network_common import load_provider
|
|
|
|
from imp import find_module, load_module
|
|
|
|
try:
|
|
from __main__ import display
|
|
except ImportError:
|
|
from ansible.utils.display import Display
|
|
display = Display()
|
|
|
|
|
|
class ActionModule(ActionBase):
|
|
|
|
def run(self, tmp=None, task_vars=None):
|
|
play_context = copy.deepcopy(self._play_context)
|
|
play_context.network_os = self._get_network_os(task_vars)
|
|
|
|
# we should be able to stream line this a bit by creating a common
|
|
# provider argument spec in module_utils/network_common.py or another
|
|
# option is that there isn't a need to push provider into the module
|
|
# since the connection is started in the action handler.
|
|
f, p, d = find_module('ansible')
|
|
f2, p2, d2 = find_module('module_utils', [p])
|
|
f3, p3, d3 = find_module(play_context.network_os, [p2])
|
|
module = load_module('ansible.module_utils.' + play_context.network_os, f3, p3, d3)
|
|
|
|
self.provider = load_provider(module.get_provider_argspec(), self._task.args)
|
|
|
|
if play_context.network_os == 'junos':
|
|
play_context.connection = 'netconf'
|
|
play_context.port = int(self.provider['port'] or self._play_context.port or 830)
|
|
else:
|
|
play_context.connection = 'network_cli'
|
|
play_context.port = int(self.provider['port'] or self._play_context.port or 22)
|
|
|
|
play_context.remote_addr = self.provider['host'] or self._play_context.remote_addr
|
|
play_context.remote_user = self.provider['username'] or self._play_context.connection_user
|
|
play_context.password = self.provider['password'] or self._play_context.password
|
|
play_context.private_key_file = self.provider['ssh_keyfile'] or self._play_context.private_key_file
|
|
play_context.timeout = int(self.provider['timeout'] or C.PERSISTENT_COMMAND_TIMEOUT)
|
|
if 'authorize' in self.provider.keys():
|
|
play_context.become = self.provider['authorize'] or False
|
|
play_context.become_pass = self.provider['auth_pass']
|
|
|
|
socket_path = None
|
|
if self._play_context.connection == 'local':
|
|
socket_path = self._start_connection(play_context)
|
|
task_vars['ansible_socket'] = socket_path
|
|
|
|
if play_context.connection == 'network_cli':
|
|
# make sure we are in the right cli context which should be
|
|
# enable mode and not config module
|
|
if socket_path is None:
|
|
socket_path = self._connection.socket_path
|
|
|
|
conn = Connection(socket_path)
|
|
out = conn.get_prompt()
|
|
if to_text(out, errors='surrogate_then_replace').strip().endswith(')#'):
|
|
display.vvvv('wrong context, sending exit to device', self._play_context.remote_addr)
|
|
conn.send_command('exit')
|
|
|
|
if 'fail_on_missing_module' not in self._task.args:
|
|
self._task.args['fail_on_missing_module'] = False
|
|
|
|
result = super(ActionModule, self).run(tmp, task_vars)
|
|
|
|
module = self._get_implementation_module(play_context.network_os, self._task.action)
|
|
|
|
if not module:
|
|
if self._task.args['fail_on_missing_module']:
|
|
result['failed'] = True
|
|
else:
|
|
result['failed'] = False
|
|
|
|
result['msg'] = ('Could not find implementation module %s for %s' %
|
|
(self._task.action, play_context.network_os))
|
|
else:
|
|
new_module_args = self._task.args.copy()
|
|
# perhaps delete the provider argument here as well since the
|
|
# module code doesn't need the information, the connection is
|
|
# already started
|
|
if 'network_os' in new_module_args:
|
|
del new_module_args['network_os']
|
|
|
|
del new_module_args['fail_on_missing_module']
|
|
|
|
display.vvvv('Running implementation module %s' % module)
|
|
result.update(self._execute_module(module_name=module,
|
|
module_args=new_module_args, task_vars=task_vars,
|
|
wrap_async=self._task.async))
|
|
|
|
display.vvvv('Caching network OS %s in facts' % play_context.network_os)
|
|
result['ansible_facts'] = {'network_os': play_context.network_os}
|
|
|
|
return result
|
|
|
|
def _start_connection(self, play_context):
|
|
|
|
display.vvv('using connection plugin %s' % play_context.connection, play_context.remote_addr)
|
|
connection = self._shared_loader_obj.connection_loader.get('persistent',
|
|
play_context, sys.stdin)
|
|
|
|
socket_path = connection.run()
|
|
display.vvvv('socket_path: %s' % socket_path, play_context.remote_addr)
|
|
if not socket_path:
|
|
return {'failed': True,
|
|
'msg': 'unable to open shell. Please see: ' +
|
|
'https://docs.ansible.com/ansible/network_debug_troubleshooting.html#unable-to-open-shell'}
|
|
|
|
if self._play_context.become_method == 'enable':
|
|
self._play_context.become = False
|
|
self._play_context.become_method = None
|
|
|
|
return socket_path
|
|
|
|
def _get_network_os(self, task_vars):
|
|
if 'network_os' in self._task.args and self._task.args['network_os']:
|
|
display.vvvv('Getting network OS from task argument')
|
|
network_os = self._task.args['network_os']
|
|
elif self._play_context.network_os:
|
|
display.vvvv('Getting network OS from inventory')
|
|
network_os = self._play_context.network_os
|
|
elif 'network_os' in task_vars.get('ansible_facts', {}) and task_vars['ansible_facts']['network_os']:
|
|
display.vvvv('Getting network OS from fact')
|
|
network_os = task_vars['ansible_facts']['network_os']
|
|
else:
|
|
raise AnsibleError('ansible_network_os must be specified on this host to use platform agnostic modules')
|
|
|
|
return network_os
|
|
|
|
def _get_implementation_module(self, network_os, platform_agnostic_module):
|
|
implementation_module = network_os + '_' + platform_agnostic_module.partition('_')[2]
|
|
if implementation_module not in self._shared_loader_obj.module_loader:
|
|
implementation_module = None
|
|
|
|
return implementation_module
|