RouterOS Platform Options
Connections Available
CLI | |
---|---|
Protocol | SSH |
Credentials | uses SSH keys / SSH-agent if presentaccepts -u myuser -k if using password |
Indirect Access | via a bastion (jump host) |
Connection Settings | ansible_connection: network_cli |
Enable Mode (Privilege Escalation) | not supported by RouterOS |
Returned Data Format | stdout[0]. |
RouterOS does not support ansible_connection: local
. You must use ansible_connection: network_cli
.
Using CLI in Ansible
Example CLI group_vars/routeros.yml
- ansible_connection: network_cli
- ansible_network_os: 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.
Example CLI Task
- - name: Display resource statistics (routeros)
- routeros_command:
- commands: /system resource print
- register: routeros_resources
- when: ansible_network_os == '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.