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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
commands список / обязательно			Список команд, которые нужно отправить удалённому устройству dellos6 через настроенного поставщика. Возвращается результат выполнения команды. Если предоставлен аргумент 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
    dellos6_command:
      commands: show version

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

  - name: run multiple commands on remote nodes
    dellos6_command:
      commands:
       - show version
       - show interfaces

  - name: run multiple commands and evaluate the output
    dellos6_command:
      commands:
       - show version
       - show interfaces
      wait_for:
       - result[0] contains Dell
       - result[1] contains Access

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

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

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

Статус

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

Авторы

Abirami N (@abirami-n)

Подсказка

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

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