community.rabbitmq.rabbitmq_queue модуль — Управление очередями rabbitMQ

Примечание

Этот модуль входит в состав коллекции community.rabbitmq (версия 1.3.0).

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

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

Для использования в плейбуке укажите: community.rabbitmq.rabbitmq_queue.

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

Описание

Этот модуль использует API rabbitMQ Rest для создания/удаления очередей.
Из-за ограничений API он не может изменять существующие очереди.

Требования

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

requests >= 1.0.0

Параметры

Параметр	Комментарии
arguments словарь	дополнительные аргументы для очереди. Если определён, этот аргумент представляет собой словарь ключ/значение Аргументы здесь имеют приоритет над параметрами. Если оба определены, будет использован аргумент. По умолчанию: `{}`
auto_delete булево	должна ли очередь удалиться после того, как все очереди/очереди отвязаны от неё. Варианты: `false` ← (по умолчанию) `true`
auto_expires целое число	Сколько времени очередь может быть неиспользуемой, прежде чем будет автоматически удалена (миллисекунды).
ca_cert алиасы: cacert путь	Сертификат CA для проверки SSL-соединения с API управления.
client_cert алиасы: cert путь	Клиентский сертификат для отправки по SSL-соединениям с API управления.
client_key алиасы: key путь	Приватный ключ, соответствующий клиентскому сертификату.
dead_letter_exchange строка	Необязательное имя очереди обмена, в которую сообщения будут повторно опубликованы, если они будут отклонены или истекут.
dead_letter_routing_key строка	Необязательный заменитель маршрутного ключа, используемого при перенаправлении сообщения. Оригинальный маршрутный ключ будет использован, если не указан.
durable булево	является ли очередь долговременной. Варианты: `false` `true` ← (по умолчанию)
login_host строка	Хост RabbitMQ для подключения. По умолчанию: `"localhost"`
login_password строка	Пароль RabbitMQ для подключения. По умолчанию: `"guest"`
login_port строка	Порт RabbitMQ API управления. По умолчанию: `"15672"`
login_protocol строка	Протокол RabbitMQ API управления. Варианты: `"http"` ← (по умолчанию) `"https"`
login_user строка	Пользователь RabbitMQ для подключения. По умолчанию: `"guest"`
max_length целое число	Сколько сообщений может содержать очередь, прежде чем начать отклонять.
max_priority целое число	Максимальное количество уровней приоритета, которые может поддерживать очередь. Если не задано, очередь не будет поддерживать приоритеты сообщений. Более высокие числа указывают на более высокий приоритет.
message_ttl целое число	Сколько времени сообщение может существовать в очереди, прежде чем будет удалено (миллисекунды).
name строка / обязательно	Имя очереди.
state строка	Следует ли наличие очереди присутствовать или отсутствовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
vhost строка	Виртуальный хост RabbitMQ. По умолчанию: `"/"`

Примеры

- name: Create a queue
  community.rabbitmq.rabbitmq_queue:
    name: myQueue

- name: Create a queue on remote host
  community.rabbitmq.rabbitmq_queue:
    name: myRemoteQueue
    login_user: user
    login_password: secret
    login_host: remote.example.org

# You may specify different types of queues using the arguments parameter.
- name: Create RabbitMQ stream
  become: yes
  community.rabbitmq.rabbitmq_queue:
    name: test-x
    arguments:
      x-queue-type: stream
      x-max-age: 24h

Авторы

Manuel Sousa (@manuel-sousa)

Ссылки на сборку

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