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

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
commands - / обязательно			Упорядоченный набор команд для выполнения на удаленном устройстве, работающем под управлением VyOS. Вывод выполнения команды возвращается в план действий. Если аргумент wait_for указан, модуль не возвращается, пока условие не будет выполнено или не будет превышено число попыток.
interval -		По умолчанию: 1	Настраивает интервал в секундах ожидания между повторными попытками выполнения команды retries. Если команда не удовлетворяет заданным условиям, интервал указывает, сколько времени следует подождать перед повторной попыткой выполнения команды.
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.7
Запуск show system boot-messages all приведет к зависанию модуля, так как 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.

Авторы

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