community.mongodb.mongodb_maintenance – Включает или отключает режим технического обслуживания для вторичного члена.
Примечание
Этот плагин является частью коллекции community.mongodb (версия 1.2.0).
Для его установки используйте: ansible-galaxy collection install community.mongodb
Для использования в книге задач укажите: community.mongodb.mongodb_maintenance
Введено в версии 1.0.0: коллекции community.mongodb
Обзор
- Включает или отключает режим технического обслуживания для вторичного члена.
- Обёртка вокруг команды replSetMaintenance.
- Не выполняет никаких действий над PRIMARY членом.
- При включении SECONDARY члены не будут обрабатывать запросы на чтение.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- pymongo
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_mechanism строка |
| Тип аутентификации. |
| connection_options список / элементы=сырые | Дополнительные параметры подключения. Укажите в виде списка словарей или строк, содержащих пары ключ-значение, разделенные знаком «=». | |
| login_database строка | Значение по умолчанию: "admin" | База данных, в которой хранятся учетные данные для входа. |
| login_host строка | Значение по умолчанию: "localhost" | Хост, на котором выполняется экземпляр MongoDB, для входа. |
| login_password строка | Пароль, используемый для аутентификации. Требуется, когда указан параметр login_user. | |
| login_port целое число | Значение по умолчанию: 27017 | Порт сервера MongoDB для входа. |
| login_user строка | Пользователь MongoDB для входа. Требуется, когда указан параметр login_password. | |
| maintenance логическое значение |
| Включить или отключить режим технического обслуживания. |
| ssl логическое значение |
| Использовать ли SSL-соединение при подключении к базе данных. |
| ssl_ca_certs строка | Параметр ssl_ca_certs принимает путь к файлу CA. | |
| ssl_cert_reqs строка |
| Указывает, требуется ли сертификат от другой стороны соединения и будет ли он проверен при предоставлении. |
| ssl_certfile строка | Представить сертификат клиента с помощью параметра ssl_certfile. | |
| ssl_crlfile строка | Параметр ssl_crlfile принимает путь к файлу CRL. | |
| ssl_keyfile строка | Приватный ключ для сертификата клиента. | |
| ssl_pem_passphrase строка | Пароль для расшифровки зашифрованных приватных ключей. |
Примечания
Примечание
- Требуется пакет pymongo Python на удалённом хосте, версии 2.4.2+. Его можно установить с помощью pip или менеджера пакетов ОС. @см 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 логическое значение | успех | Было ли член помещён в режим технического обслуживания или нет. |
| failed логическое значение | неудачно | Если что-то пошло не так |
| msg строка | успех | Краткое описание произошедшего. |
Авторы
- Rhys Campbell (@rhysmeister)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/mongodb/mongodb_maintenance_module.html
