mirror of https://github.com/ansible/ansible.git
update asa to use network_cli connection plugin (#26899)
* WIP update asa to use network_cli connection plugin * add asa.py to cliconf plugins * update asa.py terminal plugin to support regexp and events * update constants to map asa modules to asa action handler * update asa action handler to implement persistent connections * update asa shared module to use persistent connections * update asa_command module to use new connection * fixed pep8 issuespull/26293/head
Peter Sprygada
9 years ago
committed by
GitHub
parent
e976f299f8
commit
8e2dcaf9f6
@ -0,0 +1,111 @@
|
|||||||
|
#
|
||||||
|
# (c) 2016 Red Hat 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
|
||||||
|
import json
|
||||||
|
|
||||||
|
from ansible.plugins.action.normal import ActionModule as _ActionModule
|
||||||
|
from ansible.module_utils.basic import AnsibleFallbackNotFound
|
||||||
|
from ansible.module_utils.asa import asa_argument_spec
|
||||||
|
from ansible.module_utils.six import iteritems
|
||||||
|
from ansible.module_utils.connection import request_builder
|
||||||
|
|
||||||
|
try:
|
||||||
|
from __main__ import display
|
||||||
|
except ImportError:
|
||||||
|
from ansible.utils.display import Display
|
||||||
|
display = Display()
|
||||||
|
|
||||||
|
|
||||||
|
class ActionModule(_ActionModule):
|
||||||
|
|
||||||
|
def run(self, tmp=None, task_vars=None):
|
||||||
|
|
||||||
|
if self._play_context.connection != 'local':
|
||||||
|
return dict(
|
||||||
|
failed=True,
|
||||||
|
msg='invalid connection specified, expected connection=local, '
|
||||||
|
'got %s' % self._play_context.connection
|
||||||
|
)
|
||||||
|
|
||||||
|
provider = self.load_provider()
|
||||||
|
|
||||||
|
pc = copy.deepcopy(self._play_context)
|
||||||
|
pc.connection = 'network_cli'
|
||||||
|
pc.network_os = 'asa'
|
||||||
|
pc.remote_addr = provider['host'] or self._play_context.remote_addr
|
||||||
|
pc.port = provider['port'] or self._play_context.port or 22
|
||||||
|
pc.remote_user = provider['username'] or self._play_context.connection_user
|
||||||
|
pc.password = provider['password'] or self._play_context.password
|
||||||
|
pc.private_key_file = provider['ssh_keyfile'] or self._play_context.private_key_file
|
||||||
|
pc.timeout = provider['timeout'] or self._play_context.timeout
|
||||||
|
pc.become = provider['authorize'] or False
|
||||||
|
pc.become_pass = provider['auth_pass']
|
||||||
|
|
||||||
|
display.vvv('using connection plugin %s' % pc.connection, pc.remote_addr)
|
||||||
|
connection = self._shared_loader_obj.connection_loader.get('persistent', pc, sys.stdin)
|
||||||
|
|
||||||
|
socket_path = connection.run()
|
||||||
|
|
||||||
|
display.vvvv('socket_path: %s' % socket_path, pc.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'}
|
||||||
|
|
||||||
|
task_vars['ansible_socket'] = socket_path
|
||||||
|
|
||||||
|
result = super(ActionModule, self).run(tmp, task_vars)
|
||||||
|
|
||||||
|
# take the shell out of enable mode
|
||||||
|
if pc.become:
|
||||||
|
req = json.dumps(request_builder('get', 'disable'))
|
||||||
|
out = connection.exec_command(req)
|
||||||
|
|
||||||
|
return result
|
||||||
|
|
||||||
|
def load_provider(self):
|
||||||
|
provider = self._task.args.get('provider', {})
|
||||||
|
for key, value in iteritems(asa_argument_spec):
|
||||||
|
if key != 'provider' and key not in provider:
|
||||||
|
if key in self._task.args:
|
||||||
|
provider[key] = self._task.args[key]
|
||||||
|
elif 'fallback' in value:
|
||||||
|
provider[key] = self._fallback(value['fallback'])
|
||||||
|
elif key not in provider:
|
||||||
|
provider[key] = None
|
||||||
|
return provider
|
||||||
|
|
||||||
|
def _fallback(self, fallback):
|
||||||
|
strategy = fallback[0]
|
||||||
|
args = []
|
||||||
|
kwargs = {}
|
||||||
|
|
||||||
|
for item in fallback[1:]:
|
||||||
|
if isinstance(item, dict):
|
||||||
|
kwargs = item
|
||||||
|
else:
|
||||||
|
args = item
|
||||||
|
try:
|
||||||
|
return strategy(*args, **kwargs)
|
||||||
|
except AnsibleFallbackNotFound:
|
||||||
|
pass
|
||||||
@ -0,0 +1,78 @@
|
|||||||
|
#
|
||||||
|
# (c) 2017 Red Hat 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 re
|
||||||
|
import json
|
||||||
|
|
||||||
|
from itertools import chain
|
||||||
|
|
||||||
|
from ansible.module_utils._text import to_bytes, to_text
|
||||||
|
from ansible.module_utils.network_common import to_list
|
||||||
|
from ansible.plugins.cliconf import CliconfBase, enable_mode
|
||||||
|
|
||||||
|
|
||||||
|
class Cliconf(CliconfBase):
|
||||||
|
|
||||||
|
def get_device_info(self):
|
||||||
|
device_info = {}
|
||||||
|
|
||||||
|
device_info['network_os'] = 'asa'
|
||||||
|
reply = self.get(b'show version')
|
||||||
|
data = to_text(reply, errors='surrogate_or_strict').strip()
|
||||||
|
|
||||||
|
match = re.search(r'Version (\S+),', data)
|
||||||
|
if match:
|
||||||
|
device_info['network_os_version'] = match.group(1)
|
||||||
|
|
||||||
|
match = re.search(r'^Model Id:\s+(.+) \(revision', data, re.M)
|
||||||
|
if match:
|
||||||
|
device_info['network_os_model'] = match.group(1)
|
||||||
|
|
||||||
|
match = re.search(r'^(.+) up', data, re.M)
|
||||||
|
if match:
|
||||||
|
device_info['network_os_hostname'] = match.group(1)
|
||||||
|
|
||||||
|
return device_info
|
||||||
|
|
||||||
|
@enable_mode
|
||||||
|
def get_config(self, source='running'):
|
||||||
|
if source not in ('running', 'startup'):
|
||||||
|
return self.invalid_params("fetching configuration from %s is not supported" % source)
|
||||||
|
if source == 'running':
|
||||||
|
cmd = b'show running-config all'
|
||||||
|
else:
|
||||||
|
cmd = b'show startup-config'
|
||||||
|
return self.send_command(cmd)
|
||||||
|
|
||||||
|
@enable_mode
|
||||||
|
def edit_config(self, command):
|
||||||
|
for cmd in chain([b'configure terminal'], to_list(command), [b'end']):
|
||||||
|
self.send_command(cmd)
|
||||||
|
|
||||||
|
def get(self, *args, **kwargs):
|
||||||
|
return self.send_command(*args, **kwargs)
|
||||||
|
|
||||||
|
def get_capabilities(self):
|
||||||
|
result = {}
|
||||||
|
result['rpc'] = self.get_base_rpc()
|
||||||
|
result['network_api'] = 'cliconf'
|
||||||
|
result['device_info'] = self.get_device_info()
|
||||||
|
return json.dumps(result)
|
||||||
Loading…
Reference in New Issue