diff --git a/changelogs/fragments/add_symlinks_redirection.yml b/changelogs/fragments/add_symlinks_redirection.yml new file mode 100644 index 0000000..ced71e9 --- /dev/null +++ b/changelogs/fragments/add_symlinks_redirection.yml @@ -0,0 +1,3 @@ +--- +bugfixes: + - Add symlink of modules under plugins/action diff --git a/docs/vyos.vyos.vyos_cliconf.rst b/docs/vyos.vyos.vyos_cliconf.rst index 9ad60af..816f07c 100644 --- a/docs/vyos.vyos.vyos_cliconf.rst +++ b/docs/vyos.vyos.vyos_cliconf.rst @@ -1,79 +1,80 @@ .. _vyos.vyos.vyos_cliconf: ************** vyos.vyos.vyos ************** **Use vyos cliconf to run command on VyOS platform** Version added: 1.0.0 .. contents:: :local: :depth: 1 Synopsis -------- - This vyos plugin provides low level abstraction apis for sending and receiving CLI commands from VyOS network devices. Parameters ---------- .. raw:: html
Parameter Choices/Defaults Configuration Comments
config_commands
list + / elements=string
added in 2.0.0
 Default:
[]
var: ansible_vyos_config_commands
Specifies a list of commands that can make configuration changes to the target device.
When `ansible_network_single_user_mode` is enabled, if a command sent to the device is present in this list, the existing cache is invalidated.

