Spec-Zone.ru › Ansible 2.4

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

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

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

Описание

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

Параметры

параметр обязателен по умолчанию выбор комментарии
commands
да
Список команд для отправки удалённому устройству dellos10 через настроенного поставщика. Результаты выполнения команды возвращаются. Если задан аргумент 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
    dellos10_command:
      commands: show version
      provider: "{{ cli }}"

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

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

  - name: run multiple commands and evaluate the output
    dellos10_command:
      commands:
        - show version
        - show interface
      wait_for:
        - result[0] contains OS10
        - result[1] contains Ethernet
      provider: "{{ cli }}"

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

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

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

Статус

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

Для получения помощи в разработке модулей, если вы захотите, прочитайте Информацию о сообществе и вклад, Тестирование 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/dellos10_command_module.html

Spec-Zone.ru

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