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

Примечание

Этот модуль входит в коллекцию community.routeros (версия 2.19.0).

Вы, возможно, уже установили эту коллекцию, если используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.routeros.

Чтобы использовать её в playbook, укажите: community.routeros.command.

Обзор
Параметры
Атрибуты
Примечания
См. также
Примеры
Возвращаемые значения

Обзор

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

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: частичная Модуль заявляет о поддержке режима проверки, но просто всегда выполняет команду.	Может работать в режиме `check_mode` и возвращать прогноз статуса изменения без модификации цели.
diff_mode	Поддержка: отсутствует	Возвращает сведения о том, что изменилось (или, возможно, требует изменения в `check_mode`), при работе в режиме diff.
platform	Платформа: RouterOS	Целевые операционные системы/семейства, с которыми можно взаимодействовать.

Примечания

Примечание

Модуль заявляет о поддержке режима проверки. Это ошибка, которая будет исправлена в community.routeros 3.0.0.

См. также

Как подключиться к устройствам RouterOS через SSH: Как подключиться к устройствам RouterOS через SSH
Как цитировать и децитировать команды и аргументы: Как цитировать и децитировать команды и аргументы

Примеры

- 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/routeros/command_module.html