Spec-Zone.ru › Ansible 2.4

aireos_command - Выполнение команд на удалённых устройствах Cisco WLC

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

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

Описание

  • Отправляет произвольные команды узлу aireos и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставит модуль ожидать определённого условия перед возвратом или истечением времени ожидания, если условие не выполнено.
  • Этот модуль не поддерживает выполнение команд в режиме конфигурации. Для конфигурации устройств WLC используйте aireos_config.

Параметры

параметр обязательно по умолчанию варианты примечания
commands
да
Список команд для отправки на удалённое устройство aireos через настроенный поставщик. Результирующий вывод команды возвращается. Если указан аргумент wait_for, модуль не возвращается до тех пор, пока условие не будет удовлетворено или не истечёт количество попыток.
interval
нет 1
Настраивает интервал в секундах для ожидания между повторами команды. Если команда не удовлетворяет указанным условиям, интервал указывает, сколько времени ждать, прежде чем повторить команду.
match
нет all
  • any
  • all
Аргумент match используется совместно с аргументом wait_for для указания политики соответствия. Допустимые значения — all или any. Если значение установлено в all, все условные выражения в wait_for должны быть удовлетворены. Если значение установлено в any, достаточно, чтобы было удовлетворено только одно из них.
provider
нет
Объект словаря, содержащий сведения о подключении.
Объект словаря provider
параметр обязательно по умолчанию варианты примечания
username
нет
Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_USERNAME.
host
да
Указывает имя DNS хоста или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта.
ssh_keyfile
нет
Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
timeout
нет 10
Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания превышено до завершения операции, модуль выдаст ошибку.
password
нет
Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_PASSWORD.
port
нет 22
Указывает порт для подключения к удалённому устройству.
retries
нет 10
Указывает количество попыток выполнения команды, прежде чем она считается неудачной. Команда выполняется на целевом устройстве в каждой попытке и оценивается по условиям wait_for.
wait_for
нет
Список условий для оценки по результатам команды. Задача будет ожидать, пока каждое условие не станет истинным, прежде чем перейти дальше. Если условие не станет истинным в течение настроенного количества попыток, задача завершается с ошибкой. См. примеры.
псевдонимы: waitfor

Примеры

tasks:
  - name: run show sysinfo on remote devices
    aireos_command:
      commands: show sysinfo

  - name: run show sysinfo and check to see if output contains Cisco Controller
    aireos_command:
      commands: show sysinfo
      wait_for: result[0] contains 'Cisco Controller'

  - name: run multiple commands on remote nodes
    aireos_command:
      commands:
        - show sysinfo
        - show interface summary

  - name: run multiple commands and evaluate the output
    aireos_command:
      commands:
        - show sysinfo
        - show interface summary
      wait_for:
        - result[0] contains Cisco Controller
        - result[1] contains Loopback0

Возвращаемые значения

Общие возвращаемые значения документированы здесь Возвращаемые значения, следующие поля уникальны для этого модуля:

имя описание возвращается тип пример
failed_conditions
Список условий, которые не выполнились
при ошибке список ['...', '...']
stdout
Набор ответов от команд
всегда, за исключением низкоуровневых ошибок (например, ошибки плагина действия) список ['...', '...']
stdout_lines
Значение stdout, разделённое на список
всегда, за исключением низкоуровневых ошибок (например, ошибки плагина действия) список [['...', '...'], ['...'], ['...']]

Статус

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

Для получения помощи в разработке модулей, если вы так решите, пожалуйста, прочитайте Информация о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/aireos_command_module.html

Spec-Zone.ru

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