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

Новое в версии 2.2.

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

Описание

Отправляет произвольные команды узлу Dell OS10 и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставит модуль ждать выполнения определённого условия перед возвратом или истечения срока ожидания, если условие не выполняется.
Этот модуль не поддерживает выполнение команд в режиме конфигурации. Для конфигурации устройств Dell OS10 используйте dellos10_config.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
commands - / обязательно			Список команд для отправки на удалённое устройство dellos10 через настроенный поставщик. Результирующий вывод команды возвращается. Если предоставлен аргумент wait_for, модуль не возвращается, пока условие не будет выполнено или не истечёт количество попыток.
interval -		Значение по умолчанию: 1	Настраивает интервал в секундах для ожидания между повторными попытками выполнения команды. Если команда не удовлетворяет указанным условиям, интервал указывает, как долго ждать перед повторной попыткой выполнения команды.
match - добавлен в 2.5		Варианты: any all ←	Аргумент match используется совместно с аргументом wait_for для указания политики сопоставления. Допустимые значения — `all` или `any`. Если значение установлено в `all`, все условия в wait_for должны быть выполнены. Если значение установлено в `any`, должно быть выполнено только одно из условий.
provider -			Объект типа dict, содержащий детали подключения.
	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 - добавлен в 2.2			Список условий, которые должны быть проверены относительно вывода команды. Задача ожидает выполнения каждого условия перед продолжением. Если условие не выполняется в течение заданного числа retries, задача завершается неудачей. Смотрите примеры.

Примечания

Примечание

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

Статус

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

Авторы

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