Модуль community.mongodb.mongodb_maintenance — Включение или отключение режима технического обслуживания для вторичного члена.
Примечание
Этот модуль является частью коллекции community.mongodb (версия 1.7.7).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.mongodb. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать его в playbook, укажите: 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 aliases: tls boolean | Использовать подключение SSL при подключении к базе данных. Варианты:
|
ssl_ca_certs aliases: tlsCAFile string | Параметр ssl_ca_certs принимает путь к файлу CA. |
ssl_cert_reqs aliases: tlsAllowInvalidCertificates string | Определяет, требуется ли сертификат от другой стороны подключения и будет ли он проверен, если предоставлен. Варианты:
|
ssl_certfile aliases: tlsCertificateKeyFile string | Используйте клиентский сертификат с помощью ssl_certfile. |
ssl_crlfile string | Параметр ssl_crlfile принимает путь к файлу CRL. |
ssl_keyfile string | Закрытый ключ для клиентского сертификата. |
ssl_pem_passphrase aliases: tlsCertificateKeyFilePassword string | Фраза для расшифровки зашифрованных закрытых ключей. |
strict_compatibility boolean | Принудительно использовать строгие требования для версий pymongo и программного обеспечения MongoDB Варианты:
|
Примечания
Примечание
- Требуется пакет pymongo Python на удалённом хосте, версия 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
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
изменён boolean | Указывает, был ли член помещён в режим технического обслуживания. Возвращено: успешно |
ошибка boolean | Если возникла ошибка. Возвращено: ошибка |
сообщение строка | Краткое описание произошедшего. Возвращено: успешно |
Ссылки на коллекции
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/mongodb/mongodb_maintenance_module.html
