vyos_command - Выполнение одной или нескольких команд на устройствах VyOS

Новая версия 2.2.

Описание
Параметры
Примеры
Возвращаемые значения
Примечания
- Статус
- Информация о техническом обслуживании

Описание

Модуль команды позволяет выполнять одну или несколько команд на удалённых устройствах с VyOS. Этот модуль также можно использовать для проверки параметров перед успешным возвратом. Если условия не выполняются в течение периода ожидания, задача завершается неудачно.
Некоторые show команды в VyOS генерируют большое количество строк вывода и используют пользовательскую страницу, которая может привести к зависанию этого модуля. Если переменная окружения ANSIBLE_VYOS_TERMINAL_LENGTH не установлена, используется значение по умолчанию 10000.

Параметры

параметр обязательно значение по умолчанию возможные значения комментарии

commands

да

Упорядоченный набор команд для выполнения на удалённом устройстве с VyOS. Вывод команд возвращается в книгу задач. Если аргумент wait_for указан, модуль не возвращается до тех пор, пока условие не будет выполнено или не будет превышено количество попыток.

interval

нет

Настраивает интервал в секундах ожидания между повторными попытками выполнения команды. Если команда не удовлетворяет заданным условиям, интервал указывает, сколько времени ждать, прежде чем попробовать выполнить команду снова.

match

нет

all

Аргумент match используется совместно с аргументом wait_for для указания политики сопоставления. Допустимые значения — all или any. Если значение установлено в all, то все условия в wait_for должны быть выполнены. Если значение установлено в any, то должно быть выполнено только одно из значений.

provider

нет

Объект словаря, содержащий данные подключения.

**Объект словаря provider**
параметр	обязательно	значение по умолчанию	комментарии
username	нет		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
host	да		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение хоста используется в качестве целевого адреса для транспорта.
ssh_keyfile	нет		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
timeout	нет	10	Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку.
password	нет		Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
port	нет	22	Указывает порт, используемый при построении подключения к удалённому устройству.

retries

нет

Указывает количество попыток выполнения команды, прежде чем она считается неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for.

wait_for

нет

Указывает, что следует оценить из вывода команды и какие условия применить. Этот аргумент заставит задачу подождать, пока определённое условие не станет истинным, прежде чем перейти дальше. Если условие не станет истинным к конфигурируемому количеству повторов, задача завершается неудачно. См. примеры.

псевдонимы: waitfor

Примеры

tasks:
  - name: show configuration on ethernet devices eth0 and eth1
    vyos_command:
      commands:
        - show interfaces ethernet {{ item }}
    with_items:
      - eth0
      - eth1

  - name: run multiple commands and check if version output contains specific version string
    vyos_command:
      commands:
        - show version
        - show hardware cpu
      wait_for:
        - "result[0] contains 'VyOS 1.1.7'"

Возвращаемые значения

Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:

имя	описание	возвращается	тип	пример
failed_conditions	Список условий, которые не были выполнены	при неудаче	список	['...', '...']
stdout	Набор ответов от команд	всегда, за исключением ошибок низкого уровня (например, плагин действий)	список	['...', '...']
stdout_lines	Значение stdout, разделенное на список	всегда	список	[['...', '...'], ['...'], ['...']]
warnings	Список предупреждений (если есть), сгенерированных модулем на основе аргументов	всегда	список	['...', '...']

Примечания

Примечание

Проверено на VYOS 1.1.7
Выполнение show system boot-messages all приведет к зависанию модуля, так как VyOS использует пользовательские параметры вывода для отображения вывода этой команды.

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Информация о техническом обслуживании

Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>.

Для получения помощи в разработке модулей, если это вас интересует, ознакомьтесь с Информацией о сообществе и участии в разработке, Тестированием Ansible и Разработкой модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/vyos_command_module.html