community.mongodb.mongodb_balancer module – Manages the MongoDB Sharded Cluster Balancer.

Note

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

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_balancer.

New in version 1.0.0: of community.mongodb

Synopsis

  • Manages the MongoDB Sharded Cluster Balancer.

  • Start or stop the balancer.

  • Adjust the cluster chunksize.

  • Enable or disable autosplit.

  • Add or remove a balancer window.

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

autosplit

boolean

Disable or enable the autosplit flag in the config.settings collection.

Choices:

  • no

  • yes

chunksize

integer

Control the size of chunks in the sharded cluster.

Value should be given in MB.

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.

mongos_process

string

Provide a custom name for the mongos process.

Most users can ignore this setting.

Default: “mongos”

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.

state

string

Manage the Balancer for the Cluster

Choices:

  • started ← (default)

  • stopped

strict_compatibility

boolean

Enforce strict requirements for pymongo and MongoDB software versions

Choices:

  • no

  • yes ← (default)

window

raw

Schedule the balancer window.

Provide the following dictionary keys start, stop, state

The state key should be “present” or “absent”.

The start and stop keys are ignored when state is “absent”.

start and stop should be strings in “HH:MM” format indicating the time bounds of the window.

Notes

Note

Examples

- name: Start the balancer
  community.mongodb.mongodb_balancer:
    state: started

- name: Stop the balancer and disable autosplit
  community.mongodb.mongodb_balancer:
    state: stopped
    autosplit: false

- name: Enable autosplit
  community.mongodb.mongodb_balancer:
    autosplit: true

- name: Change the default chunksize to 128MB
  community.mongodb.mongodb_balancer:
    chunksize: 128

- name: Add or update a balancing window
  community.mongodb.mongodb_balancer:
    window:
      start: "23:00"
      stop: "06:00"
      state: "present"

- name: Remove a balancing window
  community.mongodb.mongodb_balancer:
    window:
      state: "absent"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

Whether the balancer state or autosplit changed.

Returned: success

failed

boolean

If something went wrong

Returned: failed

msg

string

A short description of what happened.

Returned: failure

new_autosplit

string

The new state of autosplit.

Returned: When autosplit is changed.

new_balancer_state

string

The new state of the balancer.

Returned: When balancer state is changed

new_chunksize

integer

The new value for chunksize.

Returned: When chunksize is changed.

old_autosplit

string

The previous state of autosplit.

Returned: When autosplit is changed.

old_balancer_state

string

The previous state of the balancer

Returned: When balancer state is changed

old_chunksize

integer

The previous value for chunksize.

Returned: When chunksize is changed.

Authors

  • Rhys Campbell (@rhysmeister)