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

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

Описание

Отправляет произвольные команды на узел 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 словарь			Объект словаря, содержащий детали подключения.
	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 список			Список условий для проверки по отношению к результату выполнения команды. Задача будет ждать выполнения каждого условия до продвижения дальше. Если условие не выполняется в течение заданного количества повторов, задача завершается неудачно. См. примеры.

Примечания

Примечание

Дополнительную информацию об использовании 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 список	failed	Список условий, которые не выполнены Пример: ['...', '...']
stdout список	всегда, кроме ошибок низкого уровня (например, плагина действия)	Множество ответов от команд Пример: ['...', '...']
stdout_lines список	всегда, кроме ошибок низкого уровня (например, плагина действия)	Значение stdout, разбитое на список Пример: [['...', '...'], ['...'], ['...']]
warnings список	всегда	Список предупреждений (если есть) сгенерированных модулем на основе аргументов Пример: ['...', '...']

Статус

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

Авторы

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.9/modules/dellos10_command_module.html