Модуль community.mongodb.mongodb_shutdown — очищает все ресурсы базы данных, а затем завершает процесс mongod/mongos.
Примечание
Этот модуль входит в коллекцию community.mongodb (версия 1.7.12).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install community.mongodb. Для работы с этим модулем могут потребоваться дополнительные зависимости; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: community.mongodb.mongodb_shutdown.
Добавлено в community.mongodb 1.0.0
Краткое описание
- Очищает все ресурсы базы данных, а затем завершает процесс.
Требования
Следующие требования необходимы на узле, который выполняет этот модуль.
- pymongo
Параметры
Параметр | Комментарии |
|---|---|
atlas_auth логическое значение | Способ аутентификации для экземпляров MongoDB Atlas Варианты:
|
auth_mechanism строка | Тип аутентификации. Варианты:
|
connection_options список / элементы=any | Дополнительные параметры подключения. Передайте их в виде списка словарей или строк с парами ключ-значение, разделёнными символом «=». |
force логическое значение | Укажите true, чтобы принудительно завершить работу mongod. Принудительное завершение прерывает все выполняющиеся операции mongod и может привести к непредвиденному поведению. Варианты:
|
login_database строка | База данных, в которой хранятся учётные данные для входа. По умолчанию: |
login_host строка | Узел, на котором запущен экземпляр MongoDB, к которому выполняется подключение. По умолчанию: |
login_password строка | Пароль для аутентификации. Обязателен, если указан login_user. |
login_port целое число | Порт сервера MongoDB, к которому выполняется подключение. По умолчанию: |
login_user строка | Пользователь MongoDB для подключения. Обязателен, если указан login_password. |
ssl псевдонимы: tls логическое значение | Использовать ли SSL-соединение при подключении к базе данных. Варианты:
|
ssl_ca_certs псевдонимы: tlsCAFile строка | Параметр ssl_ca_certs принимает путь к файлу CA. |
ssl_cert_reqs псевдонимы: tlsAllowInvalidCertificates строка | Определяет, требуется ли сертификат от другой стороны соединения и будет ли он проверен, если предоставлен. Варианты:
|
ssl_certfile псевдонимы: tlsCertificateKeyFile строка | Предоставляет клиентский сертификат с помощью параметра ssl_certfile. |
ssl_crlfile строка | Параметр ssl_crlfile принимает путь к файлу CRL. |
ssl_keyfile строка | Закрытый ключ клиентского сертификата. |
ssl_pem_passphrase псевдонимы: tlsCertificateKeyFilePassword строка | Парольная фраза для расшифровки зашифрованных закрытых ключей. |
strict_compatibility логическое значение | Строго проверять требования к версиям pymongo и MongoDB Варианты:
|
timeout целое число | Количество секунд, в течение которых первичный узел должен ждать синхронизации вторичного узла. По умолчанию: |
Примечания
Примечание
- На удалённом узле требуется пакет Python pymongo версии 4 или выше. Его можно установить с помощью pip или менеджера пакетов ОС. См. http://api.mongodb.org/python/current/installation.html
Примеры
- name: Attempt to perform a clean shutdown
community.mongodb.mongodb_shutdown:
- name: Force shutdown with a timeout of 60 seconds
community.mongodb.mongodb_shutdown:
force: true
timeout: 60
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
changed логическое значение | Был ли участник остановлен. Возвращается: при успехе |
failed логическое значение | Возникает ли ошибка Возвращается: при ошибке |
msg строка | Краткое описание произошедшего. Возвращается: при успехе |
Ссылки на коллекцию
© 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_shutdown_module.html
