dellos9_command – Запуск команд на удалённых устройствах с Dell OS9

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

Описание

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

Параметры

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

Примечания

Примечание

Этот модуль требует версию Dell OS9 9.10.0.1P13 или выше.
Этот модуль требует увеличения лимита скорости подключения ssh. Используйте следующую команду ip ssh connection-rate-limit 60 для настройки того же. Это также можно сделать с помощью модуля dellos9_config.
Дополнительную информацию об использовании Ansible для управления устройствами Dell EMC Network см. на странице https://www.ansible.com/ansible-dell-networking.

Примеры

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

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

  - name: run multiple commands on remote nodes
    dellos9_command:
      commands:
        - show version
        - show interfaces

  - name: run multiple commands and evaluate the output
    dellos9_command:
      commands:
        - show version
        - show interfaces
      wait_for:
        - result[0] contains OS9
        - result[1] contains Loopback

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

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

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

Статус

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

Авторы

Dhivya P (@dhivyap)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/dellos9_command_module.html