Spec-Zone.ru › Ansible 2.10

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

Примечание

Этот плагин является частью коллекции community.network (версия 1.3.0).

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

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

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

Описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/nos_command_module.html

Spec-Zone.ru

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