community.network.ironware_command – Выполнение произвольных команд на устройствах Extreme IronWare

Примечание

Этот плагин является частью коллекции community.network (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.network.

Для использования в книге задач укажите: community.network.ironware_command.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
authorize boolean		Варианты: нет ← да	Устаревший Начиная с Ansible 2.7, рекомендуется использовать `connection: network_cli` и `become: yes`. Дополнительную информацию можно найти в руководстве IronWare Platform Options. Инструктирует модуль перейти в привилегированный режим на удалённом устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
commands строка / обязательно			Список команд для отправки на удалённое устройство через конфигурированный провайдер. Результирующий вывод команды возвращается. Если указан аргумент wait_for, модуль не возвращается, пока условие не будет выполнено или не истечёт число попыток.
interval строка		По умолчанию: 1	Настраивает интервал в секундах ожидания между повторными попытками выполнения команды. Если команда не удовлетворяет указанным условиям, интервал указывает, сколько времени ждать перед повторной попыткой.
match строка		Варианты: любой все ←	Аргумент match используется совместно с аргументом wait_for для указания политики сопоставления. Если значение установлено в `all`, все условия в wait_for должны быть выполнены. Если значение установлено в `any`, достаточно выполнения одного из условий.
provider словарь			Устаревший Начиная с Ansible 2.7, рекомендуется использовать `connection: network_cli` и `become: yes`. Дополнительную информацию можно найти в руководстве IronWare Platform Options. Объект словаря, содержащий данные подключения.
	auth_pass строка		Указывает пароль для входа в привилегированный режим на удалённом устройстве, если требуется. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean	Варианты: нет ← да	Инструктирует модуль перейти в привилегированный режим на удалённом устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
	host строка		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение хоста используется в качестве адреса назначения для транспорта.
	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 строка			Список условий для оценки по выводу команды. Задача будет ждать выполнения каждого условия перед продолжением. Если условие не выполняется в течение заданного количества попыток, задача завершается ошибкой. См. примеры.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по Ansible Network

Примеры

- name: Run a command
  community.network.ironware_command:
    commands:
      - show version

- name: Run several commands
  community.network.ironware_command:
    commands:
      - show interfaces brief wide
      - show mpls vll

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

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

Ключ	Возвращаемое	Описание
failed_conditions список / элементы=строка	неудачно	условия, которые не выполнены Пример: ['...', '...']
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.10/collections/community/network/ironware_command_module.html