community.network.ironware_command – Выполнение произвольных команд на устройствах Extreme IronWare
Примечание
Этот плагин является частью коллекции community.network (версия 2.0.1).
Для его установки используйте: 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 string / обязательно | Список команд для отправки удалённому устройству через настроенный поставщик. Возвращается результат выполнения команды. Если указан аргумент wait_for, модуль не возвращается до тех пор, пока условие не будет выполнено или не истечёт количество попыток. | ||
| interval string | Значение по умолчанию: 1 | Настраивает интервал в секундах ожидания между повторными попытками выполнения команды. Если команда не соответствует указанным условиям, интервал указывает, сколько времени подождать перед повторной попыткой. | |
| match string |
| Аргумент match используется совместно с аргументом wait_for для определения политики сопоставления. Если значение установлено в all, должны быть выполнены все условия в wait_for. Если значение установлено в any, должно быть выполнено только одно из условий. | |
| provider dictionary | Устаревший Начиная с Ansible 2.7, рекомендуем использовать connection: network_cli и become: yes. Для получения дополнительной информации см. руководство IronWare Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass string | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host string | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение хоста используется в качестве адреса назначения для транспорта. | ||
| password string | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port integer | Значение по умолчанию: 22 | Указывает порт для построения подключения к удалённому устройству. | |
| ssh_keyfile path | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение - путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout integer | Значение по умолчанию: 10 | Указывает таймаут бездействия подключения в секундах. Полезно, если консоль зависает перед продолжением. Например, при сохранении конфигураций. | |
| username string | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| retries string | Значение по умолчанию: 10 | Указывает количество попыток выполнения команды до того, как она будет считана неудачной. Команда выполняется на целевом устройстве при каждой повторной попытке и оценивается по условиям wait_for. | |
| wait_for string | Список условий для проверки по результатам выполнения команды. Задача будет ожидать выполнения каждого условия до продолжения. Если условие не выполнено в течение заданного числа попыток, задача завершается с ошибкой. См. примеры. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетевым технологиям Ansible
Примеры
- 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 list / элементы=string | ошибка | условия, которые не были выполнены Пример: ['...', '...'] |
| stdout list / элементы=string | всегда | набор ответов от команд Пример: ['...', '...'] |
| stdout_lines list / элементы=string | всегда | Значение stdout, разделенное на список Пример: [['...', '...'], ['...'], ['...']] |
Авторы
- Paul Baker (@paulquack)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/ironware_command_module.html
