Spec-Zone.ru › Ansible 2.7

exos_command – Запуск команд на удалённых устройствах с Extreme EXOS

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

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

Описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
commands
- / обязательно
Список команд для отправки удалённому устройству EXOS через настроенного поставщика. Результат выполнения команды возвращается. Если указан аргумент wait_for, модуль не возвращается, пока условие не будет выполнено или не истечёт время ожидания.
interval
-
По умолчанию:
1
Настраивает интервал в секундах ожидания между повторами выполнения команды. Если команда не удовлетворяет указанным условиям, интервал определяет время ожидания перед повторной попыткой.
match
-
    Варианты:
  • any
  • all ←
Аргумент match используется совместно с аргументом wait_for для указания политики сопоставления. Допустимые значения являются all или any. Если значение установлено в all, все условия в wait_for должны быть выполнены. Если значение установлено в any, должно быть выполнено только одно из значений.
retries
-
По умолчанию:
10
Указывает количество попыток выполнения команды перед признанием её неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for.
wait_for
-
По умолчанию:
null
Список условий для оценки по результатам выполнения команды. Задача будет ожидать выполнения каждого условия перед продолжением. Если условие не выполняется в течение заданного количества попыток, задача завершается ошибкой. См. примеры.

Примечания

Примечание

  • Если команда, отправленная на устройство, требует ответа на запрос, можно передать словарь, содержащий command, answer и prompt. См. примеры.

Примеры

tasks:
  - name: run show version on remote devices
    exos_command:
      commands: show version
  - name: run show version and check to see if output contains ExtremeXOS
    exos_command:
      commands: show version
      wait_for: result[0] contains ExtremeXOS
  - name: run multiple commands on remote nodes
    exos_command:
      commands:
        - show version
        - show ports no-refresh
  - name: run multiple commands and evaluate the output
    exos_command:
      commands:
        - show version
        - show ports no-refresh
      wait_for:
        - result[0] contains ExtremeXOS
        - result[1] contains 20
  - name: run command that requires answering a prompt
    exos_command:
      commands:
        - command: 'clear license-info'
          prompt: 'Are you sure.*'
          answer: 'Yes'

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

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

Ключ Возвращаемое значение Описание
failed_conditions
список
неудача
Список условий, которые не выполнены

Пример:
['...', '...']
stdout
список
всегда, кроме низкоуровневых ошибок (таких как модуль действия)
Набор ответов на команды

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

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


Статус

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

Авторы

  • Rafael D. Vencioneck (@rdvencioneck)

Подсказка

Если вы заметите какие-либо проблемы в данной документации, вы можете отредактировать этот документ для улучшения.

© 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/exos_command_module.html

Spec-Zone.ru

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