Модуль community.mongodb.mongodb_parameter — изменение административного параметра на сервере MongoDB
Примечание
Этот модуль входит в коллекцию community.mongodb (версия 1.7.12).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install community.mongodb. Для использования этого модуля потребуются дополнительные компоненты. Подробнее см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: community.mongodb.mongodb_parameter.
Добавлено в community.mongodb 1.0.0
Краткое описание
- Изменение административного параметра на сервере MongoDB.
Требования
Следующие требования необходимы на узле, который выполняет этот модуль.
- pymongo
Параметры
Параметр | Комментарии |
|---|---|
atlas_auth логическое значение | Способ аутентификации, предназначенный для экземпляров MongoDB Atlas Варианты:
|
auth_mechanism строка | Тип аутентификации. Варианты:
|
connection_options список / элементы=любые | Дополнительные параметры подключения. Укажите список словарей или строк с парами «ключ=значение». |
login_database строка | База данных, в которой хранятся учётные данные для входа. По умолчанию: |
login_host строка | Узел с экземпляром MongoDB, к которому выполняется подключение. По умолчанию: |
login_password строка | Пароль для аутентификации. Обязателен, если указан login_user. |
login_port целое число | Порт сервера MongoDB, к которому выполняется подключение. По умолчанию: |
login_user строка | Пользователь MongoDB для входа. Обязателен, если указан login_password. |
param строка / обязательный | Административный параметр MongoDB, который необходимо изменить. |
param_type строка | Задаёт тип значения параметра. Варианты:
|
replica_set строка | Набор реплик для подключения (для записи подключение автоматически выполняется к первичному узлу). |
ssl псевдонимы: tls логическое значение | Использовать ли SSL-подключение при соединении с базой данных. Варианты:
|
ssl_ca_certs псевдонимы: tlsCAFile строка | Параметр ssl_ca_certs задаёт путь к файлу CA. |
ssl_cert_reqs псевдонимы: tlsAllowInvalidCertificates строка | Определяет, требуется ли сертификат от другой стороны подключения и будет ли он проверяться, если предоставлен. Варианты:
|
ssl_certfile псевдонимы: tlsCertificateKeyFile строка | Предоставляет сертификат клиента с помощью параметра ssl_certfile. |
ssl_crlfile строка | Параметр ssl_crlfile задаёт путь к файлу CRL. |
ssl_keyfile строка | Закрытый ключ сертификата клиента. |
ssl_pem_passphrase псевдонимы: tlsCertificateKeyFilePassword строка | Парольная фраза для расшифровки зашифрованных закрытых ключей. |
strict_compatibility логическое значение | Строго проверять требования к версиям pymongo и MongoDB Варианты:
|
value строка / обязательный | Задаваемое значение административного параметра MongoDB. |
Примечания
Примечание
- На удалённом узле требуется пакет Python pymongo версии 4 или новее.
- Его можно установить с помощью pip или менеджера пакетов ОС.
- См. также https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/
Примеры
- name: Set MongoDB syncdelay to 60 (this is an int)
community.mongodb.mongodb_parameter:
param: syncdelay
value: 60
param_type: int
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
after строка | значение после изменения Возвращается: при успехе |
before строка | значение до изменения Возвращается: при успехе |
Ссылки на коллекцию
© 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_parameter_module.html
