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

Примечание

Этот плагин входит в состав коллекции cisco.asa (версия 1.0.4).

Для его установки используйте: ansible-galaxy collection install cisco.asa.

Для использования в книге задач укажите: cisco.asa.asa_command.

Добавлена в версии 1.0.0: модуля cisco.asa

Обзор
Параметры
Примечания
Примеры
Значения возврата

Обзор

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

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
authorize логический		Варианты: нет ← да	Устарело Начиная с 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`, достаточно выполнения только одного из них.
passwords логический		Варианты: нет да	Указывает контекст, на который нужно нацелиться, если вы работаете в режиме ASA с несколькими контекстами. По умолчанию используется текущий контекст, к которому вы подключились.
provider словарь			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Для получения дополнительной информации см. Руководство по сетям. Объект словаря, содержащий данные подключения.
	auth_pass строка		Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это требуется. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize логический	Варианты: нет ← да	Инструктирует модуль перейти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	host строка		Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному протоколу. Значение host используется как адрес назначения для протокола.
	password строка		Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port целое число		Указывает порт для подключения к удалённому устройству.
	ssh_keyfile путь		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число		Устанавливает время ожидания подключения в секундах. Полезно, если консоль зависает перед продолжением (например, при сохранении конфигурации).
	username строка		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
retries целое число		Значение по умолчанию: 10	Указывает количество попыток выполнения команды перед её признанием неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for.
wait_for список / элементы=строка			Список условий для оценки по выводу команды. Задача будет ждать, пока каждое условие не станет истинным, прежде чем продолжить. Если условие не выполняется в течение заданного количества попыток, задача завершается ошибкой. См. примеры. псевдонимы: waitfor

Примечания

Примечание

При обработке wait_for вывод каждой команды сохраняется как элемент массива result. Допустимые операторы для оценки условий — eq, ==, neq, ne, !=, gt, >, ge, >=, lt, <, le, <=, contains, matches. Операторы могут быть опережаемыми not для их отрицания. Оператор contains ищет совпадение подстроки (как оператор Python in). Оператор matches ищет с использованием регулярного выражения.
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетям Ansible

Примеры

- name: Show the ASA version
  cisco.asa.asa_command:
    commands:
    - show version

- name: Show ASA drops and memory
  cisco.asa.asa_command:
    commands:
    - show asp drop
    - show memory

- name: Send repeat pings and wait for the result to pass 100%
  cisco.asa.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, разделенное на список Пример: [['...', '...'], ['...'], ['...']]

Авторы

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.10/collections/cisco/asa/asa_command_module.html