dellemc.os10.os10_command – Выполнение команд на устройствах с Dell EMC SmartFabric OS10

Примечание

Этот плагин входит в состав коллекции dellemc.os10 (версия 1.0.2).

Для его установки используйте: ansible-galaxy collection install dellemc.os10.

Чтобы использовать его в плейбуке, укажите: dellemc.os10.os10_command.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Примечание

Этот модуль имеет соответствующий плагин действий.

Параметры

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

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами сети Dell EMC см. на странице https://www.ansible.com/ansible-dell-networking.

Примеры

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

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

  - name: run multiple commands on remote nodes
    os10_command:
      commands:
        - show version
        - show interface

  - name: run multiple commands and evaluate the output
    os10_command:
      commands:
        - show version
        - show interface
      wait_for:
        - result[0] contains OS10
        - result[1] contains Ethernet

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

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

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

Авторы

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.10/collections/dellemc/os10/os10_command_module.html