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

Примечание

Этот модуль входит в коллекцию cisco.asa (версия 5.0.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

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

Новая функция в cisco.asa 1.0.0

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

Описание

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

Псевдонимы: command

Параметры

Параметр	Комментарии
commands список / элементы=строка / обязательно	Список команд, которые необходимо отправить удалённому устройству через конфигурируемый поставщик. Результирующий вывод команды возвращается. Если аргумент wait_for указан, модуль не возвращается, пока условие не будет выполнено или количество попыток не истечёт.
context строка	Указывает, какой контекст целевой, если выполняется команда в режиме ASA с несколькими контекстами. По умолчанию используется текущий контекст входа.
interval целое число	Настраивает интервал в секундах ожидания между повторными попытками выполнения команды. Если команда не удовлетворяет указанным условиям, интервал определяет, сколько времени ждать перед повторной попыткой. По умолчанию: `1`
match строка	Аргумент match используется совместно с аргументом wait_for для определения политики соответствия. Допустимые значения — `all` или `any`. Если значение установлено в `all`, все условные проверки в wait_for должны быть выполнены. Если значение установлено в `any`, должно быть удовлетворено только одно из значений. Варианты: `"any"` `"all"` ← (по умолчанию)
passwords булево	Сохраняет пароли running-config в открытом виде, если установлено в True. По умолчанию False. Варианты: `false` `true`
retries целое число	Указывает количество попыток выполнения команды перед признанием её неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for. По умолчанию: `10`
wait_for алиасы: waitfor список / элементы=строка	Список условий для оценки по выводу команды. Задача будет ждать выполнения каждого условия перед продолжением. Если условие не выполняется в течение заданного количества попыток, задача завершается неудачно. См. примеры.

Примечания

Примечание

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

Примеры

- 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/asa/asa_command_module.html