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: DATABASE_NAME, role: ROLE_NAME }'. Этот параметр требует pymongo 2.5+. Если это строка, требуется mongodb 2.4+. Если это словарь, требуется mongo 2.6+. | |
| ssl (добавлен в 1.8)
| нет | Использовать ли SSL-соединение при подключении к базе данных | ||
| ssl_cert_reqs (добавлен в 2.2)
| нет | CERT_REQUIRED |
| Указывает, требуется ли сертификат с другой стороны соединения и будет ли он валидироваться при предоставлении. |
| state | нет | present |
| Состояние пользователя базы данных |
| update_password (добавлен в 2.1)
| нет | always |
| always будет обновлять пароли, если они отличаются. on_create будет устанавливать пароль только для вновь созданных пользователей. |
Примеры
# 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 | Имя пользователя для добавления или удаления. | успешно | строка |
Примечания
Примечание
- Требуется пакет pymongo Python на удалённом хосте, версия 2.4.2+. Его можно установить с помощью pip или менеджера пакетов ОС. @см http://api.mongodb.org/python/current/installation.html
Статус
Этот модуль помечен как предварительный просмотр, что означает, что он не гарантирует обратную совместимость интерфейса.
Для получения помощи в разработке модулей, если вы этого захотите, пожалуйста, ознакомьтесь с Справочной информацией сообщества и вкладом, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/mongodb_user_module.html