ironware_command – Выполнение произвольных команд на устройствах Extreme IronWare
Новая версия 2.5.
Описание
- Отправляет произвольные команды на узел Extreme Ironware и возвращает результаты, считанные с устройства. Этот модуль включает аргумент wait_for, который заставит модуль ожидать выполнения определённого условия перед возвратом или таймаутом, если условие не выполняется.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| authorize boolean |
| Устарело Начиная с Ansible 2.7, рекомендуется использовать connection: network_cli и become: yes. Для получения дополнительной информации обратитесь к руководству Варианты платформы IronWare. Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды 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. Объект словаря, содержащий сведения о подключении. | ||
| auth_pass - | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это требуется. Если authorize ложно, этот аргумент не имеет значения. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| 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 - | Список условий, которые должны выполняться на основе вывода команды. Задача будет ждать, пока каждое условие не станет истинным, прежде чем перейти дальше. Если условие не становится истинным в течение заданного количества попыток, задача завершается неудачей. См. примеры. | ||
Примечания
Примечание
- Для получения дополнительной информации об использовании 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.7/modules/ironware_command_module.html
