mongodb_user – Добавляет или удаляет пользователя из базы данных MongoDB
Описание
- Добавляет или удаляет пользователя из базы данных MongoDB.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- pymongo
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| database - / обязательно | Имя базы данных, для которой необходимо добавить/удалить пользователя | |
| login_database - | База данных, в которой хранятся учетные данные для входа | |
| login_host - | По умолчанию: "localhost" | Хост, на котором работает база данных |
| login_password - | Пароль, используемый для аутентификации | |
| login_port - | По умолчанию: 27017 | Порт для подключения |
| login_user - | Имя пользователя, используемое для аутентификации | |
| name - / обязательно | Имя пользователя для добавления или удаления псевдонимы: user | |
| password - | Пароль для пользователя | |
| replica_set - | Реплицируемый набор для подключения (автоматически подключается к первичному для записи) | |
| roles - | Роли пользователя базы данных. Допустимые значения: 'read', 'readWrite', 'dbAdmin', 'userAdmin', 'clusterAdmin', 'readAnyDatabase', 'readWriteAnyDatabase', 'userAdminAnyDatabase', 'dbAdminAnyDatabase' Или словарь '{ db: ИМЯ_БАЗЫ_ДАННЫХ, role: ИМЯ_РОЛИ }'. Этот параметр требует pymongo 2.5+. Если это строка, то также требуется mongodb 2.4+. Если это словарь, то требуется mongo 2.6+. | |
| ssl boolean |
| Использовать ли SSL-соединение при подключении к базе данных |
| ssl_cert_reqs - |
| Указывает, требуется ли сертификат от другой стороны соединения и будет ли он валидирован при его предоставлении. |
| state - |
| Состояние пользователя базы данных |
| update_password - |
| 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 synchronized 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. [сообщество]
Авторы
- 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.9/modules/mongodb_user_module.html