mirror of https://github.com/ansible/ansible.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
81 lines
3.1 KiB
ReStructuredText
81 lines
3.1 KiB
ReStructuredText
.. _routeros_platform_options:
|
|
|
|
***************************************
|
|
RouterOS Platform Options
|
|
***************************************
|
|
|
|
RouterOS is part of the `community.network <https://galaxy.ansible.com/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.
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
Connections available
|
|
================================================================================
|
|
|
|
.. table::
|
|
:class: documentation-table
|
|
|
|
==================== ==========================================
|
|
.. 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: ansible.network.network_cli``
|
|
|
|
|enable_mode| not supported by RouterOS
|
|
|
|
Returned Data Format ``stdout[0].``
|
|
==================== ==========================================
|
|
|
|
.. |enable_mode| replace:: Enable Mode |br| (Privilege Escalation)
|
|
|
|
|
|
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``
|
|
---------------------------------------
|
|
|
|
.. code-block:: yaml
|
|
|
|
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 in ``ps`` 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 <https://wiki.mikrotik.com/wiki/Manual:Console_login_process>`_ in MikroTik wiki for more information.
|
|
|
|
Example CLI task
|
|
----------------
|
|
|
|
.. code-block:: yaml
|
|
|
|
- name: Display resource statistics (routeros)
|
|
community.network.routeros_command:
|
|
commands: /system resource print
|
|
register: routeros_resources
|
|
when: ansible_network_os == 'community.network.routeros'
|
|
|
|
.. include:: shared_snippets/SSH_warning.txt
|
|
|
|
.. seealso::
|
|
|
|
:ref:`timeout_options`
|