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

Примечание

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

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

Чтобы использовать его в плейбуке, укажите: community.network.sros_command.

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

Обзор

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

Параметры

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

Примечания

Примечание

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

Примеры

# Note: examples below use the following provider dict to handle
#       transport and authentication to the node.
---
vars:
  cli:
    host: "{{ inventory_hostname }}"
    username: admin
    password: admin
    transport: cli

---
tasks:
  - name: Run show version on remote devices
    community.network.sros_command:
      commands: show version
      provider: "{{ cli }}"

  - 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
      provider: "{{ cli }}"

  - name: Run multiple commands on remote nodes
    community.network.sros_command:
      commands:
        - show version
        - show port detail
      provider: "{{ cli }}"

  - 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
      provider: "{{ cli }}"

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

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

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

Авторы

Peter Sprygada (@privateip)

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