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

Примечание

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

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

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

Для использования в playbook укажите: community.rabbitmq.rabbitmq_user.

Обзор
Параметры
Примеры

Обзор

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

Параметры

Параметр	Комментарии
configure_priv строка	Регулярное выражение для ограничения действий configure на ресурсе для указанного vhost. По умолчанию все действия ограничены. Этот параметр будет проигнорирован, если используется параметр permissions. По умолчанию: `"^$"`
force логическое	Удаляет и создаёт пользователя заново. Варианты: `false` ← (по умолчанию) `true`
login_host строка добавлено в community.rabbitmq 1.3.0	Имя хоста API.
login_password строка добавлено в community.rabbitmq 1.3.0	Пароль входа в API управления.
login_port строка добавлено в community.rabbitmq 1.3.0	login_port для доступа через API. По умолчанию: `"15672"`
login_protocol строка добавлено в community.rabbitmq 1.3.0	Указывает, какой протокол TCP/IP будет использоваться. Варианты: `"http"` ← (по умолчанию) `"https"`
login_user строка добавлено в community.rabbitmq 1.3.0	Имя пользователя администратора API управления.
node строка	Имя узла erlang rabbit, который мы хотим настроить. По умолчанию: `"rabbit"`
password строка	Пароль добавляемого пользователя. Чтобы изменить пароль существующего пользователя, необходимо также указать `update_password=always`
permissions список / элементы=словарь	список словарей, каждый словарь содержит vhost, configure_priv, write_priv и read_priv, и представляет правило разрешений для данного vhost. Этот параметр следует предпочесть, если вы хотите учитывать все разрешения пользователя. Следует использовать параметры vhost, configure_priv, write_priv и read_priv, если вам нужны разрешения только для некоторых vhost. По умолчанию: `[]`
read_priv строка	Регулярное выражение для ограничения действий configure на ресурсе для указанного vhost. По умолчанию все действия ограничены. Этот параметр будет проигнорирован, если используется параметр permissions. По умолчанию: `"^$"`
state строка	Указывает, нужно ли добавить или удалить пользователя. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags строка	Теги пользователя, указанные через запятую. Рекомендуемые теги: management, policymaker, monitoring и administrator.
topic_permissions список / элементы=словарь добавлено в 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 строка	`on_create` будет устанавливать пароль только для вновь созданных пользователей. `always` будет обновлять пароли, если они отличаются. Варианты: `"on_create"` ← (по умолчанию) `"always"`
user псевдонимы: username, name строка / обязательно	Имя добавляемого пользователя
vhost строка	vhost для применения прав доступа. Этот параметр будет проигнорирован, если используется параметр permissions. По умолчанию: `"/"`
write_priv строка	Регулярное выражение для ограничения действий configure на ресурсе для указанного vhost. По умолчанию все действия ограничены. Этот параметр будет проигнорирован, если используется параметр permissions. По умолчанию: `"^$"`

END_OF_DOCUMENT_MARKER

Примеры

- 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/rabbitmq/rabbitmq_user_module.html