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 ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной окружения `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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/asa/asa_command_module.html