asa_command - Выполнение произвольных команд на устройствах Cisco ASA
Новая версия 2.2.
Описание
- Отправляет произвольные команды узлу ASA и возвращает результаты, считанные с устройства. Модуль
asa_commandвключает аргумент, который заставит модуль ожидать определённого условия перед возвратом или выполнить таймаут, если условие не будет выполнено.
Параметры
| параметр | обязательно | значение по умолчанию | возможные значения | комментарии | |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| authorize | нет |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | ||||||||||||||||||||||||||||||||||||||||||||||
| commands | да | Список команд для отправки на удалённое устройство по настроенному поставщику. Результирующий вывод команды возвращается. Если аргумент wait_for предоставлен, модуль не возвращается, пока условие не будет выполнено или количество повторов не истечёт. | |||||||||||||||||||||||||||||||||||||||||||||||
| context | нет | Указывает, какой контекст следует использовать, если выполняется работа в режиме нескольких контекстов ASA. По умолчанию используется текущий контекст входа. | |||||||||||||||||||||||||||||||||||||||||||||||
| interval | нет | 1 | Настраивает интервал в секундах ожидания между повторами команды. Если команда не удовлетворяет указанным условиям, интервал указывает, сколько времени ждать перед повторной попыткой выполнения команды. | ||||||||||||||||||||||||||||||||||||||||||||||
| match | нет | all |
| Аргумент match используется совместно с аргументом wait_for для указания политики соответствия. Допустимые значения — all или any. Если значение установлено в all, то все условные элементы в wait_for должны быть выполнены. Если значение установлено в any, то должно быть выполнено только одно из значений. | |||||||||||||||||||||||||||||||||||||||||||||
| provider | нет | Объект типа dict, содержащий данные подключения. |
|||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||
| retries | нет | 10 | Указывает количество попыток выполнения команды перед тем, как она будет считаться неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for. | ||||||||||||||||||||||||||||||||||||||||||||||
| wait_for | нет | Список условий для оценки по выводу команды. Задача будет ожидать выполнения каждого условия перед продолжением. Если условие не выполняется в течение заданного количества повторов, задача завершается ошибкой. См. примеры. псевдонимы: waitfor | |||||||||||||||||||||||||||||||||||||||||||||||
Примеры
# Note: examples below use the following provider dict to handle
# transport and authentication to the node.
---
vars:
cli:
host: "{{ inventory_hostname }}"
username: cisco
password: cisco
authorize: yes
auth_pass: cisco
transport: cli
---
- asa_command:
commands:
- show version
provider: "{{ cli }}"
- asa_command:
commands:
- show asp drop
- show memory
provider: "{{ cli }}"
- asa_command:
commands:
- show version
provider: "{{ cli }}"
context: system
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| failed_conditions | условия, которые не выполнены | при ошибке | список | ['...', '...'] |
| stdout | набор ответов от команд | всегда | список | ['...', '...'] |
| stdout_lines | Значение stdout, разделенное на список | всегда | список | [['...', '...'], ['...'], ['...']] |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантирует обратную совместимость.
Для получения помощи в разработке модулей, если вы так решите, пожалуйста, ознакомьтесь с Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/asa_command_module.html
