ironware_command - Выполнение произвольных команд на устройствах Brocade IronWare

Новое в версии 2.5.

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

Описание

Отправляет произвольные команды узлу Brocade IronWare и возвращает результаты, считанные с устройства. Этот модуль включает аргумент wait_for, который заставит модуль ожидать определенного условия перед возвратом или таймаутом, если условие не будет выполнено.

Параметры

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

Примеры

- ironware_command:
    commands:
      - show version

- ironware_command:
    commands:
      - show interfaces brief wide
      - show mpls vll

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

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

Ключ	Возвращённое значение	Описание
failed_conditions список	failed	Условия, которые не были выполнены Пример: ['...', '...']
stdout список	всегда	Набор ответов от команд Пример: ['...', '...']
stdout_lines список	всегда	Значение stdout, разделенное на список Пример: [['...', '...'], ['...'], ['...']]

Статус

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

Автор

Paul Baker (@paulquack)

Подсказка

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

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