модуль graphiant.naas.graphiant_bgp – Управление BGP-соседствами и политиками маршрутизации Graphiant

Примечание

Этот модуль входит в коллекцию graphiant.naas (версия 26.4.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: graphiant.naas.graphiant_bgp.

Добавлено в graphiant.naas 25.11.0

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

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

Этот модуль предоставляет широкие возможности для управления BGP-соседствами и политиками маршрутизации на устройствах Graphiant Edge.
Поддерживает настройку и удаление конфигурации BGP-соседей.
Позволяет подключать и отключать глобальные политики маршрутизации BGP (фильтры) для BGP-соседей.
Для единообразного развертывания конфигурации во всех операциях используются шаблоны Jinja2.
Файлы конфигурации поддерживают шаблонизацию Jinja2 для динамической генерации.

Требования

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

python >= 3.7
graphiant-sdk >= 26.4.0

Параметры

Параметр	Комментарии
access_token string	Токен Bearer для аутентификации API (например, полученный с помощью `graphiant login`, которая открывает браузер для входа (SSO или без SSO) и получает токен). Если аргумент модуля не указан, коллекция считывает `GRAPHIANT_ACCESS_TOKEN` (задается после `graphiant login` при выполнении `source ~/.graphiant/env.sh`). Если токен Bearer указан (в аргументе модуля или в переменной среды), он имеет приоритет над `username` и `password`. Если действительный токен недоступен, модуль выполняет аутентификацию с помощью `username` и `password`, если указаны оба параметра.
bgp_config_file string / обязательный	Путь к YAML-файлу конфигурации BGP. Обязателен для всех операций. Может быть абсолютным или относительным. Относительные пути разрешаются с использованием заданного config_path. Файлы конфигурации поддерживают синтаксис шаблонов Jinja2 для динамической генерации. Файл должен содержать определения BGP-соседей с именами устройств, IP-адресами соседей и ссылками на политики.
detailed_logs boolean	Включить подробное ведение журналов для устранения неполадок и мониторинга. При включении предоставляет подробные журналы всех операций BGP. Журналы сохраняются и включаются в result_msg для отображения с помощью модуля ansible.builtin.debug. Варианты: `false` ← (по умолчанию) `true`
host псевдонимы: base_url string / обязательный	URL хоста портала Graphiant для подключения к API. Пример: “https://api.graphiant.com”
operation string	Операция BGP, которую необходимо выполнить. `configure`: Настроить BGP-соседей и подключить глобальные политики маршрутизации BGP. `deconfigure`: Удалить конфигурацию BGP-соседей. Политики отключаются автоматически. `detach_policies`: Отключить глобальные политики маршрутизации BGP от BGP-соседей, не удаляя самих соседей. Варианты: `"configure"` `"deconfigure"` `"detach_policies"`
password string	Пароль портала Graphiant для аутентификации. Обязателен для входа по паролю, если действительный токен Bearer недоступен из `access_token` или `GRAPHIANT_ACCESS_TOKEN`.
state string	Требуемое состояние BGP-соседства. `present`: Соответствует `configure`, если `operation` не указан. `absent`: Соответствует `deconfigure`, если `operation` не указан. Варианты: `"present"` ← (по умолчанию) `"absent"`
username string	Имя пользователя портала Graphiant для аутентификации. Обязательно для входа по паролю, если действительный токен Bearer недоступен из `access_token` или `GRAPHIANT_ACCESS_TOKEN`.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: частичная Модуль не может точно определить, будут ли внесены изменения, не запросив текущее состояние с помощью вызовов API. В режиме проверки модуль предполагает, что изменения будут внесены, и возвращает `changed=True` для всех операций (`configure`, `deconfigure`, `detach_policies`). Это означает, что режим проверки может сообщать об изменениях, даже если конфигурация уже применена. Из-за ограничений API модуль не сравнивает состояния в режиме проверки.	Режим проверки поддерживается частично.

Примечания

Примечание

Операции BGP:
- Настройка: создание BGP-соседей и подключение глобальных политик маршрутизации BGP.
- Удаление конфигурации: удаление BGP-соседей (политики отключаются автоматически).
- Отключение политик: отключение глобальных политик маршрутизации BGP от BGP-соседей без удаления самих соседей.
Файлы конфигурации поддерживают синтаксис шаблонов Jinja2 для динамической генерации конфигурации.
Модуль автоматически сопоставляет имена устройств, площадок и политик с идентификаторами.
Все операции идемпотентны и безопасны при многократном запуске.
Глобальные фильтры BGP необходимо создать с помощью модуля graphiant.naas.graphiant_global_config
перед подключением к BGP-соседям.

См. также

graphiant.naas.graphiant_interfaces: Настройте интерфейсы перед настройкой BGP-соседства
graphiant.naas.graphiant_global_config: Настройте глобальные фильтры BGP (политики маршрутизации), которые можно подключить к BGP-соседям

Примеры

- name: Configure BGP peering and attach policies
  graphiant.naas.graphiant_bgp:
    operation: configure
    bgp_config_file: "sample_bgp_peering.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true
  register: bgp_result

- name: Detach policies from BGP peers
  graphiant.naas.graphiant_bgp:
    operation: detach_policies
    bgp_config_file: "sample_bgp_peering.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true

- name: Deconfigure BGP peering
  graphiant.naas.graphiant_bgp:
    operation: deconfigure
    bgp_config_file: "sample_bgp_peering.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"

- name: Configure BGP peering using state parameter
  graphiant.naas.graphiant_bgp:
    state: present
    bgp_config_file: "sample_bgp_peering.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"

- name: Deconfigure BGP peering using state parameter
  graphiant.naas.graphiant_bgp:
    state: absent
    bgp_config_file: "sample_bgp_peering.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"

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

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

Ключ	Описание
bgp_config_file string	Файл конфигурации BGP, использованный для операции. Возвращается: всегда Пример: `"sample_bgp_peering.yaml"`
changed boolean	Были ли внесены изменения в систему в результате операции. `true` для всех операций настройки, удаления конфигурации и отключения. Возвращается: всегда Пример: `true`
msg string	Сообщение о результате операции, включая подробные журналы, если включен параметр `detailed_logs`. Возвращается: всегда Пример: `"Successfully configured BGP peering and attached policies"`
operation string	Выполненная операция. Одно из значений: `configure`, `deconfigure` или `detach_policies`. Возвращается: всегда Пример: `"configure"`

Авторы

Команда Graphiant (@graphiant)

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

© 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/graphiant/naas/graphiant_bgp_module.html