Модуль community.mongodb.mongodb_stepdown — понижение узла MongoDB из состояния PRIMARY.

Примечание

Этот модуль входит в коллекцию community.mongodb (версия 1.7.12).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.mongodb. Для использования этого модуля также требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.mongodb.mongodb_stepdown.

Добавлено в community.mongodb 1.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Понижает узел MongoDB из состояния PRIMARY, если он находится в этом состоянии. Немедленно возвращает OK, если участник уже находится в состоянии SECONDARY или ARBITER. Если участник находится в состоянии STARTUP, RECOVERING, STARTUP2 или ROLLBACK, модуль будет ждать, пока его состояние не станет SECONDARY или PRIMARY, но не дольше заданного времени ожидания, прежде чем выполнить необходимые действия.

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

pymongo

Параметры

Параметр	Описание
atlas_auth boolean	Способ аутентификации для экземпляров MongoDB Atlas Варианты: `false` ← (по умолчанию) `true`
auth_mechanism string	Тип аутентификации. Варианты: `"SCRAM-SHA-256"` `"SCRAM-SHA-1"` `"MONGODB-X509"` `"GSSAPI"` `"PLAIN"`
connection_options list / elements=any	Дополнительные параметры подключения. Укажите их в виде списка словарей или строк с парами «ключ=значение».
force boolean	Необязательный параметр. Логическое значение, определяющее, будет ли primary понижен, если в течение периода ожидания не появится доступная для выборов и актуальная secondary. Варианты: `false` ← (по умолчанию) `true`
interval integer	Количество секунд ожидания между выполнениями опроса. По умолчанию: `30`
login_database string	База данных, в которой хранятся учетные данные для входа. По умолчанию: `"admin"`
login_host string	Хост, на котором запущен экземпляр MongoDB, к которому нужно подключиться. По умолчанию: `"localhost"`
login_password string	Пароль для аутентификации. Обязателен, если указан login_user.
login_port integer	Порт сервера MongoDB, к которому нужно подключиться. По умолчанию: `27017`
login_user string	Пользователь MongoDB для входа. Обязателен, если указан login_password.
poll integer	Максимальное количество запросов состояния участника. По умолчанию: `1`
secondary_catch_up integer	Параметр secondaryCatchUpPeriodSecs команды stepDown. Количество секунд, в течение которых mongod будет ждать, пока доступная для выборов secondary догонит primary. По умолчанию: `10`
ssl псевдонимы: tls boolean	Использовать ли SSL-подключение при соединении с базой данных. Варианты: `false` ← (по умолчанию) `true`
ssl_ca_certs псевдонимы: tlsCAFile string	Параметр ssl_ca_certs принимает путь к файлу CA.
ssl_cert_reqs псевдонимы: tlsAllowInvalidCertificates string	Определяет, требуется ли сертификат от другой стороны подключения и нужно ли проверять его, если он предоставлен. Варианты: `"CERT_NONE"` `"CERT_OPTIONAL"` `"CERT_REQUIRED"` ← (по умолчанию)
ssl_certfile псевдонимы: tlsCertificateKeyFile string	Предоставляет сертификат клиента с помощью параметра ssl_certfile.
ssl_crlfile string	Параметр ssl_crlfile принимает путь к файлу CRL.
ssl_keyfile string	Закрытый ключ сертификата клиента.
ssl_pem_passphrase псевдонимы: tlsCertificateKeyFilePassword string	Парольная фраза для расшифровки зашифрованных закрытых ключей.
stepdown_seconds integer	Количество секунд, на которое понижается primary; в течение этого времени участник, пониженный командой stepdown, не может стать primary. По умолчанию: `60`
strict_compatibility boolean	Применять строгие требования к версиям pymongo и MongoDB Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

На удаленном хосте требуется пакет Python pymongo версии 4 или выше. Его можно установить с помощью 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 boolean	Указывает, завершился ли модуль с ошибкой. Возвращается: всегда
iteration integer	Количество запросов модуля к состоянию набора реплик. Возвращается: всегда
msg string	Сообщение о состоянии. Возвращается: всегда

Авторы

Rhys Campbell (@rhysmeister)

Ссылки на коллекцию

© 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_stepdown_module.html