Spec-Zone.ru › Ansible 2.4

dellos6_command - Запуск команд на удалённых устройствах с Dell OS6

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

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

Описание

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

Параметры

параметр обязательно по умолчанию выбор комментарии
commands
да
Список команд, которые нужно отправить удалённому устройству dellos6 через настроенного поставщика. Результирующий вывод команды возвращается. Если предоставлен аргумент wait_for, модуль не возвращает результат до тех пор, пока условие не будет выполнено или количество повторов не истечёт.
interval
нет 1
Настраивает интервал в секундах ожидания между повторными попытками выполнения команды. Если команда не удовлетворяет заданным условиям, интервал указывает, сколько времени ждать, прежде чем попробовать выполнить команду снова.
provider
нет
Объект типа dict, содержащий данные подключения.
Объект типа словарь 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
   dellos6_command:
     commands: show version
     provider: "{{ cli }}"

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

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

 - name: run multiple commands and evaluate the output
   dellos6_command:
     commands:
      - show version
      - show interfaces
     wait_for:
      - result[0] contains Dell
      - result[1] contains Access
     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/dellos6_command_module.html

Spec-Zone.ru

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