PARALLAX

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

NameTypeRequiredDefaultDescription
userstringyesName of the RabbitMQ user
passwordstringPassword for the user
tagsstringComma-separated list of tags for the user
vhoststring/Vhost to apply permissions to
statestringpresentState of the user Choices: present, absent
configure_privstring^$Regular expression for configure permission
write_privstring^$Regular expression for write permission
read_privstring^$Regular expression for read permission
nodestringErlang node name of the rabbit we wish to configure
forceboolfalseForce user update
update_passwordstringon_createPassword policy: on_create or always
permissionslistComplete list of vhost permissions
topic_permissionslistComplete list of topic permissions
login_hoststringManagement API host; omit to use rabbitmqctl
login_portstring15672Management API port
login_protocolstringhttpManagement API protocol
login_userstringManagement API username
login_passwordstringManagement 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
Search
    ↑ ↓ move↵ openesc close