Модуль community.general.pubnub_blocks – модуль управления блоками PubNub

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.pubnub_blocks.

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет Ansible взаимодействовать с инфраструктурой PubNub BLOCKS и выполнять следующие операции: создавать и удалять блоки, запускать и останавливать их, переименовывать блоки, а также создавать, изменять и удалять обработчики событий.

Требования

Следующие требования должны быть выполнены на узле, на котором выполняется этот модуль.

pubnub_blocks_client >= 1.0

Параметры

Параметр	Комментарии
account string	Имя учетной записи PubNub, для которой используется `application` для управления блоками. Если значение не задано или пустое, используется учетная запись пользователя. По умолчанию: `""`
application string / обязательный	Имя целевого приложения PubNub, для которого на определенном `keyset` настраиваются блоки.
cache dictionary	Если в одном плейбуке модуль управления блоками используется несколько раз, рекомендуется включить «кэширование»: предыдущий запуск модуля должен передать собранные артефакты этому параметру. По умолчанию: `{}`
changes dictionary	Список полей, которые следует изменить у самого блока (не затрагивает обработчики событий). Возможные параметры для изменения: `name`. По умолчанию: `{}`
description string	Краткое описание блока, которое затем отображается на сайте https://admin.pubnub.com. Используется только при создании нового блока; описание существующего блока не изменяется.
email string	Адрес электронной почты учетной записи, для которой следует начать новый сеанс. Не требуется, если `cache` содержит результат предыдущего вызова модуля (в том же плейбуке). По умолчанию: `""`
event_handlers list / elements=dictionary	Список обработчиков событий, которые следует обновить для указанного блока `name`. Каждая запись нового обработчика событий должна содержать: `name`, `src`, `channels`, `event`. `name` используется как имя обработчика событий, по которому его можно будет найти для внесения изменений. `src` — полный путь к файлу с кодом обработчика событий. `channels` — имя канала, из которого обработчик событий получает события. `event` — тип события, которое может вызвать обработчик: `js-before-publish`, `js-after-publish`, `js-after-presence`. Каждая запись существующего обработчика должна содержать `name` (чтобы можно было определить целевой обработчик). Остальные параметры (`src`, `channels` и `event`) можно добавить, если требуется их изменить. Чтобы переименовать обработчик событий, добавьте ключ `changes` в данные обработчика и передайте словарь с единственным ключом `name`, которому следует присвоить новое имя. Чтобы удалить определенный обработчик событий, установите для него значение `state` в `absent`. По умолчанию: `[]`
keyset string / обязательный	Имя набора ключей приложения, связанного с управляемыми блоками.
name string / обязательный	Имя управляемого блока, которое затем отображается на admin.pubnub.com.
password string	Пароль учетной записи, которой принадлежит указанный `email`. Не требуется, если `cache` содержит результат предыдущего вызова модуля (в том же плейбуке). По умолчанию: `""`
state string	Требуемое состояние блока после завершения создания или обновления обработчиков событий. Варианты: `"started"` `"stopped"` `"present"` ← (по умолчанию) `"absent"`
validate_certs boolean	Этот параметр позволяет отключить проверку сертификатов при выполнении вызовов REST API. Иногда на узле возникают проблемы с сертификатами, что мешает вызывать REST API PubNub. Чтобы пропустить проверку, передайте этому параметру `false`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или возможных изменениях в `check_mode`).

Примеры

# Event handler create example.
- name: Create single event handler
  community.general.pubnub_blocks:
    email: '{{ email }}'
    password: '{{ password }}'
    application: '{{ app_name }}'
    keyset: '{{ keyset_name }}'
    name: '{{ block_name }}'
    event_handlers:
      - src: '{{ path_to_handler_source }}'
        name: '{{ handler_name }}'
        event: 'js-before-publish'
        channels: '{{ handler_channel }}'

# Change event handler trigger event type.
- name: Change event handler 'event'
  community.general.pubnub_blocks:
    email: '{{ email }}'
    password: '{{ password }}'
    application: '{{ app_name }}'
    keyset: '{{ keyset_name }}'
    name: '{{ block_name }}'
    event_handlers:
      - name: '{{ handler_name }}'
        event: 'js-after-publish'

# Stop block and event handlers.
- name: Stopping block
  community.general.pubnub_blocks:
    email: '{{ email }}'
    password: '{{ password }}'
    application: '{{ app_name }}'
    keyset: '{{ keyset_name }}'
    name: '{{ block_name }}'
    state: stop

# Multiple module calls with cached result passing
- name: Create '{{ block_name }}' block
  register: module_cache
  community.general.pubnub_blocks:
    email: '{{ email }}'
    password: '{{ password }}'
    application: '{{ app_name }}'
    keyset: '{{ keyset_name }}'
    name: '{{ block_name }}'
    state: present
- name: Add '{{ event_handler_1_name }}' handler to '{{ block_name }}'
  register: module_cache
  community.general.pubnub_blocks:
    cache: '{{ module_cache }}'
    application: '{{ app_name }}'
    keyset: '{{ keyset_name }}'
    name: '{{ block_name }}'
    state: present
    event_handlers:
      - src: '{{ path_to_handler_1_source }}'
        name: '{{ event_handler_1_name }}'
        channels: '{{ event_handler_1_channel }}'
        event: 'js-before-publish'
- name: Add '{{ event_handler_2_name }}' handler to '{{ block_name }}'
  register: module_cache
  community.general.pubnub_blocks:
    cache: '{{ module_cache }}'
    application: '{{ app_name }}'
    keyset: '{{ keyset_name }}'
    name: '{{ block_name }}'
    state: present
    event_handlers:
      - src: '{{ path_to_handler_2_source }}'
        name: '{{ event_handler_2_name }}'
        channels: '{{ event_handler_2_channel }}'
        event: 'js-before-publish'
- name: Start '{{ block_name }}' block
  register: module_cache
  community.general.pubnub_blocks:
    cache: '{{ module_cache }}'
    application: '{{ app_name }}'
    keyset: '{{ keyset_name }}'
    name: '{{ block_name }}'
    state: started

Возвращаемые значения

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

Ключ	Описание
module_cache dictionary	Кэшированные сведения об учетной записи. Если модуль используется несколько раз в одном плейбуке, для ускорения работы рекомендуется передавать кэшированные данные в последующие вызовы модуля. Возвращается: всегда

Ключ

Описание

module_cache

dictionary

Кэшированные сведения об учетной записи. Если модуль используется несколько раз в одном плейбуке, для ускорения работы рекомендуется передавать кэшированные данные в последующие вызовы модуля.

Возвращается: всегда

Авторы

PubNub (@pubnub)
Sergey Mamontov (@parfeon)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/pubnub_blocks_module.html