community.mongodb.mongodb_stepdown – Перевести узел MongoDB из состояния PRIMARY.
Примечание
Этот плагин входит в коллекцию community.mongodb (версия 1.2.0).
Для его установки используйте: ansible-galaxy collection install community.mongodb.
Для использования в книге задач укажите: community.mongodb.mongodb_stepdown.
Новое в версии 1.0.0: коллекции community.mongodb
Описание
- Переводит узел MongoDB из состояния PRIMARY, если он находится в этом состоянии. Возвращает OK сразу, если член уже находится в состояниях SECONDARY или ARBITER. Будет ждать, пока состояние члена не достигнет SECONDARY или PRIMARY, если текущее состояние члена STARTUP, RECOVERING, STARTUP2 или ROLLBACK, прежде чем предпринять необходимые действия.
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- pymongo
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_mechanism строка |
| Тип аутентификации. |
| connection_options список / элементы=сырые | Дополнительные параметры подключения. Указывать как список словарей или строк, содержащих пары ключ-значение, разделенные знаком «=». | |
| force логическое |
| Необязательно. Логическое значение, определяющее, будет ли первичный узел переведен в состояние вторичного, если нет доступного и обновленного вторичного узла в течение периода ожидания. |
| interval целое число | Значение по умолчанию: 30 | Количество секунд, ожидаемых между выполнением запросов. |
| login_database строка | Значение по умолчанию: "admin" | База данных, в которой хранятся учетные данные для входа. |
| login_host строка | Значение по умолчанию: "localhost" | Хост, на котором выполняется экземпляр MongoDB для входа. |
| login_password строка | Пароль, используемый для аутентификации. Требуется, когда указан параметр login_user. | |
| login_port целое число | Значение по умолчанию: 27017 | Порт сервера MongoDB для входа. |
| login_user строка | Пользователь MongoDB для входа. Требуется, когда указан параметр login_password. | |
| poll целое число | Значение по умолчанию: 1 | Максимальное количество попыток запроса состояния члена. |
| secondary_catch_up целое число | Значение по умолчанию: 10 | Параметр secondaryCatchUpPeriodSecs для команды stepDown. Количество секунд, которое mongod будет ожидать, пока доступный вторичный узел догонит первичный. |
| 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 строка | Пароль для расшифровки зашифрованных приватных ключей. | |
| stepdown_seconds целое число | Значение по умолчанию: 60 | Количество секунд для перевода первичного узла в состояние вторичного, в течение которого узел, переводящийся в состояние вторичного, не может стать первичным. |
Примечания
Примечание
- Требуется пакет pymongo Python на удаленном хосте, версия 2.4.2+. Его можно установить с помощью pip или менеджера пакетов ОС. См. http://api.mongodb.org/python/current/installation.html
Примеры
- name: Step down the current MongoDB member
community.mongodb.mongodb_stepdown:
login_user: admin
login_password: secret
- name: Step down the current MongoDB member, poll a maximum of 5 times if member state is recovering
community.mongodb.mongodb_stepdown:
login_user: admin
login_password: secret
poll: 5
interval: 10
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| failed логическое | всегда | Указывает, произошла ли ошибка в модуле. |
| iteration целое число | всегда | Количество раз, когда модуль запрашивал статус репликации. |
| 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_stepdown_module.html
