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

Примечания

Примечание

Для получения дополнительной информации об использовании 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/dellemc/os6/os6_command_module.html