Spec-Zone.ru › Ansible 2.4

sros_command - Выполнение команд на удалённых устройствах с Nokia SR OS

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

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

Описание

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

Параметры

параметр обязательный значение по умолчанию выбор комментарии
commands
да
Список команд для отправки на удалённое устройство SR OS через настроенного поставщика. Результирующий вывод команды возвращается. Если задан аргумент wait_for, модуль не возвращает значение до тех пор, пока условие не будет выполнено или не истечёт время ожидания.
interval
нет 1
Устанавливает интервал в секундах для ожидания между повторами команды. Если команда не удовлетворяет указанным условиям, интервал определяет время ожидания перед повторной попыткой выполнения команды.
match
нет all
  • any
  • all
Аргумент match используется совместно с аргументом wait_for для указания политики сопоставления. Допустимые значения — all или any. Если значение установлено в all, все условные операторы в wait_for должны быть выполнены. Если значение установлено в any, должно быть выполнено только одно из условий.
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
нет
Список условий для оценки по выводу команды. Задача будет ожидать выполнения каждого условия, прежде чем продолжить. Если условие не выполняется в течение заданного количества попыток, задача завершается с ошибкой. См. примеры.
псевдонимы: waitfor

Примеры

# 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
    sros_command:
      commands: show version
      provider: "{{ cli }}"

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

  - name: run multiple commands on remote nodes
    sros_command:
      commands:
        - show version
        - show port detail
      provider: "{{ cli }}"

  - name: run multiple commands and evaluate the output
    sros_command:
      commands:
        - show version
        - show port detail
      wait_for:
        - result[0] contains TiMOS-B-14.0.R4
      provider: "{{ cli }}"

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

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

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

Статус

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

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

Spec-Zone.ru

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