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

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

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

Описание

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

Параметры

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

Примечания

Примечание

Этот модуль требует версии 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. [community]

Авторы

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