Docs4dev
Docs
ansible / latest / collections / community / rabbitmq / rabbitmq_user_limits_module.html

community.rabbitmq.rabbitmq_user_limits – Manage RabbitMQ user limits

Note

This plugin is part of the community.rabbitmq collection (version 1.1.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.rabbitmq.

To use it in a playbook, specify: community.rabbitmq.rabbitmq_user_limits.

New in version 1.1.0: of community.rabbitmq

Synopsis

  • Manage the state of user limits in RabbitMQ. Supported since RabbitMQ version 3.8.10.

Parameters

Parameter Choices/Defaults Comments
max_channels
integer
Default:
-1
Max number of channels.
Negative value means "no limit".
Ignored when the state is absent.
max_connections
integer
Default:
-1
Max number of concurrent client connections.
Negative value means "no limit".
Ignored when the state is absent.
node
string
Name of the RabbitMQ Erlang node to manage.
state
string
    Choices:
  • present ←
  • absent
Specify whether the limits are to be set or cleared.
If set to absent, the limits of both max_connections and max_channels will be cleared.
user
string / required
Name of user to manage limits for.

aliases: username, name

Notes

Note

  • Supports check_mode.

Examples

- name: Limit both of the max number of connections and channels on the user 'guest'.
  community.rabbitmq.rabbitmq_user_limits:
    user: guest
    max_connections: 64
    max_channels: 256
    state: present

# This task implicitly clears the max number of channels limit using default value: -1.
- name: Limit the max number of connections on the user 'guest'.
  community.rabbitmq.rabbitmq_user_limits:
    user: guest
    max_connections: 64
    state: present

- name: Clear the limits on the user 'guest'.
  community.rabbitmq.rabbitmq_user_limits:
    user: guest
    state: absent

Authors

  • Aitor Pazos (@aitorpazos)

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