Synopsis

Resizes the MongoDB oplog.

This module should only be used with MongoDB 3.6 and above.

Old MongoDB versions should use an alternative method.

Consult https://docs.mongodb.com/manual/tutorial/change-oplog-size for further info.

Requirements

The below requirements are needed on the host that executes this module.

• pymongo

Parameters

oplog_size_mb (True, int, None)

New size of the oplog in MB.

compact (False, bool, False)

Runs compact against the oplog.rs collection in the local database to reclaim disk space.

Performs no actions against PRIMARY members.

The MongoDB user must have the compact role on the local database for this feature to work.

login_user (False, str, None)

The MongoDB user to login with.

Required when login_password is specified.

login_password (False, str, None)

The password used to authenticate with.

Required when login_user is specified.

login_database (False, str, admin)

The database where login credentials are stored.

login_host (False, str, localhost)

The host running MongoDB instance to login to.

login_port (False, int, 27017)

The MongoDB server port to login to.

strict_compatibility (optional, bool, True)

Enforce strict requirements for pymongo and MongoDB software versions

ssl (False, bool, False)

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

ssl_cert_reqs (False, str, CERT_REQUIRED)

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

ssl_ca_certs (False, str, None)

The ssl_ca_certs option takes a path to a CA file.

ssl_crlfile (False, str, None)

The ssl_crlfile option takes a path to a CRL file.

ssl_certfile (False, str, None)

Present a client certificate using the ssl_certfile option.

ssl_keyfile (False, str, None)

Private key for the client certificate.

ssl_pem_passphrase (False, str, None)

Passphrase to decrypt encrypted private keys.

auth_mechanism (False, str, None)

Authentication type.

connection_options (False, list, None)

Additional connection options.

Supply as a list of dicts or strings containing key value pairs seperated with '='.

Notes

Examples

- name: Resize oplog to 16 gigabytes, or 16000 megabytes
  community.mongodb.mongodb_oplog:
    oplog_size_mb: 16000

- name: Resize oplog to 8 gigabytes and compact secondaries to reclaim space
  community.mongodb.mongodb_oplog:
    oplog_size_mb: 8000
    compact: true

Return Values

changed (success, bool, )

Whether the member oplog was modified.

compacted (success, bool, )

Whether the member oplog was compacted.

msg (success, str, )

A short description of what happened.

failed (failed, bool, )

If something went wrong

Status