asa_command – Выполнение произвольных команд на устройствах Cisco ASA

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Краткое описание

Отправляет произвольные команды узлу ASA и возвращает результаты, считанные с устройства. Модуль asa_command включает аргумент, который заставит модуль дождаться выполнения определённого условия перед возвратом или сработает таймаут, если условие не будет выполнено.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
authorize boolean		Варианты: нет ← да	Устарело Начиная с Ansible 2.5 рекомендуется использовать `connection: network_cli` и `become: yes`. Для получения дополнительной информации, пожалуйста, обратитесь к Руководству по сети. Инструктирует модуль перейти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
commands - / обязательно			Список команд для отправки на удалённое устройство через настроенный провайдер. Результат выполнения команды возвращается. Если указан аргумент wait_for, модуль не возвращается до тех пор, пока условие не будет выполнено или не истечёт число попыток.
context строка			Указывает, какой контекст использовать, если выполнение происходит в режиме ASA с несколькими контекстами. По умолчанию используется текущий контекст, к которому вы подключились.
interval -		По умолчанию: 1	Настраивает интервал в секундах ожидания между повторами выполнения команды. Если команда не выполняется в соответствии с указанными условиями, интервал определяет время ожидания перед повторной попыткой выполнения команды.
match -		Варианты: любой все ←	Аргумент match используется совместно с аргументом wait_for для указания политики соответствия. Допустимые значения — `all` или `any`. Если значение установлено в `all`, должны выполняться все условия в wait_for. Если значение установлено в `any`, должно быть выполнено только одно из значений.
provider -			Устарело Начиная с Ansible 2.5 рекомендуется использовать `connection: network_cli`. Для получения дополнительной информации, пожалуйста, обратитесь к Руководству по сети. Объект словаря, содержащий сведения о подключении.
	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 -			Список условий для оценки по результатам выполнения команды. Задача будет ожидать выполнения каждого условия перед продолжением. Если условие не выполняется в течение заданного количества попыток, задача завершается ошибкой. См. примеры. алиасы: waitfor

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сети Ansible

Примеры

---
- name: "Show the ASA version"
  asa_command:
    commands:
      - show version

- name: "Show ASA drops and memory"
  asa_command:
    commands:
      - show asp drop
      - show memory

- name: "Send repeat pings and wait for the result to pass 100%"
  asa_command:
    commands:
      - ping 8.8.8.8 repeat 20 size 350
    wait_for:
      - result[0] contains 100
    retries: 2

Возвращаемые значения

Общие возвращаемые значения описаны в этом разделе, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
failed_conditions список	неудачно	условия, которые не были выполнены Пример: ['...', '...']
stdout список	всегда	набор ответов от команд Пример: ['...', '...']
stdout_lines список	всегда	Значение stdout разбито на список Пример: [['...', '...'], ['...'], ['...']]

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Peter Sprygada (@privateip), Patrick Ogenstad (@ogenstad)

Подсказка

Если вы заметите какие-либо проблемы в данной документации, вы можете редактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/asa_command_module.html