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

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

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
commands - / обязательно			Упорядоченный набор команд для выполнения на удалённом устройстве с VyOS. Вывод команд возвращается в плейбук. Если предоставлен аргумент wait_for, модуль не возвращается, пока условие не будет выполнено или не будет превышено количество попыток.
interval -		По умолчанию: 1	Настраивает интервал в секундах ожидания между повторными попытками выполнения команды. Если команда не соответствует указанным условиям, интервал определяет время ожидания перед повторной попыткой выполнения команды.
match -		Варианты: any all ←	Аргумент match используется совместно с аргументом wait_for для указания политики сопоставления. Допустимые значения — `all` или `any`. Если значение установлено на `all`, все условия в wait_for должны быть выполнены. Если значение установлено на `any`, должно быть выполнено только одно из условий.
provider словарь			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Дополнительную информацию см. в Руководстве по сети. Объект словаря, содержащий детали подключения.
	host строка / обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	password строка		Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
	port целое число	По умолчанию: 22	Указывает порт для подключения к удалённому устройству.
	ssh_keyfile путь		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число	По умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку.
	username строка		Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`.
retries -		По умолчанию: 10	Указывает количество попыток выполнения команды перед её признанием неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for.
wait_for -			Определяет, что оценивать из вывода команды и какие условия применять. Этот аргумент заставит задачу ожидать выполнения определённого условия перед продолжением. Если условие не выполняется в течение заданного количества retries, задача завершается неудачно. См. примеры. псевдонимы: waitfor

Примечания

Примечание

Проверено на VYOS 1.1.7
Запуск show system boot-messages all приведёт к зависанию модуля, так как VyOS использует пользовательские настройки пэйджера для отображения вывода этой команды.
Если команда, отправленная на устройство, требует ответа на запрос, можно передать словарь, содержащий command, answer и prompt. См. примеры.
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сети Ansible

Примеры

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'"

  - name: run command that requires answering a prompt
    vyos_command:
      commands:
        - command: 'rollback 1'
          prompt: 'Proceed with reboot? [confirm][y]'
          answer: y

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

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

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

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается командой Ansible Network. [сеть]

Поддержка Red Hat

Дополнительная информация о поддержке этого модуля Red Hat доступна в этой статье базы знаний Red Hat.

Авторы

Nathaniel Case (@qalthos)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

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