ironware_command - Запуск произвольных команд на устройствах Extreme IronWare
Новая в версии 2.5.
Обзор
- Отправляет произвольные команды узлу Extreme IronWare и возвращает результаты, считанные с устройства. Этот модуль включает аргумент wait_for, который заставит модуль ожидать определённого условия перед возвратом или таймаутом, если условие не выполняется.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| authorize bool |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| commands обязательно | Список команд для отправки удалённому устройству через настроенного поставщика. Результирующий вывод команды возвращается. Если указан аргумент wait_for, модуль не возвращается, пока условие не выполнено или не истекло время ожидания. | ||
| interval | Значение по умолчанию: 1 | Устанавливает интервал в секундах ожидания между попытками повторного выполнения команды. Если команда не удовлетворяет заданным условиям, интервал указывает, сколько времени нужно ждать перед повторной попыткой выполнения команды. | |
| match |
| Аргумент match используется совместно с аргументом wait_for для задания политики сопоставления. Если значение установлено в all, все условные выражения в wait_for должны быть выполнены. Если значение установлено в any, должно быть выполнено только одно из значений. | |
| provider | Объект типа dict, содержащий данные подключения. | ||
| host | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| port | Значение по умолчанию: 22 | Указывает порт для использования при построении подключения к удалённому устройству. | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| authorize bool |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| auth_pass | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| timeout | Значение по умолчанию: 10 | Указывает тайм-аут для подключения в секундах. Полезно, если консоль зависает перед продолжением. Например, при сохранении конфигураций. | |
| retries | Значение по умолчанию: 10 | Указывает количество попыток повторного выполнения команды перед её признанием неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for. | |
| wait_for | Список условий для оценки по выводу команды. Задача будет ожидать выполнения каждого условия перед продолжением. Если условие не выполняется в течение заданного числа попыток, задача завершается ошибкой. См. примеры. | ||
Примеры
- ironware_command:
commands:
- show version
- ironware_command:
commands:
- show interfaces brief wide
- show mpls vll
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| failed_conditions список | failed | условия, которые не были выполнены Пример: ['...', '...'] |
| stdout список | всегда | набор ответов от команд Пример: ['...', '...'] |
| stdout_lines список | всегда | Значение stdout, разделенное на список Пример: [['...', '...'], ['...'], ['...']] |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- Пол Бейкер (@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.6/modules/ironware_command_module.html
