mongodb_user - Добавляет или удаляет пользователя из базы данных MongoDB.
Описание
- Добавляет или удаляет пользователя из базы данных MongoDB.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- pymongo
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| database обязательно | Имя базы данных, из которой добавляется/удаляется пользователь | |
| login_database (добавлен в 2.0) | База данных, где хранятся учетные данные для входа | |
| login_host | По умолчанию: "localhost" | Хост, на котором работает база данных |
| login_password | Пароль для аутентификации | |
| login_port | По умолчанию: 27017 | Порт для подключения |
| login_user | Имя пользователя для аутентификации | |
| name обязательно | Имя пользователя для добавления или удаления псевдонимы: user | |
| password | Пароль для пользователя | |
| replica_set (добавлен в 1.6) | Репликация набора для подключения (автоматически подключается к первичному для записи) | |
| roles (добавлен в 1.3) | По умолчанию: "readWrite" | Роли пользователя базы данных, допустимые значения могут быть одним или несколькими из следующих строк: 'read', 'readWrite', 'dbAdmin', 'userAdmin', 'clusterAdmin', 'readAnyDatabase', 'readWriteAnyDatabase', 'userAdminAnyDatabase', 'dbAdminAnyDatabase' Или следующий словарь '{ db: ИМЯ_БАЗЫ_ДАННЫХ, role: ИМЯ_РОЛИ }'. Этот параметр требует pymongo 2.5+. Если это строка, также требуется mongodb 2.4+. Если это словарь, требуется mongo 2.6+. |
| ssl (добавлен в 1.8) | Использовать ли SSL-соединение при подключении к базе данных | |
| ssl_cert_reqs (добавлен в 2.2) |
| Указывает, требуется ли сертификат от другой стороны соединения и будет ли он проверен, если предоставлен. |
| state |
| Состояние пользователя базы данных |
| update_password (добавлен в 2.1) |
| always будет обновлять пароли, если они отличаются. on_create будет устанавливать пароль только для вновь созданных пользователей. |
Примечания
Примечание
- Требуется пакет pymongo Python на удаленном хосте, версия 2.4.2+. Его можно установить с помощью pip или менеджера пакетов ОС. @см http://api.mongodb.org/python/current/installation.html
Примеры
# Create 'burgers' database user with name 'bob' and password '12345'.
- mongodb_user:
database: burgers
name: bob
password: 12345
state: present
# Create a database user via SSL (MongoDB must be compiled with the SSL option and configured properly)
- mongodb_user:
database: burgers
name: bob
password: 12345
state: present
ssl: True
# Delete 'burgers' database user with name 'bob'.
- mongodb_user:
database: burgers
name: bob
state: absent
# Define more users with various specific roles (if not defined, no roles is assigned, and the user will be added via pre mongo 2.2 style)
- mongodb_user:
database: burgers
name: ben
password: 12345
roles: read
state: present
- mongodb_user:
database: burgers
name: jim
password: 12345
roles: readWrite,dbAdmin,userAdmin
state: present
- mongodb_user:
database: burgers
name: joe
password: 12345
roles: readWriteAnyDatabase
state: present
# add a user to database in a replica set, the primary server is automatically discovered and written to
- mongodb_user:
database: burgers
name: bob
replica_set: belcher
password: 12345
roles: readWriteAnyDatabase
state: present
# add a user 'oplog_reader' with read only access to the 'local' database on the replica_set 'belcher'. This is useful for oplog access (MONGO_OPLOG_URL).
# please notice the credentials must be added to the 'admin' database because the 'local' database is not syncronized and can't receive user credentials
# To login with such user, the connection string should be MONGO_OPLOG_URL="mongodb://oplog_reader:oplog_reader_password@server1,server2/local?authSource=admin"
# This syntax requires mongodb 2.6+ and pymongo 2.5+
- mongodb_user:
login_user: root
login_password: root_password
database: admin
user: oplog_reader
password: oplog_reader_password
state: present
replica_set: belcher
roles:
- db: local
role: read
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращено | Описание |
|---|---|---|
| user строка | успех | Имя пользователя для добавления или удаления. |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- Elliott Foster (@elliotttf)
- Julien Thebault (@lujeni)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/mongodb_user_module.html