модуль graphiant.naas.graphiant_lag_interfaces — управление конфигурацией LAG (группы агрегирования каналов) Graphiant

Примечание

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

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

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

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

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

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

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

Модуль предоставляет комплексные средства управления LAG для устройств Graphiant Edge и Gateway.
Поддерживает настройку и удаление конфигурации LAG, добавление и удаление участников LAG, обновление параметров LACP и управление подинтерфейсами LAG (VLAN).
Для единообразного развертывания конфигурации во всех операциях используются шаблоны Jinja2.
Файлы конфигурации поддерживают шаблоны Jinja2 для динамической генерации.
Все операции идемпотентны — их можно безопасно выполнять несколько раз без ошибок и непреднамеренных изменений.

Требования

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

python >= 3.7
graphiant-sdk >= 26.4.0

Параметры

Параметр	Комментарии
access_token строка	Токен Bearer для аутентификации в API (например, полученный с помощью `graphiant login`, который открывает браузер для входа (SSO или без SSO) и получает токен). Если параметр не передан в качестве аргумента модуля, коллекция считывает `GRAPHIANT_ACCESS_TOKEN` (устанавливается после `graphiant login` при выполнении `source ~/.graphiant/env.sh`). Если токен Bearer задан (в аргументе модуля или в переменной среды), он имеет приоритет над `username` и `password`. Если действительный токен недоступен, модуль выполняет аутентификацию с помощью `username` и `password`, если заданы оба параметра.
detailed_logs логическое значение	Включить подробное ведение журналов для устранения неполадок и мониторинга. При включении предоставляются подробные журналы всех операций с LAG. Журналы собираются и включаются в result_msg для отображения с помощью модуля ansible.builtin.debug. Варианты: `false` ← (по умолчанию) `true`
host псевдонимы: base_url строка / обязательный	URL-адрес хоста портала Graphiant для подключения к API. Пример: «https://api.graphiant.com»
lag_config_file строка / обязательный	Путь к YAML-файлу конфигурации LAG. Обязателен для всех операций. Может быть абсолютным или относительным. Относительные пути разрешаются с использованием настроенного config_path. Файлы конфигурации поддерживают синтаксис шаблонов Jinja2 для динамической генерации. Файл должен содержать определения LAG с именами устройств, именем/псевдонимом LAG, сегментом, mtu, ipv4, ipv6, lacpMode, lacpTimer, интерфейсами-участниками и необязательными подинтерфейсами.
operation строка	Операция с LAG, которую необходимо выполнить. `configure`: настроить LAG для устройств, указанных в файле конфигурации. «`deconfigure`: удалить ВСЕ подинтерфейсы (если они есть), а затем удалить основной интерфейс LAG. Полная очистка конфигурации.» `add_lag_members`: добавить интерфейсы-участники в существующий LAG. `remove_lag_members`: удалить интерфейсы-участники из существующего LAG. `update_lacp_configs`: обновить режим/таймер LACP. `delete_lag_subinterfaces`: удалить подинтерфейсы VLAN в составе LAG. Примечание: чтобы добавить/настроить подинтерфейсы LAG, используйте операцию `configure` и укажите подинтерфейсы в файле конфигурации. Варианты: `"configure"` `"deconfigure"` `"add_lag_members"` `"remove_lag_members"` `"update_lacp_configs"` `"delete_lag_subinterfaces"`
password строка	Пароль портала Graphiant для аутентификации. Требуется для входа по паролю, если действительный токен Bearer недоступен из `access_token` или `GRAPHIANT_ACCESS_TOKEN`.
state строка	Требуемое состояние конфигурации LAG. `present`: соответствует `configure`, если не задан параметр `operation`. `absent`: соответствует `deconfigure`, если не задан параметр `operation`. Варианты: `"present"` ← (по умолчанию) `"absent"`
username строка	Имя пользователя портала Graphiant для аутентификации. Требуется для входа по паролю, если действительный токен Bearer недоступен из `access_token` или `GRAPHIANT_ACCESS_TOKEN`.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная При запуске с параметром `--check` модуль выводит в журнал точные полезные данные, которые были бы отправлены, с префиксом `[check_mode]`, чтобы вы могли увидеть применяемую конфигурацию. Модуль не сравнивает состояния, поэтому `changed` может быть `True`, даже если конфигурация уже применена.	Поддерживается режим проверки. В этом режиме конфигурация не отправляется на устройства, однако полезные данные, которые были бы отправлены, записываются в журнал с `[check_mode]`.

Примечания

Примечание

