Модуль community.mongodb.mongodb_shutdown – Очищает все ресурсы базы данных и завершает процесс mongod/mongos.
Примечание
Этот модуль входит в коллекцию community.mongodb (версия 1.7.7).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 boolean | Путь аутентификации, предназначенный для экземпляров MongoDB Atlas Варианты:
|
auth_mechanism string | Тип аутентификации. Варианты:
|
connection_options list / elements=any | Дополнительные параметры подключения. Укажите в виде списка словарей или строк, содержащих пары ключ-значение, разделенные знаком ‘=’. |
force boolean | Укажите true, чтобы принудительно завершить работу mongod. Принудительное завершение работы прерывает все текущие операции в mongod и может привести к неожиданному поведению. Варианты:
|
login_database string | База данных, где хранятся учетные данные для входа. По умолчанию: |
login_host string | Хост, на котором запущен экземпляр MongoDB для входа. По умолчанию: |
login_password string | Пароль, используемый для аутентификации. Требуется, если указан login_user. |
login_port integer | Порт сервера MongoDB для входа. По умолчанию: |
login_user string | Пользователь MongoDB, под которым осуществляется вход. Требуется, если указан login_password. |
ssl aliases: tls boolean | Использовать ли SSL-соединение при подключении к базе данных. Варианты:
|
ssl_ca_certs aliases: tlsCAFile string | Параметр ssl_ca_certs принимает путь к файлу CA. |
ssl_cert_reqs aliases: tlsAllowInvalidCertificates string | Указывает, требуется ли сертификат от другой стороны соединения и будет ли он проверен, если предоставлен. Варианты:
|
ssl_certfile aliases: tlsCertificateKeyFile string | Представить клиентский сертификат, используя параметр ssl_certfile. |
ssl_crlfile string | Параметр ssl_crlfile принимает путь к файлу CRL. |
ssl_keyfile string | Закрытый ключ для клиентского сертификата. |
ssl_pem_passphrase aliases: tlsCertificateKeyFilePassword string | Пароль для расшифровки зашифрованных закрытых ключей. |
strict_compatibility boolean | Применять строгие требования к версиям pymongo и MongoDB Варианты:
|
timeout integer | Количество секунд, в течение которых основной узел должен ожидать, пока вторичный узел не догонит. По умолчанию: |
Примечания
Примечание
- Требуется пакет pymongo Python на удаленном хосте, версия 4+. Его можно установить с помощью pip или менеджера пакетов ОС. @see 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 boolean | Была ли выполнена остановка члена. Возвращаемое значение: success |
failed boolean | Если что-то пошло не так Возвращаемое значение: failed |
msg string | Краткое описание произошедшего. Возвращаемое значение: success |
Ссылки на коллекции
© 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_shutdown_module.html
