community.network.routeros_command – Выполнение команд на удалённых устройствах с MikroTik RouterOS

Примечание

Этот плагин входит в сборку community.network (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.network.

Для использования в playbook, укажите: community.network.routeros_command.

Обзор
Параметры
Примеры
Возвращаемые значения

Обзор

Отправляет произвольные команды на узел RouterOS и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставит модуль ждать определённого условия до возврата или вызовет таймаут, если условие не выполнено.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
commands строка / обязательно		Список команд для отправки на удалённое устройство RouterOS через настроенного провайдера. Результирующий вывод команды возвращается. Если предоставлен аргумент wait_for, модуль не возвращается, пока условие не будет выполнено или не истечёт лимит попыток.
interval строка	По умолчанию: 1	Настраивает интервал в секундах ожидания между повторами команды. Если команда не выполняет указанные условия, интервал определяет, сколько времени ждать, прежде чем попробовать команду снова.
match строка	Варианты: any all ←	Аргумент match используется совместно с аргументом wait_for для задания политики соответствия. Допустимые значения — `all` или `any`. Если значение установлено на `all`, все условия в wait_for должны быть выполнены. Если значение установлено на `any`, должно быть выполнено только одно из условий.
retries строка	По умолчанию: 10	Устанавливает количество попыток выполнения команды, прежде чем она будет считана неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for.
wait_for строка		Список условий, которые необходимо оценить относительно вывода команды. Задача будет ждать, пока каждое условие не станет истинным, прежде чем продолжить. Если условие не станет истинным в течение заданного числа попыток, задача завершается ошибкой. См. примеры.

Примеры

tasks:
  - name: Run command on remote devices
    community.network.routeros_command:
      commands: /system routerboard print

  - name: Run command and check to see if output contains routeros
    community.network.routeros_command:
      commands: /system resource print
      wait_for: result[0] contains MikroTik

  - name: Run multiple commands on remote nodes
    community.network.routeros_command:
      commands:
        - /system routerboard print
        - /system identity print

  - name: Run multiple commands and evaluate the output
    community.network.routeros_command:
      commands:
        - /system routerboard print
        - /interface ethernet print
      wait_for:
        - result[0] contains x86
        - result[1] contains ether1

Возвращаемые значения

Общие возвращаемые значения описаны в здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Возвращаемое значение	Описание
failed_conditions список / элементы=строка	ошибка	Список условий, которые не выполнены Пример: ['...', '...']
stdout список / элементы=строка	всегда, кроме ошибок низкого уровня (таких как плагин действия)	Набор ответов от команд Пример: ['...', '...']
stdout_lines список / элементы=строка	всегда, кроме ошибок низкого уровня (таких как плагин действия)	Значение stdout, разделенное на список Пример: [['...', '...'], ['...'], ['...']]

Авторы

Егор Зайцев (@heuels)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/routeros_command_module.html