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

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

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
authorize bool		Варианты: нет ← да	Устарело Начиная с 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`. Дополнительную информацию см. в Руководстве по сети. Объект типа dict, содержащий данные подключения.
	host		Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение хоста используется в качестве целевого адреса для транспорта.
	port	По умолчанию: 22	Указывает порт, который используется при построении подключения к удаленному устройству.
	username		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	password		Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	authorize bool	Варианты: нет ← да	Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в обычном режиме. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	auth_pass		Указывает пароль, если требуется войти в привилегированный режим на удаленном устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	timeout	По умолчанию: 10	Указывает интервал времени ожидания подключения в секундах. Полезно, если консоль зависает перед продолжением, например, при сохранении конфигураций.
retries		По умолчанию: 10	Указывает количество попыток выполнения команды перед тем, как она будет считаться неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for.
wait_for			Список условий для проверки с выводом команды. Задача будет ожидать, пока каждое условие не станет истинным, перед продолжением. Если условие не выполняется в течение заданного количества попыток, задача завершается неудачей. См. примеры. псевдонимы: 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 разбито на список Пример: [['...', '...'], ['...'], ['...']]

Статус

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

Техническое обслуживание

Этот модуль помечен как community, что означает, что его поддерживает сообщество Ansible. Дополнительную информацию см. в Документации по поддержке модулей.

Список других модулей, также поддерживаемых сообществом 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.6/modules/asa_command_module.html