diff --git a/.github/BOTMETA.yml b/.github/BOTMETA.yml
index ddf9cd3a6c..13aee0d580 100644
--- a/.github/BOTMETA.yml
+++ b/.github/BOTMETA.yml
@@ -500,6 +500,7 @@ files:
$modules/network/panos/: ivanbojer jtschichold
$modules/network/panos/panos_address.py: itdependsnetworks ivanbojer jtschichold
$modules/network/protocol/: $team_networking
+ $modules/network/routeros/: heuels
$modules/network/routing/: $team_networking
$modules/network/slxos/: $team_extreme
$modules/network/sros/: privateip
@@ -895,6 +896,9 @@ files:
$module_utils/network/onyx:
maintainers: $team_onyx
labels: networking
+ $module_utils/network/routeros:
+ maintainers: heuels
+ labels: networking
$module_utils/network/slxos:
maintainers: $team_extreme
labels: networking
@@ -1021,6 +1025,9 @@ files:
lib/ansible/plugins/cliconf/onyx.py:
maintainers: $team_onyx
labels: networking
+ lib/ansible/plugins/cliconf/routeros.py:
+ maintainers: heuels
+ labels: networking
lib/ansible/plugins/cliconf/slxos.py:
maintainers: $team_extreme
labels: networking
@@ -1128,6 +1135,9 @@ files:
lib/ansible/plugins/terminal/onyx.py:
maintainers: $team_onyx
labels: networking
+ lib/ansible/plugins/terminal/routeros.py:
+ maintainers: heuels
+ labels: networking
lib/ansible/plugins/terminal/slxos.py:
maintainers: $team_extreme
labels: networking
diff --git a/docs/docsite/rst/network/user_guide/platform_index.rst b/docs/docsite/rst/network/user_guide/platform_index.rst
index c43abeb53e..c2e50c0f30 100644
--- a/docs/docsite/rst/network/user_guide/platform_index.rst
+++ b/docs/docsite/rst/network/user_guide/platform_index.rst
@@ -15,38 +15,41 @@ Some Ansible Network platforms support multiple connection types, privilege esca
platform_ironware
platform_junos
platform_nxos
+ platform_routeros
.. _settings_by_platform:
Settings by Platform
================================
-+------------------+-------------------------+----------------------+----------------------+------------------+------------------+
-|.. | | ``ansible_connection:`` settings available |
-+------------------+-------------------------+----------------------+----------------------+------------------+------------------+
-| Network OS | ``ansible_network_os:`` | network_cli | netconf | httpapi | local |
-+==================+=========================+======================+======================+==================+==================+
-| Arista EOS* | ``eos`` | in v. >=2.5 | N/A | in v. >=2.6 | in v. >=2.4 |
-+------------------+-------------------------+----------------------+----------------------+------------------+------------------+
-| Cisco ASA | ``asa`` | in v. >=2.5 | N/A | N/A | in v. >=2.4 |
-+------------------+-------------------------+----------------------+----------------------+------------------+------------------+
-| Cisco IOS* | ``ios`` | in v. >=2.5 | N/A | N/A | in v. >=2.4 |
-+------------------+-------------------------+----------------------+----------------------+------------------+------------------+
-| Cisco IOS XR* | ``iosxr`` | in v. >=2.5 | N/A | N/A | in v. >=2.4 |
-+------------------+-------------------------+----------------------+----------------------+------------------+------------------+
-| Cisco NX-OS* | ``nxos`` | in v. >=2.5 | N/A | in v. >=2.6 | in v. >=2.4 |
-+------------------+-------------------------+----------------------+----------------------+------------------+------------------+
-| Extreme IronWare | ``ironware`` | in v. >=2.5 | N/A | N/A | in v. >=2.5 |
-+------------------+-------------------------+----------------------+----------------------+------------------+------------------+
-| F5 BIG-IP | N/A | N/A | N/A | N/A | in v. >=2.0 |
-+------------------+-------------------------+----------------------+----------------------+------------------+------------------+
-| F5 BIG-IQ | N/A | N/A | N/A | N/A | in v. >=2.0 |
-+------------------+-------------------------+----------------------+----------------------+------------------+------------------+
-| Junos OS* | ``junos`` | in v. >=2.5 | in v. >=2.5 | N/A | in v. >=2.4 |
-+------------------+-------------------------+----------------------+----------------------+------------------+------------------+
-| Nokia SR OS | ``sros`` | in v. >=2.5 | N/A | N/A | in v. >=2.4 |
-+------------------+-------------------------+----------------------+----------------------+------------------+------------------+
-| VyOS* | ``vyos`` | in v. >=2.5 | N/A | N/A | in v. >=2.4 |
-+------------------+-------------------------+----------------------+----------------------+------------------+------------------+
++-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+|.. | | ``ansible_connection:`` settings available |
++-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| Network OS | ``ansible_network_os:`` | network_cli | netconf | httpapi | local |
++===================+=========================+======================+======================+==================+==================+
+| Arista EOS* | ``eos`` | in v. >=2.5 | N/A | in v. >=2.6 | in v. >=2.4 |
++-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| Cisco ASA | ``asa`` | in v. >=2.5 | N/A | N/A | in v. >=2.4 |
++-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| Cisco IOS* | ``ios`` | in v. >=2.5 | N/A | N/A | in v. >=2.4 |
++-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| Cisco IOS XR* | ``iosxr`` | in v. >=2.5 | N/A | N/A | in v. >=2.4 |
++-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| Cisco NX-OS* | ``nxos`` | in v. >=2.5 | N/A | in v. >=2.6 | in v. >=2.4 |
++-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| Extreme IronWare | ``ironware`` | in v. >=2.5 | N/A | N/A | in v. >=2.5 |
++-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| F5 BIG-IP | N/A | N/A | N/A | N/A | in v. >=2.0 |
++-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| F5 BIG-IQ | N/A | N/A | N/A | N/A | in v. >=2.0 |
++-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| Junos OS* | ``junos`` | in v. >=2.5 | in v. >=2.5 | N/A | in v. >=2.4 |
++-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| MikroTik RouterOS | ``routeros`` | in v. >=2.7 | N/A | N/A | N/A |
++-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| Nokia SR OS | ``sros`` | in v. >=2.5 | N/A | N/A | in v. >=2.4 |
++-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| VyOS* | ``vyos`` | in v. >=2.5 | N/A | N/A | in v. >=2.4 |
++-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
`*` Maintained by Ansible Network Team
diff --git a/docs/docsite/rst/network/user_guide/platform_routeros.rst b/docs/docsite/rst/network/user_guide/platform_routeros.rst
new file mode 100644
index 0000000000..cd6fac1cfd
--- /dev/null
+++ b/docs/docsite/rst/network/user_guide/platform_routeros.rst
@@ -0,0 +1,65 @@
+.. _routeros_platform_options:
+
+***************************************
+RouterOS Platform Options
+***************************************
+
+.. contents:: Topics
+
+Connections Available
+================================================================================
+
++---------------------------+-----------------------------------------------+
+|.. | CLI |
++===========================+===============================================+
+| **Protocol** | SSH |
++---------------------------+-----------------------------------------------+
+| | **Credentials** | | uses SSH keys / SSH-agent if present |
+| | | | accepts ``-u myuser -k`` if using password |
++---------------------------+-----------------------------------------------+
+| **Indirect Access** | via a bastion (jump host) |
++---------------------------+-----------------------------------------------+
+| | **Connection Settings** | | ``ansible_connection: network_cli`` |
+| | | | |
+| | | | |
++---------------------------+-----------------------------------------------+
+| | **Enable Mode** | | not supported by RouterOS |
+| | (Privilege Escalation) | | |
++---------------------------+-----------------------------------------------+
+| **Returned Data Format** | ``stdout[0].`` |
++---------------------------+-----------------------------------------------+
+
+Using CLI in Ansible 2.6
+================================================================================
+
+Example CLI ``group_vars/routeros.yml``
+---------------------------------------
+
+.. code-block:: yaml
+
+ ansible_connection: network_cli
+ ansible_network_os: routeros
+ ansible_user: myuser
+ ansible_ssh_pass: !vault...
+ ansible_become: yes
+ ansible_become_method: enable
+ ansible_become_pass: !vault...
+ ansible_ssh_common_args: '-o ProxyCommand="ssh -W %h:%p -q bastion01"'
+
+
+- If you are using SSH keys (including an ssh-agent) you can remove the ``ansible_ssh_pass`` configuration.
+- If you are accessing your host directly (not through a bastion/jump host) you can remove the ``ansible_ssh_common_args`` configuration.
+- If you are accessing your host through a bastion/jump host, you cannot include your SSH password in the ``ProxyCommand`` directive. To prevent secrets from leaking out (for example in ``ps`` output), SSH does not support providing passwords via environment variables.
+
+Example CLI Task
+----------------
+
+.. code-block:: yaml
+
+ - name: Display resource statistics (routeros)
+ routeros_command:
+ commands: /system resource print
+ register: routeros_resources
+ when: ansible_network_os == 'routeros'
+
+.. include:: shared_snippets/SSH_warning.txt
diff --git a/lib/ansible/module_utils/network/routeros/__init__.py b/lib/ansible/module_utils/network/routeros/__init__.py
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/lib/ansible/module_utils/network/routeros/routeros.py b/lib/ansible/module_utils/network/routeros/routeros.py
new file mode 100644
index 0000000000..4e35e7a04c
--- /dev/null
+++ b/lib/ansible/module_utils/network/routeros/routeros.py
@@ -0,0 +1,156 @@
+# This code is part of Ansible, but is an independent component.
+# This particular file snippet, and this file snippet only, is BSD licensed.
+# Modules you write using this snippet, which is embedded dynamically by Ansible
+# still belong to the author of the module, and may assign their own license
+# to the complete work.
+#
+# (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:
+#
+# * Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# 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 json
+from ansible.module_utils._text import to_text
+from ansible.module_utils.basic import env_fallback, return_values
+from ansible.module_utils.network.common.utils import to_list, ComplexList
+from ansible.module_utils.connection import Connection
+
+_DEVICE_CONFIGS = {}
+
+routeros_provider_spec = {
+ 'host': dict(),
+ 'port': dict(type='int'),
+ 'username': dict(fallback=(env_fallback, ['ANSIBLE_NET_USERNAME'])),
+ 'password': dict(fallback=(env_fallback, ['ANSIBLE_NET_PASSWORD']), no_log=True),
+ 'ssh_keyfile': dict(fallback=(env_fallback, ['ANSIBLE_NET_SSH_KEYFILE']), type='path'),
+ 'timeout': dict(type='int')
+}
+routeros_argument_spec = {}
+
+
+def get_provider_argspec():
+ return routeros_provider_spec
+
+
+def get_connection(module):
+ if hasattr(module, '_routeros_connection'):
+ return module._routeros_connection
+
+ capabilities = get_capabilities(module)
+ network_api = capabilities.get('network_api')
+ if network_api == 'cliconf':
+ module._routeros_connection = Connection(module._socket_path)
+ else:
+ module.fail_json(msg='Invalid connection type %s' % network_api)
+
+ return module._routeros_connection
+
+
+def get_capabilities(module):
+ if hasattr(module, '_routeros_capabilities'):
+ return module._routeros_capabilities
+
+ capabilities = Connection(module._socket_path).get_capabilities()
+ module._routeros_capabilities = json.loads(capabilities)
+ return module._routeros_capabilities
+
+
+def get_defaults_flag(module):
+ connection = get_connection(module)
+
+ try:
+ out = connection.get('/system default-configuration print')
+ except ConnectionError as exc:
+ module.fail_json(msg=to_text(exc, errors='surrogate_then_replace'))
+
+ out = to_text(out, errors='surrogate_then_replace')
+
+ commands = set()
+ for line in out.splitlines():
+ if line.strip():
+ commands.add(line.strip().split()[0])
+
+ if 'all' in commands:
+ return ['all']
+ else:
+ return ['full']
+
+
+def get_config(module, flags=None):
+ flag_str = ' '.join(to_list(flags))
+
+ try:
+ return _DEVICE_CONFIGS[flag_str]
+ except KeyError:
+ connection = get_connection(module)
+
+ try:
+ out = connection.get_config(flags=flags)
+ except ConnectionError as exc:
+ module.fail_json(msg=to_text(exc, errors='surrogate_then_replace'))
+
+ cfg = to_text(out, errors='surrogate_then_replace').strip()
+ _DEVICE_CONFIGS[flag_str] = cfg
+ return cfg
+
+
+def to_commands(module, commands):
+ spec = {
+ 'command': dict(key=True),
+ 'prompt': dict(),
+ 'answer': dict()
+ }
+ transform = ComplexList(spec, module)
+ return transform(commands)
+
+
+def run_commands(module, commands, check_rc=True):
+ responses = list()
+ connection = get_connection(module)
+
+ for cmd in to_list(commands):
+ if isinstance(cmd, dict):
+ command = cmd['command']
+ prompt = cmd['prompt']
+ answer = cmd['answer']
+ else:
+ command = cmd
+ prompt = None
+ answer = None
+
+ try:
+ out = connection.get(command, prompt, answer)
+ except ConnectionError as exc:
+ module.fail_json(msg=to_text(exc, errors='surrogate_then_replace'))
+
+ try:
+ out = to_text(out, errors='surrogate_or_strict')
+ except UnicodeError:
+ module.fail_json(
+ msg=u'Failed to decode output from %s: %s' % (cmd, to_text(out)))
+
+ responses.append(out)
+
+ return responses
+
+
+def load_config(module, commands):
+ connection = get_connection(module)
+
+ out = connection.edit_config(commands)
diff --git a/lib/ansible/modules/network/routeros/__init__.py b/lib/ansible/modules/network/routeros/__init__.py
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/lib/ansible/modules/network/routeros/routeros_command.py b/lib/ansible/modules/network/routeros/routeros_command.py
new file mode 100644
index 0000000000..f16732d065
--- /dev/null
+++ b/lib/ansible/modules/network/routeros/routeros_command.py
@@ -0,0 +1,205 @@
+#!/usr/bin/python
+#
+# 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
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+ 'status': ['preview'],
+ 'supported_by': 'community'}
+
+
+DOCUMENTATION = """
+---
+module: routeros_command
+version_added: "2.7"
+author: "Egor Zaitsev (@heuels)"
+short_description: Run commands on remote devices running MikroTik RouterOS
+description:
+ - Sends arbitrary commands to an RouterOS node and returns the results
+ read from the device. This module includes an
+ argument that will cause the module to wait for a specific condition
+ before returning or timing out if the condition is not met.
+options:
+ commands:
+ description:
+ - List of commands to send to the remote RouterOS device over the
+ configured provider. The resulting output from the command
+ is returned. If the I(wait_for) argument is provided, the
+ module is not returned until the condition is satisfied or
+ the number of retries has expired.
+ required: true
+ wait_for:
+ description:
+ - List of conditions to evaluate against the output of the
+ command. The task will wait for each condition to be true
+ before moving forward. If the conditional is not true
+ within the configured number of retries, the task fails.
+ See examples.
+ required: false
+ default: null
+ match:
+ description:
+ - The I(match) argument is used in conjunction with the
+ I(wait_for) argument to specify the match policy. Valid
+ values are C(all) or C(any). If the value is set to C(all)
+ then all conditionals in the wait_for must be satisfied. If
+ the value is set to C(any) then only one of the values must be
+ satisfied.
+ required: false
+ default: all
+ choices: ['any', 'all']
+ retries:
+ description:
+ - Specifies the number of retries a command should by tried
+ before it is considered failed. The command is run on the
+ target device every retry and evaluated against the
+ I(wait_for) conditions.
+ required: false
+ default: 10
+ interval:
+ description:
+ - Configures the interval in seconds to wait between retries
+ of the command. If the command does not pass the specified
+ conditions, the interval indicates how long to wait before
+ trying the command again.
+ required: false
+ default: 1
+"""
+
+EXAMPLES = """
+tasks:
+ - name: run command on remote devices
+ routeros_command:
+ commands: /system routerboard print
+
+ - name: run command and check to see if output contains routeros
+ routeros_command:
+ commands: /system resource print
+ wait_for: result[0] contains MikroTik
+
+ - name: run multiple commands on remote nodes
+ routeros_command:
+ commands:
+ - /system routerboard print
+ - /system identity print
+
+ - name: run multiple commands and evaluate the output
+ routeros_command:
+ commands:
+ - /system routerboard print
+ - /interface ethernet print
+ wait_for:
+ - result[0] contains x86
+ - result[1] contains ether1
+"""
+
+RETURN = """
+stdout:
+ description: The set of responses from the commands
+ returned: always apart from low level errors (such as action plugin)
+ type: list
+ sample: ['...', '...']
+stdout_lines:
+ description: The value of stdout split into a list
+ returned: always apart from low level errors (such as action plugin)
+ type: list
+ sample: [['...', '...'], ['...'], ['...']]
+failed_conditions:
+ description: The list of conditionals that have failed
+ returned: failed
+ type: list
+ sample: ['...', '...']
+"""
+
+import re
+import time
+
+from ansible.module_utils.network.routeros.routeros import run_commands
+from ansible.module_utils.network.routeros.routeros import routeros_argument_spec
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.network.common.utils import ComplexList
+from ansible.module_utils.network.common.parsing import Conditional
+from ansible.module_utils.six import string_types
+
+
+def to_lines(stdout):
+ for item in stdout:
+ if isinstance(item, string_types):
+ item = str(item).split('\n')
+ yield item
+
+
+def main():
+ """main entry point for module execution
+ """
+ argument_spec = dict(
+ commands=dict(type='list', required=True),
+
+ wait_for=dict(type='list'),
+ match=dict(default='all', choices=['all', 'any']),
+
+ retries=dict(default=10, type='int'),
+ interval=dict(default=1, type='int')
+ )
+
+ argument_spec.update(routeros_argument_spec)
+
+ module = AnsibleModule(argument_spec=argument_spec,
+ supports_check_mode=True)
+
+ result = {'changed': False}
+
+ wait_for = module.params['wait_for'] or list()
+ conditionals = [Conditional(c) for c in wait_for]
+
+ retries = module.params['retries']
+ interval = module.params['interval']
+ match = module.params['match']
+
+ while retries > 0:
+ responses = run_commands(module, module.params['commands'])
+
+ for item in list(conditionals):
+ if item(responses):
+ if match == 'any':
+ conditionals = list()
+ break
+ conditionals.remove(item)
+
+ if not conditionals:
+ break
+
+ time.sleep(interval)
+ retries -= 1
+
+ if conditionals:
+ failed_conditions = [item.raw for item in conditionals]
+ msg = 'One or more conditional statements have not been satisfied'
+ module.fail_json(msg=msg, failed_conditions=failed_conditions)
+
+ result.update({
+ 'changed': False,
+ 'stdout': responses,
+ 'stdout_lines': list(to_lines(responses))
+ })
+
+ module.exit_json(**result)
+
+
+if __name__ == '__main__':
+ main()
diff --git a/lib/ansible/plugins/cliconf/routeros.py b/lib/ansible/plugins/cliconf/routeros.py
new file mode 100644
index 0000000000..6f88bce179
--- /dev/null
+++ b/lib/ansible/plugins/cliconf/routeros.py
@@ -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 .
+#
+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.utils import to_list
+from ansible.plugins.cliconf import CliconfBase, enable_mode
+
+try:
+ from __main__ import display
+except ImportError:
+ from ansible.utils.display import Display
+ display = Display()
+
+
+class Cliconf(CliconfBase):
+
+ def get_device_info(self):
+ device_info = {}
+ device_info['network_os'] = 'RouterOS'
+
+ resource = self.get(b'/system resource print')
+ data = to_text(resource, errors='surrogate_or_strict').strip()
+ match = re.search(r'version: (\S+)', data)
+ if match:
+ device_info['network_os_version'] = match.group(1)
+
+ routerboard = self.get(b'/system routerboard print')
+ data = to_text(routerboard, errors='surrogate_or_strict').strip()
+ match = re.search(r'model: (.+)$', data, re.M)
+ if match:
+ device_info['network_os_model'] = match.group(1)
+
+ identity = self.get(b'/system identity print')
+ data = to_text(identity, errors='surrogate_or_strict').strip()
+ match = re.search(r'name: (.+)$', data, re.M)
+ if match:
+ device_info['network_os_hostname'] = match.group(1)
+
+ return device_info
+
+ def get_config(self, source='running', format='text', flags=None):
+ return
+
+ def edit_config(self, command):
+ return
+
+ def get(self, command, prompt=None, answer=None, sendonly=False):
+ return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly)
+
+ 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)
diff --git a/lib/ansible/plugins/terminal/routeros.py b/lib/ansible/plugins/terminal/routeros.py
new file mode 100644
index 0000000000..11ddab8c0e
--- /dev/null
+++ b/lib/ansible/plugins/terminal/routeros.py
@@ -0,0 +1,72 @@
+#
+# (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 json
+import re
+
+from ansible.errors import AnsibleConnectionFailure
+from ansible.module_utils._text import to_text, to_bytes
+from ansible.plugins.terminal import TerminalBase
+
+try:
+ from __main__ import display
+except ImportError:
+ from ansible.utils.display import Display
+ display = Display()
+
+
+class TerminalModule(TerminalBase):
+
+ ansi_re = [
+ # check ECMA-48 Section 5.4 (Control Sequences)
+ re.compile(br'(\x1b\[\?1h\x1b=)'),
+ re.compile(br'((?:\x9b|\x1b\x5b)[\x30-\x3f]*[\x20-\x2f]*[\x40-\x7e])'),
+ re.compile(br'\x08.')
+ ]
+
+ terminal_initial_prompt = [
+ br'\x1bZ',
+ ]
+
+ terminal_initial_answer = b'\x1b/Z'
+
+ terminal_stdout_re = [
+ re.compile(br"\x1b<"),
+ re.compile(br"\[\w+\@[\w\-\.]+\] ?> ?$"),
+ re.compile(br"Please press \"Enter\" to continue!"),
+ re.compile(br"Do you want to see the software license\? \[Y\/n\]: ?"),
+ ]
+
+ terminal_stderr_re = [
+ re.compile(br"\nbad command name"),
+ re.compile(br"\nno such item"),
+ re.compile(br"\ninvalid value for"),
+ ]
+
+ def on_open_shell(self):
+ prompt = self._get_prompt()
+ try:
+ if prompt.strip().endswith(b':'):
+ self._exec_cli_command(b' ')
+ if prompt.strip().endswith(b'!'):
+ self._exec_cli_command(b'\n')
+ except AnsibleConnectionFailure:
+ raise AnsibleConnectionFailure('unable to bypass license prompt')
diff --git a/test/sanity/code-smell/line-endings.py b/test/sanity/code-smell/line-endings.py
index 85b8109e4a..fcbbc5cc49 100755
--- a/test/sanity/code-smell/line-endings.py
+++ b/test/sanity/code-smell/line-endings.py
@@ -10,6 +10,7 @@ def main():
'test/integration/targets/win_template/files/foo.dos.txt',
'test/integration/targets/win_module_utils/library/legacy_only_new_way_win_line_ending.ps1',
'test/integration/targets/win_module_utils/library/legacy_only_old_way_win_line_ending.ps1',
+ 'test/units/modules/network/routeros/fixtures/system_package_print',
])
for path in sys.argv[1:] or sys.stdin.read().splitlines():
diff --git a/test/units/modules/network/routeros/__init__.py b/test/units/modules/network/routeros/__init__.py
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/test/units/modules/network/routeros/fixtures/system_package_print b/test/units/modules/network/routeros/fixtures/system_package_print
new file mode 100644
index 0000000000..54ef6a809b
--- /dev/null
+++ b/test/units/modules/network/routeros/fixtures/system_package_print
@@ -0,0 +1,106 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MMM MMM KKK TTTTTTTTTTT KKK
+
+ MMMM MMMM KKK TTTTTTTTTTT KKK
+
+ MMM MMMM MMM III KKK KKK RRRRRR OOOOOO TTT III KKK KKK
+
+ MMM MM MMM III KKKKK RRR RRR OOO OOO TTT III KKKKK
+
+ MMM MMM III KKK KKK RRRRRR OOO OOO TTT III KKK KKK
+
+ MMM MMM III KKK KKK RRR RRR OOOOOO TTT III KKK KKK
+
+
+
+ MikroTik RouterOS 6.42.5 (c) 1999-2018 http://www.mikrotik.com/
+
+
+[?] Gives the list of available commands
+
+command [?] Gives help on the command and list of arguments
+
+
+
+[Tab] Completes the command/word. If the input is ambiguous,
+
+ a second [Tab] gives possible options
+
+
+
+/ Move up to base level
+
+.. Move up one level
+
+/command Use command at the base level
+
+[9999B
+[9999BZ [6n<[c[4l[20l[?47l[?7h[?5l[?25h[H[9999B[6n
+
+
+
+[admin@MainRouter] >
+[admin@MainRouter] > /system routerboard print
+[admin@MainRouter] > /system routerboard print
+
+ routerboard: yes
+ model: 750GL
+ serial-number: 1234567890AB
+ firmware-type: ar7240
+ factory-firmware: 3.09
+ current-firmware: 6.41.2
+ upgrade-firmware: 6.42.5
+
+
+
+
+
+[admin@MainRouter] >
+[admin@MainRouter] > /system identity print
+[admin@MainRouter] > /system identity print
+
+ name: MikroTik
+
+
+
+
+
+[admin@MainRouter] >
+[admin@MainRouter] > /system package print
+[admin@MainRouter] > /system package print
+
+Flags: [m[1mX[m - disabled
+[m[1m # NAME VERSION SCHEDULED
+[m 0 routeros-mipsbe 6.42.5
+ 1 system 6.42.5
+ 2 ipv6 6.42.5
+ 3 wireless 6.42.5
+ 4 hotspot 6.42.5
+ 5 dhcp 6.42.5
+ 6 mpls 6.42.5
+ 7 routing 6.42.5
+ 8 ppp 6.42.5
+ 9 security 6.42.5
+10 advanced-tools 6.42.5
+
+
+
+
+
+[admin@MainRouter] >
+[admin@MainRouter] >
\ No newline at end of file
diff --git a/test/units/modules/network/routeros/fixtures/system_resource_print b/test/units/modules/network/routeros/fixtures/system_resource_print
new file mode 100644
index 0000000000..63bc3beba5
--- /dev/null
+++ b/test/units/modules/network/routeros/fixtures/system_resource_print
@@ -0,0 +1,17 @@
+[admin@RB1100test] /system resource> print
+ uptime: 2w1d23h34m57s
+ version: "5.0rc1"
+ free-memory: 385272KiB
+ total-memory: 516708KiB
+ cpu: "e500v2"
+ cpu-count: 1
+ cpu-frequency: 799MHz
+ cpu-load: 9%
+ free-hdd-space: 466328KiB
+ total-hdd-space: 520192KiB
+ write-sect-since-reboot: 1411
+ write-sect-total: 70625
+ bad-blocks: 0.2%
+ architecture-name: "powerpc"
+ board-name: "RB1100"
+ platform: "MikroTik"
diff --git a/test/units/modules/network/routeros/routeros_module.py b/test/units/modules/network/routeros/routeros_module.py
new file mode 100644
index 0000000000..3ddd33a135
--- /dev/null
+++ b/test/units/modules/network/routeros/routeros_module.py
@@ -0,0 +1,88 @@
+# (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 .
+
+# Make coding more python3-ish
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+import os
+import json
+
+from units.modules.utils import AnsibleExitJson, AnsibleFailJson, ModuleTestCase
+
+
+fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
+fixture_data = {}
+
+
+def load_fixture(name):
+ path = os.path.join(fixture_path, name)
+
+ if path in fixture_data:
+ return fixture_data[path]
+
+ with open(path) as f:
+ data = f.read()
+
+ try:
+ data = json.loads(data)
+ except:
+ pass
+
+ fixture_data[path] = data
+ return data
+
+
+class TestRouterosModule(ModuleTestCase):
+
+ def execute_module(self, failed=False, changed=False, commands=None, sort=True, defaults=False):
+
+ self.load_fixtures(commands)
+
+ if failed:
+ result = self.failed()
+ self.assertTrue(result['failed'], result)
+ else:
+ result = self.changed(changed)
+ self.assertEqual(result['changed'], changed, result)
+
+ if commands is not None:
+ if sort:
+ self.assertEqual(sorted(commands), sorted(result['commands']), result['commands'])
+ else:
+ self.assertEqual(commands, result['commands'], result['commands'])
+
+ return result
+
+ def failed(self):
+ with self.assertRaises(AnsibleFailJson) as exc:
+ self.module.main()
+
+ result = exc.exception.args[0]
+ self.assertTrue(result['failed'], result)
+ return result
+
+ def changed(self, changed=False):
+ with self.assertRaises(AnsibleExitJson) as exc:
+ self.module.main()
+
+ result = exc.exception.args[0]
+ self.assertEqual(result['changed'], changed, result)
+ return result
+
+ def load_fixtures(self, commands=None):
+ pass
diff --git a/test/units/modules/network/routeros/test_routeros_command.py b/test/units/modules/network/routeros/test_routeros_command.py
new file mode 100644
index 0000000000..79c12e6092
--- /dev/null
+++ b/test/units/modules/network/routeros/test_routeros_command.py
@@ -0,0 +1,113 @@
+# (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 .
+
+# Make coding more python3-ish
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+import json
+
+from ansible.compat.tests.mock import patch
+from ansible.modules.network.routeros import routeros_command
+from units.modules.utils import set_module_args
+from .routeros_module import TestRouterosModule, load_fixture
+
+
+class TestRouterosCommandModule(TestRouterosModule):
+
+ module = routeros_command
+
+ def setUp(self):
+ super(TestRouterosCommandModule, self).setUp()
+
+ self.mock_run_commands = patch('ansible.modules.network.routeros.routeros_command.run_commands')
+ self.run_commands = self.mock_run_commands.start()
+
+ def tearDown(self):
+ super(TestRouterosCommandModule, self).tearDown()
+ self.mock_run_commands.stop()
+
+ def load_fixtures(self, commands=None):
+
+ def load_from_file(*args, **kwargs):
+ module, commands = args
+ output = list()
+
+ for item in commands:
+ try:
+ obj = json.loads(item)
+ command = obj
+ except ValueError:
+ command = item
+ filename = str(command).replace(' ', '_').replace('/', '')
+ output.append(load_fixture(filename))
+ return output
+
+ self.run_commands.side_effect = load_from_file
+
+ def test_routeros_command_simple(self):
+ set_module_args(dict(commands=['/system resource print']))
+ result = self.execute_module()
+ self.assertEqual(len(result['stdout']), 1)
+ self.assertTrue('platform: "MikroTik"' in result['stdout'][0])
+
+ def test_routeros_command_multiple(self):
+ set_module_args(dict(commands=['/system resource print', '/system resource print']))
+ result = self.execute_module()
+ self.assertEqual(len(result['stdout']), 2)
+ self.assertTrue('platform: "MikroTik"' in result['stdout'][0])
+
+ def test_routeros_command_wait_for(self):
+ wait_for = 'result[0] contains "MikroTik"'
+ set_module_args(dict(commands=['/system resource print'], wait_for=wait_for))
+ self.execute_module()
+
+ def test_routeros_command_wait_for_fails(self):
+ wait_for = 'result[0] contains "test string"'
+ set_module_args(dict(commands=['/system resource print'], wait_for=wait_for))
+ self.execute_module(failed=True)
+ self.assertEqual(self.run_commands.call_count, 10)
+
+ def test_routeros_command_retries(self):
+ wait_for = 'result[0] contains "test string"'
+ set_module_args(dict(commands=['/system resource print'], wait_for=wait_for, retries=2))
+ self.execute_module(failed=True)
+ self.assertEqual(self.run_commands.call_count, 2)
+
+ def test_routeros_command_match_any(self):
+ wait_for = ['result[0] contains "MikroTik"',
+ 'result[0] contains "test string"']
+ set_module_args(dict(commands=['/system resource print'], wait_for=wait_for, match='any'))
+ self.execute_module()
+
+ def test_routeros_command_match_all(self):
+ wait_for = ['result[0] contains "MikroTik"',
+ 'result[0] contains "RB1100"']
+ set_module_args(dict(commands=['/system resource print'], wait_for=wait_for, match='all'))
+ self.execute_module()
+
+ def test_routeros_command_match_all_failure(self):
+ wait_for = ['result[0] contains "MikroTik"',
+ 'result[0] contains "test string"']
+ commands = ['/system resource print', '/system resource print']
+ set_module_args(dict(commands=commands, wait_for=wait_for, match='all'))
+ self.execute_module(failed=True)
+
+ def test_routeros_command_wait_for_2(self):
+ wait_for = 'result[0] contains "wireless"'
+ set_module_args(dict(commands=['/system package print'], wait_for=wait_for))
+ self.execute_module()