Модуль community.rabbitmq.rabbitmq_user — управление пользователями RabbitMQ

Примечание

Этот модуль входит в коллекцию community.rabbitmq (версия 1.6.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.rabbitmq.

Чтобы использовать её в плейбуке, укажите: community.rabbitmq.rabbitmq_user.

Краткое описание
Параметры
Примеры

Краткое описание

Добавление и удаление пользователей RabbitMQ, а также назначение разрешений

Параметры

Параметр	Комментарии
configure_priv string	Регулярное выражение для ограничения действий настройки ресурса в указанном vhost. По умолчанию ограничиваются все действия. Этот параметр игнорируется, если используется параметр permissions. По умолчанию: `"^$"`
force boolean	Удаляет пользователя и создаёт его заново. Варианты: `false` ← (по умолчанию) `true`
login_host string добавлен в community.rabbitmq 1.3.0	Имя хоста API.
login_password string добавлен в community.rabbitmq 1.3.0	Пароль для входа в API управления.
login_port string добавлен в community.rabbitmq 1.3.0	Порт для доступа к API. По умолчанию: `"15672"`
login_protocol string добавлен в community.rabbitmq 1.3.0	Укажите, какой протокол TCP/IP будет использоваться. Варианты: `"http"` ← (по умолчанию) `"https"`
login_user string добавлен в community.rabbitmq 1.3.0	Имя пользователя администратора для API управления.
node string	Имя узла Erlang настраиваемого экземпляра RabbitMQ По умолчанию: `"rabbit"`
password string	Пароль добавляемого пользователя. Чтобы изменить пароль существующего пользователя, необходимо также указать `update_password=always`.
permissions list / elements=dictionary	Список словарей, каждый из которых содержит vhost, configure_priv, write_priv и read_priv и задаёт правило разрешений для этого vhost. Этот параметр предпочтительнее, если необходимо задать все разрешения пользователя. Если вас интересуют разрешения только для некоторых vhost, используйте вместо этого параметры vhost, configure_priv, write_priv и read_priv. По умолчанию: `[]`
read_priv string	Регулярное выражение для ограничения действий настройки ресурса в указанном vhost. По умолчанию ограничиваются все действия. Этот параметр игнорируется, если используется параметр permissions. По умолчанию: `"^$"`
state string	Укажите, нужно ли добавить или удалить пользователя Варианты: `"present"` ← (по умолчанию) `"absent"`
tags string	Теги пользователя, перечисленные через запятую. Рекомендуется использовать теги management, policymaker, monitoring и administrator.
topic_permissions list / elements=dictionary добавлен в community.rabbitmq 1.2.0	Список словарей, каждый из которых содержит vhost, exchange, read_priv и write_priv и задаёт правило разрешений для тем в этом vhost. По умолчанию vhost равен `/`, а exchange — `amq.topic`. Поддерживается начиная с RabbitMQ 3.7.0. Если версия RabbitMQ ниже, а topic_permissions заданы, выполнение модуля завершится ошибкой. По умолчанию: `[]`
update_password string	`on_create` задаёт пароль только для новых пользователей. `always` обновляет пароль, если он отличается. Варианты: `"on_create"` ← (по умолчанию) `"always"`
user aliases: username, name string / обязательный	Имя добавляемого пользователя
vhost string	vhost, для которого применяются права доступа. Этот параметр игнорируется, если используется параметр permissions. По умолчанию: `"/"`
write_priv string	Регулярное выражение для ограничения действий настройки ресурса в указанном vhost. По умолчанию ограничиваются все действия. Этот параметр игнорируется, если используется параметр permissions. По умолчанию: `"^$"`

Примеры

- name: |-
    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.
  community.rabbitmq.rabbitmq_user:
    user: joe
    password: changeme
    vhost: /
    configure_priv: .*
    read_priv: .*
    write_priv: .*
    state: present

- name: |-
    Add user to server and assign full access control on / vhost.
    The user doesn't have permission rules for other vhosts
  community.rabbitmq.rabbitmq_user:
    user: joe
    password: changeme
    permissions:
      - vhost: /
        configure_priv: .*
        read_priv: .*
        write_priv: .*
    state: present

- name: |-
    Add user to server and assign some topic permissions on / vhost.
    The user doesn't have topic permission rules for other vhosts
  community.rabbitmq.rabbitmq_user:
    user: joe
    password: changeme
    topic_permissions:
      - vhost: /
        exchange: amq.topic
        read_priv: .*
        write_priv: 'prod\\.logging\\..*'
    state: present

- name: Add or Update a user using the API
  community.rabbitmq.rabbitmq_user:
    user: joe
    password: changeme
    tags: monitoring
    login_protocol: https
    login_host: localhost
    login_port: 15672
    login_user: admin
    login_password: changeadmin
    permissions:
          - vhost: /
            configure_priv: .*
            read_priv: .*
            write_priv: .*
    topic_permissions:
      - vhost: /
        exchange: amq.topic
        read_priv: .*
        write_priv: 'prod\\.logging\\..*'
    state: present


- name: Remove a user using the API
  community.rabbitmq.rabbitmq_user:
    user: joe
    password: changeme
    tags: monitoring
    login_protocol: https
    login_host: localhost
    login_port: 15672
    login_user: admin
    login_password: changeadmin
    state: absent

Авторы

Chris Hoffman (@chrishoffman)

Ссылки на коллекцию

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