Spec-Zone.ru › Ansible 2.10

community.google.gcpubsub_info – Список тем/подписок и сообщений из Google PubSub.

Примечание

Этот плагин входит в коллекцию community.google (версия 1.0.0).

Для установки используйте: ansible-galaxy collection install community.google.

Чтобы использовать его в плейбуке, укажите: community.google.gcpubsub_info.

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата

Описание

  • Список тем/подписок из 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
строка
ID вашего проекта GCE
service_account_email
строка
электронный адрес учетной записи сервиса
state
строка
    Варианты:
  • list ←
list — единственный допустимый вариант.
topic
строка
Имя темы GCP pubsub. Требуется только имя, а не полный путь.
view
строка
    Варианты:
  • topics ←
  • subscriptions
Варианты — 'topics' или 'subscriptions'

Примечания

Примечание

  • Состояние list позволяет пользователю перечислять темы или подписки в проекте. Подробности см. в примерах.

Примеры

- 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

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:

Ключ Возвращаемое значение Описание
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/google/gcpubsub_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API