модуль graphiant.naas.graphiant_sites — управление сайтами Graphiant и подключениями объектов

Примечание

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

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

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

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

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

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

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

Этот модуль предоставляет широкие возможности управления сайтами для устройств Graphiant Edge.
Поддерживает создание и удаление сайтов.
Позволяет подключать глобальные системные объекты к сайтам и отключать их.
Может независимо выполнять операции только с сайтами или операции подключения объектов.
Для единообразного развертывания конфигурации во всех операциях используются шаблоны 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`, если заданы оба значения.
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_sites`: создание только сайтов (без подключения объектов). `deconfigure_sites`: удаление только сайтов (без отключения объектов). `attach_objects`: подключение глобальных объектов к существующим сайтам. `detach_objects`: отключение глобальных объектов от сайтов (без удаления сайтов). Варианты: `"configure"` `"deconfigure"` `"configure_sites"` `"deconfigure_sites"` `"attach_objects"` `"detach_objects"`
password string	Пароль портала Graphiant для аутентификации. Требуется для входа по паролю, если действительный токен Bearer недоступен из `access_token` или `GRAPHIANT_ACCESS_TOKEN`.
site_config_file string / обязательный	Путь к YAML-файлу конфигурации сайта. Обязателен для всех операций. Можно указать абсолютный или относительный путь. Относительные пути разрешаются с использованием настроенного config_path. Файлы конфигурации поддерживают синтаксис шаблонов Jinja2 для динамической генерации. Файл должен содержать описания сайтов с их именами и подключаемыми глобальными объектами.
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].
Используйте плейбук playbooks/site_management.yml с тегами configure_sites, deconfigure_sites,
attach_objects, detach_objects, configure, deconfigure.
Операции с сайтами:
- configure: создание сайтов и подключение глобальных объектов за одну операцию.
- deconfigure: отключение глобальных объектов и удаление сайтов за одну операцию.
- configure_sites: создание только сайтов (без подключения объектов).
- deconfigure_sites: удаление только сайтов (без отключения объектов).
- attach_objects: подключение глобальных объектов к существующим сайтам. Предварительное условие: сначала необходимо создать глобальные объекты.
- detach_objects: отключение глобальных объектов от сайтов (сайты остаются).
Файлы конфигурации поддерживают синтаксис шаблонов Jinja2 для динамической генерации конфигурации.
Модуль автоматически сопоставляет имена сайтов и глобальных объектов с их идентификаторами.
Все операции идемпотентны и безопасны для многократного выполнения.
Перед подключением к сайтам глобальные объекты необходимо создать с помощью модуля graphiant.naas.graphiant_global_config.

См. также

graphiant.naas.graphiant_global_config: Настройка глобальных объектов (сегментов LAN, наборов префиксов и т. д.), которые можно подключать к сайтам
graphiant.naas.graphiant_data_exchange: Использование сайтов в конфигурациях службы Data Exchange

Примеры

- name: Configure sites (create sites and attach objects)
  graphiant.naas.graphiant_sites:
    operation: configure
    site_config_file: "sample_sites.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true
  register: sites_result

- name: Create sites only
  graphiant.naas.graphiant_sites:
    operation: configure_sites
    site_config_file: "sample_sites.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true

- name: Attach global objects to existing sites
  graphiant.naas.graphiant_sites:
    operation: attach_objects
    site_config_file: "sample_site_attachments.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true

- name: Detach global objects from sites
  graphiant.naas.graphiant_sites:
    operation: detach_objects
    site_config_file: "sample_site_attachments.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true

- name: Delete sites only
  graphiant.naas.graphiant_sites:
    operation: deconfigure_sites
    site_config_file: "sample_sites.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"

- name: Deconfigure sites (detach objects and delete sites)
  graphiant.naas.graphiant_sites:
    operation: deconfigure
    site_config_file: "sample_sites.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"

- name: Configure sites using state parameter
  graphiant.naas.graphiant_sites:
    state: present
    site_config_file: "sample_sites.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"

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

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

Ключ	Описание
changed boolean	Были ли внесены изменения в систему в результате операции. `true` для всех операций configure/deconfigure/attach/detach. Возвращается: всегда Пример: `true`
msg string	Сообщение о результате операции, включая подробные журналы, если включен параметр `detailed_logs`. Возвращается: всегда Пример: `"Successfully configured (created sites and attached objects)"`
operation string	Выполненная операция. Одно из значений: `configure`, `deconfigure`, `configure_sites`, `deconfigure_sites`, `attach_objects` или `detach_objects`. Возвращается: всегда Пример: `"configure"`
site_config_file string	Файл конфигурации сайта, использованный для операции. Возвращается: всегда Пример: `"sample_sites.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_sites_module.html