community.google.gcpubsub_info – List Topics/Subscriptions and Messages from Google PubSub.

Note

This plugin is part of the community.google collection (version 1.0.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 community.google.

To use it in a playbook, specify: community.google.gcpubsub_info.

Synopsis

  • List Topics/Subscriptions from Google PubSub. Use the gcpubsub module for topic/subscription management. See https://cloud.google.com/pubsub/docs for an overview.

  • This module was called gcpubsub_facts before Ansible 2.9. The usage did not change.

Requirements

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

  • python >= 2.6

  • google-auth >= 0.5.0

  • google-cloud-pubsub >= 0.22.0

Parameters

Parameter Choices/Defaults Comments
credentials_file
string
path to the JSON file associated with the service account email
project_id
string
your GCE project ID
service_account_email
string
service account email
state
string
    Choices:
  • list ←
list is the only valid option.
topic
string
GCP pubsub topic name. Only the name, not the full path, is required.
view
string
    Choices:
  • topics ←
  • subscriptions
Choices are 'topics' or 'subscriptions'

Notes

Note

  • list state enables user to list topics or subscriptions in the project. See examples for details.

Examples

- name: List all Topics in a project
  community.google.gcpubsub_info:
    view: topics
    state: list

- name: List all Subscriptions in a project
  community.google.gcpubsub_info:
    view: subscriptions
    state: list

- name: List all Subscriptions for a Topic in a project
  community.google.gcpubsub_info:
    view: subscriptions
    topic: my-topic
    state: list

Return Values

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

Key Returned Description
subscriptions
list / elements=string
When view is set to subscriptions.
List of subscriptions.

Sample:
['mysubscription', 'mysubscription2']
topic
string
Always
Name of topic. Used to filter subscriptions.

Sample:
mytopic
topics
list / elements=string
When view is set to topics.
List of topics.

Sample:
['mytopic', 'mytopic2']


Authors