rabbitmq_user
Manage RabbitMQ users, tags and permissions
Collection: community.rabbitmq
Full Name: parallax.community.general.rabbitmq_user
Aliases: community.general.rabbitmq_user, rabbitmq_user, community.rabbitmq.rabbitmq_user
Synopsis
Manage RabbitMQ users, tags and permissions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| user | string | yes | Name of the RabbitMQ user | |
| password | string | Password for the user | ||
| tags | string | Comma-separated list of tags for the user | ||
| vhost | string | / | Vhost to apply permissions to | |
| state | string | present | State of the user Choices: present, absent | |
| configure_priv | string | ^$ | Regular expression for configure permission | |
| write_priv | string | ^$ | Regular expression for write permission | |
| read_priv | string | ^$ | Regular expression for read permission | |
| node | string | Erlang node name of the rabbit we wish to configure | ||
| force | bool | false | Force user update | |
| update_password | string | on_create | Password policy: on_create or always | |
| permissions | list | Complete list of vhost permissions | ||
| topic_permissions | list | Complete list of topic permissions | ||
| login_host | string | Management API host; omit to use rabbitmqctl | ||
| login_port | string | 15672 | Management API port | |
| login_protocol | string | http | Management API protocol | |
| login_user | string | Management API username | ||
| login_password | string | Management API password |
Example
yaml
- name: Create a RabbitMQ user scoped to one vhost
rabbitmq_user:
user: app
password: "{{ rabbit_app_password }}"
vhost: /app
configure_priv: .*
read_priv: .*
write_priv: .*
state: present