Модуль community.network.sros_command – Выполнение команд на удаленных устройствах с Nokia SR OS

Примечание

Этот модуль входит в коллекцию community.network (версия 5.0.3).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

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

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

Обзор

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

Псевдонимы: network.sros.sros_command

Параметры

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

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления сетевыми устройствами Nokia SR OS см. на странице https://www.ansible.com/ansible-nokia.

Примеры

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

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

  - name: Run multiple commands on remote nodes
    community.network.sros_command:
      commands:
        - show version
        - show port detail

  - name: Run multiple commands and evaluate the output
    community.network.sros_command:
      commands:
        - show version
        - show port detail
      wait_for:
        - result[0] contains TiMOS-B-14.0.R4

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

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

Ключ	Описание
failed_conditions список / элементы=строка	Список условных выражений, которые завершились неудачно Возвращается: неудачно Пример: `["...", "..."]`
stdout список / элементы=строка	Набор ответов от команд Возвращается: всегда, кроме ошибок низкого уровня (например, плагин действия) Пример: `["...", "..."]`
stdout_lines список / элементы=строка	Значение stdout, разбитое на список Возвращается: всегда, кроме ошибок низкого уровня (например, плагин действия) Пример: `[["...", "..."], ["..."], ["..."]]`

Авторы

Peter Sprygada (@privateip)

Ссылки на коллекцию

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