graphiant.naas.graphiant_public_vif_info module – Query Graphiant gateway Public VIF (local data exchange) service information

Note

This module is part of the graphiant.naas collection (version 26.10.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install graphiant.naas. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: graphiant.naas.graphiant_public_vif_info.

New in graphiant.naas 26.8.0

Synopsis

  • This module provides query capabilities for Graphiant gateway Public VIF service information.

  • Returns summary information about Public VIF services.

  • Provides detailed configuration for a specific Public VIF service.

  • All operations return read-only information and never modify the system.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.7

  • graphiant-sdk >= 26.10.0

  • tabulate

Parameters

Parameter

Comments

access_token

string

Bearer token for API authentication (for example, from graphiant login, which opens a browser for sign-in (SSO or non-SSO) and retrieves the token).

If not passed as a module argument, the collection reads GRAPHIANT_ACCESS_TOKEN (set after graphiant login when you source ~/.graphiant/env.sh).

When a bearer token is present (module argument or environment), it takes precedence over username and password.

If no valid token is available, the module authenticates with username and password when both are supplied.

detailed_logs

boolean

Enable detailed logging output for troubleshooting and monitoring.

When enabled, provides comprehensive logs of all query operations.

Logs are captured and included in the msg return value for display using ansible.builtin.debug module.

Choices:

  • false ← (default)

  • true

host

aliases: base_url

string / required

Graphiant portal host URL for API connectivity.

Example: “https://api.graphiant.com”

password

string

Graphiant portal password for authentication.

Required for password-based login when no valid bearer token is available from access_token or GRAPHIANT_ACCESS_TOKEN.

query

string / required

The specific information to query.

services_summary: Get summary of all Public VIF services with tabulated output.

Returns service details including IDs, names, creator, and last-updated time.

service_details: Get full configuration for a specific Public VIF service.

Requires service_name.

Choices:

  • "services_summary"

  • "service_details"

service_name

string

Public VIF service name.

Required for service_details query.

username

string

Graphiant portal username for authentication.

Required for password-based login when no valid bearer token is available from access_token or GRAPHIANT_ACCESS_TOKEN.

Attributes

Attribute

Support

Description

check_mode

Support: full

Supports check mode (always read-only).

Notes

Note

  • This is a read-only module that queries information only.

  • All operations return tabulated output for easy reading, where applicable.

See Also

See also

graphiant.naas.graphiant_public_vif

Manage Public VIF services

Examples

- name: Get Public VIF services summary
  graphiant.naas.graphiant_public_vif_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 details for a specific service
  graphiant.naas.graphiant_public_vif_info:
    query: service_details
    service_name: "pvif-service-1"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true
  register: service_details

- name: Display service details
  ansible.builtin.debug:
    msg: "{{ service_details.result_data }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

msg

string

Result message from the query operation, including detailed logs when detailed_logs is enabled.

Returned: always

Sample: "Public VIF Services Summary:\n+------+-------------------+------------+---------------------------+\n|   ID | Service Name      | Created By |  Updated At               |\n+======+===================+============+===========================+\n| 8568 | pvif-service-1    | jdoe       | 2026-08-14T23:08:05Z      |\n+------+-------------------+------------+---------------------------+\n"

query

string

The query that was performed.

One of services_summary or service_details.

Returned: always

Sample: "services_summary"

result_data

dictionary

Result data from the query operation, including structured data for the requested query.

Returned: always

Sample: {"services": [{"id": 8568, "serviceName": "pvif-service-1", "updatedAt": "2026-08-14T23:08:05Z", "userName": "jdoe"}]}

Authors

  • Graphiant Team (@graphiant)