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

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
authorize		Варианты: да нет ←	Устаревший Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli` и `become: yes`. Для получения дополнительной информации см. Руководство по сети. Указывает модулю перейти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
commands обязательный			Список команд, которые необходимо отправить на удалённое устройство через настроенного поставщика. Результат выполнения команды возвращается. Если указан аргумент wait_for, модуль возвращается только после того, как условие будет выполнено или истечёт время ожидания.
context		Значение по умолчанию: None	Указывает контекст, на который необходимо нацелится, если вы работаете в режиме ASA с несколькими контекстами. По умолчанию используется текущий контекст, к которому вы подключились.
interval		Значение по умолчанию: 1	Устанавливает интервал в секундах ожидания между повторными попытками выполнения команды. Если команда не удовлетворяет указанным условиям, интервал определяет время ожидания перед повторной попыткой выполнения.
match		Варианты: любой все ←	Аргумент match используется совместно с аргументом wait_for для определения политики соответствия. Допустимые значения — `all` или `any`. Если значение установлено в `all`, должны выполняться все условия в wait_for. Если значение установлено в `any`, достаточно выполнения хотя бы одного условия.
provider		Значение по умолчанию: None	Устаревший Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Для получения дополнительной информации см. Руководство по сети. Объект словаря, содержащий сведения о подключении.
	username		Устанавливает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	authorize	Варианты: да нет ←	Указывает модулю перейти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	auth_pass	Значение по умолчанию: none	Указывает пароль, который требуется использовать для перехода в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот аргумент ничего не делает. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	host		Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
	timeout	Значение по умолчанию: 10	Указывает таймаут бездействия подключения в секундах. Полезно, если консоль зависает перед продолжением, например, при сохранении конфигурации.
	password	Значение по умолчанию: None	Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port	Значение по умолчанию: 22	Указывает порт для подключения к удалённому устройству.
retries		Значение по умолчанию: 10	Указывает количество попыток выполнения команды перед её признанием неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for.
wait_for		Значение по умолчанию: None	Список условий для оценки по результатам выполнения команды. Задача ожидает выполнения каждого условия перед продолжением. Если условие не выполняется в течение заданного количества попыток, задача завершается неудачей. См. примеры. псевдонимы: waitfor

Примечания

Примечание

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

Примеры

# 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, разделенное на список Пример: [['...', '...'], ['...'], ['...']]

Статус

Данный модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Автор

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.5/modules/asa_command_module.html