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

Новое в версии 2.7.

Описание
Параметры
Примеры
Возвращаемые значения
Статус

Описание

Отправляет произвольные команды узлу 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
    routeros_command:
      commands: /system routerboard print

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

  - name: run multiple commands on remote nodes
    routeros_command:
      commands:
        - /system routerboard print
        - /system identity print

  - name: run multiple commands and evaluate the output
    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, разделенное на список Пример: [['...', '...'], ['...'], ['...']]

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Егор Зайцев (@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.8/modules/routeros_command_module.html