community.google.gcpubsub_info module – List Topics/Subscriptions and Messages from Google PubSub.
Note
This module 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
.
You need further requirements to be able to use this module,
see Requirements for details.
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 |
Comments |
---|---|
path to the JSON file associated with the service account email |
|
your GCE project ID |
|
service account email |
|
list is the only valid option. Choices:
|
|
GCP pubsub topic name. Only the name, not the full path, is required. |
|
Choices are ‘topics’ or ‘subscriptions’ Choices:
|
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 |
Description |
---|---|
List of subscriptions. Returned: When view is set to subscriptions. Sample: |
|
Name of topic. Used to filter subscriptions. Returned: Always Sample: |
|
List of topics. Returned: When view is set to topics. Sample: |