mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-23 19:01:26 -07:00
updates eos shared modules (#20738)
* eos module now uses network_cli connection plugin * adds unit tests for eos module * eapi support now provided by eapi module * updates doc fragment for eapi common properties
This commit is contained in:
Peter Sprygada
GitHub
parent
e8a00377ae
commit
ad83756b48
4 changed files with 559 additions and 283 deletions
|
|
@ -4,7 +4,7 @@
|
|||
# still belong to the author of the module, and may assign their own license
|
||||
# to the complete work.
|
||||
#
|
||||
# Copyright (c) 2015 Peter Sprygada, <psprygada@ansible.com>
|
||||
# (c) 2016 Red Hat Inc.
|
||||
#
|
||||
# Redistribution and use in source and binary forms, with or without modification,
|
||||
# are permitted provided that the following conditions are met:
|
||||
|
|
@ -25,314 +25,114 @@
|
|||
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
|
||||
# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
#
|
||||
|
||||
import re
|
||||
import time
|
||||
|
||||
from ansible.module_utils.basic import json, get_exception
|
||||
from ansible.module_utils.network import ModuleStub, NetworkError, NetworkModule
|
||||
from ansible.module_utils.network import add_argument, register_transport, to_list
|
||||
from ansible.module_utils.netcli import Command
|
||||
from ansible.module_utils.shell import CliBase
|
||||
from ansible.module_utils.urls import fetch_url, url_argument_spec
|
||||
from ansible.module_utils._text import to_native
|
||||
from ansible.module_utils.network_common import to_list
|
||||
|
||||
EAPI_FORMATS = ['json', 'text']
|
||||
_DEVICE_CONFIGS = {}
|
||||
|
||||
add_argument('use_ssl', dict(default=True, type='bool'))
|
||||
add_argument('validate_certs', dict(default=True, type='bool'))
|
||||
def get_config(module, flags=[]):
|
||||
cmd = 'show running-config '
|
||||
cmd += ' '.join(flags)
|
||||
cmd = cmd.strip()
|
||||
|
||||
try:
|
||||
return _DEVICE_CONFIGS[cmd]
|
||||
except KeyError:
|
||||
rc, out, err = module.exec_command(cmd)
|
||||
if rc != 0:
|
||||
module.fail_json(msg='unable to retrieve current config', stderr=err)
|
||||
cfg = str(out).strip()
|
||||
_DEVICE_CONFIGS[cmd] = cfg
|
||||
return cfg
|
||||
|
||||
class EosConfigMixin(object):
|
||||
def check_authorization(module):
|
||||
for cmd in ['show clock', 'prompt()']:
|
||||
rc, out, err = module.exec_command(cmd)
|
||||
return out.endswith('#')
|
||||
|
||||
### Config methods ###
|
||||
def supports_sessions(module):
|
||||
rc, out, err = module.exec_command('show configuration sessions')
|
||||
return rc == 0
|
||||
|
||||
def configure(self, commands, **kwargs):
|
||||
cmds = ['configure terminal']
|
||||
cmds.extend(to_list(commands))
|
||||
cmds.append('end')
|
||||
responses = self.execute(cmds)
|
||||
return responses[1:-1]
|
||||
def run_commands(module, commands):
|
||||
"""Run list of commands on remote device and return results
|
||||
"""
|
||||
responses = list()
|
||||
|
||||
def get_config(self, include_defaults=False, **kwargs):
|
||||
cmd = 'show running-config'
|
||||
if include_defaults:
|
||||
cmd += ' all'
|
||||
return self.execute([cmd])[0]
|
||||
for cmd in to_list(commands):
|
||||
rc, out, err = module.exec_command(cmd)
|
||||
|
||||
def load_config(self, config, commit=False, replace=False):
|
||||
if self.supports_sessions():
|
||||
return self.load_config_session(config, commit, replace)
|
||||
else:
|
||||
return self.configure(config)
|
||||
|
||||
def load_config_session(self, config, commit=False, replace=False):
|
||||
""" Loads the configuration into the remote device
|
||||
"""
|
||||
session = 'ansible_%s' % int(time.time())
|
||||
commands = ['configure session %s' % session]
|
||||
|
||||
if replace:
|
||||
commands.append('rollback clean-config')
|
||||
|
||||
commands.extend(config)
|
||||
|
||||
if commands[-1] != 'end':
|
||||
commands.append('end')
|
||||
if rc != 0:
|
||||
module.fail_json(msg=err)
|
||||
|
||||
try:
|
||||
self.execute(commands)
|
||||
diff = self.diff_config(session)
|
||||
if commit:
|
||||
self.commit_config(session)
|
||||
else:
|
||||
self.execute(['no configure session %s' % session])
|
||||
except NetworkError:
|
||||
exc = get_exception()
|
||||
if 'timeout trying to send command' in to_native(exc):
|
||||
# try to get control back and get out of config mode
|
||||
if isinstance(self, Cli):
|
||||
self.execute(['\x03', 'end'])
|
||||
self.abort_config(session)
|
||||
diff = None
|
||||
raise
|
||||
|
||||
return diff
|
||||
|
||||
def save_config(self):
|
||||
self.execute(['copy running-config startup-config'])
|
||||
|
||||
def diff_config(self, session):
|
||||
commands = ['configure session %s' % session,
|
||||
'show session-config diffs',
|
||||
'end']
|
||||
|
||||
if isinstance(self, Eapi):
|
||||
response = self.execute(commands, output='text')
|
||||
response[-2] = response[-2].get('output').strip()
|
||||
else:
|
||||
response = self.execute(commands)
|
||||
|
||||
return response[-2]
|
||||
|
||||
def commit_config(self, session):
|
||||
commands = ['configure session %s' % session, 'commit']
|
||||
self.execute(commands)
|
||||
|
||||
def abort_config(self, session):
|
||||
commands = ['configure session %s' % session, 'abort']
|
||||
self.execute(commands)
|
||||
|
||||
def supports_sessions(self):
|
||||
try:
|
||||
if isinstance(self, Eapi):
|
||||
self.execute(['show configuration sessions'], output='text')
|
||||
else:
|
||||
self.execute('show configuration sessions')
|
||||
return True
|
||||
except NetworkError:
|
||||
return False
|
||||
|
||||
|
||||
|
||||
class Eapi(EosConfigMixin):
|
||||
|
||||
def __init__(self):
|
||||
self.url = None
|
||||
self.url_args = ModuleStub(url_argument_spec(), self._error)
|
||||
self.enable = None
|
||||
self.default_output = 'json'
|
||||
self._connected = False
|
||||
|
||||
def _error(self, msg):
|
||||
raise NetworkError(msg, url=self.url)
|
||||
|
||||
def _get_body(self, commands, output, reqid=None):
|
||||
"""Create a valid eAPI JSON-RPC request message
|
||||
"""
|
||||
if output not in EAPI_FORMATS:
|
||||
msg = 'invalid format, received %s, expected one of %s' % \
|
||||
(output, ', '.join(EAPI_FORMATS))
|
||||
self._error(msg=msg)
|
||||
|
||||
params = dict(version=1, cmds=commands, format=output)
|
||||
return dict(jsonrpc='2.0', id=reqid, method='runCmds', params=params)
|
||||
|
||||
def connect(self, params, **kwargs):
|
||||
host = params['host']
|
||||
port = params['port']
|
||||
|
||||
# sets the module_utils/urls.py req parameters
|
||||
self.url_args.params['url_username'] = params['username']
|
||||
self.url_args.params['url_password'] = params['password']
|
||||
self.url_args.params['validate_certs'] = params['validate_certs']
|
||||
self.url_args.params['timeout'] = params['timeout']
|
||||
|
||||
if params['use_ssl']:
|
||||
proto = 'https'
|
||||
if not port:
|
||||
port = 443
|
||||
else:
|
||||
proto = 'http'
|
||||
if not port:
|
||||
port = 80
|
||||
|
||||
self.url = '%s://%s:%s/command-api' % (proto, host, port)
|
||||
self._connected = True
|
||||
|
||||
def disconnect(self, **kwargs):
|
||||
self.url = None
|
||||
self._connected = False
|
||||
|
||||
def authorize(self, params, **kwargs):
|
||||
if params.get('auth_pass'):
|
||||
passwd = params['auth_pass']
|
||||
self.enable = dict(cmd='enable', input=passwd)
|
||||
else:
|
||||
self.enable = 'enable'
|
||||
|
||||
### Command methods ###
|
||||
|
||||
def execute(self, commands, output='json', **kwargs):
|
||||
"""Send commands to the device.
|
||||
"""
|
||||
if self.url is None:
|
||||
raise NetworkError('Not connected to endpoint.')
|
||||
|
||||
if self.enable is not None:
|
||||
commands.insert(0, self.enable)
|
||||
|
||||
body = self._get_body(commands, output)
|
||||
data = json.dumps(body)
|
||||
|
||||
headers = {'Content-Type': 'application/json-rpc'}
|
||||
timeout = self.url_args.params['timeout']
|
||||
|
||||
response, headers = fetch_url(
|
||||
self.url_args, self.url, data=data, headers=headers,
|
||||
method='POST', timeout=timeout
|
||||
)
|
||||
|
||||
if headers['status'] != 200:
|
||||
raise NetworkError(**headers)
|
||||
|
||||
try:
|
||||
response = json.loads(response.read())
|
||||
out = module.from_json(out)
|
||||
except ValueError:
|
||||
raise NetworkError('unable to load response from device')
|
||||
out = str(out).strip()
|
||||
|
||||
if 'error' in response:
|
||||
err = response['error']
|
||||
raise NetworkError(
|
||||
msg=err['message'], code=err['code'], data=err['data'],
|
||||
commands=commands
|
||||
)
|
||||
responses.append(out)
|
||||
return responses
|
||||
|
||||
if self.enable:
|
||||
response['result'].pop(0)
|
||||
def configure(module, commands):
|
||||
"""Sends configuration commands to the remote device
|
||||
"""
|
||||
if not check_authorization(module):
|
||||
module.fail_json(msg='configuration operations require privilege escalation')
|
||||
|
||||
return response['result']
|
||||
rc, out, err = module.exec_command('configure')
|
||||
if rc != 0:
|
||||
module.fail_json(msg='unable to enter configuration mode', output=err)
|
||||
|
||||
def run_commands(self, commands, **kwargs):
|
||||
output = None
|
||||
cmds = list()
|
||||
responses = list()
|
||||
for cmd in to_list(commands):
|
||||
if cmd == 'end':
|
||||
continue
|
||||
rc, out, err = module.exec_command(cmd)
|
||||
if rc != 0:
|
||||
module.fail_json(msg=err)
|
||||
|
||||
for cmd in commands:
|
||||
if output and output != cmd.output:
|
||||
responses.extend(self.execute(cmds, output=output))
|
||||
cmds = list()
|
||||
module.exec_command('end')
|
||||
|
||||
output = cmd.output
|
||||
cmds.append(str(cmd))
|
||||
def load_config(module, commands, commit=False, replace=False):
|
||||
"""Loads the config commands onto the remote device
|
||||
"""
|
||||
if not check_authorization(module):
|
||||
module.fail_json(msg='configuration operations require privilege escalation')
|
||||
|
||||
if cmds:
|
||||
responses.extend(self.execute(cmds, output=output))
|
||||
if not supports_sessions(module):
|
||||
return configure(commands)
|
||||
|
||||
for index, cmd in enumerate(commands):
|
||||
if cmd.output == 'text':
|
||||
responses[index] = responses[index].get('output')
|
||||
session = 'ansible_%s' % int(time.time())
|
||||
|
||||
return responses
|
||||
result = {'session': session}
|
||||
|
||||
### Config methods ###
|
||||
rc, out, err = module.exec_command('configure session %s' % session)
|
||||
if rc != 0:
|
||||
module.fail_json(msg='unable to enter configuration mode', output=err)
|
||||
|
||||
def get_config(self, include_defaults=False):
|
||||
cmd = 'show running-config'
|
||||
if include_defaults:
|
||||
cmd += ' all'
|
||||
return self.execute([cmd], output='text')[0]['output']
|
||||
if replace:
|
||||
module.exec_command('rollback clean-config', check_rc=True)
|
||||
|
||||
Eapi = register_transport('eapi')(Eapi)
|
||||
failed = False
|
||||
for command in to_list(commands):
|
||||
if command == 'end':
|
||||
pass
|
||||
|
||||
rc, out, err = module.exec_command(command)
|
||||
if rc != 0:
|
||||
failed = True
|
||||
break
|
||||
|
||||
class Cli(EosConfigMixin, CliBase):
|
||||
rc, out, err = module.exec_command('show session-config diffs')
|
||||
if rc == 0:
|
||||
result['diff'] = out
|
||||
|
||||
CLI_PROMPTS_RE = [
|
||||
re.compile(r"[\r\n]?[\w+\-\.:\/\[\]]+(?:\([^\)]+\)){,3}(?:>|#) ?$"),
|
||||
re.compile(r"\[\w+\@[\w\-\.]+(?: [^\]])\] ?[>#\$] ?$")
|
||||
]
|
||||
if failed:
|
||||
module.exec_command('abort')
|
||||
module.fail_json(msg=err, commands=commands)
|
||||
elif commit:
|
||||
module.exec_command('commit')
|
||||
else:
|
||||
module.exec_command('abort')
|
||||
|
||||
CLI_ERRORS_RE = [
|
||||
re.compile(r"% ?Error"),
|
||||
re.compile(r"^% \w+", re.M),
|
||||
re.compile(r"% ?Bad secret"),
|
||||
re.compile(r"invalid input", re.I),
|
||||
re.compile(r"(?:incomplete|ambiguous) command", re.I),
|
||||
re.compile(r"connection timed out", re.I),
|
||||
re.compile(r"[^\r\n]+ not found", re.I),
|
||||
re.compile(r"'[^']' +returned error code: ?\d+"),
|
||||
re.compile(r"[^\r\n]\/bin\/(?:ba)?sh")
|
||||
]
|
||||
|
||||
NET_PASSWD_RE = re.compile(r"[\r\n]?password: $", re.I)
|
||||
|
||||
def connect(self, params, **kwargs):
|
||||
super(Cli, self).connect(params, kickstart=False, **kwargs)
|
||||
self.shell.send('terminal length 0')
|
||||
|
||||
def authorize(self, params, **kwargs):
|
||||
passwd = params['auth_pass']
|
||||
if passwd:
|
||||
self.execute(Command('enable', prompt=self.NET_PASSWD_RE, response=passwd))
|
||||
else:
|
||||
self.execute('enable')
|
||||
|
||||
### Command methods ###
|
||||
|
||||
def run_commands(self, commands):
|
||||
cmds = list(prepare_commands(commands))
|
||||
responses = self.execute(cmds)
|
||||
for index, cmd in enumerate(commands):
|
||||
if cmd.output == 'json':
|
||||
try:
|
||||
responses[index] = json.loads(responses[index])
|
||||
except ValueError:
|
||||
raise NetworkError(
|
||||
msg='unable to load response from device',
|
||||
response=responses[index],
|
||||
responses=responses
|
||||
)
|
||||
return responses
|
||||
|
||||
Cli = register_transport('cli', default=True)(Cli)
|
||||
|
||||
|
||||
def prepare_config(commands):
|
||||
commands = to_list(commands)
|
||||
commands.insert(0, 'configure terminal')
|
||||
commands.append('end')
|
||||
return commands
|
||||
|
||||
|
||||
def prepare_commands(commands):
|
||||
jsonify = lambda x: '%s | json' % x
|
||||
for item in to_list(commands):
|
||||
if item.output == 'json':
|
||||
cmd = jsonify(item)
|
||||
elif item.command.endswith('| json'):
|
||||
item.output = 'json'
|
||||
cmd = str(item)
|
||||
else:
|
||||
cmd = str(item)
|
||||
yield cmd
|
||||
return result
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue