dellemc.os10.os10_command – Выполнение команд на устройствах с Dell EMC SmartFabric OS10

Примечание

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

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

Для использования в книге задач, укажите: dellemc.os10.os10_command

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Отправляет произвольные команды устройству OS10 и возвращает результаты, полученные с устройства. В этом модуле есть аргумент, который заставит модуль ожидать определённого условия перед возвратом или сработает таймаут, если условие не выполнено.
Этот модуль не поддерживает выполнение команд в режиме конфигурации. Для конфигурации устройств OS10 используйте dellemc.os10.os10_config.

Примечание

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

Параметры

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

Примечания

Примечание

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

Примеры

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

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

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

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

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

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

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

Авторы

Senthil Kumar Ganesan (@skg-net)

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