модуль graphiant.naas.graphiant_data_exchange_info — запрос сведений о сервисах Graphiant Data Exchange, клиентах и состоянии системы

Примечание

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

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

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

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

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

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

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

Этот модуль позволяет запрашивать сведения Graphiant Data Exchange.
Возвращает сводную информацию о сервисах и клиентах Data Exchange.
Предоставляет сведения о мониторинге состояния сервиса для соответствующих клиентов.
Все операции возвращают информацию только для чтения и не изменяют систему.

Требования

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

python >= 3.7
graphiant-sdk >= 26.4.0
tabulate

Параметры

Параметр	Комментарии
access_token строка	Токен Bearer для аутентификации в API (например, полученный с помощью `graphiant login`, который открывает браузер для входа (SSO или без SSO) и получает токен). Если аргумент модуля не задан, коллекция считывает `GRAPHIANT_ACCESS_TOKEN` (задаётся после `graphiant login` при выполнении `source ~/.graphiant/env.sh`). Если токен Bearer указан (в аргументе модуля или в переменных среды), он имеет приоритет над `username` и `password`. Если действительный токен недоступен, модуль выполняет аутентификацию с помощью `username` и `password`, если заданы оба значения.
detailed_logs логическое значение	Включить подробный вывод журналов для устранения неполадок и мониторинга. При включении выводятся подробные журналы всех операций запроса. Журналы собираются и включаются в возвращаемое значение `msg` для отображения с помощью модуля ansible.builtin.debug. Варианты: `false` ← (по умолчанию) `true`
host псевдонимы: base_url строка / обязательный	URL-адрес узла портала Graphiant для подключения к API. Пример: «https://api.graphiant.com»
is_provider логическое значение	Показывать ли представление поставщика для мониторинга состояния сервиса. При значении `false` возвращается состояние с точки зрения потребителя/клиента. При значении `true` возвращается состояние с точки зрения поставщика сервиса. Применяется только к запросу `service_health`. Варианты: `false` ← (по умолчанию) `true`
password строка	Пароль для аутентификации на портале Graphiant. Необходим для входа по паролю, если действительный токен Bearer недоступен из `access_token` или `GRAPHIANT_ACCESS_TOKEN`.
query строка / обязательный	Тип запрашиваемых сведений. `services_summary`: получить сводку по всем сервисам Data Exchange в виде таблицы. Возвращает сведения о сервисах, включая идентификаторы, названия, состояние, роль и количество соответствующих клиентов. `customers_summary`: получить сводку по всем клиентам Data Exchange в виде таблицы. Возвращает сведения о клиентах, включая идентификаторы, названия, тип, состояние и количество соответствующих сервисов. `service_health`: получить сведения о мониторинге состояния сервиса для всех соответствующих клиентов. Возвращает состояние в виде таблицы, включая общее состояние, состояние префиксов производителя и состояние префиксов клиента. Поддерживаются представления потребителя и поставщика. Варианты: `"services_summary"` `"customers_summary"` `"service_health"`
service_name строка	Название сервиса для операций мониторинга состояния. Обязательно для запроса `service_health`. Должно быть названием существующего сервиса Data Exchange.
username строка	Имя пользователя портала Graphiant для аутентификации. Необходимо для входа по паролю, если действительный токен Bearer недоступен из `access_token` или `GRAPHIANT_ACCESS_TOKEN`.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Поддерживает режим проверки (всегда только для чтения).

Примечания

Примечание

Этот модуль предназначен только для чтения и лишь запрашивает сведения.
Все операции возвращают данные в виде таблицы для удобства чтения.
Для операций мониторинга состояния сервиса поддерживаются представления потребителя и поставщика.

См. также

graphiant.naas.graphiant_data_exchange: Управление сервисами Data Exchange, клиентами, связями и приглашениями

Примеры

- name: Get Data Exchange services summary
  graphiant.naas.graphiant_data_exchange_info:
    query: services_summary
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
  register: services_summary

- name: Display services summary
  ansible.builtin.debug:
    msg: "{{ services_summary.msg }}"

- name: Get Data Exchange customers summary
  graphiant.naas.graphiant_data_exchange_info:
    query: customers_summary
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
  register: customers_summary

- name: Display customers summary
  ansible.builtin.debug:
    msg: "{{ customers_summary.msg }}"

- name: Get service health (consumer view)
  graphiant.naas.graphiant_data_exchange_info:
    query: service_health
    service_name: "de-service-1"
    is_provider: false
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true
  register: service_health

- name: Display service health
  ansible.builtin.debug:
    msg: "{{ service_health.msg }}"

- name: Get service health (provider view)
  graphiant.naas.graphiant_data_exchange_info:
    query: service_health
    service_name: "de-service-1"
    is_provider: true
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true
  register: service_health_provider

- name: Display service health (provider view)
  ansible.builtin.debug:
    msg: "{{ service_health_provider.msg }}"

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

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

Ключ	Описание
msg строка	Сообщение с результатом операции запроса, включая подробные журналы, если включён параметр `detailed_logs`. Для операций получения сводки содержит данные в виде таблицы для удобства чтения. Для операций мониторинга состояния содержит сведения о состоянии в виде таблицы для всех соответствующих клиентов. Возвращается: всегда Пример: "Data Exchange Services Summary:\n+------------------+----------------------------------+--------+------+-------------------+\n\| Service Name \| Service ID \| Status \| Role \| Matched Customers \|\n+==================+==================================+========+======+===================+\n\| de-service-1 \| 12345678-1234-1234-1234-12345678 \| Active \| Both \| 2 \|\n+------------------+----------------------------------+--------+------+-------------------+\n"
query строка	Выполненный запрос. Одно из значений: `services_summary`, `customers_summary` или `service_health`. Возвращается: всегда Пример: `"services_summary"`
result_data словарь	Данные, полученные в результате операции запроса, включая структурированные данные для операций получения сводки и мониторинга состояния. Для операций получения сводки содержит сведения о сервисах/клиентах, включая идентификаторы, названия, состояние и количества. Для операций мониторинга состояния содержит показатели состояния для всех соответствующих клиентов. Возвращается: всегда Пример: `{"services": [{"matched_customers_count": 2, "role": "Both", "service_id": "12345678-1234-1234-1234-12345678", "service_name": "de-service-1", "status": "Active"}]}`

Авторы

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