Модуль community.mongodb.mongodb_maintenance — включает или отключает режим обслуживания для вторичного участника.
Примечание
Этот модуль является частью коллекции community.mongodb (версия 1.7.12).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install community.mongodb. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: community.mongodb.mongodb_maintenance.
Добавлено в community.mongodb 1.0.0
Описание
- Включает или отключает режим обслуживания для вторичного участника.
- Обёртка для команды replSetMaintenance.
- Не выполняет никаких действий для участника PRIMARY.
- При включённом режиме участники SECONDARY не обслуживают запросы на чтение.
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- pymongo
Параметры
Параметр | Комментарии |
|---|---|
atlas_auth boolean | Способ аутентификации, предназначенный для экземпляров MongoDB Atlas Варианты:
|
auth_mechanism string | Тип аутентификации. Варианты:
|
connection_options list / elements=any | Дополнительные параметры подключения. Укажите список словарей или строк с парами ключ-значение, разделёнными символом «=». |
login_database string | База данных, в которой хранятся учётные данные для входа. По умолчанию: |
login_host string | Хост, на котором запущен экземпляр MongoDB, к которому выполняется подключение. По умолчанию: |
login_password string | Пароль для аутентификации. Обязателен, если задан login_user. |
login_port integer | Порт сервера MongoDB, к которому выполняется подключение. По умолчанию: |
login_user string | Пользователь MongoDB для входа. Обязателен, если задан login_password. |
maintenance boolean | Включить или отключить режим обслуживания. Варианты:
|
ssl псевдонимы: tls boolean | Использовать ли SSL-соединение при подключении к базе данных. Варианты:
|
ssl_ca_certs псевдонимы: tlsCAFile string | Параметр ssl_ca_certs принимает путь к файлу центра сертификации (CA). |
ssl_cert_reqs псевдонимы: tlsAllowInvalidCertificates string | Указывает, требуется ли сертификат от другой стороны соединения и нужно ли проверять его, если он предоставлен. Варианты:
|
ssl_certfile псевдонимы: tlsCertificateKeyFile string | Предоставляет сертификат клиента с помощью параметра ssl_certfile. |
ssl_crlfile string | Параметр ssl_crlfile принимает путь к файлу списка отзыва сертификатов (CRL). |
ssl_keyfile string | Закрытый ключ сертификата клиента. |
ssl_pem_passphrase псевдонимы: tlsCertificateKeyFilePassword string | Парольная фраза для расшифровки зашифрованных закрытых ключей. |
strict_compatibility boolean | Строго проверять требования к версиям pymongo и MongoDB Варианты:
|
Примечания
Примечание
- На удалённом хосте требуется пакет Python pymongo версии 4 или выше. Его можно установить с помощью pip или менеджера пакетов ОС. @see http://api.mongodb.org/python/current/installation.html
Примеры
- name: Enable maintenance mode
community.mongodb.mongodb_maintenance:
maintenance: true
- name: Disable maintenance mode
community.mongodb.mongodb_maintenance:
maintenance: false
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
changed boolean | Был ли участник переведён в режим обслуживания. Возвращается: при успешном выполнении |
failed boolean | Если произошла ошибка Возвращается: при ошибке |
msg string | Краткое описание произошедшего. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 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_maintenance_module.html
