Spec-Zone.ru › Ansible 2.9

eos_command – Выполнение произвольных команд на устройстве Arista EOS

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

Описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
auth_pass
строка
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass.
Этот параметр необходим только при использовании eAPI.
Для получения дополнительной информации обратитесь к руководству EOS Platform Options.
Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот параметр не используется. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS.
authorize
булево
    Варианты:
  • no ←
  • yes
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes.
Этот параметр необходим только при использовании eAPI.
Для получения дополнительной информации обратитесь к руководству EOS Platform Options.
Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE.
commands
- / обязательно
Команды для отправки на удалённое устройство EOS через конфигурируемый поставщик. Результат выполнения команды возвращается. Если указан аргумент wait_for, модуль возвращает результат только после выполнения условия или превышения числа повторов.
interval
-
Значение по умолчанию:
1
Настраивает интервал в секундах ожидания между повторами команды. Если команда не удовлетворяет указанному условию, интервал определяет время ожидания перед повторной попыткой выполнения команды.
match
-
    Варианты:
  • any
  • all ←
Аргумент match используется совместно с аргументом wait_for для указания политики соответствия. Допустимые значения — all или any. Если значение установлено в all, все условия в wait_for должны быть выполнены. Если значение установлено в any, достаточно выполнения только одного из условий.
provider
словарь
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.
Этот параметр необходим только при использовании eAPI.
Для получения дополнительной информации обратитесь к руководству EOS Platform Options.
Объект словаря, содержащий данные подключения.
auth_pass
строка
Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот параметр не используется. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS.
authorize
булево
    Варианты:
  • no ←
  • yes
Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE.
host
строка / обязательно
Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта.
password
строка
Указывает пароль для аутентификации подключения к удалённому устройству. Этот параметр используется для транспорта cli или eapi. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD.
port
целое число
Значение по умолчанию:
0
Указывает порт для подключения к удалённому устройству. Это значение применяется для транспорта cli или eapi.
Значение порта по умолчанию соответствует стандартному порту для транспорта, если не указано в задаче (cli=22, http=80, https=443).
ssh_keyfile
путь
Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот параметр используется только для транспорта cli. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE.
timeout
целое число
Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку.
transport
строка / обязательно
    Варианты:
  • cli ←
  • eapi
Настраивает транспортное соединение для подключения к удалённому устройству.
use_proxy
булево
добавлено в 2.5
    Варианты:
  • no
  • yes ←
Если no, переменные окружения http_proxy и https_proxy будут проигнорированы.
use_ssl
булево
    Варианты:
  • no
  • yes ←
Настраивает transport на использование SSL, если установлено yes, только когда transport=eapi. Если аргумент transport не eapi, это значение игнорируется.
username
строка
Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа CLI или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_USERNAME.
validate_certs
булево
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с самозаверяющими сертификатами. Если аргумент transport не eapi, это значение игнорируется.
retries
-
Значение по умолчанию:
10
Указывает количество повторов выполнения команды перед её признанием неудачной. Команда выполняется на целевом устройстве при каждом повторе и проверяется на соответствие условиям wait_for.
wait_for
-
Указывает, что нужно оценить из вывода команды и какие условия применить. Этот аргумент заставит задачу подождать, пока определённое условие не станет истинным, прежде чем продолжить. Если условие не станет истинным в течение заданного числа повторов, задача завершится ошибкой. Примечание: с wait_for значение в result['stdout'] можно получить, используя result, т. е. для доступа к result['stdout'][0] используйте result[0] См. примеры.

псевдонимы: waitfor

Примечания

Примечание

  • Проверено на EOS 4.15
  • Информация об использовании CLI, eAPI и привилегированного режима содержится в руководстве EOS Platform Options
  • Дополнительная информация об использовании Ansible для управления сетевыми устройствами содержится в руководстве Ansible Network Guide
  • Дополнительная информация об использовании Ansible для управления устройствами Arista EOS содержится на странице интеграции Arista.

Примеры

- name: run show version on remote devices
  eos_command:
    commands: show version

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

- name: run multiple commands on remote nodes
  eos_command:
    commands:
      - show version
      - show interfaces

- name: run multiple commands and evaluate the output
  eos_command:
    commands:
      - show version
      - show interfaces
    wait_for:
      - result[0] contains Arista
      - result[1] contains Loopback0

- name: run commands and specify the output format
  eos_command:
    commands:
      - command: show version
        output: json

- name: using cli transport, check whether the switch is in maintenance mode
  eos_command:
    commands: show maintenance
    wait_for: result[0] contains 'Under Maintenance'

- name: using cli transport, check whether the switch is in maintenance mode using json output
  eos_command:
    commands: show maintenance | json
    wait_for: result[0].units.System.state eq 'underMaintenance'

- name: "using eapi transport check whether the switch is in maintenance,
         with 8 retries and 2 second interval between retries"
  eos_command:
    commands: show maintenance
    wait_for: result[0]['units']['System']['state'] eq 'underMaintenance'
    interval: 2
    retries: 8
    provider:
      transport: eapi

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

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

Ключ Возвращаемое значение Описание
failed_conditions
список
неудачные
Список условных выражений, которые завершились неудачно

Пример:
['...', '...']
stdout
список
всегда, кроме ошибок низкого уровня (например, плагин действий)
Набор ответов от команд

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

Пример:
[['...', '...'], ['...'], ['...']]


Статус

  • Данный модуль не гарантирует обратную совместимость. [превью]
  • Этот модуль поддерживается командой Ansible Network Team. [сеть]

Поддержка Red Hat

Дополнительную информацию о поддержке данного модуля Red Hat можно найти в этой статье базы знаний Red Hat.

Авторы

  • Peter Sprygada (@privateip)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

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

Spec-Zone.ru

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