From beb2af83c16294bac949c64d29cdb7e61a2c15ac Mon Sep 17 00:00:00 2001 From: Nilashish Chakraborty Date: Fri, 1 Feb 2019 17:56:31 +0530 Subject: [PATCH] frr: Add terminal and cliconf plugins (#51169) * Added terminal plugin for FRR Signed-off-by: NilashishC * Added cliconf plugin for FRR Signed-off-by: NilashishC * Added cliconf plugin for FRR Signed-off-by: NilashishC * Override required methods Signed-off-by: NilashishC * Fix pep8 issues Signed-off-by: NilashishC * Add get_supported_protocols and minor error regex fix Signed-off-by: NilashishC * Remove unused imports Signed-off-by: NilashishC * Fix review comments Signed-off-by: NilashishC * Add get_diff and run_commands Signed-off-by: NilashishC * Set output to empty list Signed-off-by: NilashishC * Fix CI errors Signed-off-by: NilashishC --- lib/ansible/plugins/cliconf/frr.py | 218 ++++++++++++++++++++++++++++ lib/ansible/plugins/terminal/frr.py | 60 ++++++++ 2 files changed, 278 insertions(+) create mode 100644 lib/ansible/plugins/cliconf/frr.py create mode 100644 lib/ansible/plugins/terminal/frr.py diff --git a/lib/ansible/plugins/cliconf/frr.py b/lib/ansible/plugins/cliconf/frr.py new file mode 100644 index 00000000000..e3201de7dd0 --- /dev/null +++ b/lib/ansible/plugins/cliconf/frr.py @@ -0,0 +1,218 @@ +# +# (c) 2018 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 . +# +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +DOCUMENTATION = """ +--- +author: Ansible Networking Team +cliconf: frr +short_description: Use frr cliconf to run command on Free Range Routing platform +description: + - This frr plugin provides low level abstraction api's for + sending and receiving CLI commands from devices running frr. +version_added: "2.8" +""" + +import re +import json + +from ansible.errors import AnsibleConnectionFailure +from ansible.module_utils._text import to_text +from ansible.module_utils.common._collections_compat import Mapping +from ansible.module_utils.network.common.config import NetworkConfig, dumps +from ansible.module_utils.network.common.utils import to_list +from ansible.module_utils.basic import get_timestamp +from ansible.plugins.cliconf import CliconfBase, enable_mode + + +class Cliconf(CliconfBase): + + def get_supported_protocols(self): + supported_protocols = {} + protocols = ['bgp', 'isis', 'ospf', 'ldp', 'ospf6', 'pim', 'rip', 'ripm', 'zebra'] + daemons = self.get('show daemons') + data = to_text(daemons, errors='surrogate_or_strict').strip() + + for item in protocols: + supported_protocols[item] = True if item in data else False + return supported_protocols + + def get_device_info(self): + device_info = {} + + device_info['network_os'] = 'frr' + reply = self.get('show version') + data = to_text(reply, errors='surrogate_or_strict').strip() + + match = re.search(r'FRRouting (\S+) \((\S+)\)', data) + if match: + device_info['network_os_version'] = match.group(1) + if match.group(2): + device_info['network_os_hostname'] = match.group(2) + + return device_info + + def get_option_values(self): + return { + 'format': ['text'], + 'diff_match': ['line', 'strict', 'exact', 'none'], + 'diff_replace': ['line', 'block'], + 'output': [] + } + + def get_device_operations(self): + return { + 'supports_diff_replace': False, + 'supports_commit': False, + 'supports_rollback': False, + 'supports_defaults': False, + 'supports_onbox_diff': False, + 'supports_commit_comment': False, + 'supports_multiline_delimiter': False, + 'supports_diff_match': False, + 'supports_diff_ignore_lines': False, + 'supports_generate_diff': True, + 'supports_replace': False + } + + def get_capabilities(self): + result = super(Cliconf, self).get_capabilities() + result['rpc'] += ['get_diff', 'run_commands'] + result['device_operations'] = self.get_device_operations() + result['supported_protocols'] = self.get_supported_protocols() + result.update(self.get_option_values()) + return json.dumps(result) + + def get_diff(self, candidate=None, running=None, diff_match='line', diff_ignore_lines=None, path=None, diff_replace='line'): + + diff = {} + device_operations = self.get_device_operations() + option_values = self.get_option_values() + + if candidate is None and device_operations['supports_generate_diff']: + raise ValueError("candidate configuration is required to generate diff") + + if diff_match not in option_values['diff_match']: + raise ValueError("'match' value %s in invalid, valid values are %s" % ( + diff_match, ', '.join(option_values['diff_match']))) + + if diff_replace not in option_values['diff_replace']: + raise ValueError("'replace' value %s in invalid, valid values are %s" % ( + diff_replace, ', '.join(option_values['diff_replace']))) + + # prepare candidate configuration + candidate_obj = NetworkConfig(indent=1) + candidate_obj.load(candidate) + + if running and diff_match != 'none': + # running configuration + running_obj = NetworkConfig(indent=1, contents=running, ignore_lines=diff_ignore_lines) + configdiffobjs = candidate_obj.difference(running_obj, path=path, match=diff_match, replace=diff_replace) + + else: + configdiffobjs = candidate_obj.items + + diff['config_diff'] = dumps(configdiffobjs, 'commands') if configdiffobjs else '' + return diff + + @enable_mode + def get_config(self, source='running', flags=None, format=None): + if source not in ('running', 'startup'): + raise ValueError("fetching configuration from %s is not supported" % source) + + if format: + raise ValueError("'format' value %s is not supported for get_config" % format) + + if not flags: + flags = [] + if source == 'running': + cmd = 'show running-config ' + else: + cmd = 'show startup-config ' + + cmd += ' '.join(to_list(flags)) + cmd = cmd.strip() + + return self.send_command(cmd) + + @enable_mode + def edit_config(self, candidate=None, commit=True, replace=None, comment=None): + resp = {} + operations = self.get_device_operations() + self.check_edit_config_capability(operations, candidate, commit, replace, comment) + + results = [] + requests = [] + if commit: + self.send_command('configure terminal') + for line in to_list(candidate): + if not isinstance(line, Mapping): + line = {'command': line} + + cmd = line['command'] + if cmd != 'end' and cmd[0] != '!': + results.append(self.send_command(**line)) + requests.append(cmd) + + self.send_command('end') + else: + raise ValueError('check mode is not supported') + + resp['request'] = requests + resp['response'] = results + return resp + + def get(self, command=None, prompt=None, answer=None, sendonly=False, output=None, check_all=False): + if not command: + raise ValueError('must provide value of command to execute') + if output: + raise ValueError("'output' value %s is not supported for get" % output) + + return self.send_command(command=command, prompt=prompt, answer=answer, sendonly=sendonly, check_all=check_all) + + def run_commands(self, commands=None, check_rc=True, return_timestamps=False): + if commands is None: + raise ValueError("'commands' value is required") + + responses = list() + timestamps = list() + for cmd in to_list(commands): + if not isinstance(cmd, Mapping): + cmd = {'command': cmd} + + output = cmd.pop('output', None) + if output: + raise ValueError("'output' value %s is not supported for run_commands" % output) + + try: + out = self.send_command(**cmd) + timestamp = get_timestamp() + except AnsibleConnectionFailure as e: + if check_rc: + raise + out = getattr(e, 'err', to_text(e)) + + responses.append(out) + timestamps.append(timestamp) + + if return_timestamps: + return responses, timestamps + else: + return responses diff --git a/lib/ansible/plugins/terminal/frr.py b/lib/ansible/plugins/terminal/frr.py new file mode 100644 index 00000000000..937e0809d2c --- /dev/null +++ b/lib/ansible/plugins/terminal/frr.py @@ -0,0 +1,60 @@ +# +# (c) 2018 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 . +# +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +import re + +from ansible.errors import AnsibleConnectionFailure +from ansible.plugins.terminal import TerminalBase + + +class TerminalModule(TerminalBase): + + terminal_stdout_re = [ + re.compile(br"[\r\n]?[\w\+\-\.:\/\[\]]+(?:\([^\)]+\)){0,3}(?:[>#]) ?$") + ] + + terminal_stderr_re = [ + re.compile(br"% Command incomplete", re.I), + re.compile(br"% Unknown command", re.I), + re.compile(br"(?:\S+) instance is already running", re.I), + re.compile(br"% (?:Create|Specify) .* first", re.I), + re.compile(br"(?:\S+) is not running", re.I), + re.compile(br"% Can't find .*", re.I), + re.compile(br"invalid input", re.I), + re.compile(br"connection timed out", re.I), + re.compile(br"[^\r\n]+ not found"), + ] + + def on_open_shell(self): + try: + self._exec_cli_command(b'terminal length 0') + except AnsibleConnectionFailure: + raise AnsibleConnectionFailure('unable to set terminal parameters') + + def on_become(self, passwd=None): + # NOTE: For FRR, enable password only takes effect when telnetting to individual daemons + # vtysh will always drop into enable mode since it runs as a privileged process + pass + + def on_unbecome(self): + # NOTE: For FRR, enable password only takes effect when telnetting to individual daemons + # vtysh will always drop into enable mode since it runs as a privileged process + pass