Spec-Zone.ru › Ansible 2.4

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

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

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

Описание

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

Параметры

параметр обязательно по умолчанию выбор комментарии
commands
да
Список команд для отправки на удалённое устройство dellos9 через настроенный поставщик. Результирующий вывод команды возвращается. Если предоставлен аргумент wait_for, модуль не возвращается до тех пор, пока условие не будет выполнено или не истечёт количество попыток.
interval
нет 1
Настраивает интервал в секундах ожидания между повторами команды. Если команда не удовлетворяет указанным условиям, интервал указывает, сколько ждать перед повторной попыткой выполнения команды.
provider
нет
Объект словаря, содержащий данные подключения.
Объект словаря provider
параметр обязательно по умолчанию выбор комментарии
username
нет
Пользователь для аутентификации SSH-сессии с удалённым устройством. Если значение не указано в задании, будет использовано значение переменной окружения ANSIBLE_NET_USERNAME.
host
да
Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
ssh_keyfile
нет
Путь к SSH-ключу, используемому для аутентификации SSH-сессии с удалённым устройством. Если значение не указано в задании, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE.
timeout
нет 10
Указывает время ожидания бездействия (в секундах) для подключения. Полезно, если консоль зависает перед продолжением. Например, при сохранении конфигураций.
password
нет
Пароль для аутентификации SSH-сессии с удалённым устройством. Если значение не указано в задании, будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD.
port
нет 22
Указывает порт для использования при построении подключения к удалённому устройству.
retries
нет 10
Указывает количество попыток выполнения команды перед её признанием неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for.
wait_for
нет
Список условий для оценки по результатам команды. Задача будет ждать, пока каждое условие не станет истинным, прежде чем перейти дальше. Если условие не станет истинным в течение заданного количества попыток, задача завершается с ошибкой. См. примеры.

Примеры

# Note: examples below use the following provider dict to handle
#       transport and authentication to the node.
vars:
  cli:
    host: "{{ inventory_hostname }}"
    username: admin
    password: admin
    transport: cli

tasks:
  - name: run show version on remote devices
    dellos9_command:
      commands: show version
      provider: "{{ cli }}"

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

  - name: run multiple commands on remote nodes
    dellos9_command:
      commands:
        - show version
        - show interfaces
      provider: "{{ cli }}"

  - 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
      provider: "{{ cli }}"

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

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

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

Примечания

Примечание

  • Этот модуль требует версии Dell OS9 9.10.0.1P13 или выше.
  • Этот модуль требует увеличения лимита скорости подключения ssh. Используйте следующую команду ip ssh connection-rate-limit 60 для настройки этого значения. Это также можно сделать с помощью модуля dellos9_config.

Статус

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

Для получения помощи в разработке модулей, если вы захотите, пожалуйста, прочтите Информацию о сообществе и участии в разработке, Тестирование Ansible и Разработка модулей.

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API