dellos10_command – Выполнение команд на удалённых устройствах с Dell OS10

Новая в версии 2.2.

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

Описание

Отправляет произвольные команды на узел Dell EMC OS10 и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставит модуль дождаться выполнения определённого условия перед возвратом или сработает таймаут, если условие не выполнено.
Этот модуль не поддерживает выполнение команд в режиме конфигурации. Используйте dellos10_config для конфигурации устройств Dell EMC OS10.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
commands список / обязательно			Список команд, которые нужно отправить на удалённое устройство dellos10 через настроенный поставщик. Результирующий вывод команды возвращается. Если указан аргумент wait_for, модуль не возвращается до тех пор, пока условие не будет выполнено или не истечёт время ожидания.
interval целое число		Значение по умолчанию: 1	Настраивает интервал в секундах ожидания между попытками повтора команды. Если команда не выполняет указанные условия, интервал определяет, сколько времени ждать перед новой попыткой.
match строка добавлен в 2.5		Варианты: all ← any	Аргумент 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 список добавлен в 2.2			Список условий для оценки по выводу команды. Задача будет ожидать, пока каждое условие не станет истинным, прежде чем продолжить. Если условие не станет истинным в течение заданного количества попыток retries, задача завершается неудачей. См. примеры.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами Dell EMC Network см. на сайте https://www.ansible.com/ansible-dell-networking.

Примеры

tasks:
  - name: run show version on remote devices
    dellos10_command:
      commands: show version

  - name: run show version and check to see if output contains OS10
    dellos10_command:
      commands: show version
      wait_for: result[0] contains OS10

  - name: run multiple commands on remote nodes
    dellos10_command:
      commands:
        - show version
        - show interface

  - name: run multiple commands and evaluate the output
    dellos10_command:
      commands:
        - show version
        - show interface
      wait_for:
        - result[0] contains OS10
        - result[1] contains Ethernet

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

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

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

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Senthil Kumar Ganesan (@skg-net)

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ для его улучшения.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/dellos10_command_module.html