Provides modules for Ansible to manage MikroTik RouterOS instances.
You can find documentation for the modules and plugins in this collection here.
Tested with the current Ansible 2.9, ansible-base 2.10 and ansible-core 2.11 releases and the current development version of ansible-core. Ansible versions before 2.9.10 are not supported.
The exact requirements for every module are listed in the module documentation.
The collection supports the network_cli
connection.
community.routeros.api
community.routeros.command
community.routeros.facts
You can find documentation for the modules and plugins in this collection here.
See Ansible Using collections for general detail on using collections.
There are two approaches for using this collection. The command
and facts
modules use the network_cli
connection and connect with SSH. The api
module connects with the HTTP/HTTPS API.
The terminal-based modules in this collection (community.routeros.command
and community.routeros.facts
) do not support arbitrary symbols in router's identity. If you are having trouble connecting to your device, please make sure that your MikroTik's identity contains only alphanumeric characters and dashes. Also, the community.routeros.command
module does not support nesting commands and expects every command to start with a forward slash (/
). Running the following command will produce an error.
- community.routeros.command:
commands:
- /ip
- print
Example inventory hosts
file:
[routers]
router ansible_host=192.168.1.1
[routers:vars]
ansible_connection=ansible.netcommon.network_cli
ansible_network_os=community.routeros.routeros
ansible_user=admin
ansible_ssh_pass=test1234
Example playbook:
---
- name: RouterOS test with network_cli connection
hosts: routers
gather_facts: false
tasks:
# Run a command and print its output
- community.routeros.command:
commands:
- /system resource print
register: system_resource_print
- debug:
var: system_resource_print.stdout_lines
# Retrieve facts
- community.routeros.facts:
- debug:
msg: "First IP address: {{ ansible_net_all_ipv4_addresses[0] }}"
Example playbook:
---
- name: RouterOS test with API
hosts: localhost
gather_facts: no
vars:
hostname: 192.168.1.1
username: admin
password: test1234
tasks:
- name: Get "ip address print"
community.routeros.api:
hostname: "{{ hostname }}"
password: "{{ password }}"
username: "{{ username }}"
path: "ip address"
ssl: true
register: print_path
We're following the general Ansible contributor guidelines; see Ansible Community Guide.
If you want to clone this repositority (or a fork of it) to improve it, you can proceed as follows:
- Create a directory
ansible_collections/community
; - In there, checkout this repository (or a fork) as
routeros
; - Add the directory containing
ansible_collections
to your ANSIBLE_COLLECTIONS_PATH.
See Ansible's dev guide for more information.
See the changelog.
We plan to regularly release minor and patch versions, whenever new features are added or bugs fixed. Our collection follows semantic versioning, so breaking changes will only happen in major releases.
- Ansible Collection overview
- Ansible User guide
- Ansible Developer guide
- Ansible Collections Checklist
- Ansible Community code of conduct
- The Bullhorn (the Ansible Contributor newsletter)
- Changes impacting Contributors
GNU General Public License v3.0 or later.
See COPYING to see the full text.