Documentation

rabbitmq_user - Adds or removes users to RabbitMQ

Synopsis

  • Add or remove users to RabbitMQ and assign permissions

Options

parameter required default choices comments
configure_priv
no ^$
    Regular expression to restrict configure actions on a resource for the specified vhost.
    By default all actions are restricted.
    This option will be ignored when permissions option is used.
    force
    no no
    • yes
    • no
    Deletes and recreates the user.
    node
    no rabbit
      erlang node name of the rabbit we wish to configure
      password
      no
        Password of user to add.
        To change the password of an existing user, you must also specify force=yes.
        permissions
        no
          a list of dicts, each dict contains vhost, configure_priv, write_priv, and read_priv, and represents a permission rule for that vhost.
          This option should be preferable when you care about all permissions of the user.
          You should use vhost, configure_priv, write_priv, and read_priv options instead if you care about permissions for just some vhosts.
          read_priv
          no ^$
            Regular expression to restrict configure actions on a resource for the specified vhost.
            By default all actions are restricted.
            This option will be ignored when permissions option is used.
            state
            no present
            • present
            • absent
            Specify if user is to be added or removed
            tags
            no
              User tags specified as comma delimited
              user
              yes
                Name of user to add

                aliases: username, name
                vhost
                no /
                  vhost to apply access privileges.
                  This option will be ignored when permissions option is used.
                  write_priv
                  no ^$
                    Regular expression to restrict configure actions on a resource for the specified vhost.
                    By default all actions are restricted.
                    This option will be ignored when permissions option is used.

                    Examples

                    # Add user to server and assign full access control on / vhost.
                    # The user might have permission rules for other vhost but you don't care.
                    - rabbitmq_user:
                        user: joe
                        password: changeme
                        vhost: /
                        configure_priv: .*
                        read_priv: .*
                        write_priv: .*
                        state: present
                    
                    # Add user to server and assign full access control on / vhost.
                    # The user doesn't have permission rules for other vhosts
                    - rabbitmq_user:
                        user: joe
                        password: changeme
                        permissions:
                          - vhost: /
                            configure_priv: .*
                            read_priv: .*
                            write_priv: .*
                        state: present
                    

                    Status

                    This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

                    Support

                    This module is community maintained without core committer oversight.

                    For more information on what this means please read Module Support

                    For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.