ironware_command – Выполнение произвольных команд на устройствах Extreme IronWare
Новое в версии 2.5.
Обзор
- Отправляет произвольные команды на узел 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
Примеры
- ironware_command:
commands:
- show version
- ironware_command:
commands:
- show interfaces brief wide
- show mpls vll
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| failed_conditions список | неудача | условные операторы, которые не были выполнены Пример: ['...', '...'] |
| stdout список | всегда | набор ответов от команд Пример: ['...', '...'] |
| stdout_lines список | всегда | Значение stdout, разделенное на список Пример: [['...', '...'], ['...'], ['...']] |
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.8/modules/ironware_command_module.html
