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 строка |
| Аргумент 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/routeros/command_module.html
