Spec-Zone.ru › Ansible 2.9

rabbitmq_publish – Опубликовать сообщение в очередь RabbitMQ

Новое в версии 2.8.

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

Описание

  • Опубликовать сообщение в очередь RabbitMQ с использованием блокирующего подключения.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • pika

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
auto_delete
boolean
    Варианты:
  • нет ←
  • да
Установить автоудаление очереди.
body
-
Тело сообщения.
Значение body не может быть предоставлено, если указано src.
content_type
-
По умолчанию:
"text/plain"
Тип содержимого тела.
durable
boolean
    Варианты:
  • нет ←
  • да
Установить устойчивость очереди.
exchange
-
Обмен, в который публикуется сообщение.
exclusive
boolean
    Варианты:
  • нет ←
  • да
Установить эксклюзивность очереди.
headers
dictionary
По умолчанию:
{}
Словарь заголовков, которые нужно отправить вместе с сообщением.
host
-
Имя хоста или IP-адрес сервера RabbitMQ.
password
-
Пароль RabbitMQ.
port
-
Порт сервера RabbitMQ.
proto
-
    Варианты:
  • amqps
  • amqp
Протокол для использования.
queue
-
Очередь, в которую публикуется сообщение. Если очередь не указана, RabbitMQ вернет случайное имя очереди.
routing_key
-
Ключ маршрутизации.
src
-
Файл для загрузки в очередь. Если content_type не определен (оставлен по умолчанию), используется автоматическое определение типа MIME.
Значение src не может быть предоставлено, если указано body.
Имя файла добавляется в заголовки отправляемого сообщения в RabbitMQ. Ключ - filename, значение - имя файла.

псевдонимы: файл
url
-
Строка подключения URL для подключения к серверу RabbitMQ.
url и host/port/user/pass/vhost взаимоисключающие, используйте либо то, либо другое, но не оба.
username
-
Имя пользователя RabbitMQ.
vhost
-
Виртуальный хост для целевого объекта.
Если требуется виртуальный хост по умолчанию, используйте '%2F'.

Примечания

Примечание

  • Этот модуль требует библиотеки pika для Python https://pika.readthedocs.io/.
  • Pika — это чисто Python-реализация протокола AMQP 0-9-1, которая старается быть довольно независимой от библиотеки поддержки базовой сети.
  • Этот плагин протестирован с RabbitMQ. Другие серверы, основанные на протоколе AMQP 0.9.1, могут работать, но не тестировались/не гарантируются.

Примеры

- name: Publish a message to a queue with headers
  rabbitmq_publish:
    url: "amqp://guest:guest@192.168.0.32:5672/%2F"
    queue: 'test'
    body: "Hello world from ansible module rabbitmq_publish"
    content_type: "text/plain"
    headers:
      myHeader: myHeaderValue


- name: Publish a file to a queue
  rabbitmq_publish:
    url: "amqp://guest:guest@192.168.0.32:5672/%2F"
    queue: 'images'
    file: 'path/to/logo.gif'

- name: RabbitMQ auto generated queue
  rabbitmq_publish:
    url: "amqp://guest:guest@192.168.0.32:5672/%2F"
    body: "Hello world random queue from ansible module rabbitmq_publish"
    content_type: "text/plain"

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

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

Ключ Возвращаемое значение Описание
result
dictionary
success
Содержит статус msg, тип содержимого content_type и имя очереди queue.

Пример:
'result': { 'content_type': 'text/plain', 'msg': 'Успешно опубликовано в очередь test', 'queue': 'test' }


Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

  • John Imison (@Im0)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/rabbitmq_publish_module.html

Spec-Zone.ru

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