m1yag1.globus.globus_search module – Manage Globus Search indexes

Note

This module is part of the m1yag1.globus collection (version 0.6.0).

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 m1yag1.globus.

To use it in a playbook, specify: m1yag1.globus.globus_search.

New in m1yag1.globus 0.4.0

Synopsis

• Create, update, or delete Globus Search indexes

• Free tier accounts are limited to 3 trial indexes (1 MB each, 30-day auto-deletion)

• Contact support@globus.org for subscription upgrades

Parameters

Parameter	Comments
auth_method string	Authentication method to use. If not specified, auto-detects based on available credentials. When client_id and client_secret are provided, uses client_credentials. Otherwise falls back to cli (reads tokens from globus-cli storage). Choices: "client_credentials" "cli"
client_id string	Globus Auth client ID for client_credentials authentication. Can also be set via the GLOBUS_CLIENT_ID environment variable.
client_secret string	Globus Auth client secret for client_credentials authentication. Can also be set via the GLOBUS_CLIENT_SECRET environment variable.
description string	Description of the search index Will be updated if changed on an existing index
name string / required	Display name of the search index Used to find existing indexes (not a unique identifier)
state string	Desired state of the search index Choices: "present" ← (default) "absent"

Notes

Note

• Trial indexes are limited to 1 MB and automatically deleted after 30 days

• Free tier accounts can have up to 3 trial indexes

• To upgrade an index or get more than 3 indexes, contact support@globus.org

• Deleting an index is irreversible and removes all indexed data

• Authentication is required for all Globus API operations.

• For client_credentials auth, register a confidential client at https://developers.globus.org.

• For cli auth, run globus login first to cache tokens.

• The cli method reads tokens from ~/.globus/cli/storage.db.

• For cli auth with multiple profiles, set GLOBUS_PROFILE environment variable.

• Set GLOBUS_SDK_ENVIRONMENT to sandbox or test for non-production environments.

See Also

See also

Globus Auth Documentation

Official Globus authentication documentation

Globus CLI

Command-line interface for Globus

Examples

- name: Create a Globus Search index
  globus_search:
    name: "research-publications"
    description: "Index for research publications metadata"
    client_id: "{{ globus_client_id }}"
    client_secret: "{{ globus_client_secret }}"
    state: present

- name: Update an existing search index description
  globus_search:
    name: "research-publications"
    description: "Updated description for publications index"
    client_id: "{{ globus_client_id }}"
    client_secret: "{{ globus_client_secret }}"
    state: present

- name: Delete a search index
  globus_search:
    name: "old-index"
    client_id: "{{ globus_client_id }}"
    client_secret: "{{ globus_client_secret }}"
    state: absent

Return Values

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

Key	Description
changed boolean	Whether the index was changed Returned: always Sample: true
description string	Description of the index Returned: when state=present Sample: "Index for research publications metadata"
index_id string	UUID of the created/managed search index Returned: when state=present Sample: "a1b2c3d4-5678-90ef-ghij-klmnopqrstuv"
is_trial boolean	Whether this is a trial index (limited to 1 MB, 30-day lifetime) Returned: when state=present Sample: true
name string	Display name of the index Returned: always Sample: "research-publications"
trial_count integer	Number of trial indexes currently owned (out of 3 maximum) Returned: when creating a trial index Sample: 2

Authors

• m1yag1

Collection links

• Issue Tracker
• Repository (Sources)