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

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

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

Описание

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

Параметры

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

Примечания

Примечание

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

Статус

Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантирует обратную совместимость.

Автор

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