Модуль graphiant.naas.graphiant_global_config — управление глобальными объектами конфигурации Graphiant

Примечание

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

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

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

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

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

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

Обзор

Этот модуль предоставляет широкие возможности управления глобальными объектами конфигурации устройств Graphiant.
Поддерживаются различные типы глобальных объектов: наборы префиксов, фильтры BGP и Graphiant, службы SNMP, syslog и NTP, службы IPFIX, профили VPN и сегменты LAN.
Можно управлять всеми типами объектов одновременно с помощью общих операций или отдельно для каждого типа объектов.
Во всех операциях для согласованного развертывания конфигурации используются шаблоны 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`, если указаны оба значения.
config_file string / обязательный	Путь к YAML-файлу глобальной конфигурации. Обязателен для всех операций. Может быть абсолютным или относительным. Относительные пути разрешаются с учетом настроенного config_path. В файлах конфигурации поддерживается синтаксис шаблонов Jinja2 для динамической генерации. Файл должен содержать соответствующие определения глобальных объектов для указанного типа операции.
detailed_logs boolean	Включить подробное ведение журналов для устранения неполадок и мониторинга. При включении предоставляются подробные журналы всех операций с глобальной конфигурацией. Журналы собираются и включаются в result_msg для отображения с помощью модуля ansible.builtin.debug. Варианты: `false` ← (по умолчанию) `true`
host псевдонимы: base_url string / обязательный	URL хоста портала Graphiant для подключения к API. Пример: «https://api.graphiant.com»
operation string	Конкретная операция с глобальной конфигурацией. `configure`: настройка всех глобальных объектов (автоматически определяются все типы в файле). `deconfigure`: отмена настройки всех глобальных объектов (автоматически определяются все типы в файле). `configure_prefix_sets`: настройка только глобальных наборов префиксов. `deconfigure_prefix_sets`: отмена настройки только глобальных наборов префиксов. `configure_bgp_filters`: настройка только глобальных фильтров BGP (политик маршрутизации). `deconfigure_bgp_filters`: отмена настройки только глобальных фильтров BGP. `configure_graphiant_filters`: настройка только глобальных фильтров Graphiant (GraphiantIn/GraphiantOut). `deconfigure_graphiant_filters`: отмена настройки только глобальных фильтров Graphiant. `configure_snmp_services`: настройка только глобальных служб SNMP. `deconfigure_snmp_services`: отмена настройки только глобальных служб SNMP. `configure_syslog_services`: настройка только глобальных служб syslog. `deconfigure_syslog_services`: отмена настройки только глобальных служб syslog. `configure_ntps`: настройка только глобальных объектов NTP. `deconfigure_ntps`: отмена настройки только глобальных объектов NTP. `configure_ipfix_services`: настройка только глобальных служб IPFIX. `deconfigure_ipfix_services`: отмена настройки только глобальных служб IPFIX. `configure_vpn_profiles`: настройка только глобальных профилей VPN. `deconfigure_vpn_profiles`: отмена настройки только глобальных профилей VPN. `configure_lan_segments`: настройка только глобальных сегментов LAN. `deconfigure_lan_segments`: отмена настройки только глобальных сегментов LAN. `configure_site_lists`: настройка только глобальных списков сайтов. `deconfigure_site_lists`: отмена настройки только глобальных списков сайтов. Варианты: `"configure"` `"deconfigure"` `"configure_prefix_sets"` `"deconfigure_prefix_sets"` `"configure_bgp_filters"` `"deconfigure_bgp_filters"` `"configure_graphiant_filters"` `"deconfigure_graphiant_filters"` `"configure_snmp_services"` `"deconfigure_snmp_services"` `"configure_syslog_services"` `"deconfigure_syslog_services"` `"configure_ntps"` `"deconfigure_ntps"` `"configure_ipfix_services"` `"deconfigure_ipfix_services"` `"configure_vpn_profiles"` `"deconfigure_vpn_profiles"` `"configure_lan_segments"` `"deconfigure_lan_segments"` `"configure_site_lists"` `"deconfigure_site_lists"`
password string	Пароль портала Graphiant для аутентификации. Требуется для входа по паролю, если действительный bearer-токен недоступен из `access_token` или `GRAPHIANT_ACCESS_TOKEN`.
state string	Требуемое состояние объектов глобальной конфигурации. `present`: сопоставляется с `configure`, если `operation` не задан. `absent`: сопоставляется с `deconfigure`, если `operation` не задан. Варианты: `"present"` ← (по умолчанию) `"absent"`
username string	Имя пользователя портала Graphiant для аутентификации. Требуется для входа по паролю, если действительный bearer-токен недоступен из `access_token` или `GRAPHIANT_ACCESS_TOKEN`.

Атрибуты

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

Примечания

Примечание

Режим проверки (--check): конфигурация не отправляется; данные, которые были бы отправлены, записываются в журнал с помощью [check_mode].
Операции с глобальной конфигурацией:
- Общие операции (configure, deconfigure): - автоматически определяют и обрабатывают все типы конфигурации в YAML-файле.
- Специальные операции (configure_*, deconfigure_*): - обрабатывают только указанный тип конфигурации.
В файлах конфигурации поддерживается синтаксис шаблонов Jinja2 для динамической генерации конфигурации.
Модуль автоматически преобразует имена в идентификаторы сайтов, сегментов LAN и других связанных объектов.
Все операции идемпотентны и безопасны при многократном выполнении.
После создания на глобальные объекты могут ссылаться другие модули (BGP, Sites, Data Exchange).
Если указаны и operation, и state, приоритет имеет operation.

См. также

graphiant.naas.graphiant_bgp: Привязка глобальных фильтров BGP к соседям BGP
graphiant.naas.graphiant_sites: Привязка глобальных объектов к сайтам
graphiant.naas.graphiant_data_exchange: Использование глобальных сегментов LAN и профилей VPN в рабочих процессах Data Exchange

Примеры

- name: Configure all global objects (general operation)
  graphiant.naas.graphiant_global_config:
    operation: configure
    config_file: "sample_global_prefix_lists.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true

- name: Configure global prefix sets (specific operation)
  graphiant.naas.graphiant_global_config:
    operation: configure_prefix_sets
    config_file: "sample_global_prefix_lists.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true

- name: Configure global BGP filters
  graphiant.naas.graphiant_global_config:
    operation: configure_bgp_filters
    config_file: "sample_global_bgp_filters.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true

- name: Configure global Graphiant filters
  graphiant.naas.graphiant_global_config:
    operation: configure_graphiant_filters
    config_file: "sample_global_graphiant_filters.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true

- name: Deconfigure global Graphiant filters
  graphiant.naas.graphiant_global_config:
    operation: deconfigure_graphiant_filters
    config_file: "sample_global_graphiant_filters.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true

- name: Configure global LAN segments
  graphiant.naas.graphiant_global_config:
    operation: configure_lan_segments
    config_file: "sample_global_lan_segments.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true

- name: Configure global VPN profiles
  graphiant.naas.graphiant_global_config:
    operation: configure_vpn_profiles
    config_file: "sample_global_vpn_profiles.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true

- name: Configure global NTP objects
  graphiant.naas.graphiant_global_config:
    operation: configure_ntps
    config_file: "sample_global_ntp.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true

- name: Configure global site lists
  graphiant.naas.graphiant_global_config:
    operation: configure_site_lists
    config_file: "sample_global_site_lists.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true

- name: Deconfigure global prefix sets
  graphiant.naas.graphiant_global_config:
    operation: deconfigure_prefix_sets
    config_file: "sample_global_prefix_lists.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"

- name: Deconfigure all global objects using state parameter
  graphiant.naas.graphiant_global_config:
    state: absent
    config_file: "sample_global_prefix_lists.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"

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

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

Ключ	Описание
changed boolean	Были ли внесены изменения в систему в результате операции. `true` для всех операций настройки и отмены настройки. Возвращается: всегда Пример: `true`
config_file string	Файл конфигурации, использованный для операции. Возвращается: всегда Пример: `"sample_global_prefix_lists.yaml"`
msg string	Сообщение о результате операции, включая подробные журналы, если включен параметр `detailed_logs`. Возвращается: всегда Пример: `"Successfully configured all global objects"`
operation string	Выполненная операция. Одно из значений `configure`, `deconfigure` или конкретная операция `configure_`/`deconfigure_`. Возвращается: всегда Пример: `"configure_prefix_sets"`

Авторы

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