community.general.gcpubsub_facts – Список тем/подписок и сообщений из Google PubSub.
Примечание
Этот плагин входит в сборку community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.gcpubsub_facts.
Обзор
- Список тем/подписок из Google PubSub. Используйте модуль gcpubsub для управления темами/подписками. Для обзора см. https://cloud.google.com/pubsub/docs.
- Этот модуль назывался
gcpubsub_factsдо Ansible 2.9. Использование не изменилось.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- google-auth >= 0.5.0
- google-cloud-pubsub >= 0.22.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| credentials_file строка | путь к файлу JSON, связанному с электронной почтой учетной записи службы | |
| project_id строка | ваш идентификатор проекта GCE | |
| service_account_email строка | электронная почта учетной записи службы | |
| state строка |
| list — единственный допустимый вариант. |
| topic строка | Имя темы GCP pubsub. Требуется только имя, а не полный путь. | |
| view строка |
| Допустимые значения — 'topics' или 'subscriptions' |
Примечания
Примечание
- Состояние list позволяет пользователю перечислять темы или подписки в проекте. Подробности см. в примерах.
Примеры
- name: List all Topics in a project
community.general.gcpubsub_info:
view: topics
state: list
- name: List all Subscriptions in a project
community.general.gcpubsub_info:
view: subscriptions
state: list
- name: List all Subscriptions for a Topic in a project
community.general.gcpubsub_info:
view: subscriptions
topic: my-topic
state: list
Возвращаемые значения
Общие возвращаемые значения описаны здесь, а следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| subscriptions список / элементы=строка | При view установлено в subscriptions. | Список подписок. Пример: ['mysubscription', 'mysubscription2'] |
| topic строка | Всегда | Имя темы. Используется для фильтрации подписок. Пример: mytopic |
| topics список / элементы=строка | При view установлено в topics. | Список тем. Пример: ['mytopic', 'mytopic2'] |
Авторы
- Tom Melendez (@supertom) <tom@supertom.com>
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/gcpubsub_facts_module.html