RouterOS Platform Options¶
RouterOS is part of the community.network collection and only supports CLI connections today. httpapi
modules may be added in future.
This page offers details on how to use ansible.netcommon.network_cli
on RouterOS in Ansible.
Connections available¶
CLI |
|
---|---|
Protocol |
SSH |
Credentials |
uses SSH keys / SSH-agent if present accepts |
Indirect Access |
via a bastion (jump host) |
Connection Settings |
|
Enable Mode |
not supported by RouterOS |
Returned Data Format |
|
RouterOS does not support ansible_connection: local
. You must use ansible_connection: ansible.netcommon.network_cli
.
Using CLI in Ansible¶
Example CLI group_vars/routeros.yml
¶
ansible_connection: ansible.netcommon.network_cli
ansible_network_os: community.network.routeros
ansible_user: myuser
ansible_password: !vault...
ansible_become: yes
ansible_become_method: enable
ansible_become_password: !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_password
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 inps
output), SSH does not support providing passwords via environment variables.If you are getting timeout errors you may want to add
+cet1024w
suffix to your username which will disable console colors, enable “dumb” mode, tell RouterOS not to try detecting terminal capabilities and set terminal width to 1024 columns. See article Console login process in MikroTik wiki for more information.
Example CLI task¶
- name: Display resource statistics (routeros)
community.network.routeros_command:
commands: /system resource print
register: routeros_resources
when: ansible_network_os == 'community.network.routeros'
Warning
Never store passwords in plain text. We recommend using SSH keys to authenticate SSH connections. Ansible supports ssh-agent to manage your SSH keys. If you must use passwords to authenticate SSH connections, we recommend encrypting them with Ansible Vault.
See also