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

Новая версия 2.2.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Отправляет произвольные команды узлу 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 равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды `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.8/modules/asa_command_module.html