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

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

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

Описание

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

Параметры

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

Примечания

Примечание

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

Статус

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

Авторы

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