community.mongodb.mongodb_shutdown – Очищает все ресурсы базы данных и завершает процесс mongod/mongos.
Примечание
Этот плагин входит в коллекцию community.mongodb (версия 1.1.1).
Для его установки используйте: ansible-galaxy collection install community.mongodb
Для использования в playbook, укажите: community.mongodb.mongodb_shutdown
В версии 1.0.0: из community.mongodb
Описание
- Очищает все ресурсы базы данных и завершает процесс.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- pymongo
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_mechanism строка |
| Тип аутентификации. |
| connection_options список / элементы=сырые | Дополнительные параметры подключения. Укажите в виде списка словарей или строк, содержащих пары ключ-значение, разделенные знаком «=». | |
| force булево |
| Укажите значение «true» для принудительного завершения mongod. Принудительное завершение прерывает любые текущие операции с mongod и может привести к непредсказуемому поведению. |
| login_database строка | Значение по умолчанию: "admin" | База данных, в которой хранятся учетные данные для входа. |
| login_host строка | Значение по умолчанию: "localhost" | Хост, на котором работает экземпляр MongoDB для входа. |
| login_password строка | Пароль для аутентификации. Требуется, когда указан параметр login_user. | |
| login_port целое число | Значение по умолчанию: 27017 | Порт сервера MongoDB для входа. |
| login_user строка | Пользователь MongoDB для входа. Требуется, когда указан параметр login_password. | |
| 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 строка | Пароль для расшифровки зашифрованных закрытых ключей. | |
| timeout целое число | Значение по умолчанию: 10 | Количество секунд, которое первичный сервер должен ждать, пока вторичный сервер догонит. |
Примечания
Примечание
- Требуется пакет pymongo Python на удалённом хосте, версии 2.4.2+. Его можно установить с помощью 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
mongodb_maintenance:
force: true
timeout: 60
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| changed булево | успех | Выполнилось ли завершение члена. |
| failed булево | ошибка | Если что-то пошло не так |
| msg строка | успех | Краткое описание того, что произошло. |
Авторы
- Rhys Campbell (@rhysmeister)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/mongodb/mongodb_shutdown_module.html
