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

Примечание

Этот плагин входит в коллекцию community.routeros (версия 1.1.0).

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

Для использования в плейбуке укажите: community.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 строка		Список условий для оценки по выводу команды. Задача будет ожидать выполнения каждого условия перед продолжением. Если условие не выполняется в течение заданного количества попыток, задача завершается с ошибкой. См. примеры.

Примеры

- name: Run command on remote devices
  community.routeros.command:
    commands: /system routerboard print

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

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

- name: Run multiple commands and evaluate the output
  community.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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/routeros/command_module.html