Spec-Zone.ru › Ansible 2.7

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 ложно, этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS.
authorize
boolean
    Варианты:
  • нет ←
  • да
Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE.
host
-
Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение хоста используется как адрес назначения для транспорта.
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 для сетей

Примеры

# 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, разделенное на список

Пример:
[['...', '...'], ['...'], ['...']]


Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Пётр Спрыгада (@privateip), Патрик Огенстад (@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.7/modules/asa_command_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API