community / community.mongodb / 1.6.1 / module / mongodb_maintenance Enables or disables maintenance mode for a secondary member. | "added in version" 1.0.0 of community.mongodb" Authors: Rhys Campbell (@rhysmeister)community.mongodb.mongodb_maintenance (1.6.1) — module
Install with ansible-galaxy collection install community.mongodb:==1.6.1
collections: - name: community.mongodb version: 1.6.1
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.
- name: Enable maintenance mode community.mongodb.mongodb_maintenance: maintenance: true
- name: Disable maintenance mode community.mongodb.mongodb_maintenance: maintenance: false
ssl: aliases: - tls default: false description: - Whether to use an SSL connection when connecting to the database. required: false type: bool atlas_auth: default: false description: - Authentication path intended for MongoDB Atlas Instances type: bool login_host: default: localhost description: - The host running MongoDB instance to login to. required: false type: str login_port: default: 27017 description: - The MongoDB server port to login to. required: false type: int login_user: description: - The MongoDB user to login with. - Required when I(login_password) is specified. required: false type: str maintenance: default: false description: Enable or disable maintenance mode. type: bool ssl_crlfile: description: - The ssl_crlfile option takes a path to a CRL file. required: false type: str ssl_keyfile: description: - Private key for the client certificate. required: false type: str ssl_ca_certs: aliases: - tlsCAFile description: - The ssl_ca_certs option takes a path to a CA file. required: false type: str ssl_certfile: aliases: - tlsCertificateKeyFile description: - Present a client certificate using the ssl_certfile option. required: false type: str ssl_cert_reqs: aliases: - tlsAllowInvalidCertificates choices: - CERT_NONE - CERT_OPTIONAL - CERT_REQUIRED default: CERT_REQUIRED description: - Specifies whether a certificate is required from the other side of the connection, and whether it will be validated if provided. required: false type: str auth_mechanism: choices: - SCRAM-SHA-256 - SCRAM-SHA-1 - MONGODB-X509 - GSSAPI - PLAIN description: - Authentication type. required: false type: str login_database: default: admin description: - The database where login credentials are stored. required: false type: str login_password: description: - The password used to authenticate with. - Required when I(login_user) is specified. required: false type: str connection_options: description: - Additional connection options. - Supply as a list of dicts or strings containing key value pairs seperated with '='. elements: raw required: false type: list ssl_pem_passphrase: aliases: - tlsCertificateKeyFilePassword description: - Passphrase to decrypt encrypted private keys. required: false type: str strict_compatibility: default: true description: - Enforce strict requirements for pymongo and MongoDB software versions type: bool
changed: description: Whether the member was placed into maintenance mode or not. returned: success type: bool failed: description: If something went wrong returned: failed type: bool msg: description: A short description of what happened. returned: success type: str