Модуль arista.eos.eos_eapi — управление и настройка Arista EOS eAPI.

Примечание

Этот модуль входит в коллекцию arista.eos (версия 12.1.2).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install arista.eos. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: arista.eos.eos_eapi.

Добавлено в arista.eos 1.0.0

Краткое описание
Требования
Параметры
Примеры
Возвращаемые значения

Краткое описание

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

Примечание

Этому модулю соответствует плагин действий.

Псевдонимы: eapi

Требования

На хосте, где выполняется этот модуль, должны быть соблюдены следующие требования.

EOS v4.12 или более поздней версии

Параметры

Параметр	Комментарии
config string	По умолчанию модуль подключается к удалённому устройству и получает текущую конфигурацию running-config, которая используется в качестве основы для сравнения с содержимым source. Иногда нежелательно получать текущую running-config при выполнении каждой задачи плейбука. Аргумент config позволяет передать конфигурацию, которая будет использоваться как базовая конфигурация для сравнения.
http псевдонимы: enable_http boolean	Аргумент `http` управляет состоянием протокола передачи данных HTTP, если eAPI присутствует в running-config. Если значение равно True, протокол HTTP включён; если значение равно False, протокол HTTP отключён. По умолчанию при первоначальной настройке eAPI протокол HTTP отключён. Варианты: `false` `true`
http_port integer	Настраивает порт HTTP, на котором будут приниматься подключения при включённом протоколе передачи данных HTTP. Этот аргумент принимает целочисленные значения в допустимом диапазоне от 1 до 65535.
https псевдонимы: enable_https boolean	Аргумент `https` управляет состоянием протокола передачи данных HTTPS, если eAPI присутствует в running-config. Если значение равно True, протокол HTTPS включён; если значение равно False, протокол HTTPS отключён. По умолчанию при первоначальной настройке eAPI протокол HTTPS включён. Варианты: `false` `true`
https_port integer	Настраивает порт HTTP, на котором будут приниматься подключения при включённом протоколе передачи данных HTTP. Этот аргумент принимает целочисленные значения в допустимом диапазоне от 1 до 65535.
local_http псевдонимы: enable_local_http boolean	Аргумент `local_http` управляет состоянием локального протокола передачи данных HTTP, если eAPI присутствует в running-config. Если значение равно True, протокол HTTP включён, но подключения разрешены только с localhost. Если значение равно False, локальный протокол HTTP отключён. Обратите внимание: это значение не зависит от аргумента `http` Варианты: `false` `true`
local_http_port integer	Настраивает порт HTTP, на котором будут приниматься подключения при включённом протоколе передачи данных HTTP. Этот аргумент принимает целочисленные значения в допустимом диапазоне от 1 до 65535.
socket псевдонимы: enable_socket boolean	Аргумент `socket` управляет состоянием доменного сокета UNIX, используемого для получения запросов eAPI. Если значение этого аргумента равно True, UDS будет принимать запросы eAPI. Если значение равно False, UDS не будет доступен для обработки запросов. По умолчанию при первоначальной настройке eAPI UDS отключён. Варианты: `false` `true`
state string	Аргумент `state` управляет рабочим состоянием eAPI на удалённом устройстве. Если для этого аргумента задано значение `started`, eAPI включается для приёма запросов; если задано значение `stopped`, eAPI отключается и запросы не принимает. Варианты: `"started"` ← (по умолчанию) `"stopped"`
timeout integer	Время ожидания (в секундах), пока конфигурация eAPI отразится в running-config. По умолчанию: `30`
vrf string	Аргумент `vrf` настраивает eAPI для приёма подключений в указанном VRF. По умолчанию транспортные протоколы eAPI принимают подключения в глобальной таблице. Этот параметр требует, чтобы VRF уже был создан; в противном случае задача завершится с ошибкой. По умолчанию: `"default"`

Примеры

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

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

- name: Shutdown eAPI access
  arista.eos.eos_eapi:
    state: stopped

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

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

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

Авторы

Peter Sprygada (@privateip)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/arista/eos/eos_eapi_module.html