community.mongodb.mongodb_maintenance – Включает или отключает режим технического обслуживания для вторичного члена.
Примечание
Этот плагин входит в коллекцию community.mongodb (версия 1.1.1).
Для его установки используйте: ansible-galaxy collection install community.mongodb.
Для использования в playbook, укажите: community.mongodb.mongodb_maintenance.
Новое в версии 1.0.0: плагина community.mongodb
Описание
- Включает или отключает режим технического обслуживания для вторичного члена.
- Обёртка вокруг команды replSetMaintenance.
- Не выполняет никаких действий над PRIMARY членом.
- При включении вторичные члены не будут обслуживать запросы чтения.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется данный модуль.
- 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 или менеджера пакетов ОС. @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 булево | успех | Была ли вторичная член введён в режим технического обслуживания или нет. |
| failed булево | неудача | Если что-то пошло не так |
| msg строка | успех | Краткое описание того, что произошло. |
Авторы
- Rhys Campbell (@rhysmeister)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/mongodb/mongodb_maintenance_module.html
