Модуль community.rabbitmq.rabbitmq_queue — управление очередями RabbitMQ
Примечание
Этот модуль входит в коллекцию community.rabbitmq (версия 1.6.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.rabbitmq. Для использования этого модуля необходимы дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: community.rabbitmq.rabbitmq_queue.
Краткое описание
- Этот модуль использует REST API RabbitMQ для создания и удаления очередей.
- Из-за ограничений API модуль не может изменять существующие очереди.
Требования
Следующие требования должны быть выполнены на хосте, на котором выполняется этот модуль.
- requests >= 1.0.0
Параметры
Параметр | Комментарии |
|---|---|
arguments dictionary | Дополнительные аргументы для очереди. Если задан, этот аргумент представляет собой словарь пар «ключ/значение». Аргументы, указанные здесь, имеют приоритет над параметрами. Если заданы оба варианта, будет использован аргумент. По умолчанию: |
auto_delete boolean | Следует ли удалять очередь автоматически после того, как все очереди/очереди будут отвязаны от неё. Варианты:
|
auto_expires integer | Как долго очередь может оставаться неиспользуемой до автоматического удаления (миллисекунды). |
ca_cert псевдонимы: cacert path | Сертификат центра сертификации для проверки SSL-соединения с API управления. |
client_cert псевдонимы: cert path | Клиентский сертификат для отправки при SSL-подключении к API управления. |
client_key псевдонимы: key path | Закрытый ключ, соответствующий клиентскому сертификату. |
dead_letter_exchange string | Необязательное имя exchange, в который будут повторно опубликованы сообщения, если они отклонены или срок их действия истёк. |
dead_letter_routing_key string | Необязательный ключ маршрутизации, который будет использоваться для сообщения, помещаемого в очередь недоставленных сообщений. Если не задан, будет использоваться исходный ключ маршрутизации. |
durable boolean | Является ли очередь устойчивой. Варианты:
|
login_host string | Хост RabbitMQ для подключения. По умолчанию: |
login_password string | Пароль RabbitMQ для подключения. По умолчанию: |
login_port string | Порт API управления RabbitMQ. По умолчанию: |
login_protocol string | Протокол API управления RabbitMQ. Варианты:
|
login_user string | Пользователь RabbitMQ для подключения. По умолчанию: |
max_length integer | Количество сообщений, которое может содержать очередь до того, как начнёт отклонять новые сообщения. |
max_priority integer | Максимальное количество уровней приоритета, поддерживаемых очередью. Если не задано, очередь не будет поддерживать приоритеты сообщений. Чем больше значение, тем выше приоритет. |
message_ttl integer | Как долго сообщение может находиться в очереди до удаления (миллисекунды). |
name string / обязательный | Имя очереди. |
state string | Должна ли очередь существовать или отсутствовать. Варианты:
|
vhost string | Виртуальный хост 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
Ссылки на коллекцию
© 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/rabbitmq/rabbitmq_queue_module.html
