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

Примечание

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

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

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

Для использования в playbook, укажите: 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 строка	По умолчанию модуль подключается к удаленному устройству и извлекает текущую конфигурацию запуска, чтобы использовать ее в качестве основы для сравнения с содержимым источника. Бывают случаи, когда нежелательно, чтобы задача получала текущую конфигурацию запуска для каждой задачи в playbook. Аргумент config позволяет разработчику передавать конфигурацию, которая будет использоваться в качестве базовой конфигурации для сравнения.
http псевдонимы: enable_http логическое	Аргумент `http` управляет рабочим состоянием транспортного протокола HTTP, когда eAPI присутствует в конфигурации запуска. Когда значение установлено в True, протокол HTTP включен, а когда значение установлено в False, протокол HTTP отключен. По умолчанию, когда eAPI впервые настраивается, протокол HTTP отключен. Варианты: `false` `true`
http_port целое число	Настраивает порт HTTP, который будет прослушивать подключения, когда транспортный протокол HTTP включен. Этот аргумент принимает целые значения в допустимом диапазоне от 1 до 65535.
https псевдонимы: enable_https логическое	Аргумент `https` управляет рабочим состоянием транспортного протокола HTTPS, когда eAPI присутствует в конфигурации запуска. Когда значение установлено в True, протокол HTTPS включен, а когда значение установлено в False, протокол HTTPS отключен. По умолчанию, когда eAPI впервые настраивается, протокол HTTPS включен. Варианты: `false` `true`
https_port целое число	Настраивает порт HTTP, который будет прослушивать подключения, когда транспортный протокол HTTP включен. Этот аргумент принимает целые значения в допустимом диапазоне от 1 до 65535.
local_http псевдонимы: enable_local_http логическое	Аргумент `local_http` управляет рабочим состоянием локального транспортного протокола HTTP, когда eAPI присутствует в конфигурации запуска. Когда значение установлено в True, протокол HTTP включен и ограничен подключениями только с localhost. Когда значение установлено в False, локальный протокол HTTP отключен. Примечание: значение независимо от аргумента `http` Варианты: `false` `true`
local_http_port целое число	Настраивает порт HTTP, который будет прослушивать подключения, когда транспортный протокол HTTP включен. Этот аргумент принимает целые значения в допустимом диапазоне от 1 до 65535.
socket псевдонимы: enable_socket логическое	Аргумент `socket` управляет рабочим состоянием сокета домена UNIX, используемого для приема запросов eAPI. Когда значение этого аргумента установлено в True, UDS будет прослушивать запросы eAPI. Когда значение установлено в False, UDS будет недоступен для обработки запросов. По умолчанию, когда eAPI впервые настраивается, UDS отключен. Варианты: `false` `true`
state строка	Аргумент `state` управляет рабочим состоянием eAPI на удаленном устройстве. Когда этот аргумент установлен в `started`, eAPI включен для приема запросов, а когда этот аргумент `stopped`, eAPI отключен и не будет принимать запросы. Варианты: `"started"` ← (по умолчанию) `"stopped"`
timeout целое число	Время (в секундах) ожидания отражения конфигурации eAPI в конфигурации запуска. По умолчанию: `30`
vrf строка	Аргумент `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 список / элементы=строка	Список команд режима конфигурации для отправки устройству Возвращается: всегда Пример: `["management api http-commands", "protocol http port 81", "no protocol https"]`
session_name строка	Имя сеанса конфигурации EOS, используемого для загрузки конфигурации Возвращается: когда changed равно True Пример: `"ansible_1479315771"`
urls словарь	Хэш конечных точек URL, на которых eAPI прослушивает по каждому интерфейсу Возвращается: при запуске eAPI Пример: `{"Management1": ["http://172.26.10.1:80"]}`

Авторы

Peter Sprygada (@privateip)

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

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