dellemc.os6.os6_command – Выполнение команд на устройствах с Dell EMC OS6

Примечание

Этот плагин входит в коллекцию dellemc.os6 (версия 1.0.6).

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

Для использования в плейбуке укажите: dellemc.os6.os6_command

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

Обзор

Отправляет произвольные команды устройству OS6 и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставит модуль ожидать выполнения определенного условия перед возвратом или таймаутом, если условие не выполняется.
Этот модуль не поддерживает выполнение команд в режиме конфигурации. Пожалуйста, используйте dellemc_os6_os6_config для конфигурации устройств OS6.

Примечание

У данного модуля есть соответствующий плагин действий.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
commands список / элементы=строка / обязательный			Список команд, которые необходимо отправить удалённому устройству OS6 через настроенного поставщика. Результирующий вывод команды возвращается. Если указан аргумент wait_for, модуль не возвращается, пока условие не будет выполнено или таймаут не истечёт.
interval целое число		Значение по умолчанию: 1	Настраивает интервал в секундах ожидания между повторными попытками выполнения команды. Если команда не удовлетворяет указанным условиям, интервал определяет время ожидания перед повторной попыткой.
match строка		Варианты: all ← any	Аргумент match используется совместно с аргументом wait_for для указания политики сопоставления. Допустимые значения — `all` или `any`. Если значение установлено на `all`, все условия в wait_for должны быть выполнены. Если значение установлено на `any`, достаточно выполнения только одного условия.
provider словарь			Объект типа dict, содержащий данные подключения.
	auth_pass строка		Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize — false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`
	authorize логическое значение	Варианты: no yes	Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в обычном режиме. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`
	host строка		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта.
	password строка		Пароль для аутентификации SSH-сессии с удалённым устройством. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`
	port целое число		Указывает порт для подключения к удалённому устройству.
	ssh_keyfile путь		Путь к ssh-ключу для аутентификации SSH-сессии с удалённым устройством. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`
	timeout целое число		Указывает время ожидания (в секундах) для подключения. Полезно, если консоль зависает перед продолжением. Например, при сохранении конфигураций.
	username строка		Имя пользователя для аутентификации SSH-сессии с удалённым устройством. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`
retries целое число		Значение по умолчанию: 10	Указывает количество попыток выполнения команды перед признанием её неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for.
wait_for список / элементы=строка			Список условий для оценки на основе вывода команды. Задача будет ждать выполнения каждого условия перед продолжением. Если условие не выполняется в течение заданного количества попыток retries, задача завершается неудачей. См. примеры.

Примечания

Примечание

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

Примеры

tasks:
  - name: run show version on remote devices
    os6_command:
      commands: show version
  - name: run show version and check to see if output contains Dell
    os6_command:
      commands: show version
      wait_for: result[0] contains Dell
  - name: run multiple commands on remote nodes
    os6_command:
      commands:
       - show version
       - show interfaces
  - name: run multiple commands and evaluate the output
    os6_command:
      commands:
       - show version
       - show interfaces
      wait_for:
       - result[0] contains Dell
       - result[1] contains Access

Значения возврата

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

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

Авторы

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.10/collections/dellemc/os6/os6_command_module.html