Модуль community.mongodb.mongodb_stepdown – Перевод узла MongoDB из состояния PRIMARY.

Примечание

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

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

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

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

Впервые появился в community.mongodb 1.0.0

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

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

Требования

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

pymongo

Параметры

Параметр	Комментарии
atlas_auth boolean	Путь аутентификации для экземпляров MongoDB Atlas Варианты: `false` ← (default) `true`
auth_mechanism string	Тип аутентификации. Варианты: `"SCRAM-SHA-256"` `"SCRAM-SHA-1"` `"MONGODB-X509"` `"GSSAPI"` `"PLAIN"`
connection_options list / elements=any	Дополнительные параметры подключения. Укажите в виде списка словарей или строк, содержащих пары ключ-значение, разделенные символом ‘=’.
force boolean	Необязательно. Булево значение, определяющее, будет ли первичный узел переведен в состояние «вне строя», если в течение периода ожидания не существует ни одного избираемого и актуального вторичного узла. Варианты: `false` ← (default) `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 будет ожидать, пока избираемый вторичный узел не догонит первичный. По умолчанию: `10`
ssl aliases: tls boolean	Использовать ли SSL-подключение при подключении к базе данных. Варианты: `false` ← (default) `true`
ssl_ca_certs aliases: tlsCAFile string	Параметр ssl_ca_certs принимает путь к файлу CA.
ssl_cert_reqs aliases: tlsAllowInvalidCertificates string	Указывает, требуется ли сертификат от другой стороны соединения и будет ли он проверен, если предоставлен. Варианты: `"CERT_NONE"` `"CERT_OPTIONAL"` `"CERT_REQUIRED"` ← (default)
ssl_certfile aliases: tlsCertificateKeyFile string	Представить клиентский сертификат, используя параметр ssl_certfile.
ssl_crlfile string	Параметр ssl_crlfile принимает путь к файлу CRL.
ssl_keyfile string	Закрытый ключ для клиентского сертификата.
ssl_pem_passphrase aliases: tlsCertificateKeyFilePassword string	Пароль для расшифровки зашифрованных закрытых ключей.

stepdown_seconds целое число	Количество секунд для перевода узла в состояние пассивного, в течение которого узел не может стать первичным. По умолчанию: `60`
strict_compatibility логическое	Принудительное соблюдение строгих требований к версиям pymongo и MongoDB. Допустимые значения: `false` `true` ← (по умолчанию)

Примечания

Примечание

Требуется пакет pymongo Python версии 4+ на удаленном узле. Его можно установить с помощью pip или менеджера пакетов операционной системы. @see 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/mongodb/mongodb_stepdown_module.html