Status ------ Authors ~~~~~~~ - Ansible Networking Team (@ansible-network) .. hint:: Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/meta/runtime.yml b/meta/runtime.yml index 814c20b..8bd9d88 100644 --- a/meta/runtime.yml +++ b/meta/runtime.yml @@ -1,258 +1,121 @@ --- requires_ansible: ">=2.9.10" plugin_routing: - action: - vyos_banner: - redirect: vyos.vyos.vyos - banner: - redirect: vyos.vyos.vyos - vyos_bgp_global: - redirect: vyos.vyos.vyos - bgp_global: - redirect: vyos.vyos.vyos - vyos_bgp_address_family: - redirect: vyos.vyos.vyos - bgp_address_family: - redirect: vyos.vyos.vyos - vyos_command: - redirect: vyos.vyos.vyos - command: - redirect: vyos.vyos.vyos - vyos_config: - redirect: vyos.vyos.vyos - config: - redirect: vyos.vyos.vyos - vyos_facts: - redirect: vyos.vyos.vyos - facts: - redirect: vyos.vyos.vyos - vyos_firewall_global: - redirect: vyos.vyos.vyos - firewall_global: - redirect: vyos.vyos.vyos - vyos_firewall_interfaces: - redirect: vyos.vyos.vyos - firewall_interfaces: - redirect: vyos.vyos.vyos - vyos_firewall_rules: - redirect: vyos.vyos.vyos - firewall_rules: - redirect: vyos.vyos.vyos - vyos_hostname: - redirect: vyos.vyos.vyos - hostname: - redirect: vyos.vyos.vyos - vyos_interface: - redirect: vyos.vyos.vyos - interface: - redirect: vyos.vyos.vyos - vyos_interfaces: - redirect: vyos.vyos.vyos - interfaces: - redirect: vyos.vyos.vyos - vyos_l3_interface: - redirect: vyos.vyos.vyos - l3_interface: - redirect: vyos.vyos.vyos - vyos_l3_interfaces: - redirect: vyos.vyos.vyos - l3_interfaces: - redirect: vyos.vyos.vyos - vyos_lag_interfaces: - redirect: vyos.vyos.vyos - lag_interfaces: - redirect: vyos.vyos.vyos - vyos_linkagg: - redirect: vyos.vyos.vyos - linkagg: - redirect: vyos.vyos.vyos - vyos_lldp: - redirect: vyos.vyos.vyos - lldp: - redirect: vyos.vyos.vyos - vyos_lldp_global: - redirect: vyos.vyos.vyos - lldp_global: - redirect: vyos.vyos.vyos - vyos_lldp_interface: - redirect: vyos.vyos.vyos - lldp_interface: - redirect: vyos.vyos.vyos - vyos_lldp_interfaces: - redirect: vyos.vyos.vyos - lldp_interfaces: - redirect: vyos.vyos.vyos - vyos_logging: - redirect: vyos.vyos.vyos - vyos_logging_global: - redirect: vyos.vyos.vyos - logging_global: - redirect: vyos.vyos.vyos - logging: - redirect: vyos.vyos.vyos - vyos_ntp_global: - redirect: vyos.vyos.vyos - ntp_global: - redirect: vyos.vyos.vyos - vyos_ospfv2: - redirect: vyos.vyos.vyos - ospfv2: - redirect: vyos.vyos.vyos - vyos_ospfv3: - redirect: vyos.vyos.vyos - ospfv3: - redirect: vyos.vyos.vyos - vyos_ospf_interfaces: - redirect: vyos.vyos.vyos - ospf_interfaces: - redirect: vyos.vyos.vyos - vyos_ping: - redirect: vyos.vyos.vyos - ping: - redirect: vyos.vyos.vyos - vyos_prefix_lists: - redirect: vyos.vyos.vyos - prefix_lists: - redirect: vyos.vyos.vyos - vyos_snmp_server: - redirect: vyos.vyos.vyos - snmp_server: - redirect: vyos.vyos.vyos - vyos_static_route: - redirect: vyos.vyos.vyos - static_route: - redirect: vyos.vyos.vyos - vyos_static_routes: - redirect: vyos.vyos.vyos - static_routes: - redirect: vyos.vyos.vyos - vyos_system: - redirect: vyos.vyos.vyos - system: - redirect: vyos.vyos.vyos - vyos_user: - redirect: vyos.vyos.vyos - user: - redirect: vyos.vyos.vyos - vyos_vlan: - redirect: vyos.vyos.vyos - vlan: - redirect: vyos.vyos.vyos modules: banner: redirect: vyos.vyos.vyos_banner bgp_global: redirect: vyos.vyos.vyos_bgp_global bgp_address_family: redirect: vyos.vyos.vyos_bgp_address_family command: redirect: vyos.vyos.vyos_command config: redirect: vyos.vyos.vyos_config facts: redirect: vyos.vyos.vyos_facts firewall_global: redirect: vyos.vyos.vyos_firewall_global firewall_interfaces: redirect: vyos.vyos.vyos_firewall_interfaces firewall_rules: redirect: vyos.vyos.vyos_firewall_rules hostname: redirect: vyos.vyos.vyos_hostname interface: redirect: vyos.vyos.vyos_interface deprecation: removal_date: "2022-06-01" warning_text: See the plugin documentation for more details vyos_interface: deprecation: removal_date: "2022-06-01" warning_text: See the plugin documentation for more details interfaces: redirect: vyos.vyos.vyos_interfaces l3_interface: redirect: vyos.vyos.vyos_l3_interface deprecation: removal_date: "2022-06-01" warning_text: See the plugin documentation for more details vyos_l3_interface: deprecation: removal_date: "2022-06-01" warning_text: See the plugin documentation for more details l3_interfaces: redirect: vyos.vyos.vyos_l3_interfaces lag_interfaces: redirect: vyos.vyos.vyos_lag_interfaces linkagg: redirect: vyos.vyos.vyos_linkagg deprecation: removal_date: "2022-06-01" warning_text: See the plugin documentation for more details vyos_linkagg: deprecation: removal_date: "2022-06-01" warning_text: See the plugin documentation for more details lldp: redirect: vyos.vyos.vyos_lldp deprecation: removal_date: "2022-06-01" warning_text: See the plugin documentation for more details vyos_lldp: deprecation: removal_date: "2022-06-01" warning_text: See the plugin documentation for more details lldp_global: redirect: vyos.vyos.vyos_lldp_global lldp_interface: redirect: vyos.vyos.vyos_lldp_interface deprecation: removal_date: "2022-06-01" warning_text: See the plugin documentation for more details vyos_lldp_interface: deprecation: removal_date: "2022-06-01" warning_text: See the plugin documentation for more details lldp_interfaces: redirect: vyos.vyos.vyos_lldp_interfaces logging: redirect: vyos.vyos.vyos_logging deprecation: removal_date: '2023-08-01' warning_text: See the plugin documentation for more details vyos_logging: deprecation: removal_date: '2023-08-01' warning_text: See the plugin documentation for more details logging_global: redirect: vyos.vyos.vyos_logging_global ntp_global: redirect: vyos.vyos.vyos_ntp_global ospfv2: redirect: vyos.vyos.vyos_ospfv2 ospfv3: redirect: vyos.vyos.vyos_ospfv3 ospf_interfaces: redirect: vyos.vyos.vyos_ospf_interfaces ping: redirect: vyos.vyos.vyos_ping prefix_lists: redirect: vyos.vyos.vyos_prefix_lists snmp_server: redirect: vyos.vyos.vyos_snmp_servers static_route: redirect: vyos.vyos.vyos_static_route deprecation: removal_date: "2022-06-01" warning_text: See the plugin documentation for more details vyos_static_route: deprecation: removal_date: "2022-06-01" warning_text: See the plugin documentation for more details static_routes: redirect: vyos.vyos.vyos_static_routes system: redirect: vyos.vyos.vyos_system user: redirect: vyos.vyos.vyos_user vlan: redirect: vyos.vyos.vyos_vlan diff --git a/plugins/action/banner.py b/plugins/action/banner.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/banner.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/bgp_address_family.py b/plugins/action/bgp_address_family.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/bgp_address_family.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/bgp_global.py b/plugins/action/bgp_global.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/bgp_global.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/command.py b/plugins/action/command.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/command.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/config.py b/plugins/action/config.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/config.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/facts.py b/plugins/action/facts.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/facts.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/firewall_global.py b/plugins/action/firewall_global.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/firewall_global.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/firewall_interfaces.py b/plugins/action/firewall_interfaces.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/firewall_interfaces.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/firewall_rules.py b/plugins/action/firewall_rules.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/firewall_rules.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/hostname.py b/plugins/action/hostname.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/hostname.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/interface.py b/plugins/action/interface.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/interface.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/interfaces.py b/plugins/action/interfaces.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/interfaces.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/l3_interface.py b/plugins/action/l3_interface.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/l3_interface.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/l3_interfaces.py b/plugins/action/l3_interfaces.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/l3_interfaces.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/lag_interfaces.py b/plugins/action/lag_interfaces.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/lag_interfaces.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/linkagg.py b/plugins/action/linkagg.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/linkagg.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/lldp.py b/plugins/action/lldp.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/lldp.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/lldp_global.py b/plugins/action/lldp_global.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/lldp_global.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/lldp_interface.py b/plugins/action/lldp_interface.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/lldp_interface.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/lldp_interfaces.py b/plugins/action/lldp_interfaces.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/lldp_interfaces.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/logging.py b/plugins/action/logging.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/logging.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/logging_global.py b/plugins/action/logging_global.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/logging_global.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/ntp_global.py b/plugins/action/ntp_global.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/ntp_global.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/ospf_interfaces.py b/plugins/action/ospf_interfaces.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/ospf_interfaces.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/ospfv2.py b/plugins/action/ospfv2.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/ospfv2.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/ospfv3.py b/plugins/action/ospfv3.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/ospfv3.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/ping.py b/plugins/action/ping.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/ping.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/prefix_lists.py b/plugins/action/prefix_lists.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/prefix_lists.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/route_maps.py b/plugins/action/route_maps.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/route_maps.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/snmp_server.py b/plugins/action/snmp_server.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/snmp_server.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/static_route.py b/plugins/action/static_route.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/static_route.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/static_routes.py b/plugins/action/static_routes.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/static_routes.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/system.py b/plugins/action/system.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/system.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/user.py b/plugins/action/user.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/user.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/action/vlan.py b/plugins/action/vlan.py new file mode 120000 index 0000000..331a791 --- /dev/null +++ b/plugins/action/vlan.py @@ -0,0 +1 @@ +vyos.py \ No newline at end of file diff --git a/plugins/cliconf/vyos.py b/plugins/cliconf/vyos.py index b100ce0..b1a55b1 100644 --- a/plugins/cliconf/vyos.py +++ b/plugins/cliconf/vyos.py @@ -1,360 +1,361 @@ # (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 . # from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = """ author: Ansible Networking Team (@ansible-network) name: vyos short_description: Use vyos cliconf to run command on VyOS platform description: - This vyos plugin provides low level abstraction apis for sending and receiving CLI commands from VyOS network devices. version_added: 1.0.0 options: config_commands: description: - Specifies a list of commands that can make configuration changes to the target device. - When `ansible_network_single_user_mode` is enabled, if a command sent to the device is present in this list, the existing cache is invalidated. version_added: 2.0.0 type: list + elements: str default: [] vars: - name: ansible_vyos_config_commands """ 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_collections.ansible.netcommon.plugins.module_utils.network.common.config import ( NetworkConfig, ) from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import ( to_list, ) from ansible.plugins.cliconf import CliconfBase class Cliconf(CliconfBase): __rpc__ = CliconfBase.__rpc__ + [ "commit", "discard_changes", "get_diff", "run_commands", ] def __init__(self, *args, **kwargs): super(Cliconf, self).__init__(*args, **kwargs) self._device_info = {} def get_device_info(self): if not self._device_info: device_info = {} device_info["network_os"] = "vyos" reply = self.get("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"HW model:\s*(\S+)", data) if match: device_info["network_os_model"] = match.group(1) reply = self.get("show host name") device_info["network_os_hostname"] = to_text( reply, errors="surrogate_or_strict" ).strip() self._device_info = device_info return self._device_info def get_config(self, flags=None, format=None): if format: option_values = self.get_option_values() if format not in option_values["format"]: raise ValueError( "'format' value %s is invalid. Valid values of format are %s" % (format, ", ".join(option_values["format"])) ) if not flags: flags = [] if format == "text": command = "show configuration" else: command = "show configuration commands" command += " ".join(to_list(flags)) command = command.strip() out = self.send_command(command) return out 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 = [] self.send_command("configure") for cmd in to_list(candidate): if not isinstance(cmd, Mapping): cmd = {"command": cmd} results.append(self.send_command(**cmd)) requests.append(cmd["command"]) out = self.get("compare") out = to_text(out, errors="surrogate_or_strict") diff_config = out if not out.startswith("No changes") else None if diff_config: if commit: try: self.commit(comment) except AnsibleConnectionFailure as e: msg = "commit failed: %s" % e.message self.discard_changes() raise AnsibleConnectionFailure(msg) else: self.send_command("exit") else: self.discard_changes() else: self.send_command("exit") if ( to_text( self._connection.get_prompt(), errors="surrogate_or_strict" ) .strip() .endswith("#") ): self.discard_changes() if diff_config: resp["diff"] = diff_config resp["response"] = results resp["request"] = requests return resp def get( self, command=None, prompt=None, answer=None, sendonly=False, newline=True, 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, newline=newline, check_all=check_all, ) def commit(self, comment=None): if comment: command = 'commit comment "{0}"'.format(comment) else: command = "commit" self.send_command(command) def discard_changes(self): self.send_command("exit discard") def get_diff( self, candidate=None, running=None, diff_match="line", diff_ignore_lines=None, path=None, diff_replace=None, ): 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: raise ValueError("'replace' in diff is not supported") if diff_ignore_lines: raise ValueError("'diff_ignore_lines' in diff is not supported") if path: raise ValueError("'path' in diff is not supported") set_format = candidate.startswith("set") or candidate.startswith( "delete" ) candidate_obj = NetworkConfig(indent=4, contents=candidate) if not set_format: config = [c.line for c in candidate_obj.items] commands = list() # this filters out less specific lines for item in config: for index, entry in enumerate(commands): if item.startswith(entry): del commands[index] break commands.append(item) candidate_commands = [ "set %s" % cmd.replace(" {", "") for cmd in commands ] else: candidate_commands = str(candidate).strip().split("\n") if diff_match == "none": diff["config_diff"] = list(candidate_commands) return diff running_commands = [ str(c).replace("'", "") for c in running.splitlines() ] updates = list() visited = set() for line in candidate_commands: item = str(line).replace("'", "") if not item.startswith("set") and not item.startswith("delete"): raise ValueError( "line must start with either `set` or `delete`" ) elif item.startswith("set") and item not in running_commands: updates.append(line) elif item.startswith("delete"): if not running_commands: updates.append(line) else: item = re.sub(r"delete", "set", item) for entry in running_commands: if entry.startswith(item) and line not in visited: updates.append(line) visited.add(line) diff["config_diff"] = list(updates) return diff def run_commands(self, commands=None, check_rc=True): if commands is None: raise ValueError("'commands' value is required") responses = 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) except AnsibleConnectionFailure as e: if check_rc: raise out = getattr(e, "err", e) responses.append(out) return responses def get_device_operations(self): return { "supports_diff_replace": False, "supports_commit": True, "supports_rollback": False, "supports_defaults": False, "supports_onbox_diff": True, "supports_commit_comment": True, "supports_multiline_delimiter": False, "supports_diff_match": True, "supports_diff_ignore_lines": False, "supports_generate_diff": False, "supports_replace": False, } def get_option_values(self): return { "format": ["text", "set"], "diff_match": ["line", "none"], "diff_replace": [], "output": [], } def get_capabilities(self): result = super(Cliconf, self).get_capabilities() result["device_operations"] = self.get_device_operations() result.update(self.get_option_values()) return json.dumps(result) def set_cli_prompt_context(self): """ Make sure we are in the operational cli mode :return: None """ if self._connection.connected: self._update_cli_prompt_context( config_context="#", exit_command="exit discard" ) diff --git a/plugins/terminal/vyos.py b/plugins/terminal/vyos.py index 0b5e74b..850e528 100644 --- a/plugins/terminal/vyos.py +++ b/plugins/terminal/vyos.py @@ -1,76 +1,76 @@ # # (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 . # from __future__ import absolute_import, division, print_function __metaclass__ = type import os import re from ansible.plugins.terminal import TerminalBase from ansible.errors import AnsibleConnectionFailure class TerminalModule(TerminalBase): terminal_stdout_re = [ - re.compile(br"[\r\n]?[\w+\-\.:\/\[\]]+(?:\([^\)]+\)){,3}(?:>|#) ?$"), - re.compile(br"\@[\w\-\.]+:\S+?[>#\$] ?$"), + re.compile(rb"[\r\n]?[\w+\-\.:\/\[\]]+(?:\([^\)]+\)){,3}(?:>|#) ?$"), + re.compile(rb"\@[\w\-\.]+:\S+?[>#\$] ?$"), ] terminal_stderr_re = [ - re.compile(br"\n\s*Invalid command:"), - re.compile(br"\nCommit failed"), - re.compile(br"\n\s+Set failed"), - re.compile(br"\n\s+Delete failed"), + re.compile(rb"\n\s*Invalid command:"), + re.compile(rb"\nCommit failed"), + re.compile(rb"\n\s+Set failed"), + re.compile(rb"\n\s+Delete failed"), ] ansi_re = TerminalBase.ansi_re + [ # Color codes - re.compile(br"\x1b\[(\d+(;\d+)*)?m"), + re.compile(rb"\x1b\[(\d+(;\d+)*)?m"), # Clear line (CSI K) - re.compile(br"\x1b\[K"), + re.compile(rb"\x1b\[K"), # Xterm change cursor mode (CSI ? 1 [h|l]) - re.compile(br"\x1b\[\?1(h|l)"), + re.compile(rb"\x1b\[\?1(h|l)"), # Xterm change keypad (ESC [=|>]) - re.compile(br"\x1b(=|>)"), + re.compile(rb"\x1b(=|>)"), # Xterm window title string (OSC BEL) - re.compile(br"\x1b]0;[^\x07]*\x07"), + re.compile(rb"\x1b]0;[^\x07]*\x07"), ] terminal_config_prompt = re.compile(r"^.+#$") try: terminal_length = os.getenv("ANSIBLE_VYOS_TERMINAL_LENGTH", 10000) terminal_length = int(terminal_length) except ValueError: raise AnsibleConnectionFailure( "Invalid value set for vyos terminal length '%s', value should be a valid integer string" % terminal_length ) def on_open_shell(self): try: for cmd in (b"set terminal length 0", b"set terminal width 512"): self._exec_cli_command(cmd) self._exec_cli_command( b"set terminal length %d" % self.terminal_length ) except AnsibleConnectionFailure: raise AnsibleConnectionFailure("unable to set terminal parameters") diff --git a/test-requirements.txt b/test-requirements.txt index aa3427d..5baa138 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,7 +1,7 @@ -black==21.12b0 ; python_version > '3.5' +black==22.3.0 ; python_version > '3.5' flake8 mock pexpect pytest-xdist yamllint coverage==4.5.4 diff --git a/tests/sanity/ignore-2.14.txt b/tests/sanity/ignore-2.14.txt new file mode 100644 index 0000000..c835eef --- /dev/null +++ b/tests/sanity/ignore-2.14.txt @@ -0,0 +1 @@ +plugins/action/vyos.py action-plugin-docs # base class for deprecated network platform modules using `connection: local`