eos_eapi — Управление и настройка Arista EOS eAPI.

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

Описание
Требования (к хосту, на котором выполняется модуль)
Параметры
Примеры
Значения возврата
- Статус
- Информация о техническом обслуживании

Описание

Используется для включения или отключения доступа к eAPI и установки порта и состояния серверов http, https, local_http и unix-socket.
При включении доступа к eAPI по умолчанию включен HTTP на порту 80, включен HTTPS на порту 443, отключен local HTTP и отключен сервер Unix-сокет. Используйте указанные ниже параметры для переопределения конфигурации по умолчанию.
Требуется EOS версии 4.12 или выше.

Требования (к хосту, на котором выполняется модуль)

EOS версии 4.12 или выше

Параметры

параметр обязателен значение по умолчанию возможные значения комментарии

auth_pass

нет

Указывает пароль, используемый для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS.

authorize

нет

да
нет

Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE.

config

(добавлен в 2.2)

нет

nul

По умолчанию модуль подключается к удалённому устройству и получает текущую running-config для сравнения с содержимым источника. Бывают случаи, когда нежелательно получать текущую running-config для каждой задачи в playbook. Параметр config позволяет разработчику передать конфигурацию в качестве базовой для сравнения.

http

нет

да
нет

Аргумент http управляет режимом работы протокола HTTP при наличии eAPI в running-config. Если значение равно True, протокол HTTP включен, а если False — отключен. По умолчанию при первой настройке eAPI протокол HTTP отключён.

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

http_port

нет

Настраивает порт HTTP, который будет принимать подключения при включенном протоколе HTTP. Этот аргумент принимает целые значения от 1 до 65535.

https

нет

True

да
нет

Аргумент https управляет режимом работы протокола HTTPS при наличии eAPI в running-config. Если значение равно True, протокол HTTPS включен, а если False — отключен. По умолчанию при первой настройке eAPI протокол HTTPS включён.

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

https_port

нет

443

local_http

нет

да
нет

Аргумент local_http управляет режимом работы протокола local HTTP при наличии eAPI в running-config. Если значение равно True, протокол HTTP включён и ограничен подключениями только с localhost. Если значение равно False, протокол local HTTP отключён.

Примечание: значение независимо от аргумента http

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

local_http_port

нет

8080

provider

нет

Объект dict, содержащий детали подключения.

**Объект словаря provider**
параметр	обязателен	значение по умолчанию	возможные значения	комментарии
username	нет			Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа CLI или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`.
authorize	нет		да нет	Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
ssh_keyfile	нет			Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
auth_pass	нет	none		Указывает пароль, используемый для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
host	да			Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
timeout	нет	10		Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль вернёт ошибку.
use_ssl	нет	True	да нет	Настраивает transport на использование SSL, если установлено значение true только когда `transport=eapi`. Если аргумент transport не eapi, это значение игнорируется.
password	нет			Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или eapi. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
validate_certs	нет		да нет	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с самозаверенными сертификатами. Если аргумент transport не eapi, это значение игнорируется.
port	нет	0 (используется стандартный порт)		Указывает порт для подключения к удалённому устройству. Это значение относится к cli или eapi. Значение порта по умолчанию соответствует стандартному порту для транспорта, если не указано в задаче. (cli=22, http=80, https=443).
transport	да	cli	eapi cli	Настраивает транспортное подключение для подключения к удалённому устройству.

socket

нет

да
нет

Аргумент socket управляет состоянием UNIX Domain Socket для получения запросов eAPI. Если значение равно True, UDS будет принимать запросы eAPI. Если значение равно False, UDS не будет доступен для обработки запросов. По умолчанию при первой настройке eAPI UDS отключён.

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

state

нет

started

started
stopped

Аргумент state управляет рабочим состоянием eAPI на удалённом устройстве. Если значение равно started, eAPI включён и будет принимать запросы. Если значение равно stopped, eAPI отключён и не будет принимать запросы.

vrf

(добавлен в 2.2)

нет

default

Аргумент vrf настраивает eAPI на прослушивание подключений в указанной VRF. По умолчанию eAPI-транспорты будут прослушивать подключения в глобальной таблице. Это значение требует, чтобы VRF уже был создан, иначе задача завершится ошибкой.

Примеры

- name: Enable eAPI access with default configuration
  eos_eapi:
    state: started

- name: Enable eAPI with no HTTP, HTTPS at port 9443, local HTTP at port 80, and socket enabled
  eos_eapi:
    state: started
    http: false
    https_port: 9443
    local_http: yes
    local_http_port: 80
    socket: yes

- name: Shutdown eAPI access
  eos_eapi:
    state: stopped

Значения возврата

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

Имя	Описание	Возвращаемое значение	Тип	Пример
commands	Список команд конфигурационного режима для отправки на устройство	всегда	список	['management api http-commands', 'protocol http port 81', 'no protocol https']
session_name	Имя сессии конфигурации EOS, используемой для загрузки конфигурации	при изменении is True	строка	ansible_1479315771
urls	Хэш конечных точек URL, на которых eAPI прослушивает по интерфейсу	при запуске eAPI	словарь	{'Management1': ['http://172.26.10.1:80']}

Статус

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

Информация о техническом обслуживании

Для получения дополнительной информации о поддержке этого модуля компанией Red Hat, обратитесь к этому knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

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