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

Примечание

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

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

Для использования в playbook укажите: 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 словарь			Объект типа dict, содержащий данные подключения.
	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 список / элементы=строка	failed	Список условий, которые не были выполнены Пример: ['...', '...']
stdout список / элементы=строка	всегда, за исключением ошибок низкого уровня (таких как плагин действия)	Набор ответов от команд Пример: ['...', '...']
stdout_lines список / элементы=строка	всегда, за исключением ошибок низкого уровня (таких как плагин действия)	Значение stdout, разбитое на список Пример: [['...', '...'], ['...'], ['...']]

Авторы

Peter Sprygada (@privateip)

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