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

Примечание

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

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

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

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

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

Краткое описание

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

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет До версии community.routeros 3.0.0 модуль заявлял поддержку режима проверки. В этом режиме он просто выполнял команду.	Может работать в режиме `check_mode` и возвращать прогноз статуса изменения, не изменяя целевое устройство.
diff_mode	Поддержка: нет	В режиме diff возвращает подробную информацию об изменениях (или о том, что, возможно, требуется изменить в `check_mode`).
idempotent	Поддержка: не применимо Идемпотентность выполняемой команды зависит от самой команды.	При повторном запуске подряд вне режима проверки с теми же аргументами второй вызов указывает, что изменений нет. Предполагается, что система, которой управляет модуль или которую он опрашивает, не изменилась существенным образом.
platform	Платформа: RouterOS	Целевая ОС или семейства ОС, с которыми можно работать.

См. также

Как подключаться к устройствам 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 список / elements=string	Список невыполненных условий. Возвращается: failed Пример: `["...", "..."]`
stdout список / elements=string	Набор ответов на команды. Возвращается: всегда, кроме ошибок низкого уровня (например, ошибок плагина действия) Пример: `["...", "..."]`
stdout_lines список / elements=string	Значение stdout, разбитое на список. Возвращается: всегда, кроме ошибок низкого уровня (например, ошибок плагина действия) Пример: `[["...", "..."], ["..."], ["..."]]`

Авторы

Egor Zaitsev (@heuels)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/routeros/command_module.html