Режим проверки (--check): конфигурация не отправляется; полезные данные, которые были бы отправлены, записываются в журнал с [check_mode].
Операции с LAG:
- configure: настроить LAG на физических интерфейсах (и при необходимости подинтерфейсах). Идемпотентная операция — создает новые LAG или обновляет существующие.
- deconfigure: удалить ВСЕ подинтерфейсы (если они есть), а затем удалить основной интерфейс LAG. Это полная очистка, удаляющая все компоненты. Идемпотентная операция — пропускает несуществующие LAG и подинтерфейсы.
- add_lag_members: добавить интерфейсы-участники в существующий LAG. Идемпотентная операция — пропускает уже добавленные интерфейсы.
- remove_lag_members: удалить интерфейсы-участники из существующего LAG. Идемпотентная операция — пропускает уже удаленные интерфейсы.
- update_lacp_configs: обновить режим/таймер LACP. Идемпотентная операция — пропускает обновление, если конфигурация уже соответствует требуемому состоянию.
- delete_lag_subinterfaces: удалить указанные подинтерфейсы VLAN в составе LAG. Удаляются только подинтерфейсы, перечисленные в файле конфигурации. Идемпотентная операция — пропускает несуществующие LAG и подинтерфейсы.
Файлы конфигурации поддерживают синтаксис шаблонов Jinja2 для динамической генерации конфигурации.
Модуль автоматически преобразует имена устройств в идентификаторы.
Подробности идемпотентности:
Перед внесением изменений модуль запрашивает текущее состояние LAG. При настройке повторяющиеся назначения псевдонимов обрабатываются автоматически: псевдоним исключается из полезных данных, если совпадает с существующим. При операциях с участниками проверяется наличие уже добавленных интерфейсов и применяются только необходимые изменения. Перед отправкой конфигурации LACP сравниваются текущие режим и таймер. При удалении конфигурации автоматически обнаруживаются все существующие подинтерфейсы и удаляются перед удалением основного LAG. При операции delete_lag_subinterfaces удаляются только указанные подинтерфейсы. При удалении конфигурации автоматически обнаруживаются все существующие подинтерфейсы и удаляются перед удалением основного LAG. При операции delete_lag_subinterfaces удаляются только указанные подинтерфейсы.
Интерфейсы-участники должны существовать на устройстве; имена интерфейсов из конфигурации преобразуются в идентификаторы интерфейсов с использованием сведений об устройстве.

См. также

graphiant.naas.graphiant_interfaces: Управление конфигурацией интерфейсов LAN/WAN и каналов связи

Примеры

- name: Configure LAG
  graphiant.naas.graphiant_lag_interfaces:
    operation: configure
    lag_config_file: "sample_lag_interface_config.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true
  register: lag_result

- name: Add LAG members
  graphiant.naas.graphiant_lag_interfaces:
    operation: add_lag_members
    lag_config_file: "sample_lag_interface_config.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"

- name: Remove LAG members
  graphiant.naas.graphiant_lag_interfaces:
    operation: remove_lag_members
    lag_config_file: "sample_lag_interface_config.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"

- name: Update LACP settings
  graphiant.naas.graphiant_lag_interfaces:
    operation: update_lacp_configs
    lag_config_file: "sample_lag_interface_config.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"

- name: Configure LAG subinterfaces (use configure operation with subinterfaces in config)
  graphiant.naas.graphiant_lag_interfaces:
    operation: configure
    lag_config_file: "sample_lag_interface_config.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"

- name: Delete LAG subinterfaces
  graphiant.naas.graphiant_lag_interfaces:
    operation: delete_lag_subinterfaces
    lag_config_file: "sample_lag_interface_config.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"

- name: Deconfigure LAG using state parameter
  graphiant.naas.graphiant_lag_interfaces:
    state: absent
    lag_config_file: "sample_lag_interface_config.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"

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

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

Ключ	Описание
changed логическое значение	Были ли внесены изменения в систему в результате операции. Возвращается: всегда Пример: `true`
lag_config_file строка	Файл конфигурации LAG, использованный для операции. Возвращается: всегда Пример: `"sample_lag_interface_config.yaml"`
msg строка	Сообщение о результате операции, включая подробные журналы, если включен параметр `detailed_logs`. Возвращается: всегда Пример: `"Successfully configured LAG interfaces"`
operation строка	Выполненная операция. Одно из значений: configure, deconfigure, add_lag_members, remove_lag_members, update_lacp_configs или delete_lag_subinterfaces. Возвращается: всегда Пример: `"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_lag_interfaces_module.html