Модуль graphiant.naas.graphiant_static_routes — управление статическими маршрутами Graphiant (edge.segments.*.staticRoutes)

Примечание

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

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

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

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

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

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

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

Настраивает или удаляет статические маршруты в сегментах edge (edge.segments.<segment>.staticRoutes).
Читает структурированный файл конфигурации YAML и формирует полезную нагрузку конфигурации устройства в исходном виде на Python.
Все операции идемпотентны и безопасны при многократном выполнении.

Требования

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

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 логическое значение	Включить подробное ведение журнала. Варианты: `false` ← (по умолчанию) `true`
host псевдонимы: base_url строка / обязательный	URL узла портала Graphiant для подключения к API. Пример: “https://api.graphiant.com”
operation строка	Операция для выполнения. `configure` формирует полные объекты маршрутов. `deconfigure` удаляет перечисленные маршруты, задавая route=null для каждого префикса. Варианты: `"configure"` `"deconfigure"`
password строка	Пароль портала Graphiant для аутентификации. Требуется для входа по паролю, если действительный токен Bearer недоступен из `access_token` или `GRAPHIANT_ACCESS_TOKEN`.
state строка	Требуемое состояние маршрутов. `present` соответствует `configure`; `absent` соответствует `deconfigure`, если операция не задана. Варианты: `"present"` ← (по умолчанию) `"absent"`
static_routes_config_file псевдонимы: static_route_config_file строка / обязательный	Путь к файлу YAML со статическими маршрутами. Может быть абсолютным или относительным к заданному config_path. Ожидаемый ключ верхнего уровня — `staticRoutes` (список устройств).
username строка	Имя пользователя портала Graphiant для аутентификации. Требуется для входа по паролю, если действительный токен Bearer недоступен из `access_token` или `GRAPHIANT_ACCESS_TOKEN`.

Атрибуты

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

Примечания

Примечание

Операции со статическими маршрутами:
- Настройка: создание или обновление статических маршрутов, перечисленных в конфигурации.
- Отмена настройки: удаление статических маршрутов, перечисленных в конфигурации.
Файлы конфигурации поддерживают синтаксис шаблонов Jinja2 для динамического формирования конфигурации.
Модуль автоматически сопоставляет имена устройств с их идентификаторами.
В схеме YAML используются ключи в camelCase (например: staticRoutes, lanSegment, destinationPrefix, nextHops).
Идемпотентность настройки: сравнивает заданные маршруты с текущим состоянием устройства для каждого сегмента и префикса; отправка пропускается, если они совпадают (changed=false).
Отмена настройки удаляет только префиксы, перечисленные в YAML (для каждого сегмента).
В полезной нагрузке для отмены настройки используется route: null для каждого префикса; этот модуль сохраняет значения null в итоговой полезной нагрузке, отправляемой в API.

См. также

graphiant.naas.graphiant_global_config: Настройте сегменты LAN перед применением маршрутов (при необходимости)
graphiant.naas.graphiant_interfaces: Настройте интерфейсы перед применением маршрутов (при необходимости)
graphiant.naas.graphiant_device_config: Альтернативный способ отправки полных полезных нагрузок конфигурации устройства

Примеры

- name: Configure static routes
  graphiant.naas.graphiant_static_routes:
    operation: configure
    static_routes_config_file: "sample_static_route.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true
  register: static_routes_result
  no_log: true

- name: Display result message (includes detailed logs)
  ansible.builtin.debug:
    msg: "{{ static_routes_result.msg }}"

- name: Deconfigure static routes (deletes only prefixes listed in YAML)
  graphiant.naas.graphiant_static_routes:
    operation: deconfigure
    static_routes_config_file: "sample_static_route.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true

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

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

Ключ	Описание
changed логическое значение	Были ли внесены изменения в ходе операции. `true`, если конфигурация была бы отправлена хотя бы на одно устройство; `false`, если требуемое состояние уже соответствовало текущему. В режиме проверки (`--check`) конфигурация не отправляется, но `changed` отражает, были бы внесены изменения или нет. Возвращается: всегда Пример: `false`
configured_devices список / элементы=строка	Имена устройств, на которые была отправлена конфигурация (если changed=true). Возвращается: если поддерживается Пример: `["edge-1-sdktest"]`
details словарь	Подробности исходного результата диспетчера (включают changed/configured_devices/skipped_devices). Возвращается: если поддерживается
msg строка	Сообщение с результатом операции, включая подробные журналы, если включён параметр `detailed_logs`. Возвращается: всегда Пример: `"Static routes already match desired state; no changes needed"`
operation строка	Выполненная операция. Возвращается: всегда Пример: `"configure"`
skipped_devices список / элементы=строка	Имена устройств, обработка которых была пропущена, поскольку требуемое состояние уже соответствовало текущему. Возвращается: если поддерживается Пример: `["edge-1-sdktest"]`
static_routes_config_file строка	Файл конфигурации статических маршрутов, использованный для операции. Возвращается: всегда Пример: `"sample_static_route.yaml"`

Авторы

Команда 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_static_routes_module.html