Note
This plugin is part of the community.mongodb collection.
To install it use: ansible-galaxy collection install community.mongodb.
To use it in a playbook, specify: community.mongodb.mongodb_shutdown.
New in version 1.0.0: of community.mongodb
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| auth_mechanism string |
| Authentication type. |
| connection_options list / elements=raw | Additional connection options. Supply as a list of dicts or strings containing key value pairs seperated with '='. | |
| force boolean |
| Specify true to force the mongod to shut down. Force shutdown interrupts any ongoing operations on the mongod and may result in unexpected behavior. |
| login_database string | Default: "admin" | The database where login credentials are stored. |
| login_host string | Default: "localhost" | The host running MongoDB instance to login to. |
| login_password string | The password used to authenticate with. Required when login_user is specified. | |
| login_port integer | Default: 27017 | The MongoDB server port to login to. |
| login_user string | The MongoDB user to login with. Required when login_password is specified. | |
| ssl boolean |
| Whether to use an SSL connection when connecting to the database. |
| ssl_ca_certs string | The ssl_ca_certs option takes a path to a CA file. | |
| ssl_cert_reqs string |
| Specifies whether a certificate is required from the other side of the connection, and whether it will be validated if provided. |
| ssl_certfile string | Present a client certificate using the ssl_certfile option. | |
| ssl_crlfile string | The ssl_crlfile option takes a path to a CRL file. | |
| ssl_keyfile string | Private key for the client certificate. | |
| ssl_pem_passphrase string | Passphrase to decrypt encrypted private keys. | |
| timeout integer | Default: 10 | The number of seconds the primary should wait for a secondary to catch up. |
Note
- 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
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| changed boolean | success | Whether the member was shutdown. |
| failed boolean | failed | If something went wrong |
| msg string | success | A short description of what happened. |
© 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