community.mongodb.mongodb_maintenance – Enables or disables maintenance mode for a secondary member.
community.mongodb.mongodb_maintenance – Enables or disables maintenance mode for a secondary member.
Note
This plugin is part of the community.mongodb collection (version 1.1.1).
To install it use: ansible-galaxy collection install community.mongodb
.
To use it in a playbook, specify: community.mongodb.mongodb_maintenance
.
New in version 1.0.0: of community.mongodb
Synopsis
- Enables or disables maintenance mode for a secondary member.
- Wrapper around the replSetMaintenance command.
- Performs no actions against a PRIMARY member.
- When enabled SECONDARY members will not service reads.
Requirements
The below requirements are needed on the host that executes this module.
- pymongo
Parameters
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 '='. | |
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. | |
maintenance boolean |
|
Enable or disable maintenance mode. |
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. |
Notes
Note
- Requires the pymongo Python package on the remote host, version 2.4.2+. This can be installed using pip or the OS package manager. @see http://api.mongodb.org/python/current/installation.html
Examples
- name: Enable maintenance mode
community.mongodb.mongodb_maintenance:
maintenance: true
- name: Disable maintenance mode
community.mongodb.mongodb_maintenance:
maintenance: false
Return Values
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 placed into maintenance mode or not.
|
failed boolean |
failed |
If something went wrong
|
msg string |
success |
A short description of what happened.
|
Authors
- 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_maintenance_module.html