Модуль community.mongodb.mongodb_role — добавляет или удаляет роль из базы данных MongoDB

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.mongodb. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать модуль в сценарии, укажите: community.mongodb.mongodb_role.

Добавлено в community.mongodb 1.5.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

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

Добавляет или удаляет роль из базы данных MongoDB.
Дополнительные сведения о требуемом формате параметров privileges, authenticationRestriction и roles см. в документации MongoDB: https://www.mongodb.com/docs/manual/reference/command/createRole/

Требования

Следующие требования должны быть выполнены на узле, на котором выполняется этот модуль.

pymongo

Параметры

Параметр	Комментарии
atlas_auth boolean	Путь аутентификации, предназначенный для экземпляров MongoDB Atlas Варианты: `false` ← (по умолчанию) `true`
auth_mechanism string	Тип аутентификации. Варианты: `"SCRAM-SHA-256"` `"SCRAM-SHA-1"` `"MONGODB-X509"` `"GSSAPI"` `"PLAIN"`
authenticationRestrictions list / elements=any	Ограничения аутентификации, применяемые сервером к роли. Указывает список IP-адресов и диапазонов CIDR, с которых пользователям, получившим эту роль, разрешено подключаться и/или к которым им разрешено подключаться. Укажите список словарей со следующими полями: clientSource (список), serverAddress (список). Укажите пустой список, если поле использовать не нужно. По умолчанию: `[]`
connection_options list / elements=any	Дополнительные параметры подключения. Укажите список словарей или строк с парами «ключ-значение», разделёнными символом «=».
database псевдонимы: db string / обязательный	Имя базы данных, из которой нужно добавить или удалить роль.
debug boolean	Включить дополнительный вывод отладочной информации. Варианты: `false` ← (по умолчанию) `true`
login_database string	База данных, в которой хранятся учётные данные для входа. По умолчанию: `"admin"`
login_host string	Узел, на котором запущен экземпляр MongoDB, к которому выполняется подключение. По умолчанию: `"localhost"`
login_password string	Пароль для аутентификации. Обязательный параметр, если указан login_user.
login_port integer	Порт сервера MongoDB, к которому выполняется подключение. По умолчанию: `27017`
login_user string	Пользователь MongoDB для входа. Обязательный параметр, если указан login_password.
name псевдонимы: user string / обязательный	Имя роли, которую нужно добавить или удалить.
privileges list / elements=any	Привилегии, предоставляемые роли. Привилегия состоит из ресурса и разрешённых действий. По умолчанию: `[]`
replica_set string	Набор реплик для подключения (для записи автоматически подключается к первичному узлу).
roles list / elements=any	Роли пользователя базы данных нужно указать в виде словаря с ключами db и role. По умолчанию: `[]`
ssl псевдонимы: tls boolean	Использовать ли SSL-соединение при подключении к базе данных. Варианты: `false` ← (по умолчанию) `true`
ssl_ca_certs псевдонимы: tlsCAFile string	Параметр ssl_ca_certs принимает путь к файлу CA.
ssl_cert_reqs псевдонимы: tlsAllowInvalidCertificates string	Указывает, требуется ли сертификат от другой стороны соединения и следует ли проверять его, если он предоставлен. Варианты: `"CERT_NONE"` `"CERT_OPTIONAL"` `"CERT_REQUIRED"` ← (по умолчанию)
ssl_certfile псевдонимы: tlsCertificateKeyFile string	Предоставляет клиентский сертификат с помощью параметра ssl_certfile.
ssl_crlfile string	Параметр ssl_crlfile принимает путь к файлу CRL.
ssl_keyfile string	Закрытый ключ клиентского сертификата.
ssl_pem_passphrase псевдонимы: tlsCertificateKeyFilePassword string	Парольная фраза для расшифровки зашифрованных закрытых ключей.
state string	Состояние пользователя базы данных. Варианты: `"absent"` `"present"` ← (по умолчанию)
strict_compatibility boolean	Строго проверять требования к версиям pymongo и MongoDB Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

На удалённом узле требуется пакет Python pymongo версии 4 или новее. Его можно установить с помощью pip или диспетчера пакетов ОС. Для более новых версий сервера MongoDB требуются более новые версии pymongo. См. https://www.mongodb.com/docs/languages/python/pymongo-driver/current/compatibility/

Примеры

- name: Create sales role
  community.mongodb.mongodb_role:
    name: sales
    database: salesdb
    privileges:
      - resource:
          db: salesdb
          collection: ""
        actions:
          - find
    state: present

- name: Create ClusterAdmin Role
  community.mongodb.mongodb_role:
    name: myClusterwideAdmin
    database: admin
    privileges:
      - resource:
          cluster: true
        actions:
          - addShard
      - resource:
          db: config
          collection: ""
        actions:
          - find
          - update
          - insert
          - remove
      - resource:
          db: "users"
          collection: "usersCollection"
        actions:
          - update
          - insert
          - remove
      - resource:
          db: ""
          collection: ""
        actions:
          - find
    roles:
      - role: "read"
        db: "admin"
    state: present

- name: Create ClusterAdmin Role with a login only from 127.0.0.1 restriction
  community.mongodb.mongodb_role:
    name: myClusterwideAdmin
    database: admin
    privileges:
      - resource:
          cluster: true
        actions:
          - addShard
      - resource:
          db: config
          collection: ""
        actions:
          - find
          - update
          - insert
      - resource:
          db: "users"
          collection: "usersCollection"
        actions:
          - update
          - insert
          - remove
      - resource:
          db: ""
          collection: ""
        actions:
          - find
    roles:
      - role: "read"
        db: "admin"
      - role: "read"
        db: "mynewdb"
    authenticationRestrictions:
      - clientSource:
          - "127.0.0.1"
        serverAddress: []
    state: present

- name: Delete sales role
  community.mongodb.mongodb_role:
    name: sales
    database: "salesdb"
    state: absent

- name: Delete myClusterwideAdmin role
  community.mongodb.mongodb_role:
    name: myClusterwideAdmin
    database: admin
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
user string	Имя роли, которую нужно добавить или удалить. Возвращается: при успешном выполнении

Авторы

Rhys Campbell (@rhysmeister)

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

© 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/mongodb/mongodb_role_module.html