community.rabbitmq.rabbitmq_vhost_limits – Manage the state of virtual host limits in RabbitMQ
Note
This plugin is part of the community.rabbitmq collection (version 1.0.1).
To install it use: ansible-galaxy collection install community.rabbitmq.
To use it in a playbook, specify: community.rabbitmq.rabbitmq_vhost_limits.
Synopsis
- This module sets/clears certain limits on a virtual host.
- The configurable limits are max_connections and max-queues.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| max_connections
integer
|
Default:
-1
|
Max number of concurrent client connections.
Negative value means "no limit".
Ignored when the state is absent.
|
| max_queues
integer
|
Default:
-1
|
Max number of queues.
Negative value means "no limit".
Ignored when the state is absent.
|
| node
string
|
Name of the RabbitMQ Erlang node to manage.
|
|
| state
string
|
|
Specify whether the limits are to be set or cleared.
If set to absent, the limits of both max_connections and max-queues will be cleared.
|
| vhost
string
|
Default:
"/"
|
Name of the virtual host to manage.
|
Examples
# Limit both of the max number of connections and queues on the vhost '/'.
- community.rabbitmq.rabbitmq_vhost_limits:
vhost: /
max_connections: 64
max_queues: 256
state: present
# Limit the max number of connections on the vhost '/'.
# This task implicitly clears the max number of queues limit using default value: -1.
- community.rabbitmq.rabbitmq_vhost_limits:
vhost: /
max_connections: 64
state: present
# Clear the limits on the vhost '/'.
- community.rabbitmq.rabbitmq_vhost_limits:
vhost: /
state: absent
Authors
- Hiroyuki Matsuo (@h-matsuo)
© 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/rabbitmq/rabbitmq_vhost_limits_module.html