community.mongodb.mongodb_maintenance module – Enables or disables maintenance mode for a secondary member.

Note

This module is part of the community.mongodb collection (version 1.4.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

Comments

auth_mechanism

string

Authentication type.

Choices:

  • SCRAM-SHA-256

  • SCRAM-SHA-1

  • MONGODB-X509

  • GSSAPI

  • PLAIN

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

The database where login credentials are stored.

Default: “admin”

login_host

string

The host running MongoDB instance to login to.

Default: “localhost”

login_password

string

The password used to authenticate with.

Required when login_user is specified.

login_port

integer

The MongoDB server port to login to.

Default: 27017

login_user

string

The MongoDB user to login with.

Required when login_password is specified.

maintenance

boolean

Enable or disable maintenance mode.

Choices:

  • no ← (default)

  • yes

ssl

aliases: tls

boolean

Whether to use an SSL connection when connecting to the database.

Choices:

  • no ← (default)

  • yes

ssl_ca_certs

aliases: tlsCAFile

string

The ssl_ca_certs option takes a path to a CA file.

ssl_cert_reqs

aliases: tlsAllowInvalidCertificates

string

Specifies whether a certificate is required from the other side of the connection, and whether it will be validated if provided.

Choices:

  • CERT_NONE

  • CERT_OPTIONAL

  • CERT_REQUIRED ← (default)

ssl_certfile

aliases: tlsCertificateKeyFile

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

aliases: tlsCertificateKeyFilePassword

string

Passphrase to decrypt encrypted private keys.

strict_compatibility

boolean

Enforce strict requirements for pymongo and MongoDB software versions

Choices:

  • no

  • yes ← (default)

Notes

Note

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

Description

changed

boolean

Whether the member was placed into maintenance mode or not.

Returned: success

failed

boolean

If something went wrong

Returned: failed

msg

string

A short description of what happened.

Returned: success

Authors

  • Rhys Campbell (@rhysmeister)