Spec-Zone.ru › Ansible 2.11

community.network.nos_command – Выполнение команд на удаленных устройствах с Extreme Networks NOS

Примечание

Этот плагин входит в сборку community.network (версия 2.0.1).

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

Для использования в книге задач укажите: community.network.nos_command.

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

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

Параметры

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

Примечания

Примечание

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

Примеры

tasks:
  - name: Run show version on remote devices
    community.network.nos_command:
      commands: show version

  - name: Run show version and check to see if output contains NOS
    community.network.nos_command:
      commands: show version
      wait_for: result[0] contains NOS

  - name: Run multiple commands on remote nodes
    community.network.nos_command:
      commands:
        - show version
        - show interfaces

  - name: Run multiple commands and evaluate the output
    community.network.nos_command:
      commands:
        - show version
        - show interface status
      wait_for:
        - result[0] contains NOS
        - result[1] contains Te
  - name: Run command that requires answering a prompt
    community.network.nos_command:
      commands:
        - command: 'clear sessions'
          prompt: 'This operation will logout all the user sessions. Do you want to continue (yes/no)?:'
          answer: y

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

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

Ключ Возвращаемое значение Описание
failed_conditions
список / элементы=строка
ошибка
Список условных выражений, которые не выполнились

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

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

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


Авторы

  • Lindsay Hill (@LindsayHill)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/nos_command_module.html

Spec-Zone.ru

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