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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
commands - / обязательно			Упорядоченный набор команд для выполнения на удаленном устройстве с VyOS. Вывод команд возвращается в playbook. Если указан аргумент 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 -			Указывает, что следует оценивать из вывода команды и какие условия применять. Этот аргумент заставит задачу ждать выполнения определенного условия, прежде чем продолжить. Если условие не выполняется в течение заданного количества попыток, задача завершается неудачей. См. примеры. псевдонимы: waitfor

Примечания

Примечание

Проверено на VyOS 1.1.8 (helium).
Выполнение show system boot-messages all приведет к зависанию модуля, так как VyOS использует пользовательские настройки просмотрщика для отображения вывода этой команды.
Если команда, отправленная устройству, требует ответа на запрос, можно передать словарь, содержащий command, answer и prompt. См. примеры.
Этот модуль работает с соединениями network_cli. См. Параметры платформы VyOS.
Дополнительную информацию об использовании 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 Red Hat Knowledge Base article.

Авторы

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.9/modules/vyos_command_module.html